aom.scripting.xs.tr

Class Selection

Object

Selection

public class Selection
extends Object

This class provides a collection of Trigger commands concerning Selections.

Trigger selection is not the same as UI selection. If a unit is selected by triggers, no visual feedback is shown to the user (no selection circle). However, the idea stays the same: first select some units, then invoke some command on them.

Contrary to UI selection, the previous Trigger selection is not automatically cleared when a new selection is made. Common practice is to include trUnitSelectClear() before every new selection.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Method Summary

Modifier and Type	Method and Description
void	trArmySelect(string army) Selects the units in the army specified.
int	trGetNumberSelectedUnitIDs() Returns the number of currently selected units.
int	trGetSelectedUnitID(int index) Returns the unit ID of the currently selected unit.
void	trUnitSelect(string unitScenarioName) Adds the given unit to the trigger selection system.
void	trUnitSelectByID(int unitID) Adds the given unit to the trigger selection system.
void	trUnitSelectClear() Clears the units in the trigger selection system.

Methods inherited from class Object

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

Method Detail

trArmySelect

public void trArmySelect(string army)

Selects the units in the army specified. This automatically clears the previous selection.

trGetNumberSelectedUnitIDs

public int trGetNumberSelectedUnitIDs()

Returns the number of currently selected units.

trGetSelectedUnitID

public int trGetSelectedUnitID(int index)

Returns the unit ID of the currently selected unit.

trUnitSelect

public void trUnitSelect(string unitScenarioName)

Adds the given unit to the trigger selection system. Previous selected units stay selected. Can't hold more than 30 units.

trUnitSelectByID

public void trUnitSelectByID(int unitID)

Adds the given unit to the trigger selection system. Previous selected units stay selected. Can't hold more than 30 units.

trUnitSelectClear

public void trUnitSelectClear()

Clears the units in the trigger selection system.