Unit Group

Groups

Add Unit Group To Unit Group

• Adds all the units in the source unit group to the target unit group.

Center Of Unit Group

• 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

• Picks the closest unit to the point specified in a unit group.

Remove Unit Group From Unit Group

• Removes all the units in the source unit group from the target unit group.

Add Unit To Unit Group

• Adds the specified unit to the specified unit group.

Remove All Units From Unit Group

• Removes all the units in the specified unit group.

Copy Of Unit Group

• Copies the specified unit group.

Number Of Units In Unit Group

• Returns the total number of units in the specified unit group.

Unit In Unit Group

• Returns true if the specified unit is part of the specified unit group.

Random Unit From Unit Group

• Returns a random unit from the specified unit group.

Remove Unit From Unit Group

• Removes the specified unit from the specified unit group.

Unit From Unit Group

• 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

• Runs the contained actions once for each unit in the unit group.

Pick Each Unit In Unit Group

• 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

• Returns the current unit picked in a "Pick Each Unit In Unit Group" loop.

Useful Unit Groups

Convert Unit To Unit Group

• Takes one unit and creates a unit group out of it.

Units In Region Matching Condition

• Returns a unit group containing all units that match the specified filters.

Units In Region With Alliance To Player

• Returns a unit group containing all units within the alliance filter specified.

Empty Unit Group

• Returns an empty unit group.

Units In Unit Group Matching Condition

• Returns a unit group that contains units that have passed the specified filters from another unit group.

Units In Unit Group With Alliance

• Returns a unit group that contains units that have passed the specified ally filters from another unit group.

Units In Unit Group Targetable As

• Returns a unit group that contains units that have passed the specified filters from another unit group.

Units In Unit Group For Player

• Returns a unit group by extracting units from a unit group belonging to the specified player.

Units In Unit Group Within Region

• Returns a unit group that contains units that are in a certain region from another unit group.

Idle Units For Player

• Returns a unit group that contains all of a player's idle units.