bwapi

Class Mirror

java.lang.Object

bwapi.Mirror

public class Mirror
extends java.lang.Object

The API entry point. Standard use case:

• Create a Mirror object and use getModule() and then set an AIModule's BWEventListener
  
• Call startGame() to init the API and connect to Broodwar, then launch Broodwar from ChaosLauncher.
• In you BWEventListener.onStart() method, receive the Game object by calling getGame()

Example

     mirror.getModule().setEventListener(new DefaultBWListener()
     {
            public void onStart() {
                game = mirror.getGame();
                self = game.self();
                //initialization
                ....
            }

           public void onUpdate() {
               for (Unit myUnit : self.getUnits()) {
                   //give orders to unit
                   ...
                }
           }
        });
     
     mirror.startGame();
 

Note: The Game object is initialized during the startGame() as well as other BWMirror API's constants. Do not use any API releated methods/fields prior to startGame().

Constructor Summary

Constructors

Constructor and Description
Mirror()

Method Summary

Methods

Modifier and Type	Method and Description
Game	getGame()
AIModule	getModule()
void	startGame() Starts the API, initializes all constants ( UnitType, WeaponType ) and the Game object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Mirror

public Mirror()

Method Detail

getGame

public Game getGame()

getModule

public AIModule getModule()

startGame

public void startGame()

Starts the API, initializes all constants ( UnitType, WeaponType ) and the Game object. This method blocks until the end of game.