Group

Handle Wrappers View source
Group

Use this group for your non-nested group enum calls and then iterate through the group via for from or clear the group after use

Source on GitHub

Extension Functions

group.enumUnitsInRange

public function group.enumUnitsInRange(vec2 pos, real range)

group.enumUnitsInRange

public function group.enumUnitsInRange(vec2 pos, real range, boolexpr filter)

group.enumUnitsInRect

public function group.enumUnitsInRect(rect rec)

group.enumUnitsInRect

public function group.enumUnitsInRect(rect rec, boolexpr filter)

group.enumUnitsSelected

public function group.enumUnitsSelected(player p, boolexpr filter)

group.enumUnitsOfPlayer

public function group.enumUnitsOfPlayer(player p, boolexpr filter)

group.enumUnitsOfType

public function group.enumUnitsOfType(string unitname, boolexpr filter)

group.enumUnitsOfType

public function group.enumUnitsOfType(int id, boolexpr filter)

group.enumUnitsAll

public function group.enumUnitsAll(boolexpr filter)

group.clear

public function group.clear()

group.add

public function group.add(vararg unit units) returns int

Returns the number of added units.

group.remove

public function group.remove(vararg unit units) returns int

Retruns the number of removed units.

group.destr

public function group.destr()

group.has

public function group.has(unit u) returns bool

group.size

public function group.size() returns int

group.isEmpty

public function group.isEmpty() returns bool

group.getRandom

public function group.getRandom() returns unit

Returns a random unit from this group without removing it or null if the group is empty

group.immediateOrder

public function group.immediateOrder(string order) returns bool

group.immediateOrderById

public function group.immediateOrderById(int order) returns bool

group.pointOrder

public function group.pointOrder(string order, vec2 point) returns bool

group.pointOrderById

public function group.pointOrderById(int order, vec2 point) returns bool

group.targetOrder

public function group.targetOrder(string order, widget targetWidget) returns bool

group.targetOrder

public function group.targetOrder(int order, widget targetWidget) returns bool

group.add

public function group.add(vararg group groups) returns int

group.remove

public function group.remove(vararg group groups) returns int

group.get

public function group.get(int index) returns unit

group.iterator

public function group.iterator() returns GroupIterator

Creates a new iterator for this group.

group.hasNext

public function group.hasNext() returns bool

Returns whether the iterator has the next item

group.next

public function group.next() returns unit

Returns the next item from the iterator

group.close

public function group.close()

Closes the iterator, releaseing the group

group.forGroup

public function group.forGroup(code callback)

Constants

ENUM_GROUP

public constant ENUM_GROUP = CreateGroup()