Game (jbwapi 2.1.0 API)

java.lang.Object
- bwapi.Game

```
public final class Game
extends Object
```
The Game class is implemented by BWAPI and is the primary means of obtaining all game state information from Starcraft Broodwar. Game state information includes all units, resources, players, forces, bullets, terrain, fog of war, regions, etc.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<Player>`	`allies()` Retrieves a set of all the current player's remaining allies.
`boolean`	`canBuildHere(TilePosition position, UnitType type)`
`boolean`	`canBuildHere(TilePosition position, UnitType type, Unit builder)`
`boolean`	`canBuildHere(TilePosition position, UnitType type, Unit builder, boolean checkExplored)` Checks if the given unit type can be built at the given build tile position.
`boolean`	`canMake(UnitType type)`
`boolean`	`canMake(UnitType type, Unit builder)` Checks all the requirements in order to make a given unit type for the current player.
`boolean`	`canResearch(TechType type)`
`boolean`	`canResearch(TechType type, Unit unit)`
`boolean`	`canResearch(TechType type, Unit unit, boolean checkCanIssueCommandType)` Checks all the requirements in order to research a given technology type for the current player.
`boolean`	`canUpgrade(UpgradeType type)`
`boolean`	`canUpgrade(UpgradeType type, Unit unit)`
`boolean`	`canUpgrade(UpgradeType type, Unit unit, boolean checkCanIssueCommandType)` Checks all the requirements in order to upgrade a given upgrade type for the current player.
`int`	`countdownTimer()` Returns the remaining countdown time.
`void`	`drawBox(CoordinateType ctype, int left, int top, int right, int bottom, Color color)`
`void`	`drawBox(CoordinateType ctype, int left, int top, int right, int bottom, Color color, boolean isSolid)` Draws a rectangle on the screen with the given color.
`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`	`drawBoxMap(Position leftTop, Position rightBottom, Color color)`
`void`	`drawBoxMap(Position leftTop, Position rightBottom, 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`	`drawBoxMouse(Position leftTop, Position rightBottom, Color color)`
`void`	`drawBoxMouse(Position leftTop, Position rightBottom, 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`	`drawBoxScreen(Position leftTop, Position rightBottom, Color color)`
`void`	`drawBoxScreen(Position leftTop, Position rightBottom, Color color, boolean isSolid)`
`void`	`drawCircle(CoordinateType ctype, int x, int y, int radius, Color color)`
`void`	`drawCircle(CoordinateType ctype, int x, int y, int radius, Color color, boolean isSolid)` Draws a circle on the screen with the given color.
`void`	`drawCircleMap(int x, int y, int radius, Color color)`
`void`	`drawCircleMap(int x, int y, int radius, Color color, boolean isSolid)`
`void`	`drawCircleMap(Position p, int radius, Color color)`
`void`	`drawCircleMap(Position p, 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`	`drawCircleMouse(Position p, int radius, Color color)`
`void`	`drawCircleMouse(Position p, 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`	`drawCircleScreen(Position p, int radius, Color color)`
`void`	`drawCircleScreen(Position p, int radius, Color color, boolean isSolid)`
`void`	`drawDot(CoordinateType ctype, int x, int y, Color color)` Draws a dot on the map or screen with a given color.
`void`	`drawDotMap(int x, int y, Color color)`
`void`	`drawDotMap(Position p, Color color)`
`void`	`drawDotMouse(int x, int y, Color color)`
`void`	`drawDotMouse(Position p, Color color)`
`void`	`drawDotScreen(int x, int y, Color color)`
`void`	`drawDotScreen(Position p, Color color)`
`void`	`drawEllipse(CoordinateType ctype, int x, int y, int xrad, int yrad, Color color)`
`void`	`drawEllipse(CoordinateType ctype, int x, int y, int xrad, int yrad, Color color, boolean isSolid)` Draws an ellipse on the screen with the given color.
`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`	`drawEllipseMap(Position p, int xrad, int yrad, Color color)`
`void`	`drawEllipseMap(Position p, 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`	`drawEllipseMouse(Position p, int xrad, int yrad, Color color)`
`void`	`drawEllipseMouse(Position p, 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`	`drawEllipseScreen(Position p, int xrad, int yrad, Color color)`
`void`	`drawEllipseScreen(Position p, int xrad, int yrad, Color color, boolean isSolid)`
`void`	`drawLine(CoordinateType ctype, int x1, int y1, int x2, int y2, Color color)` Draws a line on the map or screen with a given color.
`void`	`drawLineMap(int x1, int y1, int x2, int y2, Color color)`
`void`	`drawLineMap(Position a, Position b, Color color)`
`void`	`drawLineMouse(int x1, int y1, int x2, int y2, Color color)`
`void`	`drawLineMouse(Position a, Position b, Color color)`
`void`	`drawLineScreen(int x1, int y1, int x2, int y2, Color color)`
`void`	`drawLineScreen(Position a, Position b, Color color)`
`void`	`drawText(CoordinateType ctype, int x, int y, String string, Text... colors)`
`void`	`drawTextMap(int x, int y, String string, Text... colors)`
`void`	`drawTextMap(Position p, String string, Text... colors)`
`void`	`drawTextMouse(int x, int y, String string, Text... colors)`
`void`	`drawTextMouse(Position p, String string, Text... colors)`
`void`	`drawTextScreen(int x, int y, String string, Text... colors)`
`void`	`drawTextScreen(Position p, String string, Text... colors)`
`void`	`drawTriangle(CoordinateType ctype, int ax, int ay, int bx, int by, int cx, int cy, Color color)`
`void`	`drawTriangle(CoordinateType ctype, int ax, int ay, int bx, int by, int cx, int cy, Color color, boolean isSolid)` Draws a triangle on the screen with the given color.
`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`	`drawTriangleMap(Position a, Position b, Position c, Color color)`
`void`	`drawTriangleMap(Position a, Position b, Position c, 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`	`drawTriangleMouse(Position a, Position b, Position c, Color color)`
`void`	`drawTriangleMouse(Position a, Position b, Position c, 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`	`drawTriangleScreen(Position a, Position b, Position c, Color color)`
`void`	`drawTriangleScreen(Position a, Position b, Position c, Color color, boolean isSolid)`
`int`	`elapsedTime()` Retrieves current amount of time in seconds that the game has elapsed.
`void`	`enableFlag(Flag flag)` Enables the state of a given flag.
`List<Player>`	`enemies()` Retrieves a set of all the current player's remaining enemies.
`Player`	`enemy()` Retrieves the `Player` interface that represents the enemy player.
`List<Region>`	`getAllRegions()` Retrieves the set of all regions on the map.
`List<Unit>`	`getAllUnits()` Retrieves the set of all accessible units.
`int`	`getAPM()`
`int`	`getAPM(boolean includeSelects)` Retrieves the Actions Per Minute (APM) that the bot is producing.
`double`	`getAverageFPS()` Retrieves the average logical frame rate of the game in frames per second (FPS).
`TilePosition`	`getBuildLocation(UnitType type, TilePosition desiredPosition)`
`TilePosition`	`getBuildLocation(UnitType type, TilePosition desiredPosition, int maxRange)`
`TilePosition`	`getBuildLocation(UnitType type, TilePosition desiredPosition, int maxRange, boolean creep)` Retrieves a basic build position just as the default Computer AI would.
`List<Bullet>`	`getBullets()` Retrieves the set of all accessible bullets.
`Unit`	`getClosestUnit(Position center)`
`Unit`	`getClosestUnit(Position center, int radius)`
`Unit`	`getClosestUnit(Position center, int radius, UnitFilter pred)` Retrieves the closest unit to center that matches the criteria of the callback pred within an optional radius.
`Unit`	`getClosestUnit(Position center, UnitFilter pred)`
`Unit`	`getClosestUnitInRectangle(Position center, int left, int top, int right, int bottom)`
`Unit`	`getClosestUnitInRectangle(Position center, int left, int top, int right, int bottom, UnitFilter pred)` Retrieves the closest unit to center that matches the criteria of the callback pred within an optional rectangle.
`int`	`getDamageFrom(UnitType fromType, UnitType toType)`
`int`	`getDamageFrom(UnitType fromType, UnitType toType, Player fromPlayer)`
`int`	`getDamageFrom(UnitType fromType, UnitType toType, Player fromPlayer, Player toPlayer)` Calculates the damage received for a given player.
`int`	`getDamageTo(UnitType toType, UnitType fromType)`
`int`	`getDamageTo(UnitType toType, UnitType fromType, Player toPlayer)`
`int`	`getDamageTo(UnitType toType, UnitType fromType, Player toPlayer, Player fromPlayer)` Calculates the damage dealt for a given player.
`Force`	`getForce(int forceID)` Retrieves the `Force` object associated with a given identifier.
`List<Force>`	`getForces()` Retrieves the set of all teams/forces.
`int`	`getFPS()` Retrieves the logical frame rate of the game in frames per second (FPS).
`int`	`getFrameCount()` Retrieves the number of logical frames since the beginning of the match.
`GameType`	`getGameType()` Retrieves the `GameType` of the current game.
`List<Unit>`	`getGeysers()` Retrieves the set of all accessible @geysers in the game.
`int`	`getGroundHeight(int tileX, int tileY)` Returns the ground height at the given tile position.
`int`	`getGroundHeight(TilePosition position)`
`int`	`getInstanceNumber()` Retrieves the Starcraft instance number recorded by BWAPI to identify which Starcraft instance an AI module belongs to.
`boolean`	`getKeyState(Key key)` Retrieves the state of the given keyboard key.
`int`	`getLastEventTime()` Retrieves the amount of time (in milliseconds) that has elapsed when running the last AI module callback.
`Latency`	`getLatency()` Retrieves the current latency setting that the game is set to.
`int`	`getLatencyFrames()` Retrieves the maximum delay, in number of frames, between a command being issued and the command being executed by Broodwar.
`int`	`getLatencyTime()` Retrieves the maximum delay, in milliseconds, between a command being issued and the command being executed by Broodwar.
`List<Unit>`	`getMinerals()` Retrieves the set of all accessible @minerals in the game.
`Position`	`getMousePosition()` Retrieves the position of the user's mouse on the screen, in `Position` coordinates.
`boolean`	`getMouseState(MouseButton button)` Retrieves the state of the given mouse button.
`List<Unit>`	`getNeutralUnits()` Retrieves the set of all accessible neutral units in the game.
`List<Position>`	`getNukeDots()` Retrieves the set of all accessible @Nuke dots.
`Player`	`getPlayer(int playerID)` Retrieves the `Player` object associated with a given identifier.
`List<Player>`	`getPlayers()` Retrieves the set of all players in the match.
`int`	`getRandomSeed()` Retrieves the initial random seed that was used in this game's creation.
`Region`	`getRegion(int regionID)` Retrieves the `Region` object associated with a given identifier.
`Region`	`getRegionAt(int x, int y)` Retrieves the region at a given position.
`Region`	`getRegionAt(Position position)`
`int`	`getRemainingLatencyFrames()` Retrieves the number of frames it will take before a command sent in the current frame will be executed by the game.
`int`	`getRemainingLatencyTime()` Retrieves the number of milliseconds it will take before a command sent in the current frame will be executed by Broodwar.
`int`	`getReplayFrameCount()` Retrieves the maximum number of logical frames that have been recorded in a replay.
`int`	`getRevision()` Retrieves the current revision of BWAPI.
`Position`	`getScreenPosition()` Retrieves the top left position of the viewport from the top left corner of the map, in pixels.
`List<Unit>`	`getSelectedUnits()` Retrieves the set of units that are currently selected by the user outside of BWAPI.
`List<TilePosition>`	`getStartLocations()` Retrieves the set of all starting locations for the current map.
`List<Unit>`	`getStaticGeysers()` Retrieves the set of all @geysers that were available at the beginning of the game.
`List<Unit>`	`getStaticMinerals()` Retrieves the set of all @minerals that were available at the beginning of the game.
`List<Unit>`	`getStaticNeutralUnits()` Retrieves the set of all units owned by the neutral player (resources, critters, etc.) that were available at the beginning of the game.
`Unit`	`getUnit(int unitID)` Retrieves the `Unit` object associated with a given identifier.
`List<Unit>`	`getUnitsInRadius(int x, int y, int radius)`
`List<Unit>`	`getUnitsInRadius(int x, int y, int radius, UnitFilter pred)` Retrieves the set of accessible units that are within a given radius of a position.
`List<Unit>`	`getUnitsInRadius(Position center, int radius)`
`List<Unit>`	`getUnitsInRadius(Position center, int radius, UnitFilter pred)`
`List<Unit>`	`getUnitsInRectangle(int left, int top, int right, int bottom)`
`List<Unit>`	`getUnitsInRectangle(int left, int top, int right, int bottom, UnitFilter pred)` Retrieves the set of accessible units that are in a given rectangle.
`List<Unit>`	`getUnitsInRectangle(Position leftTop, Position rightBottom)`
`List<Unit>`	`getUnitsInRectangle(Position leftTop, Position rightBottom, UnitFilter pred)`
`List<Unit>`	`getUnitsOnTile(int tileX, int tileY)`
`List<Unit>`	`getUnitsOnTile(int tileX, int tileY, UnitFilter pred)` Retrieves the set of accessible units that are on a given build tile.
`List<Unit>`	`getUnitsOnTile(TilePosition tile)`
`boolean`	`hasCreep(int tileX, int tileY)` Checks if the given tile position has @Zerg creep on it.
`boolean`	`hasCreep(TilePosition position)`
`boolean`	`hasPath(Position source, Position destination)` Checks if there is a path from source to destination.
`boolean`	`hasPower(int tileX, int tileY)`
`boolean`	`hasPower(int tileX, int tileY, int tileWidth, int tileHeight)`
`boolean`	`hasPower(int tileX, int tileY, int tileWidth, int tileHeight, UnitType unitType)` Checks if the given tile position if powered by an owned @Protoss_Pylon for an optional unit type.
`boolean`	`hasPower(int tileX, int tileY, UnitType unitType)`
`boolean`	`hasPower(TilePosition position)`
`boolean`	`hasPower(TilePosition position, int tileWidth, int tileHeight)`
`boolean`	`hasPower(TilePosition position, int tileWidth, int tileHeight, UnitType unitType)`
`boolean`	`hasPower(TilePosition position, UnitType unitType)`
`boolean`	`hasPowerPrecise(int x, int y)`
`boolean`	`hasPowerPrecise(int x, int y, UnitType unitType)` Checks if the given pixel position is powered by an owned @Protoss_Pylon for an optional unit type.
`boolean`	`hasPowerPrecise(Position position)`
`boolean`	`hasPowerPrecise(Position position, UnitType unitType)`
`boolean`	`isBattleNet()` Checks if the client is in a game that was created through the Battle.net multiplayer gaming service.
`boolean`	`isBuildable(int tileX, int tileY)`
`boolean`	`isBuildable(int tileX, int tileY, boolean includeBuildings)` Checks if a given tile position is buildable.
`boolean`	`isBuildable(TilePosition position)`
`boolean`	`isBuildable(TilePosition position, boolean includeBuildings)`
`boolean`	`isDebug()` Retrieves the debug state of the BWAPI build.
`boolean`	`isExplored(int tileX, int tileY)` Checks if a given tile position has been explored by the player.
`boolean`	`isExplored(TilePosition position)`
`boolean`	`isFlagEnabled(Flag flag)` Checks if the state of the given flag is enabled or not.
`boolean`	`isInGame()` Checks if the current client is inside a game.
`boolean`	`isLatComEnabled()` Checks the state of latency compensation.
`boolean`	`isMultiplayer()` Checks if the current client is inside a multiplayer game.
`boolean`	`isPaused()` Checks if the current game is paused.
`boolean`	`isReplay()` Checks if the client is watching a replay.
`boolean`	`issueCommand(Collection<Unit> units, UnitCommand command)` Issues a given command to a set of units.
`boolean`	`isVisible(int tileX, int tileY)` Checks if a given tile position is visible to the current player.
`boolean`	`isVisible(TilePosition position)`
`boolean`	`isWalkable(int walkX, int walkY)` Checks if the given mini-tile position is walkable.
`boolean`	`isWalkable(WalkPosition position)`
`void`	`leaveGame()` Leaves the current game by surrendering and enters the post-game statistics/score screen.
`String`	`mapFileName()` Retrieves the file name of the currently loaded map.
`String`	`mapHash()` Calculates the SHA-1 hash of the currently loaded map file.
`int`	`mapHeight()` Retrieves the height of the map in build tile units.
`String`	`mapName()` Retrieves the title of the currently loaded map.
`String`	`mapPathName()` Retrieves the full path name of the currently loaded map.
`int`	`mapWidth()` Retrieves the width of the map in build tile units.
`Player`	`neutral()` Retrieves the `Player` object representing the neutral player.
`List<Player>`	`observers()` Retrieves a set of all players currently observing the game.
`void`	`pauseGame()` Pauses the game.
`void`	`pingMinimap(int x, int y)` Pings the minimap at the given position.
`void`	`pingMinimap(Position p)`
`void`	`printf(String string, Text... colors)` Prints text to the screen as a notification.
`void`	`restartGame()` Restarts the match.
`void`	`resumeGame()` Resumes the game from a paused state.
`Player`	`self()` Retrieves the player object that BWAPI is controlling.
`void`	`sendText(String string, Text... colors)` Sends a text message to all other players in the game.
`void`	`sendTextEx(boolean toAllies, String string, Text... colors)` An extended version of `sendText(java.lang.String, bwapi.Text...)` which allows messages to be forwarded to allies.
`boolean`	`setAlliance(Player player)`
`boolean`	`setAlliance(Player player, boolean allied)`
`boolean`	`setAlliance(Player player, boolean allied, boolean alliedVictory)` Sets the alliance state of the current player with the target player.
`void`	`setCommandOptimizationLevel(int level)` Sets the command optimization level.
`void`	`setFrameSkip(int frameSkip)` Sets the number of graphical frames for every logical frame.
`void`	`setGUI(boolean enabled)` Sets the rendering state of the Starcraft GUI.
`void`	`setLatCom(boolean isEnabled)` Changes the state of latency compensation.
`void`	`setLocalSpeed(int speed)` Sets the number of milliseconds Broodwar spends in each frame.
`boolean`	`setMap(String mapFileName)` Changes the map to the one specified.
`boolean`	`setRevealAll()`
`boolean`	`setRevealAll(boolean reveal)` Sets the state of the fog of war when watching a replay.
`void`	`setScreenPosition(int x, int y)` Moves the top left corner of the viewport to the provided position relative to the map's origin (top left (0,0)).
`void`	`setScreenPosition(Position p)`
`void`	`setTextSize()`
`void`	`setTextSize(Text.Size size)` Sets the size of the text for all calls to `drawText(bwapi.CoordinateType, int, int, java.lang.String, bwapi.Text...)` following this one.
`boolean`	`setVision(Player player, boolean enabled)` In a game, this function sets the vision of the current BWAPI player with the target player.

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

- Method Detail
  - getForces
```
public List<Force> getForces()
```
    Retrieves the set of all teams/forces. Forces are commonly seen in @UMS game types and some others such as @TvB and the team versions of game types.
    
    Returns:
    
    List containing all forces in the game.
  - getPlayers
```
public List<Player> getPlayers()
```
    Retrieves the set of all players in the match. This includes the neutral player, which owns all the resources and critters by default.
    
    Returns:
    
    List containing all players in the game.
  - getAllUnits
```
public List<Unit> getAllUnits()
```
    Retrieves the set of all accessible units. If Flag.CompleteMapInformation is enabled, then the set also includes units that are not visible to the player.
    Units that are inside refineries are not included in this set.
    
    Returns:
    
    List containing all known units in the game.
  - getMinerals
```
public List<Unit> getMinerals()
```
    Retrieves the set of all accessible @minerals in the game.
    
    Returns:
    
    List containing @minerals
  - getGeysers
```
public List<Unit> getGeysers()
```
    Retrieves the set of all accessible @geysers in the game.
    
    Returns:
    
    List containing @geysers
  - getNeutralUnits
```
public List<Unit> getNeutralUnits()
```
    Retrieves the set of all accessible neutral units in the game. This includes @minerals, @geysers, and @critters.
    
    Returns:
    
    List containing all neutral units.
  - getStaticMinerals
```
public List<Unit> getStaticMinerals()
```
    Retrieves the set of all @minerals that were available at the beginning of the game.
    This set includes resources that have been mined out or are inaccessible.
    
    Returns:
    
    List containing static @minerals
  - getStaticGeysers
```
public List<Unit> getStaticGeysers()
```
    Retrieves the set of all @geysers that were available at the beginning of the game.
    This set includes resources that are inaccessible.
    
    Returns:
    
    List containing static @geysers
  - getStaticNeutralUnits
```
public List<Unit> getStaticNeutralUnits()
```
    Retrieves the set of all units owned by the neutral player (resources, critters, etc.) that were available at the beginning of the game.
    This set includes units that are inaccessible.
    
    Returns:
    
    List containing static neutral units
  - getBullets
```
public List<Bullet> getBullets()
```
    Retrieves the set of all accessible bullets.
    
    Returns:
    
    List containing all accessible Bullet objects.
  - getNukeDots
```
public List<Position> getNukeDots()
```
    Retrieves the set of all accessible @Nuke dots.
    Nuke dots are the red dots painted by a @Ghost when using the nuclear strike ability.
    
    Returns:
    
    Set of Positions giving the coordinates of nuke locations.
  - getForce
```
public Force getForce(int forceID)
```
    Retrieves the Force object associated with a given identifier.
    
    Parameters:
    
    forceID - The identifier for the Force object.
    
    Returns:
    
    Force object mapped to the given forceID. Returns null if the given identifier is invalid.
  - getPlayer
```
public Player getPlayer(int playerID)
```
    Retrieves the Player object associated with a given identifier.
    
    Parameters:
    
    playerID - The identifier for the Player object.
    
    Returns:
    
    Player object mapped to the given playerID. null if the given identifier is invalid.
  - getUnit
```
public Unit getUnit(int unitID)
```
    Retrieves the Unit object associated with a given identifier.
    
    Parameters:
    
    unitID - The identifier for the Unit object.
    
    Returns:
    
    Unit object mapped to the given unitID. null if the given identifier is invalid.
  - getRegion
```
public Region getRegion(int regionID)
```
    Retrieves the Region object associated with a given identifier.
    
    Parameters:
    
    regionID - The identifier for the Region object.
    
    Returns:
    
    Region object mapped to the given regionID. Returns null if the given ID is invalid.
  - getGameType
```
public GameType getGameType()
```
    Retrieves the GameType of the current game.
    
    Returns:
    
    GameType indicating the rules of the match.
    
    See Also:
    
    GameType
  - getLatency
```
public Latency getLatency()
```
    Retrieves the current latency setting that the game is set to. Latency indicates the delay between issuing a command and having it processed.
    
    Returns:
    
    The Latency setting of the game, which is of Latency.
    
    See Also:
    
    Latency
  - getFrameCount
```
public int getFrameCount()
```
    Retrieves the number of logical frames since the beginning of the match. If the game is paused, then getFrameCount will not increase.
    
    Returns:
    
    Number of logical frames that have elapsed since the game started as an integer.
  - getReplayFrameCount
```
public int getReplayFrameCount()
```
    Retrieves the maximum number of logical frames that have been recorded in a replay. If the game is not a replay, then the value returned is undefined.
    
    Returns:
    
    The number of logical frames that the replay contains.
  - getFPS
```
public int getFPS()
```
    Retrieves the logical frame rate of the game in frames per second (FPS).
    
    Returns:
    
    Logical frames per second that the game is currently running at as an integer.
    
    See Also:
    
    getAverageFPS()
  - getAverageFPS
```
public double getAverageFPS()
```
    Retrieves the average logical frame rate of the game in frames per second (FPS).
    
    Returns:
    
    Average logical frames per second that the game is currently running at as a double.
    
    See Also:
    
    getFPS()
  - getMousePosition
```
public Position getMousePosition()
```
    Retrieves the position of the user's mouse on the screen, in Position coordinates.
    
    Returns:
    
    Position indicating the location of the mouse. Returns Position.Unknown if Flag.UserInput is disabled.
  - getMouseState
```
public final boolean getMouseState(MouseButton button)
```
    Retrieves the state of the given mouse button.
    
    Parameters:
    
    button - A MouseButton enum member indicating which button on the mouse to check.
    
    Returns:
    
    A boolean indicating the state of the given button. true if the button was pressed and false if it was not. Returns false always if Flag.UserInput is disabled.
    
    See Also:
    
    MouseButton
  - getKeyState
```
public final boolean getKeyState(Key key)
```
    Retrieves the state of the given keyboard key.
    
    Parameters:
    
    key - A Key enum member indicating which key on the keyboard to check.
    
    Returns:
    
    A boolean indicating the state of the given key. true if the key was pressed and false if it was not. Returns false always if Flag.UserInput is disabled.
    
    See Also:
    
    Key
  - getScreenPosition
```
public Position getScreenPosition()
```
    Retrieves the top left position of the viewport from the top left corner of the map, in pixels.
    
    Returns:
    
    Position containing the coordinates of the top left corner of the game's viewport. Returns Position.Unknown always if Flag.UserInput is disabled.
    
    See Also:
    
    setScreenPosition(bwapi.Position)
  - setScreenPosition
```
public void setScreenPosition(Position p)
```
  - setScreenPosition
```
public void setScreenPosition(int x,
                              int y)
```
    Moves the top left corner of the viewport to the provided position relative to the map's origin (top left (0,0)).
    
    Parameters:
    
    x - The x coordinate to move the screen to, in pixels.
    
    y - The y coordinate to move the screen to, in pixels.
    
    See Also:
    
    getScreenPosition()
  - pingMinimap
```
public void pingMinimap(int x,
                        int y)
```
    Pings the minimap at the given position. Minimap pings are visible to allied players.
    
    Parameters:
    
    x - The x coordinate to ping at, in pixels, from the map's origin (left).
    
    y - The y coordinate to ping at, in pixels, from the map's origin (top).
  - pingMinimap
```
public void pingMinimap(Position p)
```
  - isFlagEnabled
```
public final boolean isFlagEnabled(Flag flag)
```
    Checks if the state of the given flag is enabled or not.
    Flags may only be enabled at the start of the match during the BWEventListener.onStart() callback.
    
    Parameters:
    
    flag - The Flag entry describing the flag's effects on BWAPI.
    
    Returns:
    
    true if the given flag is enabled, false if the flag is disabled.
    
    See Also:
    
    Flag
  - enableFlag
```
public void enableFlag(Flag flag)
```
    Enables the state of a given flag.
    Flags may only be enabled at the start of the match during the BWEventListener.onStart() callback.
    
    Parameters:
    
    flag - The Flag entry describing the flag's effects on BWAPI.
    
    See Also:
    
    Flag
  - getUnitsOnTile
```
public List<Unit> getUnitsOnTile(TilePosition tile)
```
  - getUnitsOnTile
```
public List<Unit> getUnitsOnTile(int tileX,
                                 int tileY)
```
  - getUnitsOnTile
```
public List<Unit> getUnitsOnTile(int tileX,
                                 int tileY,
                                 UnitFilter pred)
```
    Retrieves the set of accessible units that are on a given build tile.
    
    Parameters:
    
    tileX - The X position, in tiles.
    
    tileY - The Y position, in tiles.
    
    pred - A function predicate that indicates which units are included in the returned set.
    
    Returns:
    
    A List object consisting of all the units that have any part of them on the given build tile.
  - getUnitsInRectangle
```
public List<Unit> getUnitsInRectangle(int left,
                                      int top,
                                      int right,
                                      int bottom)
```
  - getUnitsInRectangle
```
public List<Unit> getUnitsInRectangle(int left,
                                      int top,
                                      int right,
                                      int bottom,
                                      UnitFilter pred)
```
    Retrieves the set of accessible units that are in a given rectangle.
    
    Parameters:
    
    left - The X coordinate of the left position of the bounding box, in pixels.
    
    top - The Y coordinate of the top position of the bounding box, in pixels.
    
    right - The X coordinate of the right position of the bounding box, in pixels.
    
    bottom - The Y coordinate of the bottom position of the bounding box, in pixels.
    
    pred - A function predicate that indicates which units are included in the returned set.
    
    Returns:
    
    A List object consisting of all the units that have any part of them within the given rectangle bounds.
  - getUnitsInRectangle
```
public List<Unit> getUnitsInRectangle(Position leftTop,
                                      Position rightBottom)
```
  - getUnitsInRectangle
```
public List<Unit> getUnitsInRectangle(Position leftTop,
                                      Position rightBottom,
                                      UnitFilter pred)
```
  - getUnitsInRadius
```
public List<Unit> getUnitsInRadius(int x,
                                   int y,
                                   int radius)
```
  - getUnitsInRadius
```
public List<Unit> getUnitsInRadius(int x,
                                   int y,
                                   int radius,
                                   UnitFilter pred)
```
    Retrieves the set of accessible units that are within a given radius of a position.
    
    Parameters:
    
    x - The x coordinate of the center, in pixels.
    
    y - The y coordinate of the center, in pixels.
    
    radius - The radius from the center, in pixels, to include units.
    
    pred - A function predicate that indicates which units are included in the returned set.
    
    Returns:
    
    A List object consisting of all the units that have any part of them within the given radius from the center position.
  - getUnitsInRadius
```
public List<Unit> getUnitsInRadius(Position center,
                                   int radius)
```
  - getUnitsInRadius
```
public List<Unit> getUnitsInRadius(Position center,
                                   int radius,
                                   UnitFilter pred)
```
  - getClosestUnitInRectangle
```
public Unit getClosestUnitInRectangle(Position center,
                                      int left,
                                      int top,
                                      int right,
                                      int bottom)
```
  - getClosestUnitInRectangle
```
public Unit getClosestUnitInRectangle(Position center,
                                      int left,
                                      int top,
                                      int right,
                                      int bottom,
                                      UnitFilter pred)
```
    Retrieves the closest unit to center that matches the criteria of the callback pred within an optional rectangle.
    
    Parameters:
    
    center - The position to start searching for the closest unit.
    
    pred - The UnitFilter predicate to determine which units should be included. This includes all units by default.
    
    left - The left position of the rectangle. This value is 0 by default.
    
    top - The top position of the rectangle. This value is 0 by default.
    
    right - The right position of the rectangle. This value includes the entire map width by default.
    
    bottom - The bottom position of the rectangle. This value includes the entire map height by default.
    
    See Also:
    
    UnitFilter
  - getClosestUnit
```
public Unit getClosestUnit(Position center)
```
  - getClosestUnit
```
public Unit getClosestUnit(Position center,
                           UnitFilter pred)
```
  - getClosestUnit
```
public Unit getClosestUnit(Position center,
                           int radius)
```
  - getClosestUnit
```
public Unit getClosestUnit(Position center,
                           int radius,
                           UnitFilter pred)
```
    Retrieves the closest unit to center that matches the criteria of the callback pred within an optional radius.
    
    Parameters:
    
    center - The position to start searching for the closest unit.
    
    pred - The UnitFilter predicate to determine which units should be included. This includes all units by default.
    
    radius - The radius to search in. If omitted, the entire map will be searched.
    
    Returns:
    
    The desired unit that is closest to center. Returns null If a suitable unit was not found.
    
    See Also:
    
    UnitFilter
  - mapWidth
```
public int mapWidth()
```
    Retrieves the width of the map in build tile units.
    
    Returns:
    
    Width of the map in tiles.
  - mapHeight
```
public int mapHeight()
```
    Retrieves the height of the map in build tile units.
    
    Returns:
    
    Height of the map in tiles.
  - mapFileName
```
public String mapFileName()
```
    Retrieves the file name of the currently loaded map.
    
    Returns:
    
    Map file name as String object.
    
    See Also:
    
    mapPathName, mapName
  - mapPathName
```
public String mapPathName()
```
    Retrieves the full path name of the currently loaded map.
    
    Returns:
    
    Map file name as String object.
    
    See Also:
    
    mapFileName, mapName
  - mapName
```
public String mapName()
```
    Retrieves the title of the currently loaded map.
    
    Returns:
    
    Map title as String object.
    
    See Also:
    
    mapFileName, mapPathName
  - mapHash
```
public String mapHash()
```
    Calculates the SHA-1 hash of the currently loaded map file.
    
    Returns:
    
    String object containing SHA-1 hash.
    Campaign maps will return a hash of their internal map chunk components(.chk), while standard maps will return a hash of their entire map archive (.scm,.scx).
  - isWalkable
```
public final boolean isWalkable(int walkX,
                                int walkY)
```
    Checks if the given mini-tile position is walkable.
    This function only checks if the static terrain is walkable. Its current occupied state is excluded from this check. To see if the space is currently occupied or not, then see getUnitsInRectangle(int, int, int, int).
    
    Parameters:
    
    walkX - The x coordinate of the mini-tile, in mini-tile units (8 pixels).
    
    walkY - The y coordinate of the mini-tile, in mini-tile units (8 pixels).
    
    Returns:
    
    true if the mini-tile is walkable and false if it is impassable for ground units.
  - isWalkable
```
public final boolean isWalkable(WalkPosition position)
```
  - getGroundHeight
```
public final int getGroundHeight(int tileX,
                                 int tileY)
```
    Returns the ground height at the given tile position.
    
    Parameters:
    
    tileX - X position to query, in tiles
    
    tileY - Y position to query, in tiles
    
    Returns:
    
    The tile height as an integer. Possible values are: - 0: Low ground - 1: Low ground doodad - 2: High ground - 3: High ground doodad - 4: Very high ground - 5: Very high ground doodad .
  - getGroundHeight
```
public final int getGroundHeight(TilePosition position)
```
  - isBuildable
```
public final boolean isBuildable(int tileX,
                                 int tileY)
```
  - isBuildable
```
public final boolean isBuildable(int tileX,
                                 int tileY,
                                 boolean includeBuildings)
```
    Checks if a given tile position is buildable. This means that, if all other requirements are met, a structure can be placed on this tile. This function uses static map data.
    
    Parameters:
    
    tileX - The x value of the tile to check.
    
    tileY - The y value of the tile to check.
    
    includeBuildings - If this is true, then this function will also check if any visible structures are occupying the space. If this value is false, then it only checks the static map data for tile buildability. This value is false by default.
    
    Returns:
    
    boolean identifying if the given tile position is buildable (true) or not (false). If includeBuildings was provided, then it will return false if a structure is currently occupying the tile.
  - isBuildable
```
public final boolean isBuildable(TilePosition position)
```
  - isBuildable
```
public final boolean isBuildable(TilePosition position,
                                 boolean includeBuildings)
```
  - isVisible
```
public final boolean isVisible(int tileX,
                               int tileY)
```
    Checks if a given tile position is visible to the current player.
    
    Parameters:
    
    tileX - The x value of the tile to check.
    
    tileY - The y value of the tile to check.
    
    Returns:
    
    boolean identifying the visibility of the tile. If the given tile is visible, then the value is true. If the given tile is concealed by the fog of war, then this value will be false.
  - isVisible
```
public final boolean isVisible(TilePosition position)
```
  - isExplored
```
public final boolean isExplored(int tileX,
                                int tileY)
```
    Checks if a given tile position has been explored by the player. An explored tile position indicates that the player has seen the location at some point in the match, partially revealing the fog of war for the remainder of the match.
    
    Parameters:
    
    tileX - The x tile coordinate to check.
    
    tileY - The y tile coordinate to check.
    
    Returns:
    
    true if the player has explored the given tile position (partially revealed fog), false if the tile position was never explored (completely black fog).
    
    See Also:
    
    isVisible(int, int)
  - isExplored
```
public final boolean isExplored(TilePosition position)
```
  - hasCreep
```
public final boolean hasCreep(int tileX,
                              int tileY)
```
    Checks if the given tile position has @Zerg creep on it.
    
    Parameters:
    
    tileX - The x tile coordinate to check.
    
    tileY - The y tile coordinate to check.
    
    Returns:
    
    true if the given tile has creep on it, false if the given tile does not have creep, or if it is concealed by the fog of war.
  - hasCreep
```
public final boolean hasCreep(TilePosition position)
```
  - hasPowerPrecise
```
public final boolean hasPowerPrecise(int x,
                                     int y)
```
  - hasPowerPrecise
```
public final boolean hasPowerPrecise(int x,
                                     int y,
                                     UnitType unitType)
```
    Checks if the given pixel position is powered by an owned @Protoss_Pylon for an optional unit type.
    
    Parameters:
    
    x - The x pixel coordinate to check.
    
    y - The y pixel coordinate to check.
    
    unitType - Checks if the given UnitType requires power or not. If ommitted, then it will assume that the position requires power for any unit type.
    
    Returns:
    
    true if the type at the given position will have power, false if the type at the given position will be unpowered.
  - hasPowerPrecise
```
public final boolean hasPowerPrecise(Position position)
```
  - hasPowerPrecise
```
public final boolean hasPowerPrecise(Position position,
                                     UnitType unitType)
```
  - hasPower
```
public final boolean hasPower(TilePosition position)
```
  - hasPower
```
public final boolean hasPower(int tileX,
                              int tileY)
```
  - hasPower
```
public final boolean hasPower(TilePosition position,
                              UnitType unitType)
```
  - hasPower
```
public final boolean hasPower(int tileX,
                              int tileY,
                              UnitType unitType)
```
  - hasPower
```
public final boolean hasPower(int tileX,
                              int tileY,
                              int tileWidth,
                              int tileHeight)
```
  - hasPower
```
public final boolean hasPower(int tileX,
                              int tileY,
                              int tileWidth,
                              int tileHeight,
                              UnitType unitType)
```
    Checks if the given tile position if powered by an owned @Protoss_Pylon for an optional unit type.
    
    Parameters:
    
    tileX - The x tile coordinate to check.
    
    tileY - The y tile coordinate to check.
    
    unitType - Checks if the given UnitType will be powered if placed at the given tile position. If omitted, then only the immediate tile position is checked for power, and the function will assume that the location requires power for any unit type.
    
    Returns:
    
    true if the type at the given tile position will receive power, false if the type will be unpowered at the given tile position.
  - hasPower
```
public final boolean hasPower(TilePosition position,
                              int tileWidth,
                              int tileHeight)
```
  - hasPower
```
public final boolean hasPower(TilePosition position,
                              int tileWidth,
                              int tileHeight,
                              UnitType unitType)
```
  - canBuildHere
```
public final boolean canBuildHere(TilePosition position,
                                  UnitType type,
                                  Unit builder)
```
  - canBuildHere
```
public final boolean canBuildHere(TilePosition position,
                                  UnitType type)
```
  - canBuildHere
```
public final boolean canBuildHere(TilePosition position,
                                  UnitType type,
                                  Unit builder,
                                  boolean checkExplored)
```
    Checks if the given unit type can be built at the given build tile position. This function checks for creep, power, and resource distance requirements in addition to the tiles' buildability and possible units obstructing the build location.
    If the type is an addon and a builer is provided, then the location of the addon will be placed 4 tiles to the right and 1 tile down from the given position. If the builder is not given, then the check for the addon will be conducted at position.
    If type is UnitType.Special_Start_Location, then the area for a resource depot (@Command_Center, @Hatchery, @Nexus) is checked as normal, but any potential obstructions (existing structures, creep, units, etc.) are ignored.
    
    Parameters:
    
    position - Indicates the tile position that the top left corner of the structure is intended to go.
    
    type - The UnitType to check for.
    
    builder - The intended unit that will build the structure. If specified, then this function will also check if there is a path to the build site and exclude the builder from the set of units that may be blocking the build site.
    
    checkExplored - If this parameter is true, it will also check if the target position has been explored by the current player. This value is false by default, ignoring the explored state of the build site.
    
    Returns:
    
    true indicating that the structure can be placed at the given tile position, and false if something may be obstructing the build location.
  - canMake
```
public final boolean canMake(UnitType type)
```
  - canMake
```
public final boolean canMake(UnitType type,
                             Unit builder)
```
    Checks all the requirements in order to make a given unit type for the current player. These include resources, supply, technology tree, availability, and required units.
    
    Parameters:
    
    type - The UnitType to check.
    
    builder - The Unit that will be used to build/train the provided unit type. If this value is null or excluded, then the builder will be excluded in the check.
    
    Returns:
    
    true indicating that the type can be made. If builder is provided, then it is only true if builder can make the type. Otherwise it will return false, indicating that the unit type can not be made.
  - canResearch
```
public final boolean canResearch(TechType type,
                                 Unit unit)
```
  - canResearch
```
public final boolean canResearch(TechType type)
```
  - canResearch
```
public final boolean canResearch(TechType type,
                                 Unit unit,
                                 boolean checkCanIssueCommandType)
```
    Checks all the requirements in order to research a given technology type for the current player. These include resources, technology tree, availability, and required units.
    
    Parameters:
    
    type - The TechType to check.
    
    unit - The Unit that will be used to research the provided technology type. If this value is null or excluded, then the unit will be excluded in the check.
    
    checkCanIssueCommandType - TODO fill this in
    
    Returns:
    
    true indicating that the type can be researched. If unit is provided, then it is only true if unit can research the type. Otherwise it will return false, indicating that the technology can not be researched.
  - canUpgrade
```
public final boolean canUpgrade(UpgradeType type,
                                Unit unit)
```
  - canUpgrade
```
public final boolean canUpgrade(UpgradeType type)
```
  - canUpgrade
```
public final boolean canUpgrade(UpgradeType type,
                                Unit unit,
                                boolean checkCanIssueCommandType)
```
    Checks all the requirements in order to upgrade a given upgrade type for the current player. These include resources, technology tree, availability, and required units.
    
    Parameters:
    
    type - The UpgradeType to check.
    
    unit - The Unit that will be used to upgrade the provided upgrade type. If this value is null or excluded, then the unit will be excluded in the check.
    
    checkCanIssueCommandType - TODO fill this in
    
    Returns:
    
    true indicating that the type can be upgraded. If unit is provided, then it is only true if unit can upgrade the type. Otherwise it will return false, indicating that the upgrade can not be upgraded.
  - getStartLocations
```
public List<TilePosition> getStartLocations()
```
    Retrieves the set of all starting locations for the current map. A starting location is essentially a candidate for a player's spawn point.
    
    Returns:
    
    A List containing all the TilePosition objects that indicate a start location.
    
    See Also:
    
    Player.getStartLocation()
  - printf
```
public void printf(String string,
                   Text... colors)
```
    Prints text to the screen as a notification. This function allows text formatting using Text.formatText(java.lang.String, bwapi.Text).
    That text printed through this function is not seen by other players or in replays.
    
    Parameters:
    
    string - String to print.
  - sendText
```
public void sendText(String string,
                     Text... colors)
```
    Sends a text message to all other players in the game.
    In a single player game this function can be used to execute cheat codes.
    
    Parameters:
    
    string - String to send.
    
    See Also:
    
    sendTextEx(boolean, java.lang.String, bwapi.Text...)
  - sendTextEx
```
public void sendTextEx(boolean toAllies,
                       String string,
                       Text... colors)
```
    An extended version of sendText(java.lang.String, bwapi.Text...) which allows messages to be forwarded to allies.
    
    Parameters:
    
    toAllies - If this parameter is set to true, then the message is only sent to allied players, otherwise it will be sent to all players.
    
    string - String to send.
    
    See Also:
    
    sendText(java.lang.String, bwapi.Text...)
  - isInGame
```
public final boolean isInGame()
```
    Checks if the current client is inside a game.
    
    Returns:
    
    true if the client is in a game, and false if it is not.
  - isMultiplayer
```
public final boolean isMultiplayer()
```
    Checks if the current client is inside a multiplayer game.
    
    Returns:
    
    true if the client is in a multiplayer game, and false if it is a single player game, a replay, or some other state.
  - isBattleNet
```
public final boolean isBattleNet()
```
    Checks if the client is in a game that was created through the Battle.net multiplayer gaming service.
    
    Returns:
    
    true if the client is in a multiplayer Battle.net game and false if it is not.
  - isPaused
```
public final boolean isPaused()
```
    Checks if the current game is paused. While paused, BWEventListener.onFrame() will still be called.
    
    Returns:
    
    true if the game is paused and false otherwise
    
    See Also:
    
    pauseGame(), resumeGame()
  - isReplay
```
public final boolean isReplay()
```
    Checks if the client is watching a replay.
    
    Returns:
    
    true if the client is watching a replay and false otherwise
  - pauseGame
```
public void pauseGame()
```
    Pauses the game. While paused, BWEventListener.onFrame() will still be called.
    
    See Also:
    
    resumeGame()
  - resumeGame
```
public void resumeGame()
```
    Resumes the game from a paused state.
    
    See Also:
    
    pauseGame()
  - leaveGame
```
public void leaveGame()
```
    Leaves the current game by surrendering and enters the post-game statistics/score screen.
  - restartGame
```
public void restartGame()
```
    Restarts the match. Works the same as if the match was restarted from the in-game menu (F10). This option is only available in single player games.
  - setLocalSpeed
```
public void setLocalSpeed(int speed)
```
    Sets the number of milliseconds Broodwar spends in each frame. The default values are as follows: - Fastest: 42ms/frame - Faster: 48ms/frame - Fast: 56ms/frame - Normal: 67ms/frame - Slow: 83ms/frame - Slower: 111ms/frame - Slowest: 167ms/frame
    Specifying a value of 0 will not guarantee that logical frames are executed as fast as possible. If that is the intention, use this in combination with #setFrameSkip.
    Changing this value will cause the execution of @UMS scenario triggers to glitch. This will only happen in campaign maps and custom scenarios (non-melee).
    
    Parameters:
    
    speed - The time spent per frame, in milliseconds. A value of 0 indicates that frames are executed immediately with no delay. Negative values will restore the default value as listed above.
    
    See Also:
    
    setFrameSkip(int), getFPS()
  - issueCommand
```
public final boolean issueCommand(Collection<Unit> units,
                                  UnitCommand command)
```
    Issues a given command to a set of units. This function automatically splits the set into groups of 12 and issues the same command to each of them. If a unit is not capable of executing the command, then it is simply ignored.
    
    Parameters:
    
    units - A List containing all the units to issue the command for.
    
    command - A UnitCommand object containing relevant information about the command to be issued. The Unit object associated with the command will be ignored.
    
    Returns:
    
    true if any one of the units in the List were capable of executing the command, and false if none of the units were capable of executing the command.
  - getSelectedUnits
```
public List<Unit> getSelectedUnits()
```
    Retrieves the set of units that are currently selected by the user outside of BWAPI. This function requires thatFlag.UserInput be enabled.
    
    Returns:
    
    A List containing the user's selected units. If Flag.UserInput is disabled, then this set is always empty.
    
    See Also:
    
    enableFlag(bwapi.Flag)
  - self
```
public Player self()
```
    Retrieves the player object that BWAPI is controlling.
    
    Returns:
    
    Player object representing the current player. null if the current game is a replay.
  - enemy
```
public Player enemy()
```
    Retrieves the Player interface that represents the enemy player. If there is more than one enemy, and that enemy is destroyed, then this function will still retrieve the same, defeated enemy. If you wish to handle multiple opponents, see the enemies function.
    
    Returns:
    
    Player interface representing an enemy player. Returns null if there is no enemy or the current game is a replay.
    
    See Also:
    
    enemies
  - neutral
```
public Player neutral()
```
    Retrieves the Player object representing the neutral player. The neutral player owns all the resources and critters on the map by default.
    
    Returns:
    
    Player indicating the neutral player.
  - allies
```
public List<Player> allies()
```
    Retrieves a set of all the current player's remaining allies.
    
    Returns:
    
    List containing all allied players.
  - enemies
```
public List<Player> enemies()
```
    Retrieves a set of all the current player's remaining enemies.
    
    Returns:
    
    List containing all enemy players.
  - observers
```
public List<Player> observers()
```
    Retrieves a set of all players currently observing the game. An observer is defined typically in a @UMS game type as not having any impact on the game. This means an observer cannot start with any units, and cannot have any active trigger actions that create units for it.
    
    Returns:
    
    List containing all currently active observer players
  - drawText
```
public void drawText(CoordinateType ctype,
                     int x,
                     int y,
                     String string,
                     Text... colors)
```
  - drawTextMap
```
public void drawTextMap(int x,
                        int y,
                        String string,
                        Text... colors)
```
  - drawTextMap
```
public void drawTextMap(Position p,
                        String string,
                        Text... colors)
```
  - drawTextMouse
```
public void drawTextMouse(int x,
                          int y,
                          String string,
                          Text... colors)
```
  - drawTextMouse
```
public void drawTextMouse(Position p,
                          String string,
                          Text... colors)
```
  - drawTextScreen
```
public void drawTextScreen(int x,
                           int y,
                           String string,
                           Text... colors)
```
  - drawTextScreen
```
public void drawTextScreen(Position p,
                           String string,
                           Text... colors)
```
  - drawBox
```
public void drawBox(CoordinateType ctype,
                    int left,
                    int top,
                    int right,
                    int bottom,
                    Color color)
```
  - drawBox
```
public void drawBox(CoordinateType ctype,
                    int left,
                    int top,
                    int right,
                    int bottom,
                    Color color,
                    boolean isSolid)
```
    Draws a rectangle on the screen with the given color.
    
    Parameters:
    
    ctype - The coordinate type. Indicates the relative position to draw the shape.
    
    left - The x coordinate, in pixels, relative to ctype, of the left edge of the rectangle.
    
    top - The y coordinate, in pixels, relative to ctype, of the top edge of the rectangle.
    
    right - The x coordinate, in pixels, relative to ctype, of the right edge of the rectangle.
    
    bottom - The y coordinate, in pixels, relative to ctype, of the bottom edge of the rectangle.
    
    color - The color of the rectangle.
    
    isSolid - If true, then the shape will be filled and drawn as a solid, otherwise it will be drawn as an outline. If omitted, this value will default to false.
  - 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)
```
  - drawBoxMap
```
public void drawBoxMap(Position leftTop,
                       Position rightBottom,
                       Color color)
```
  - drawBoxMap
```
public void drawBoxMap(Position leftTop,
                       Position rightBottom,
                       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)
```
  - drawBoxMouse
```
public void drawBoxMouse(Position leftTop,
                         Position rightBottom,
                         Color color)
```
  - drawBoxMouse
```
public void drawBoxMouse(Position leftTop,
                         Position rightBottom,
                         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)
```
  - drawBoxScreen
```
public void drawBoxScreen(Position leftTop,
                          Position rightBottom,
                          Color color)
```
  - drawBoxScreen
```
public void drawBoxScreen(Position leftTop,
                          Position rightBottom,
                          Color color,
                          boolean isSolid)
```
  - drawTriangle
```
public void drawTriangle(CoordinateType ctype,
                         int ax,
                         int ay,
                         int bx,
                         int by,
                         int cx,
                         int cy,
                         Color color)
```
  - drawTriangle
```
public void drawTriangle(CoordinateType ctype,
                         int ax,
                         int ay,
                         int bx,
                         int by,
                         int cx,
                         int cy,
                         Color color,
                         boolean isSolid)
```
    Draws a triangle on the screen with the given color.
    
    Parameters:
    
    ctype - The coordinate type. Indicates the relative position to draw the shape.
    
    ax - The x coordinate, in pixels, relative to ctype, of the first point.
    
    ay - The y coordinate, in pixels, relative to ctype, of the first point.
    
    bx - The x coordinate, in pixels, relative to ctype, of the second point.
    
    by - The y coordinate, in pixels, relative to ctype, of the second point.
    
    cx - The x coordinate, in pixels, relative to ctype, of the third point.
    
    cy - The y coordinate, in pixels, relative to ctype, of the third point.
    
    color - The color of the triangle.
    
    isSolid - If true, then the shape will be filled and drawn as a solid, otherwise it will be drawn as an outline. If omitted, this value will default to false.
  - 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)
```
  - drawTriangleMap
```
public void drawTriangleMap(Position a,
                            Position b,
                            Position c,
                            Color color)
```
  - drawTriangleMap
```
public void drawTriangleMap(Position a,
                            Position b,
                            Position c,
                            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)
```
  - drawTriangleMouse
```
public void drawTriangleMouse(Position a,
                              Position b,
                              Position c,
                              Color color)
```
  - drawTriangleMouse
```
public void drawTriangleMouse(Position a,
                              Position b,
                              Position c,
                              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)
```
  - drawTriangleScreen
```
public void drawTriangleScreen(Position a,
                               Position b,
                               Position c,
                               Color color)
```
  - drawTriangleScreen
```
public void drawTriangleScreen(Position a,
                               Position b,
                               Position c,
                               Color color,
                               boolean isSolid)
```
  - drawCircle
```
public void drawCircle(CoordinateType ctype,
                       int x,
                       int y,
                       int radius,
                       Color color)
```
  - drawCircle
```
public void drawCircle(CoordinateType ctype,
                       int x,
                       int y,
                       int radius,
                       Color color,
                       boolean isSolid)
```
    Draws a circle on the screen with the given color.
    
    Parameters:
    
    ctype - The coordinate type. Indicates the relative position to draw the shape.
    
    x - The x coordinate, in pixels, relative to ctype.
    
    y - The y coordinate, in pixels, relative to ctype.
    
    radius - The radius of the circle, in pixels.
    
    color - The color of the circle.
    
    isSolid - If true, then the shape will be filled and drawn as a solid, otherwise it will be drawn as an outline. If omitted, this value will default to false.
  - 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)
```
  - drawCircleMap
```
public void drawCircleMap(Position p,
                          int radius,
                          Color color)
```
  - drawCircleMap
```
public void drawCircleMap(Position p,
                          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)
```
  - drawCircleMouse
```
public void drawCircleMouse(Position p,
                            int radius,
                            Color color)
```
  - drawCircleMouse
```
public void drawCircleMouse(Position p,
                            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)
```
  - drawCircleScreen
```
public void drawCircleScreen(Position p,
                             int radius,
                             Color color)
```
  - drawCircleScreen
```
public void drawCircleScreen(Position p,
                             int radius,
                             Color color,
                             boolean isSolid)
```
  - drawEllipse
```
public void drawEllipse(CoordinateType ctype,
                        int x,
                        int y,
                        int xrad,
                        int yrad,
                        Color color)
```
  - drawEllipse
```
public void drawEllipse(CoordinateType ctype,
                        int x,
                        int y,
                        int xrad,
                        int yrad,
                        Color color,
                        boolean isSolid)
```
    Draws an ellipse on the screen with the given color.
    
    Parameters:
    
    ctype - The coordinate type. Indicates the relative position to draw the shape.
    
    x - The x coordinate, in pixels, relative to ctype.
    
    y - The y coordinate, in pixels, relative to ctype.
    
    xrad - The x radius of the ellipse, in pixels.
    
    yrad - The y radius of the ellipse, in pixels.
    
    color - The color of the ellipse.
    
    isSolid - If true, then the shape will be filled and drawn as a solid, otherwise it will be drawn as an outline. If omitted, this value will default to false.
  - 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)
```
  - drawEllipseMap
```
public void drawEllipseMap(Position p,
                           int xrad,
                           int yrad,
                           Color color)
```
  - drawEllipseMap
```
public void drawEllipseMap(Position p,
                           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)
```
  - drawEllipseMouse
```
public void drawEllipseMouse(Position p,
                             int xrad,
                             int yrad,
                             Color color)
```
  - drawEllipseMouse
```
public void drawEllipseMouse(Position p,
                             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)
```
  - drawEllipseScreen
```
public void drawEllipseScreen(Position p,
                              int xrad,
                              int yrad,
                              Color color)
```
  - drawEllipseScreen
```
public void drawEllipseScreen(Position p,
                              int xrad,
                              int yrad,
                              Color color,
                              boolean isSolid)
```
  - drawDot
```
public void drawDot(CoordinateType ctype,
                    int x,
                    int y,
                    Color color)
```
    Draws a dot on the map or screen with a given color.
    
    Parameters:
    
    ctype - The coordinate type. Indicates the relative position to draw the shape.
    
    x - The x coordinate, in pixels, relative to ctype.
    
    y - The y coordinate, in pixels, relative to ctype.
    
    color - The color of the dot.
  - drawDotMap
```
public void drawDotMap(int x,
                       int y,
                       Color color)
```
  - drawDotMap
```
public void drawDotMap(Position p,
                       Color color)
```
  - drawDotMouse
```
public void drawDotMouse(int x,
                         int y,
                         Color color)
```
  - drawDotMouse
```
public void drawDotMouse(Position p,
                         Color color)
```
  - drawDotScreen
```
public void drawDotScreen(int x,
                          int y,
                          Color color)
```
  - drawDotScreen
```
public void drawDotScreen(Position p,
                          Color color)
```
  - drawLine
```
public void drawLine(CoordinateType ctype,
                     int x1,
                     int y1,
                     int x2,
                     int y2,
                     Color color)
```
    Draws a line on the map or screen with a given color.
    
    Parameters:
    
    ctype - The coordinate type. Indicates the relative position to draw the shape.
    
    x1 - The starting x coordinate, in pixels, relative to ctype.
    
    y1 - The starting y coordinate, in pixels, relative to ctype.
    
    x2 - The ending x coordinate, in pixels, relative to ctype.
    
    y2 - The ending y coordinate, in pixels, relative to ctype.
    
    color - The color of the line.
  - drawLineMap
```
public void drawLineMap(int x1,
                        int y1,
                        int x2,
                        int y2,
                        Color color)
```
  - drawLineMap
```
public void drawLineMap(Position a,
                        Position b,
                        Color color)
```
  - drawLineMouse
```
public void drawLineMouse(int x1,
                          int y1,
                          int x2,
                          int y2,
                          Color color)
```
  - drawLineMouse
```
public void drawLineMouse(Position a,
                          Position b,
                          Color color)
```
  - drawLineScreen
```
public void drawLineScreen(int x1,
                           int y1,
                           int x2,
                           int y2,
                           Color color)
```
  - drawLineScreen
```
public void drawLineScreen(Position a,
                           Position b,
                           Color color)
```
  - getLatencyFrames
```
public int getLatencyFrames()
```
    Retrieves the maximum delay, in number of frames, between a command being issued and the command being executed by Broodwar.
    In Broodwar, latency is used to keep the game synchronized between players without introducing lag.
    
    Returns:
    
    Difference in frames between commands being sent and executed.
    
    See Also:
    
    getLatencyTime(), getRemainingLatencyFrames()
  - getLatencyTime
```
public int getLatencyTime()
```
    Retrieves the maximum delay, in milliseconds, between a command being issued and the command being executed by Broodwar.
    
    Returns:
    
    Difference in milliseconds between commands being sent and executed.
    
    See Also:
    
    getLatencyFrames(), getRemainingLatencyTime()
  - getRemainingLatencyFrames
```
public int getRemainingLatencyFrames()
```
    Retrieves the number of frames it will take before a command sent in the current frame will be executed by the game.
    
    Returns:
    
    Number of frames until a command is executed if it were sent in the current frame.
    
    See Also:
    
    getRemainingLatencyTime(), getLatencyFrames()
  - getRemainingLatencyTime
```
public int getRemainingLatencyTime()
```
    Retrieves the number of milliseconds it will take before a command sent in the current frame will be executed by Broodwar.
    
    Returns:
    
    Amount of time, in milliseconds, until a command is executed if it were sent in the current frame.
    
    See Also:
    
    getRemainingLatencyFrames(), getLatencyTime()
  - getRevision
```
public int getRevision()
```
    Retrieves the current revision of BWAPI.
    
    Returns:
    
    The revision number of the current BWAPI interface.
  - isDebug
```
public final boolean isDebug()
```
    Retrieves the debug state of the BWAPI build.
    
    Returns:
    
    true if the BWAPI module is a DEBUG build, and false if it is a RELEASE build.
  - isLatComEnabled
```
public final boolean isLatComEnabled()
```
    Checks the state of latency compensation.
    
    Returns:
    
    true if latency compensation is enabled, false if it is disabled.
    
    See Also:
    
    setLatCom(boolean)
  - setLatCom
```
public void setLatCom(boolean isEnabled)
```
    Changes the state of latency compensation. Latency compensation modifies the state of BWAPI's representation of units to reflect the implications of issuing a command immediately after the command was performed, instead of waiting consecutive frames for the results. Latency compensation is enabled by default.
    
    Parameters:
    
    isEnabled - Set whether the latency compensation feature will be enabled (true) or disabled (false).
    
    See Also:
    
    isLatComEnabled()
  - getInstanceNumber
```
public int getInstanceNumber()
```
    Retrieves the Starcraft instance number recorded by BWAPI to identify which Starcraft instance an AI module belongs to. The very first instance should return 0.
    
    Returns:
    
    An integer value representing the instance number.
  - getAPM
```
public int getAPM()
```
  - getAPM
```
public int getAPM(boolean includeSelects)
```
    Retrieves the Actions Per Minute (APM) that the bot is producing.
    
    Parameters:
    
    includeSelects - If true, the return value will include selections as individual commands, otherwise it will exclude selections. This value is false by default.
    
    Returns:
    
    The number of actions that the bot has executed per minute, on average.
  - setFrameSkip
```
public void setFrameSkip(int frameSkip)
```
    Sets the number of graphical frames for every logical frame. This allows the game to step more logical frames per graphical frame, increasing the speed at which the game runs.
    
    Parameters:
    
    frameSkip - Number of graphical frames per logical frame. If this value is 0 or less, then it will default to 1.
    
    See Also:
    
    setLocalSpeed(int)
  - setAlliance
```
public final boolean setAlliance(Player player,
                                 boolean allied,
                                 boolean alliedVictory)
```
    Sets the alliance state of the current player with the target player.
    
    Parameters:
    
    player - The target player to set alliance with.
    
    allied - If true, the current player will ally the target player. If false, the current player will make the target player an enemy. This value is true by default.
    
    alliedVictory - Sets the state of "allied victory". If true, the game will end in a victory if all allied players have eliminated their opponents. Otherwise, the game will only end if no other players are remaining in the game. This value is true by default.
  - setAlliance
```
public final boolean setAlliance(Player player,
                                 boolean allied)
```
  - setAlliance
```
public final boolean setAlliance(Player player)
```
  - setVision
```
public final boolean setVision(Player player,
                               boolean enabled)
```
    In a game, this function sets the vision of the current BWAPI player with the target player.
    In a replay, this function toggles the visibility of the target player.
    
    Parameters:
    
    player - The target player to toggle vision.
    
    enabled - The vision state. If true, and in a game, the current player will enable shared vision with the target player, otherwise it will unshare vision. If in a replay, the vision of the target player will be shown, otherwise the target player will be hidden. This value is true by default.
  - setGUI
```
public void setGUI(boolean enabled)
```
    Sets the rendering state of the Starcraft GUI.
    This typically gives Starcraft a very low graphical frame rate and disables all drawing functionality in BWAPI.
    
    Parameters:
    
    enabled - A boolean value that determines the state of the GUI. Passing false to this function will disable the GUI, and true will enable it.
    
    See Also:
    
    isGUIEnabled()
  - getLastEventTime
```
public int getLastEventTime()
```
    Retrieves the amount of time (in milliseconds) that has elapsed when running the last AI module callback.
    This is used by tournament modules to penalize AI modules that use too much processing time.
    
    Returns:
    
    Time in milliseconds spent in last AI module call. Returns 0 When called from an AI module.
  - setMap
```
public final boolean setMap(String mapFileName)
```
    Changes the map to the one specified.
    Once restarted, the game will load the map that was provided. Changes do not take effect unless the game is restarted.
    
    Parameters:
    
    mapFileName - A string containing the path and file name to the desired map.
    
    Returns:
    
    Returns true if the function succeeded and has changed the map. Returns false if the function failed, does not have permission from the tournament module, failed to find the map specified, or received an invalid parameter.
  - setRevealAll
```
public final boolean setRevealAll(boolean reveal)
```
    Sets the state of the fog of war when watching a replay.
    
    Parameters:
    
    reveal - The state of the reveal all flag. If false, all fog of war will be enabled. If true, then the fog of war will be revealed. It is true by default.
  - setRevealAll
```
public final boolean setRevealAll()
```
  - hasPath
```
public final boolean hasPath(Position source,
                             Position destination)
```
    Checks if there is a path from source to destination. This only checks if the source position is connected to the destination position. This function does not check if all units can actually travel from source to destination. Because of this limitation, it has an O(1) complexity, and cases where this limitation hinders gameplay is uncommon at best.
    If making queries on a unit, it's better to call Unit.hasPath(bwapi.Position), since it is a more lenient version of this function that accounts for some edge cases.
    
    Parameters:
    
    source - The source position.
    
    destination - The destination position.
    
    Returns:
    
    true if there is a path between the two positions, and false if there is not.
    
    See Also:
    
    Unit.hasPath(bwapi.Position)
  - setTextSize
```
public void setTextSize()
```
  - setTextSize
```
public void setTextSize(Text.Size size)
```
    Sets the size of the text for all calls to drawText(bwapi.CoordinateType, int, int, java.lang.String, bwapi.Text...) following this one.
    
    Parameters:
    
    size - The size of the text. This value is one of Text#Size. If this value is omitted, then a default value of Text.Size.Default is used.
    
    See Also:
    
    Text.Size
  - elapsedTime
```
public int elapsedTime()
```
    Retrieves current amount of time in seconds that the game has elapsed.
    
    Returns:
    
    Time, in seconds, that the game has elapsed as an integer.
  - setCommandOptimizationLevel
```
public void setCommandOptimizationLevel(int level)
```
    Sets the command optimization level. Command optimization is a feature in BWAPI that tries to reduce the APM of the bot by grouping or eliminating unnecessary game actions. For example, suppose the bot told 24 @Zerglings to @Burrow. At command optimization level 0, BWAPI is designed to select each Zergling to burrow individually, which costs 48 actions. With command optimization level 1, it can perform the same behaviour using only 4 actions. The command optimizer also reduces the amount of bytes used for each action if it can express the same action using a different command. For example, Right_Click uses less bytes than Move.
    
    Parameters:
    
    level - An integer representation of the aggressiveness for which commands are optimized. A lower level means less optimization, and a higher level means more optimization.
    The values for level are as follows: - 0: No optimization. - 1: Some optimization. - Is not detected as a hack. - Does not alter behaviour. - Units performing the following actions are grouped and ordered 12 at a time: - Attack_Unit - Morph (@Larva only) - Hold_Position - Stop - Follow - Gather - Return_Cargo - Repair - Burrow - Unburrow - Cloak - Decloak - Siege - Unsiege - Right_Click_Unit - Halt_Construction - Cancel_Train (@Carrier and @Reaver only) - Cancel_Train_Slot (@Carrier and @Reaver only) - Cancel_Morph (for non-buildings only) - Use_Tech - Use_Tech_Unit . - The following order transformations are applied to allow better grouping: - Attack_Unit becomes Right_Click_Unit if the target is an enemy - Move becomes Right_Click_Position - Gather becomes Right_Click_Unit if the target contains resources - Set_Rally_Position becomes Right_Click_Position for buildings - Set_Rally_Unit becomes Right_Click_Unit for buildings - Use_Tech_Unit with Infestation becomes Right_Click_Unit if the target is valid . . - 2: More optimization by grouping structures. - Includes the optimizations made by all previous levels. - May be detected as a hack by some replay utilities. - Does not alter behaviour. - Units performing the following actions are grouped and ordered 12 at a time: - Attack_Unit (@Turrets, @Photon_Cannons, @Sunkens, @Spores) - Train - Morph - Set_Rally_Unit - Lift - Cancel_Construction - Cancel_Addon - Cancel_Train - Cancel_Train_Slot - Cancel_Morph - Cancel_Research - Cancel_Upgrade . . - 3: Extensive optimization - Includes the optimizations made by all previous levels. - Units may behave or move differently than expected. - Units performing the following actions are grouped and ordered 12 at a time: - Attack_Move - Set_Rally_Position - Move - Patrol - Unload_All - Unload_All_Position - Right_Click_Position - Use_Tech_Position . . - 4: Aggressive optimization - Includes the optimizations made by all previous levels. - Positions used in commands will be rounded to multiples of 32. - @High_Templar and @Dark_Templar that merge into @Archons will be grouped and may choose a different target to merge with. It will not merge with a target that wasn't included. . .
  - countdownTimer
```
public int countdownTimer()
```
    Returns the remaining countdown time. The countdown timer is used in @CTF and @UMS game types.
    
    Returns:
    
    Integer containing the time (in game seconds) on the countdown timer.
  - getAllRegions
```
public List<Region> getAllRegions()
```
    Retrieves the set of all regions on the map.
    
    Returns:
    
    List containing all map regions.
  - getRegionAt
```
public Region getRegionAt(int x,
                          int y)
```
    Retrieves the region at a given position.
    
    Parameters:
    
    x - The x coordinate, in pixels.
    
    y - The y coordinate, in pixels.
    
    Returns:
    
    the Region interface at the given position. Returns null if the provided position is not valid (i.e. not within the map bounds).
    
    See Also:
    
    getAllRegions(), getRegion(int)
  - getRegionAt
```
public Region getRegionAt(Position position)
```
  - getBuildLocation
```
public TilePosition getBuildLocation(UnitType type,
                                     TilePosition desiredPosition,
                                     int maxRange)
```
  - getBuildLocation
```
public TilePosition getBuildLocation(UnitType type,
                                     TilePosition desiredPosition)
```
  - getBuildLocation
```
public TilePosition getBuildLocation(UnitType type,
                                     TilePosition desiredPosition,
                                     int maxRange,
                                     boolean creep)
```
    Retrieves a basic build position just as the default Computer AI would. This allows users to find simple build locations without relying on external libraries.
    
    Parameters:
    
    type - A valid UnitType representing the unit type to accomodate space for.
    
    desiredPosition - A valid TilePosition containing the desired placement position.
    
    maxRange - The maximum distance (in tiles) to build from desiredPosition.
    
    creep - A special boolean value that changes the behaviour of @Creep_Colony placement.
    
    Returns:
    
    A TilePosition containing the location that the structure should be constructed at. Returns TilePosition.Invalid If a build location could not be found within maxRange.
  - getDamageFrom
```
public int getDamageFrom(UnitType fromType,
                         UnitType toType,
                         Player fromPlayer)
```
  - getDamageFrom
```
public int getDamageFrom(UnitType fromType,
                         UnitType toType)
```
  - getDamageFrom
```
public int getDamageFrom(UnitType fromType,
                         UnitType toType,
                         Player fromPlayer,
                         Player toPlayer)
```
    Calculates the damage received for a given player. It can be understood as the damage from fromType to toType. Does not include shields in calculation. Includes upgrades if players are provided.
    
    Parameters:
    
    fromType - The unit type that will be dealing the damage.
    
    toType - The unit type that will be receiving the damage.
    
    fromPlayer - The player owner of the given type that will be dealing the damage. If omitted, then no player will be used to calculate the upgrades for fromType.
    
    toPlayer - The player owner of the type that will be receiving the damage. If omitted, then this parameter will default to self.
    
    Returns:
    
    The amount of damage that fromType would deal to toType.
    
    See Also:
    
    getDamageTo(bwapi.UnitType, bwapi.UnitType, bwapi.Player)
  - getDamageTo
```
public int getDamageTo(UnitType toType,
                       UnitType fromType,
                       Player toPlayer)
```
  - getDamageTo
```
public int getDamageTo(UnitType toType,
                       UnitType fromType)
```
  - getDamageTo
```
public int getDamageTo(UnitType toType,
                       UnitType fromType,
                       Player toPlayer,
                       Player fromPlayer)
```
    Calculates the damage dealt for a given player. It can be understood as the damage to toType from fromType. Does not include shields in calculation. Includes upgrades if players are provided.
    This function is nearly the same as getDamageFrom(bwapi.UnitType, bwapi.UnitType, bwapi.Player). The only difference is that the last parameter is intended to default to self.
    
    Parameters:
    
    toType - The unit type that will be receiving the damage.
    
    fromType - The unit type that will be dealing the damage.
    
    toPlayer - The player owner of the type that will be receiving the damage. If omitted, then no player will be used to calculate the upgrades for toType.
    
    fromPlayer - The player owner of the given type that will be dealing the damage. If omitted, then this parameter will default to self).
    
    Returns:
    
    The amount of damage that fromType would deal to toType.
    
    See Also:
    
    getDamageFrom(bwapi.UnitType, bwapi.UnitType, bwapi.Player)
  - getRandomSeed
```
public int getRandomSeed()
```
    Retrieves the initial random seed that was used in this game's creation. This is used to identify the seed that started this game, in case an error occurred, so that developers can deterministically reproduce the error. Works in both games and replays.
    
    Returns:
    
    This game's random seed.
    
    Since:
    
    4.2.0

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

getRegion

getGameType

getLatency

getFrameCount

getReplayFrameCount

getFPS

getAverageFPS

getMousePosition

getMouseState

getKeyState

getScreenPosition

setScreenPosition

setScreenPosition

pingMinimap

pingMinimap

isFlagEnabled

enableFlag

getUnitsOnTile

getUnitsOnTile

getUnitsOnTile

getUnitsInRectangle

getUnitsInRectangle

getUnitsInRectangle

getUnitsInRectangle

getUnitsInRadius

getUnitsInRadius

getUnitsInRadius

getUnitsInRadius

getClosestUnitInRectangle

getClosestUnitInRectangle

getClosestUnit

getClosestUnit

getClosestUnit

getClosestUnit

mapWidth

mapHeight

mapFileName

mapPathName

mapName

mapHash

isWalkable

isWalkable

getGroundHeight

getGroundHeight

isBuildable

isBuildable

isBuildable

isBuildable

isVisible

isVisible

isExplored

isExplored

hasCreep

hasCreep

hasPowerPrecise

hasPowerPrecise

hasPowerPrecise

hasPowerPrecise

hasPower

hasPower

hasPower

hasPower