Selection

Object
- Selection

```
public class Selection
extends Object
```
This class provides a collection of Console commands concerning Selections and Finding Units.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Local Call
Selection commands are all local. Of course certain Auto Sync commands pass along the currently selected unit, but the actual UI selection process is completely local.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`uiAddSelectionButtonDown()` Indicates that the add selection button has been pressed.
`void`	`uiAddSelectionButtonUp()` Indicates that the add selection button has been released.
`void`	`uiClearSelection()` Deselects all selected units.
`void`	`uiDoubleClickSelect(int add, bool checkAction)` Double click select at pointer location.
`void`	`uiFindIdleType(string typeName)` Finds the next idle unit of the given type in the arbitrary order of unit ID, so that it can be called repeatedly to cycle.
`void`	`uiFindTownBellTC()` Finds the next town center that has the town bell active, so that it can be called repeatedly to cycle.
`void`	`uiFindType(string typeName)` Finds the next unit (idle or not) of the given type in the arbitrary order of unit ID, so that it can be called repeatedly to cycle.
`void`	`uiMoveSelectionAddButtonDown()` Indicates that selection button has been pressed.
`void`	`uiMoveSelectionAddButtonUp()` Indicates that selection button has been released.
`void`	`uiMoveSelectionButtonDown()` Indicates that selection button has been pressed.
`void`	`uiMoveSelectionButtonUp()` Indicates that selection button has been released.
`void`	`uiSelectionButtonDown()` Indicates that selection button has been pressed.
`void`	`uiSelectionButtonUp()` Indicates that selection button has been released.
`void`	`uiSelectWaterAtPointer()` Selects water at pointer location.
`void`	`uiToggleSelectionButton()` Toggles the selection button state (pressed or not).
`void`	`uiUnSelectWater()` Deselects currently selected water.

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - uiSelectionButtonDown
```
public void uiSelectionButtonDown()
```
    Indicates that selection button has been pressed. When activated, a white selection rectangle is drawn on the screen, allowing the player to select multiple units.
  - uiSelectionButtonUp
```
public void uiSelectionButtonUp()
```
    Indicates that selection button has been released. When released, the selection rectangle disappears.
  - uiDoubleClickSelect
```
public void uiDoubleClickSelect(int add,
                                bool checkAction)
```
    Double click select at pointer location. A doubleclick action selects all units of the same type as the unit under the pointer.
    
    Parameters:
    
    add - If add == 1, the previous selected is extended with this selection. Else, the previous selection is dropped.
    
    checkAction - When checkAction is true, only units that are performing the same action (idle, moving, ...) are selected.
  - uiAddSelectionButtonDown
```
public void uiAddSelectionButtonDown()
```
    Indicates that the add selection button has been pressed.
  - uiAddSelectionButtonUp
```
public void uiAddSelectionButtonUp()
```
    Indicates that the add selection button has been released.
  - uiToggleSelectionButton
```
public void uiToggleSelectionButton()
```
    Toggles the selection button state (pressed or not).
  - uiMoveSelectionButtonDown
```
public void uiMoveSelectionButtonDown()
```
    Indicates that selection button has been pressed.
  - uiMoveSelectionButtonUp
```
public void uiMoveSelectionButtonUp()
```
    Indicates that selection button has been released.
  - uiMoveSelectionAddButtonDown
```
public void uiMoveSelectionAddButtonDown()
```
    Indicates that selection button has been pressed.
  - uiMoveSelectionAddButtonUp
```
public void uiMoveSelectionAddButtonUp()
```
    Indicates that selection button has been released.
  - uiSelectWaterAtPointer
```
public void uiSelectWaterAtPointer()
```
    Selects water at pointer location.
    
    Editor Mode Only
  - uiUnSelectWater
```
public void uiUnSelectWater()
```
    Deselects currently selected water.
    
    Editor Mode Only
  - uiClearSelection
```
public void uiClearSelection()
```
    Deselects all selected units.
  - uiFindIdleType
```
public void uiFindIdleType(string typeName)
```
    Finds the next idle unit of the given type in the arbitrary order of unit ID, so that it can be called repeatedly to cycle.
  - uiFindTownBellTC
```
public void uiFindTownBellTC()
```
    Finds the next town center that has the town bell active, so that it can be called repeatedly to cycle.
  - uiFindType
```
public void uiFindType(string typeName)
```
    Finds the next unit (idle or not) of the given type in the arbitrary order of unit ID, so that it can be called repeatedly to cycle.

Class Selection

Method Summary

Methods inherited from class Object

Method Detail

uiSelectionButtonDown

uiSelectionButtonUp

uiDoubleClickSelect

uiAddSelectionButtonDown

uiAddSelectionButtonUp

uiToggleSelectionButton

uiMoveSelectionButtonDown

uiMoveSelectionButtonUp

uiMoveSelectionAddButtonDown

uiMoveSelectionAddButtonUp

uiSelectWaterAtPointer

uiUnSelectWater

uiClearSelection

uiFindIdleType

uiFindTownBellTC

uiFindType