An API for interacting with Starcraft: Broodwar (1.16.1)
|virtual int||getBoundsBottom () const =0|
|virtual int||getBoundsLeft () const =0|
|virtual int||getBoundsRight () const =0|
|virtual int||getBoundsTop () const =0|
|virtual BWAPI::Position||getCenter () const =0|
|virtual BWAPI::Region||getClosestAccessibleRegion () const =0|
|virtual BWAPI::Region||getClosestInaccessibleRegion () const =0|
|virtual int||getDefensePriority () const =0|
|int||getDistance (BWAPI::Region other) const|
|virtual int||getID () const =0|
|virtual const Regionset &||getNeighbors () const =0|
|virtual int||getRegionGroupID () const =0|
|Unitset||getUnits (const UnitFilter &pred=nullptr) const|
|virtual bool||isAccessible () const =0|
|virtual bool||isHigherGround () const =0|
Region objects are created by Starcraft: Broodwar to contain several tiles with the same properties, and create a node in pathfinding and other algorithms.
Regions may not contain detailed information, but have a sufficient amount of data to identify general chokepoints, accessibility to neighboring terrain, be used in general pathing algorithms, and used as nodes to rally units to.
Most parameters that are available are explicitly assigned by Broodwar itself.
Retrieves a unique identifier for this region.
Retrieves a unique identifier for a group of regions that are all connected and accessible by each other.
That is, all accessible regions will have the same group ID. This function is generally used to check if a path is available between two points in constant time.
Retrieves the center of the region.
This position is used as the node of the region.
Checks if this region is part of higher ground.
Higher ground may be used in strategic placement of units and structures.
Retrieves a value that represents the strategic advantage of this region relative to other regions.
A value of 2 may indicate a possible choke point, and a value of 3 indicates a signficant strategic position.
Retrieves the state of accessibility of the region.
The region is considered accessible if it can be accessed by ground units.
Retrieves the set of neighbor Regions that this one is connected to.
Retrieves the approximate left boundary of the region.
Retrieves the approximate top boundary of the region.
Retrieves the approximate right boundary of the region.
Retrieves the approximate bottom boundary of the region.
Retrieves the closest accessible neighbor region.
Retrieves the closest inaccessible neighbor region.
Retrieves the center-to-center distance between two regions.
|other||The target Region to calculate distance to.|
Retrieves a Unitset containing all the units that are in this region.
Also has the ability to filter the units before the creation of the Unitset.
|pred||(optional) If this parameter is used, it is a UnitFilter or function predicate that will retrieve only the units whose attributes match the given criteria. If omitted, then a default value of nullptr is used, in which case there is no filter.|