Region (jbwapi 2.1.0 API)

java.lang.Object
- bwapi.Region

All Implemented Interfaces:

Comparable<Region>
```
public final class Region
extends Object
implements Comparable<Region>
```
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.

See Also:

Game.getAllRegions(), Game.getRegionAt(int, int), Unit.getRegion()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Region other)`
`boolean`	`equals(Object o)`
`int`	`getBoundsBottom()` Retrieves the approximate bottom boundary of the region.
`int`	`getBoundsLeft()` Retrieves the approximate left boundary of the region.
`int`	`getBoundsRight()` Retrieves the approximate right boundary of the region.
`int`	`getBoundsTop()` Retrieves the approximate top boundary of the region.
`Position`	`getCenter()` Retrieves the center of the region.
`Region`	`getClosestAccessibleRegion()` Retrieves the closest accessible neighbor region.
`Region`	`getClosestInaccessibleRegion()` Retrieves the closest inaccessible neighbor region.
`int`	`getDefensePriority()` Retrieves a value that represents the strategic advantage of this region relative to other regions.
`int`	`getDistance(Region other)` Retrieves the center-to-center distance between two regions.
`int`	`getID()` Retrieves a unique identifier for this region.
`List<Region>`	`getNeighbors()` Retrieves the set of neighbor Regions that this one is connected to.
`int`	`getRegionGroupID()` Retrieves a unique identifier for a group of regions that are all connected and accessible by each other.
`List<Unit>`	`getUnits()`
`List<Unit>`	`getUnits(UnitFilter pred)` Retrieves a List containing all the units that are in this region.
`int`	`hashCode()`
`boolean`	`isAccessible()` Retrieves the state of accessibility of the region.
`boolean`	`isHigherGround()` Checks if this region is part of higher ground.

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

- Method Detail
  - getID
```
public int getID()
```
    Retrieves a unique identifier for this region.
    This identifier is explicitly assigned by Broodwar.
    
    Returns:
    
    An integer that represents this region.
    
    See Also:
    
    Game.getRegion(int)
  - getRegionGroupID
```
public int getRegionGroupID()
```
    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.
    This identifier is explicitly assigned by Broodwar.
    
    Returns:
    
    An integer that represents the group of regions that this one is attached to.
  - getCenter
```
public Position getCenter()
```
    Retrieves the center of the region. This position is used as the node of the region.
    
    Returns:
    
    A Position indicating the center location of the Region, in pixels.
  - isHigherGround
```
public boolean isHigherGround()
```
    Checks if this region is part of higher ground. Higher ground may be used in strategic placement of units and structures.
    
    Returns:
    
    true if this region is part of strategic higher ground, and false otherwise.
  - getDefensePriority
```
public int getDefensePriority()
```
    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.
    This value is explicitly assigned by Broodwar.
    
    Returns:
    
    An integer indicating this region's strategic potential.
  - isAccessible
```
public boolean isAccessible()
```
    Retrieves the state of accessibility of the region. The region is considered accessible if it can be accessed by ground units.
    
    Returns:
    
    true if ground units can traverse this region, and false if the tiles in this region are inaccessible or unwalkable.
  - getNeighbors
```
public List<Region> getNeighbors()
```
    Retrieves the set of neighbor Regions that this one is connected to.
    
    Returns:
    
    A reference to a List containing the neighboring Regions.
  - getBoundsLeft
```
public int getBoundsLeft()
```
    Retrieves the approximate left boundary of the region.
    
    Returns:
    
    The x coordinate, in pixels, of the approximate left boundary of the region.
  - getBoundsTop
```
public int getBoundsTop()
```
    Retrieves the approximate top boundary of the region.
    
    Returns:
    
    The y coordinate, in pixels, of the approximate top boundary of the region.
  - getBoundsRight
```
public int getBoundsRight()
```
    Retrieves the approximate right boundary of the region.
    
    Returns:
    
    The x coordinate, in pixels, of the approximate right boundary of the region.
  - getBoundsBottom
```
public int getBoundsBottom()
```
    Retrieves the approximate bottom boundary of the region.
    
    Returns:
    
    The y coordinate, in pixels, of the approximate bottom boundary of the region.
  - getClosestAccessibleRegion
```
public Region getClosestAccessibleRegion()
```
    Retrieves the closest accessible neighbor region.
    
    Returns:
    
    The closest Region that is accessible.
  - getClosestInaccessibleRegion
```
public Region getClosestInaccessibleRegion()
```
    Retrieves the closest inaccessible neighbor region.
    
    Returns:
    
    The closest Region that is inaccessible.
  - getDistance
```
public int getDistance(Region other)
```
    Retrieves the center-to-center distance between two regions.
    Ignores all collisions.
    
    Parameters:
    
    other - The target Region to calculate distance to.
    
    Returns:
    
    The integer distance from this Region to other.
  - getUnits
```
public List<Unit> getUnits()
```
  - getUnits
```
public List<Unit> getUnits(UnitFilter pred)
```
    Retrieves a List containing all the units that are in this region. Also has the ability to filter the units before the creation of the List.
    
    Parameters:
    
    pred - 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 null is used, in which case there is no filter.
    
    Returns:
    
    A List containing all units in this region that have met the requirements of pred.
    
    See Also:
    
    UnitFilter
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(Region other)
```
    Specified by:
    
    compareTo in interface Comparable<Region>

Class Region

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getID

getRegionGroupID

getCenter

isHigherGround

getDefensePriority

isAccessible

getNeighbors

getBoundsLeft

getBoundsTop

getBoundsRight

getBoundsBottom

getClosestAccessibleRegion

getClosestInaccessibleRegion

getDistance

getUnits

getUnits

equals

hashCode

compareTo