bwapi

Class Regionset

java.lang.Object

bwapi.Regionset

public class Regionset
extends java.lang.Object

A container that holds a set of Region objects.

Method Summary

Methods

Modifier and Type	Method and Description
Position	getCenter() Retrieves the center of the region.
java.util.List<Unit>	getUnits() Retrieves a Unitset containing all the units that are in this region.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

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.

getUnits

public java.util.List<Unit> getUnits()

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. Parameters 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. Returns A Unitset containing all units in this region that have met the requirements of pred. See also UnitFilter