Game

java.lang.Object
- bwapi.Game

```
public class Game
extends java.lang.Object
```
The abstract Game class is implemented by BWAPI and offers many methods for retrieving information about the current Broodwar game, including the set of players, units, map information, as well as information about the user, such as mouse position, screen position, and the current selection of units.

Method Summary

Methods
Modifier and Type	Method and Description
`java.util.List<Player>`	`allies()` Returns a set of all the ally players that have not left or been defeated.
`boolean`	`canBuildHere(Unit builder, TilePosition position, UnitType type)` Returns true if the given unit type can be built at the given build tile position.
`boolean`	`canBuildHere(Unit builder, TilePosition position, UnitType type, boolean checkExplored)`
`boolean`	`canMake(Unit builder, UnitType type)` Returns true if the AI player has enough resources, supply, tech, and required units in order to make the given unit type.
`boolean`	`canResearch(Unit unit, TechType type)` Returns true if the AI player has enough resources required to research the given tech type.
`boolean`	`canUpgrade(Unit unit, UpgradeType type)` Returns true if the AI player has enough resources required to upgrade the given upgrade type.
`void`	`drawBox(int ctype, int left, int top, int right, int bottom, Color color)` Draws a box on the screen, with the given color.
`void`	`drawBox(int ctype, int left, int top, int right, int bottom, Color color, boolean isSolid)`
`void`	`drawBoxMap(int left, int top, int right, int bottom, Color color)`
`void`	`drawBoxMap(int left, int top, int right, int bottom, Color color, boolean isSolid)`
`void`	`drawBoxMouse(int left, int top, int right, int bottom, Color color)`
`void`	`drawBoxMouse(int left, int top, int right, int bottom, Color color, boolean isSolid)`
`void`	`drawBoxScreen(int left, int top, int right, int bottom, Color color)`
`void`	`drawBoxScreen(int left, int top, int right, int bottom, Color color, boolean isSolid)`
`void`	`drawCircle(int ctype, int x, int y, int radius, Color color)` Draws a circle on the screen, with the given color.
`void`	`drawCircle(int ctype, int x, int y, int radius, Color color, boolean isSolid)`
`void`	`drawCircleMap(int x, int y, int radius, Color color)`
`void`	`drawCircleMap(int x, int y, int radius, Color color, boolean isSolid)`
`void`	`drawCircleMouse(int x, int y, int radius, Color color)`
`void`	`drawCircleMouse(int x, int y, int radius, Color color, boolean isSolid)`
`void`	`drawCircleScreen(int x, int y, int radius, Color color)`
`void`	`drawCircleScreen(int x, int y, int radius, Color color, boolean isSolid)`
`void`	`drawDot(int ctype, int x, int y, Color color)` Draws a dot on the screen at the given position with the given color.
`void`	`drawDotMap(int x, int y, Color color)`
`void`	`drawDotMouse(int x, int y, Color color)`
`void`	`drawDotScreen(int x, int y, Color color)`
`void`	`drawEllipse(int ctype, int x, int y, int xrad, int yrad, Color color)` Draws an ellipse on the screen, with the given color.
`void`	`drawEllipse(int ctype, int x, int y, int xrad, int yrad, Color color, boolean isSolid)`
`void`	`drawEllipseMap(int x, int y, int xrad, int yrad, Color color)`
`void`	`drawEllipseMap(int x, int y, int xrad, int yrad, Color color, boolean isSolid)`
`void`	`drawEllipseMouse(int x, int y, int xrad, int yrad, Color color)`
`void`	`drawEllipseMouse(int x, int y, int xrad, int yrad, Color color, boolean isSolid)`
`void`	`drawEllipseScreen(int x, int y, int xrad, int yrad, Color color)`
`void`	`drawEllipseScreen(int x, int y, int xrad, int yrad, Color color, boolean isSolid)`
`void`	`drawLine(int ctype, int x1, int y1, int x2, int y2, Color color)` Draws a line on the screen from (x1,y1) to (x2,y2) with the given color.
`void`	`drawLineMap(int x1, int y1, int x2, int y2, Color color)`
`void`	`drawLineMouse(int x1, int y1, int x2, int y2, Color color)`
`void`	`drawLineScreen(int x1, int y1, int x2, int y2, Color color)`
`void`	`drawText(int ctype, int x, int y, java.lang.String cstr_format)` Draws text on the screen at the given position.
`void`	`drawTextMap(int x, int y, java.lang.String cstr_format)`
`void`	`drawTextMouse(int x, int y, java.lang.String cstr_format)`
`void`	`drawTextScreen(int x, int y, java.lang.String cstr_format)`
`void`	`drawTriangle(int ctype, int ax, int ay, int bx, int by, int cx, int cy, Color color)` Draws a triangle on the screen.
`void`	`drawTriangle(int ctype, int ax, int ay, int bx, int by, int cx, int cy, Color color, boolean isSolid)`
`void`	`drawTriangleMap(int ax, int ay, int bx, int by, int cx, int cy, Color color)`
`void`	`drawTriangleMap(int ax, int ay, int bx, int by, int cx, int cy, Color color, boolean isSolid)`
`void`	`drawTriangleMouse(int ax, int ay, int bx, int by, int cx, int cy, Color color)`
`void`	`drawTriangleMouse(int ax, int ay, int bx, int by, int cx, int cy, Color color, boolean isSolid)`
`void`	`drawTriangleScreen(int ax, int ay, int bx, int by, int cx, int cy, Color color)`
`void`	`drawTriangleScreen(int ax, int ay, int bx, int by, int cx, int cy, Color color, boolean isSolid)`
`void`	`enableFlag(int flag)` Enables the specified flag.
`java.util.List<Player>`	`enemies()` Returns a set of all the enemy players that have not left or been defeated.
`Player`	`enemy()` Returns a pointer to the enemy player.
`java.util.List<Unit>`	`getAllUnits()` Returns all the visible units.
`int`	`getAPM()` Retrieves the instance number recorded by BWAPI to identify which instance an AI module belongs to
`int`	`getAPM(boolean includeSelects)`
`double`	`getAverageFPS()`
`java.util.List<Bullet>`	`getBullets()` Returns all visible bullets.
`Force`	`getForce(int forceID)` Returns the list of events
`java.util.List<Force>`	`getForces()` Returns the set of all forces in the match.
`int`	`getFPS()` Returns the Frames Per Second (FPS) that the game is currently running at
`int`	`getFrameCount()` Returns the number of logical frames since the match started.
`GameType`	`getGameType()` Returns the game type
`java.util.List<Unit>`	`getGeysers()` Returns the set of all accessible vespene geysers.
`boolean`	`getKeyState(int key)` Returns true if the specified key is pressed.
`boolean`	`getKeyState(Key key)` Returns true if the specified key is pressed.
`Error`	`getLastError()` Returns the last error that was set.
`int`	`getLastEventTime()` Returns the time taken to perform the previous event call.
`int`	`getLatency()` Returns the amount of latency the current game has.
`int`	`getLatencyFrames()` Retrieves latency values for the game.
`int`	`getLatencyTime()`
`java.util.List<Unit>`	`getMinerals()` Returns the set of all accessible mineral patches.
`Position`	`getMousePosition()` Returns the position of the mouse on the screen.
`boolean`	`getMouseState(int button)` Returns true if the specified mouse button is pressed.
`boolean`	`getMouseState(MouseButton button)` Returns true if the specified mouse button is pressed.
`java.util.List<Unit>`	`getNeutralUnits()` Returns the set of all accessible neutral units.
`java.util.List<Position>`	`getNukeDots()` Returns all visible nuke dots.
`Player`	`getPlayer(int playerID)` Returns the player with the given ID, or NULL if no player has the given ID
`java.util.List<Player>`	`getPlayers()` Returns the set of all players in the match.
`Region`	`getRegion(int regionID)` Returns the Region with the given ID, or NULL if no region has the given ID
`Region`	`getRegionAt(int x, int y)` Returns the remaining countdown time in seconds.
`Region`	`getRegionAt(Position position)`
`int`	`getRemainingLatencyFrames()`
`int`	`getRemainingLatencyTime()`
`int`	`getReplayFrameCount()` Retrieves the number of frames in the replay
`int`	`getRevision()` Retrieves the current revision of BWAPI.
`void`	`getScreenBuffer()` Retrieves the screen buffer for the game (excluding the HUD)
`Position`	`getScreenPosition()` Returns the position of the top left corner of the screen on the map.
`java.util.List<Unit>`	`getSelectedUnits()` Returns the set of units currently selected by the user in the GUI.
`java.util.List<TilePosition>`	`getStartLocations()` Returns the set of starting locations for the given map.
`java.util.List<Unit>`	`getStaticGeysers()` Returns the set of all vespene geysers (including mined out and other inaccessible ones).
`java.util.List<Unit>`	`getStaticMinerals()` Returns the set of all mineral patches (including mined out and other inaccessible ones).
`java.util.List<Unit>`	`getStaticNeutralUnits()` Returns the set of all neutral units (including mined out and other inaccessible ones).
`Unit`	`getUnit(int unitID)` Returns the unit with the given ID, or NULL if no unit has the given ID
`java.util.List<Unit>`	`getUnitsInRadius(Position center, int radius)` Returns the set of accessible units within or overlapping a circle at the given point with the given radius.
`java.util.List<Unit>`	`getUnitsInRectangle(int left, int top, int right, int bottom)` Returns the set of accessible units that are in or overlapping the given rectangle.
`java.util.List<Unit>`	`getUnitsInRectangle(Position topLeft, Position bottomRight)`
`java.util.List<Unit>`	`getUnitsOnTile(int tileX, int tileY)` Returns the set of accessible units that are on the given build tile.
`boolean`	`hasCreep(int tileX, int tileY)` Returns true if the specified build tile has zerg creep on it.
`boolean`	`hasCreep(TilePosition position)` Returns true if the specified build tile has zerg creep on it.
`boolean`	`hasPath(Position source, Position destination)` Returns true if Starcraft can find a path from the source to the destination.
`boolean`	`hasPower(int tileX, int tileY)` Returns true if the given build location is powered by a nearby friendly pylon.
`boolean`	`hasPower(int tileX, int tileY, int tileWidth, int tileHeight)` Returns true if the given build location is powered by a nearby friendly pylon.
`boolean`	`hasPower(int tileX, int tileY, int tileWidth, int tileHeight, UnitType unitType)`
`boolean`	`hasPower(int tileX, int tileY, UnitType unitType)`
`boolean`	`hasPower(TilePosition position)` Returns true if the given build location is powered by a nearby friendly pylon.
`boolean`	`hasPower(TilePosition position, int tileWidth, int tileHeight)` Returns true if the given build location is powered by a nearby friendly pylon.
`boolean`	`hasPower(TilePosition position, int tileWidth, int tileHeight, UnitType unitType)`
`boolean`	`hasPower(TilePosition position, UnitType unitType)`
`boolean`	`hasPowerPrecise(int x, int y)` Returns true if the given pixel location is powered by a nearby friendly pylon.
`boolean`	`hasPowerPrecise(int x, int y, UnitType unitType)`
`boolean`	`hasPowerPrecise(Position position)` Returns true if the given pixel location is powered by a nearby friendly pylon.
`boolean`	`hasPowerPrecise(Position position, UnitType unitType)`
`void`	`changeRace(Race race)` Used to change the race while in a lobby.
`Unit`	`indexToUnit(int unitIndex)` Returns a pointer to a Unit given an index.
`boolean`	`isBattleNet()` Returns true if Broodwar is in a BNet multiplayer game.
`boolean`	`isBuildable(int tileX, int tileY)` Returns the ground height of the given build tile. 0 = normal, 1 = high ground. 2 = very high ground.
`boolean`	`isBuildable(int tileX, int tileY, boolean includeBuildings)`
`boolean`	`isBuildable(TilePosition position)` Returns the ground height of the given build tile. 0 = normal, 1 = high ground. 2 = very high ground.
`boolean`	`isBuildable(TilePosition position, boolean includeBuildings)`
`boolean`	`isDebug()` Retrieves the debug state of the BWAPI build.
`boolean`	`isExplored(int tileX, int tileY)` Returns true if the specified build tile has been explored (i.e. was visible at some point in the match).
`boolean`	`isExplored(TilePosition position)` Returns true if the specified build tile has been explored (i.e. was visible at some point in the match).
`boolean`	`isFlagEnabled(int flag)` Returns true if the given flag has been enabled.
`boolean`	`isInGame()` Returns true if Broodwar is in a game.
`boolean`	`isLatComEnabled()` Returns true if latency compensation is enabled
`boolean`	`isMultiplayer()` Returns true if Broodwar is in a multiplayer game.
`boolean`	`isPaused()` Returns true if Broodwar is paused.
`boolean`	`isReplay()` Returns true if Broodwar is in a replay.
`boolean`	`issueCommand(java.util.List<Unit> units, UnitCommand command)` Issues a command to a group of units
`boolean`	`isVisible(int tileX, int tileY)` Returns true if the specified build tile is visible.
`boolean`	`isVisible(TilePosition position)` Returns true if the specified build tile is visible.
`boolean`	`isWalkable(int walkX, int walkY)` Returns true if the specified walk tile is walkable.
`void`	`leaveGame()` Leaves the current match and goes to the after-game stats screen.
`java.lang.String`	`mapFileName()` Returns the file name of the current map.
`java.lang.String`	`mapHash()` Returns the SHA-1 hash of the map file.
`int`	`mapHeight()` Returns the height of the current map, in build tile units.
`java.lang.String`	`mapName()` Returns the name/title of the current map.
`java.lang.String`	`mapPathName()` Returns the full path name of the current map.
`int`	`mapWidth()` Returns the width of the current map, in build tile units.
`Player`	`neutral()` Returns a pointer to the neutral player.
`java.util.List<Player>`	`observers()` Returns a set of all the observer players that have not left.
`void`	`pauseGame()` Pauses the game.
`void`	`pingMinimap(int x, int y)` Pings the given position on the minimap.
`void`	`pingMinimap(Position p)` Pings the given position on the minimap.
`void`	`printf(java.lang.String cstr_format)` Prints text on the screen.
`void`	`restartGame()` Restarts the match.
`void`	`resumeGame()` Resumes the game.
`Player`	`self()` Returns a pointer to the player that BWAPI controls.
`void`	`sendText(java.lang.String cstr_format)` Sends text to other players - as if it were entered in chat.
`void`	`sendTextEx(boolean toAllies, java.lang.String cstr_format)`
`boolean`	`setAlliance(Player player)`
`boolean`	`setAlliance(Player player, boolean allied)` Sets the BWAPI player's alliance with another player.
`boolean`	`setAlliance(Player player, boolean allied, boolean alliedVictory)`
`void`	`setCommandOptimizationLevel()` Returns the elapsed game time in seconds.
`void`	`setCommandOptimizationLevel(int level)`
`void`	`setFrameSkip()` Sets the frame skip value. 1 = normal
`void`	`setFrameSkip(int frameSkip)`
`void`	`setGUI()` Sets the rendering state of the Starcraft GUI
`void`	`setGUI(boolean enabled)`
`boolean`	`setLastError(Error e)` Sets the last error code.
`void`	`setLatCom(boolean isEnabled)` Use to enable or disable latency compensation.
`void`	`setLocalSpeed()` Sets the speed of the game to the given number.
`void`	`setLocalSpeed(int speed)`
`boolean`	`setMap(java.lang.String cstr_mapFileName)` Changes the map to the one specified.
`boolean`	`setReplayVision(Player player)` Hides or reveals a player in a replay.
`boolean`	`setReplayVision(Player player, boolean enabled)`
`boolean`	`setRevealAll()` Enables or disables the Fog of War in a replay.
`boolean`	`setRevealAll(boolean reveal)`
`void`	`setScreenPosition(int x, int y)` Moves the screen to the given position on the map.
`void`	`setScreenPosition(Position p)` Moves the screen to the given position on the map.
`void`	`setTextSize()`
`void`	`setTextSize(int size)`
`boolean`	`setVision(Player player)` Sets the BWAPI player's vision with another player.
`boolean`	`setVision(Player player, boolean enabled)`
`void`	`startGame()` Used to start the game while in a lobby.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getForces
```
public java.util.List<Force> getForces()
```
Returns the set of all forces in the match.

getPlayers
```
public java.util.List<Player> getPlayers()
```
Returns the set of all players in the match. Note that this includes the Neutral player, which owns all the neutral units such as minerals, critters, etc.

getAllUnits
```
public java.util.List<Unit> getAllUnits()
```
Returns all the visible units. If Flag::CompleteMapInformation is enabled, the set of all units is returned, not just visible ones. Note that units inside refineries are not included in this set yet.

getMinerals
```
public java.util.List<Unit> getMinerals()
```
Returns the set of all accessible mineral patches.

getGeysers
```
public java.util.List<Unit> getGeysers()
```
Returns the set of all accessible vespene geysers.

getNeutralUnits
```
public java.util.List<Unit> getNeutralUnits()
```
Returns the set of all accessible neutral units.

getStaticMinerals
```
public java.util.List<Unit> getStaticMinerals()
```
Returns the set of all mineral patches (including mined out and other inaccessible ones).

getStaticGeysers
```
public java.util.List<Unit> getStaticGeysers()
```
Returns the set of all vespene geysers (including mined out and other inaccessible ones).

getStaticNeutralUnits
```
public java.util.List<Unit> getStaticNeutralUnits()
```
Returns the set of all neutral units (including mined out and other inaccessible ones).

getBullets
```
public java.util.List<Bullet> getBullets()
```
Returns all visible bullets. If Flag::CompleteMapInformation is enabled, the set of all bullets is returned, not just visible ones.

getNukeDots
```
public java.util.List<Position> getNukeDots()
```
Returns all visible nuke dots. If Flag::CompleteMapInformation is enabled, the set of all nuke dots is returned, not just visible ones.

getForce
```
public Force getForce(int forceID)
```
Returns the list of events

getPlayer
```
public Player getPlayer(int playerID)
```
Returns the player with the given ID, or NULL if no player has the given ID

getUnit
```
public Unit getUnit(int unitID)
```
Returns the unit with the given ID, or NULL if no unit has the given ID

indexToUnit
```
public Unit indexToUnit(int unitIndex)
```
Returns a pointer to a Unit given an index.

getRegion
```
public Region getRegion(int regionID)
```
Returns the Region with the given ID, or NULL if no region has the given ID

getGameType
```
public GameType getGameType()
```
Returns the game type

getLatency
```
public int getLatency()
```
Returns the amount of latency the current game has. Currently only returns Latency::SinglePlayer, Latency::LanLow, Latency::LanMedium, or Latency::LanHigh.

getFrameCount
```
public int getFrameCount()
```
Returns the number of logical frames since the match started. If the game is paused, Game::getFrameCount will not increase however AIModule::onFrame will still be called while paused. On Fastest, there are about 23.8 - 24 frames per second.

getFPS
```
public int getFPS()
```
Returns the Frames Per Second (FPS) that the game is currently running at

getAverageFPS
```
public double getAverageFPS()
```

getMousePosition
```
public Position getMousePosition()
```
Returns the position of the mouse on the screen. Returns Positions::Unknown if Flag::UserInput is disabled.

getMouseState
```
public boolean getMouseState(MouseButton button)
```
Returns true if the specified mouse button is pressed. Returns false if Flag::UserInput is disabled.

getMouseState
```
public boolean getMouseState(int button)
```
Returns true if the specified mouse button is pressed. Returns false if Flag::UserInput is disabled.

getKeyState
```
public boolean getKeyState(Key key)
```
Returns true if the specified key is pressed. Returns false if Flag::UserInput is disabled. Unfortunately this does not read the raw keyboard input yet - when you hold down a key, the getKeyState function is true for a frame, then false for a few frames, and then alternates between true and false (as if you were holding down the key in a text box). Hopefully this will be fixed in a later version.

getKeyState
```
public boolean getKeyState(int key)
```
Returns true if the specified key is pressed. Returns false if Flag::UserInput is disabled. Unfortunately this does not read the raw keyboard input yet - when you hold down a key, the getKeyState function is true for a frame, then false for a few frames, and then alternates between true and false (as if you were holding down the key in a text box). Hopefully this will be fixed in a later version.

getScreenPosition
```
public Position getScreenPosition()
```
Returns the position of the top left corner of the screen on the map. Returns Positions::Unknown if Flag::UserInput is disabled.

setScreenPosition
```
public void setScreenPosition(int x,
                     int y)
```
Moves the screen to the given position on the map. The position specified where the top left corner of the screen will be.

setScreenPosition
```
public void setScreenPosition(Position p)
```
Moves the screen to the given position on the map. The position specified where the top left corner of the screen will be.

pingMinimap

public void pingMinimap(int x,
               int y)

Pings the given position on the minimap.

pingMinimap
```
public void pingMinimap(Position p)
```
Pings the given position on the minimap.

isFlagEnabled
```
public boolean isFlagEnabled(int flag)
```
Returns true if the given flag has been enabled. Note that flags can only be enabled at the beginning of a match, during the AIModule::onStart callback.

enableFlag
```
public void enableFlag(int flag)
```
Enables the specified flag. Note that flags can only be enabled at the beginning of a match, during the AIModule::onStart callback.

getUnitsOnTile

public java.util.List<Unit> getUnitsOnTile(int tileX,
                                  int tileY)

Returns the set of accessible units that are on the given build tile.

getUnitsInRectangle

public java.util.List<Unit> getUnitsInRectangle(int left,
                                       int top,
                                       int right,
                                       int bottom)

Returns the set of accessible units that are in or overlapping the given rectangle.

getUnitsInRectangle

public java.util.List<Unit> getUnitsInRectangle(Position topLeft,
                                       Position bottomRight)

getUnitsInRadius
```
public java.util.List<Unit> getUnitsInRadius(Position center,
                                    int radius)
```
Returns the set of accessible units within or overlapping a circle at the given point with the given radius.

getLastError
```
public Error getLastError()
```
Returns the last error that was set. If you try to order enemy units around, or morph bunkers into lurkers, BWAPI will set error codes, which can be retrieved using this function.

setLastError
```
public boolean setLastError(Error e)
```
Sets the last error code.

mapWidth
```
public int mapWidth()
```
Returns the width of the current map, in build tile units. To get the width of the current map in walk tile units, multiply by 4. To get the width of the current map in Position units, multiply by TILE_SIZE (which is 32).

mapHeight
```
public int mapHeight()
```
Returns the height of the current map, in build tile units. To get the height of the current map in walk tile units, multiply by 4. To get the height of the current map in Position units, multiply by TILE_SIZE (which is 32).

mapFileName
```
public java.lang.String mapFileName()
```
Returns the file name of the current map.

mapPathName
```
public java.lang.String mapPathName()
```
Returns the full path name of the current map.

mapName
```
public java.lang.String mapName()
```
Returns the name/title of the current map.

mapHash
```
public java.lang.String mapHash()
```
Returns the SHA-1 hash of the map file.

isWalkable
```
public boolean isWalkable(int walkX,
                 int walkY)
```
Returns true if the specified walk tile is walkable. The values of x and y are in walk tile coordinates (different from build tile coordinates). Note that this just uses the static map data. You will also need to make sure no ground units are on the coresponding build tile to see if its currently walkable. To do this, see unitsOnTile.

isBuildable
```
public boolean isBuildable(int tileX,
                  int tileY)
```
Returns the ground height of the given build tile. 0 = normal, 1 = high ground. 2 = very high ground.

isBuildable

public boolean isBuildable(int tileX,
                  int tileY,
                  boolean includeBuildings)

isBuildable
```
public boolean isBuildable(TilePosition position)
```
Returns the ground height of the given build tile. 0 = normal, 1 = high ground. 2 = very high ground.

isBuildable

public boolean isBuildable(TilePosition position,
                  boolean includeBuildings)

isVisible
```
public boolean isVisible(int tileX,
                int tileY)
```
Returns true if the specified build tile is visible. If the tile is concealed by fog of war, the function will return false.

isVisible
```
public boolean isVisible(TilePosition position)
```
Returns true if the specified build tile is visible. If the tile is concealed by fog of war, the function will return false.

isExplored
```
public boolean isExplored(int tileX,
                 int tileY)
```
Returns true if the specified build tile has been explored (i.e. was visible at some point in the match).

isExplored
```
public boolean isExplored(TilePosition position)
```
Returns true if the specified build tile has been explored (i.e. was visible at some point in the match).

hasCreep
```
public boolean hasCreep(int tileX,
               int tileY)
```
Returns true if the specified build tile has zerg creep on it. If the tile is concealed by fog of war, the function will return false.

hasCreep
```
public boolean hasCreep(TilePosition position)
```
Returns true if the specified build tile has zerg creep on it. If the tile is concealed by fog of war, the function will return false.

hasPower
```
public boolean hasPower(int tileX,
               int tileY)
```
Returns true if the given build location is powered by a nearby friendly pylon.

hasPower

public boolean hasPower(int tileX,
               int tileY,
               UnitType unitType)

hasPower
```
public boolean hasPower(TilePosition position)
```
Returns true if the given build location is powered by a nearby friendly pylon.

hasPower

public boolean hasPower(TilePosition position,
               UnitType unitType)

hasPower

public boolean hasPower(int tileX,
               int tileY,
               int tileWidth,
               int tileHeight)

Returns true if the given build location is powered by a nearby friendly pylon.

hasPower

public boolean hasPower(int tileX,
               int tileY,
               int tileWidth,
               int tileHeight,
               UnitType unitType)

hasPower

public boolean hasPower(TilePosition position,
               int tileWidth,
               int tileHeight)

Returns true if the given build location is powered by a nearby friendly pylon.

hasPower

public boolean hasPower(TilePosition position,
               int tileWidth,
               int tileHeight,
               UnitType unitType)

hasPowerPrecise
```
public boolean hasPowerPrecise(int x,
                      int y)
```
Returns true if the given pixel location is powered by a nearby friendly pylon.

hasPowerPrecise

public boolean hasPowerPrecise(int x,
                      int y,
                      UnitType unitType)

hasPowerPrecise
```
public boolean hasPowerPrecise(Position position)
```
Returns true if the given pixel location is powered by a nearby friendly pylon.

hasPowerPrecise

public boolean hasPowerPrecise(Position position,
                      UnitType unitType)

canBuildHere
```
public boolean canBuildHere(Unit builder,
                   TilePosition position,
                   UnitType type)
```
Returns true if the given unit type can be built at the given build tile position. Note the tile position specifies the top left tile of the building. If builder is not null, the unit will be discarded when determining whether or not any ground units are blocking the build location.

canBuildHere

public boolean canBuildHere(Unit builder,
                   TilePosition position,
                   UnitType type,
                   boolean checkExplored)

canMake
```
public boolean canMake(Unit builder,
              UnitType type)
```
Returns true if the AI player has enough resources, supply, tech, and required units in order to make the given unit type. If builder is not null, canMake will return true only if the builder unit can build the given unit type.

canResearch
```
public boolean canResearch(Unit unit,
                  TechType type)
```
Returns true if the AI player has enough resources required to research the given tech type. If unit is not null, canResearch will return true only if the given unit can research the given tech type.

canUpgrade
```
public boolean canUpgrade(Unit unit,
                 UpgradeType type)
```
Returns true if the AI player has enough resources required to upgrade the given upgrade type. If unit is not null, canUpgrade will return true only if the given unit can upgrade the given upgrade type.

getStartLocations
```
public java.util.List<TilePosition> getStartLocations()
```
Returns the set of starting locations for the given map. To determine the starting location for the players in the current match, see Player::getStartLocation.

printf
```
public void printf(java.lang.String cstr_format)
```
Prints text on the screen. Text is not sent to other players in multiplayer games.

sendText
```
public void sendText(java.lang.String cstr_format)
```
Sends text to other players - as if it were entered in chat. In single player games and replays, this will just print the text on the screen. If the game is a single player match and not a replay, then this function can be used to execute cheat codes, i.e. Broodwar->sendText("show me the money").

sendTextEx

public void sendTextEx(boolean toAllies,
              java.lang.String cstr_format)

changeRace
```
public void changeRace(Race race)
```
Used to change the race while in a lobby. Note that there is no onLobbyEnter callback yet, so this function cannot be used at this time.

isInGame
```
public boolean isInGame()
```
Returns true if Broodwar is in a game. Returns false for lobby and menu screens

isMultiplayer
```
public boolean isMultiplayer()
```
Returns true if Broodwar is in a multiplayer game. Returns false for single player games and replays.

isBattleNet
```
public boolean isBattleNet()
```
Returns true if Broodwar is in a BNet multiplayer game.

isPaused
```
public boolean isPaused()
```
Returns true if Broodwar is paused. If the game is paused, Game::getFrameCount will continue to increase and AIModule::onFrame will still be called while paused.

isReplay
```
public boolean isReplay()
```
Returns true if Broodwar is in a replay.

startGame
```
public void startGame()
```
Used to start the game while in a lobby. Note that there is no onLobbyEnter callback yet, so this function cannot be used at this time.

pauseGame
```
public void pauseGame()
```
Pauses the game. If the game is paused, Game::getFrameCount will not increase however AIModule::onFrame will still be called while paused.

resumeGame
```
public void resumeGame()
```
Resumes the game.

leaveGame
```
public void leaveGame()
```
Leaves the current match and goes to the after-game stats screen.

restartGame
```
public void restartGame()
```
Restarts the match. Works the same way as if you restarted the match from the menu screen. Only available in single player mode.

setLocalSpeed
```
public void setLocalSpeed()
```
Sets the speed of the game to the given number. Lower numbers are faster. 0 is the fastest speed StarCraft can handle (which is about as fast as the fastest speed you can view a replay at). Any negative value will reset the speed to the StarCraft default.

setLocalSpeed
```
public void setLocalSpeed(int speed)
```

issueCommand

public boolean issueCommand(java.util.List<Unit> units,
                   UnitCommand command)

Issues a command to a group of units

getSelectedUnits
```
public java.util.List<Unit> getSelectedUnits()
```
Returns the set of units currently selected by the user in the GUI. If Flag?::UserInput? was not enabled during the AIModule::onStart callback, this function will always return an empty set.

self
```
public Player self()
```
Returns a pointer to the player that BWAPI controls. In replays this will return null.

enemy
```
public Player enemy()
```
Returns a pointer to the enemy player. If there is more than one enemy, this returns a pointer to just one enemy (see enemies to get all enemies still in game). In replays this will return NULL.

neutral
```
public Player neutral()
```
Returns a pointer to the neutral player.

allies
```
public java.util.List<Player> allies()
```
Returns a set of all the ally players that have not left or been defeated. Does not include self.

enemies
```
public java.util.List<Player> enemies()
```
Returns a set of all the enemy players that have not left or been defeated.

observers
```
public java.util.List<Player> observers()
```
Returns a set of all the observer players that have not left.

setTextSize
```
public void setTextSize()
```

setTextSize
```
public void setTextSize(int size)
```

drawText
```
public void drawText(int ctype,
            int x,
            int y,
            java.lang.String cstr_format)
```
Draws text on the screen at the given position. Text can be drawn in different colors by using the following control characters: TODO: add image from wiki.

drawTextMap

public void drawTextMap(int x,
               int y,
               java.lang.String cstr_format)

drawTextMouse

public void drawTextMouse(int x,
                 int y,
                 java.lang.String cstr_format)

drawTextScreen

public void drawTextScreen(int x,
                  int y,
                  java.lang.String cstr_format)

drawBox

public void drawBox(int ctype,
           int left,
           int top,
           int right,
           int bottom,
           Color color)

Draws a box on the screen, with the given color. If isSolid is true, the entire box will be rendered, otherwise just the outline will be drawn.

drawBox

public void drawBox(int ctype,
           int left,
           int top,
           int right,
           int bottom,
           Color color,
           boolean isSolid)

drawBoxMap

public void drawBoxMap(int left,
              int top,
              int right,
              int bottom,
              Color color)

drawBoxMap

public void drawBoxMap(int left,
              int top,
              int right,
              int bottom,
              Color color,
              boolean isSolid)

drawBoxMouse

public void drawBoxMouse(int left,
                int top,
                int right,
                int bottom,
                Color color)

drawBoxMouse

public void drawBoxMouse(int left,
                int top,
                int right,
                int bottom,
                Color color,
                boolean isSolid)

drawBoxScreen

public void drawBoxScreen(int left,
                 int top,
                 int right,
                 int bottom,
                 Color color)

drawBoxScreen

public void drawBoxScreen(int left,
                 int top,
                 int right,
                 int bottom,
                 Color color,
                 boolean isSolid)

drawTriangle

public void drawTriangle(int ctype,
                int ax,
                int ay,
                int bx,
                int by,
                int cx,
                int cy,
                Color color)

Draws a triangle on the screen. If isSolid is true, a solid triangle is drawn, otherwise just the outline of the triangle will be drawn.

drawTriangle

public void drawTriangle(int ctype,
                int ax,
                int ay,
                int bx,
                int by,
                int cx,
                int cy,
                Color color,
                boolean isSolid)

drawTriangleMap

public void drawTriangleMap(int ax,
                   int ay,
                   int bx,
                   int by,
                   int cx,
                   int cy,
                   Color color)

drawTriangleMap

public void drawTriangleMap(int ax,
                   int ay,
                   int bx,
                   int by,
                   int cx,
                   int cy,
                   Color color,
                   boolean isSolid)

drawTriangleMouse

public void drawTriangleMouse(int ax,
                     int ay,
                     int bx,
                     int by,
                     int cx,
                     int cy,
                     Color color)

drawTriangleMouse

public void drawTriangleMouse(int ax,
                     int ay,
                     int bx,
                     int by,
                     int cx,
                     int cy,
                     Color color,
                     boolean isSolid)

drawTriangleScreen

public void drawTriangleScreen(int ax,
                      int ay,
                      int bx,
                      int by,
                      int cx,
                      int cy,
                      Color color)

drawTriangleScreen

public void drawTriangleScreen(int ax,
                      int ay,
                      int bx,
                      int by,
                      int cx,
                      int cy,
                      Color color,
                      boolean isSolid)

drawCircle
```
public void drawCircle(int ctype,
              int x,
              int y,
              int radius,
              Color color)
```
Draws a circle on the screen, with the given color. If isSolid is true, a solid circle is drawn, otherwise just the outline of a circle will be drawn.

drawCircle

public void drawCircle(int ctype,
              int x,
              int y,
              int radius,
              Color color,
              boolean isSolid)

drawCircleMap

public void drawCircleMap(int x,
                 int y,
                 int radius,
                 Color color)

drawCircleMap

public void drawCircleMap(int x,
                 int y,
                 int radius,
                 Color color,
                 boolean isSolid)

drawCircleMouse

public void drawCircleMouse(int x,
                   int y,
                   int radius,
                   Color color)

drawCircleMouse

public void drawCircleMouse(int x,
                   int y,
                   int radius,
                   Color color,
                   boolean isSolid)

drawCircleScreen

public void drawCircleScreen(int x,
                    int y,
                    int radius,
                    Color color)

drawCircleScreen

public void drawCircleScreen(int x,
                    int y,
                    int radius,
                    Color color,
                    boolean isSolid)

drawEllipse

public void drawEllipse(int ctype,
               int x,
               int y,
               int xrad,
               int yrad,
               Color color)

Draws an ellipse on the screen, with the given color. If isSolid is true, a solid ellipse is drawn, otherwise just the outline of an ellipse will be drawn.

drawEllipse

public void drawEllipse(int ctype,
               int x,
               int y,
               int xrad,
               int yrad,
               Color color,
               boolean isSolid)

drawEllipseMap

public void drawEllipseMap(int x,
                  int y,
                  int xrad,
                  int yrad,
                  Color color)

drawEllipseMap

public void drawEllipseMap(int x,
                  int y,
                  int xrad,
                  int yrad,
                  Color color,
                  boolean isSolid)

drawEllipseMouse

public void drawEllipseMouse(int x,
                    int y,
                    int xrad,
                    int yrad,
                    Color color)

drawEllipseMouse

public void drawEllipseMouse(int x,
                    int y,
                    int xrad,
                    int yrad,
                    Color color,
                    boolean isSolid)

drawEllipseScreen

public void drawEllipseScreen(int x,
                     int y,
                     int xrad,
                     int yrad,
                     Color color)

drawEllipseScreen

public void drawEllipseScreen(int x,
                     int y,
                     int xrad,
                     int yrad,
                     Color color,
                     boolean isSolid)

drawDot

public void drawDot(int ctype,
           int x,
           int y,
           Color color)

Draws a dot on the screen at the given position with the given color.

drawDotMap

public void drawDotMap(int x,
              int y,
              Color color)

drawDotMouse

public void drawDotMouse(int x,
                int y,
                Color color)

drawDotScreen

public void drawDotScreen(int x,
                 int y,
                 Color color)

drawLine

public void drawLine(int ctype,
            int x1,
            int y1,
            int x2,
            int y2,
            Color color)

Draws a line on the screen from (x1,y1) to (x2,y2) with the given color.

drawLineMap

public void drawLineMap(int x1,
               int y1,
               int x2,
               int y2,
               Color color)

drawLineMouse

public void drawLineMouse(int x1,
                 int y1,
                 int x2,
                 int y2,
                 Color color)

drawLineScreen

public void drawLineScreen(int x1,
                  int y1,
                  int x2,
                  int y2,
                  Color color)

getScreenBuffer
```
public void getScreenBuffer()
```
Retrieves the screen buffer for the game (excluding the HUD)

getLatencyFrames
```
public int getLatencyFrames()
```
Retrieves latency values for the game. Includes latency, speed, and mode

getLatencyTime
```
public int getLatencyTime()
```

getRemainingLatencyFrames

public int getRemainingLatencyFrames()

getRemainingLatencyTime
```
public int getRemainingLatencyTime()
```

getRevision
```
public int getRevision()
```
Retrieves the current revision of BWAPI.

isDebug
```
public boolean isDebug()
```
Retrieves the debug state of the BWAPI build.

isLatComEnabled
```
public boolean isLatComEnabled()
```
Returns true if latency compensation is enabled

setLatCom
```
public void setLatCom(boolean isEnabled)
```
Use to enable or disable latency compensation. Default: Enabled

getReplayFrameCount
```
public int getReplayFrameCount()
```
Retrieves the number of frames in the replay

setGUI
```
public void setGUI()
```
Sets the rendering state of the Starcraft GUI

setGUI
```
public void setGUI(boolean enabled)
```

getAPM
```
public int getAPM()
```
Retrieves the instance number recorded by BWAPI to identify which instance an AI module belongs to

getAPM

public int getAPM(boolean includeSelects)

setMap
```
public boolean setMap(java.lang.String cstr_mapFileName)
```
Changes the map to the one specified. Changes do not take effect unless the game is restarted.

setFrameSkip
```
public void setFrameSkip()
```
Sets the frame skip value. 1 = normal

setFrameSkip

public void setFrameSkip(int frameSkip)

hasPath

public boolean hasPath(Position source,
              Position destination)

Returns true if Starcraft can find a path from the source to the destination.

setAlliance

public boolean setAlliance(Player player,
                  boolean allied)

Sets the BWAPI player's alliance with another player.

setAlliance

public boolean setAlliance(Player player)

setAlliance

public boolean setAlliance(Player player,
                  boolean allied,
                  boolean alliedVictory)

setVision
```
public boolean setVision(Player player)
```
Sets the BWAPI player's vision with another player.

setVision

public boolean setVision(Player player,
                boolean enabled)

setCommandOptimizationLevel
```
public void setCommandOptimizationLevel()
```
Returns the elapsed game time in seconds.

setCommandOptimizationLevel

public void setCommandOptimizationLevel(int level)

getRegionAt

public Region getRegionAt(int x,
                 int y)

Returns the remaining countdown time in seconds.

getRegionAt

public Region getRegionAt(Position position)

getLastEventTime
```
public int getLastEventTime()
```
Returns the time taken to perform the previous event call. Used for tournament management.

setReplayVision
```
public boolean setReplayVision(Player player)
```
Hides or reveals a player in a replay.

setReplayVision

public boolean setReplayVision(Player player,
                      boolean enabled)

setRevealAll
```
public boolean setRevealAll()
```
Enables or disables the Fog of War in a replay.

setRevealAll

public boolean setRevealAll(boolean reveal)

Class Game

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getForces

getPlayers

getAllUnits

getMinerals

getGeysers

getNeutralUnits

getStaticMinerals

getStaticGeysers

getStaticNeutralUnits

getBullets

getNukeDots

getForce

getPlayer

getUnit

indexToUnit

getRegion

getGameType

getLatency

getFrameCount

getFPS

getAverageFPS

getMousePosition

getMouseState

getMouseState

getKeyState

getKeyState

getScreenPosition

setScreenPosition

setScreenPosition

pingMinimap

pingMinimap

isFlagEnabled

enableFlag

getUnitsOnTile

getUnitsInRectangle

getUnitsInRectangle

getUnitsInRadius

getLastError

setLastError

mapWidth

mapHeight

mapFileName

mapPathName

mapName

mapHash

isWalkable

isBuildable

isBuildable

isBuildable

isBuildable

isVisible

isVisible

isExplored

isExplored

hasCreep

hasCreep

hasPower

hasPower

hasPower

hasPower

hasPower

hasPower

hasPower

hasPower

hasPowerPrecise

hasPowerPrecise

hasPowerPrecise

hasPowerPrecise

canBuildHere

canBuildHere

canMake

canResearch

canUpgrade

getStartLocations

printf

sendText