The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
Action. Adds all the units in the source unit group to the target unit group.
Center Of Unit Group
Function. Returns the center of a group of units, defined as the average of their X and Y positions. Returns No Point if the unit group is empty.
Closest Unit To Point
Action. Picks the closest unit to the point specified in a unit group.
Remove Unit Group From Unit Group
Action. Removes all the units in the source unit group from the target unit group.
Add Unit To Unit Group
Action. Adds the specified unit to the specified unit group.
Remove All Units From Unit Group
Action. Removes all the units in the specified unit group.
Copy Of Unit Group
Action. Copies the specified unit group.
Number Of Units In Unit Group
Function. Returns the total number of units in the specified unit group.
Unit In Unit Group
Function. Returns true if the specified unit is part of the specified unit group.
Random Unit From Unit Group
Function. Returns a random unit from the specified unit group.
Remove Unit From Unit Group
Action. Removes the specified unit from the specified unit group.
Unit From Unit Group
Function. Returns a specific unit, by index, from the unit group. Use the "Number Of Units In Unit Group" function to determine how many units are in the unit group.
Loops
For Each Unit In Unit Group
Action. Runs the contained actions once for each unit in the unit group.
Pick Each Unit In Unit Group
Action. Runs the contained actions once for each unit in the unit group. Use the "Picked Unit" function to refer to the unit for which the actions are being run.
Picked Unit
Function. Returns the current unit picked in a "Pick Each Unit In Unit Group" loop.
Useful Unit Groups
Convert Unit To Unit Group
Action. Takes one unit and creates a unit group out of it.
Units In Region Matching Condition
Function. Returns a unit group containing all units that match the specified filters.
Units In Region With Alliance To Player
Function. Returns a unit group containing all units within the alliance filter specified.
Empty Unit Group
Function. Returns an empty unit group.
Units In Unit Group Matching Condition
Function. Returns a unit group that contains units that have passed the specified filters from another unit group.
Units In Unit Group With Alliance
Function. Returns a unit group that contains units that have passed the specified ally filters from another unit group.
Units In Unit Group Targetable As
Function. Returns a unit group that contains units that have passed the specified filters from another unit group.
Units In Unit Group For Player
Function. Returns a unit group by extracting units from a unit group belonging to the specified player.
Units In Unit Group Within Region
Function. Returns a unit group that contains units that are in a certain region from another unit group.
Idle Units For Player
Function. Returns a unit group that contains all of a player's idle units.
