Package bwapi

Interface Summary

Interface	Description
BWEventListener	Implement this interface and call AIModule.setEventListener(bwapi.BWEventListener) to receive all of the in game events.

Class Summary

Class	Description
AIModule	This class receives all events from Broodwar.
Bullet	The Bullet class is used to get information about individual bullets, missiles, spells, and generally any sort of non-melee attack.
BulletType	Each Bullet object in the game has a certain type.
Client	The Client class manages the connection between a BWAPI client program and the BWAPI server running in BWAPI.dll.
Color	Starcraft uses a 256 color palette to render everything, so the colors available for draw shapes using BWAPI is limited to the colors available in the Pallete.
DamageType	Each type of Unit in Starcraft: Broodwar has a particular WeaponType for its ground weapon and air weapon (either of which could be WeaponTypes::None).
DefaultBWListener	A utility stub class providing a default implementation of BWEventListener, override it's methods if you want to handle only some events.
Error	Functions in BWAPI may set an error code.
Event	Events correspond to AIModule callbacks and can be obtained by calling Game::getEvents.
ExplosionType	Each type of Unit in Starcraft: Broodwar has a particular WeaponType for its ground weapon and air weapon (either of which could be WeaponTypes::None).
Force	The Force class is used to get information about each force in the match, such as the name of the force and the set of players in the force.
Game	The abstract Game class is implemented by BWAPI and offers many methods for retrieving information about the current Broodwar game, including the set of players, units, map information, as well as information about the user, such as mouse position, screen position, and the current selection of units.
GameType	List of all GameTypes.
Mirror	The API entry point.
Order	To get detailed information about what a unit is doing, you can use the Unit::getOrder method, which will return an Order object.
Player	Each player in a match will have his or her own player instance.
PlayerType	List of all PlayerTypes.
Position	Positions are measured in pixels and are the highest resolution.
Race	List of all Races.
Region	The Region class provides access to some of Broodwar's pathing information and offers members that can assist in navigation, scouting, construction, and information for key areas such as chokepoints.
TechType	List of all TechTypes.
TilePosition	Build Tiles - each build tile is a 4x4 square of walk tiles, or a 32x32 square of pixels.
Unit	The Unit class is used to get information about individual units as well as issue orders to units.
UnitCommand	UnitCommand objects are currently used only as arguments to one function - Unit::issueCommand.
UnitCommandType	Specifies the type of UnitCommand.
UnitSizeType	List of all UnitSizeTypes.
UnitType	The UnitType class is used to get information about a particular type of unit, such as the build time of a Lurker, or the mineral price of an Ultralisk.
UpgradeType	The UpgradeType class is used to get information about a particular upgrade.
WeaponType	List of all WeaponTypes.

Enum Summary

Enum	Description
Key
MouseButton