Unit

Object
- Unit

```
public class Unit
extends Object
```
This class provides a collection of Console commands concerning Units. The concept of "units" is very broad: it is not limited to just regular units. Also buildings, SFX effects etc. are included. A unit always has an ID and is of a certain protounit type.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`protoCount(string typeName)` Deprecated.
`void`	`tis(string protoName, int traincount)` Just like trainInSelected, but more abbreviated.
`void`	`tisID(int protoID, int traincount)` Just like trainInSelected, but more abbreviated because it takes a protoID.
`void`	`trainByID(int protoUnitID, int trainingUnitID, int playerID)` Start the training of a unit of ProtoUnitID from TrainingUnitID.
`void`	`trainCancelByButtonIndex(int buttonIndex, int trainingUnitID, int playerID)` Cancels the training of a unit from TrainingUnitID at the given index.
`void`	`trainInSelected(string protoName, int traincount)` Tries to train the selected unit type in any valid selected unit.
`void`	`uiBuildAtPointer()` Instructs the currently selected unit(s) to build the currently active cursor protounit at the pointer location.
`void`	`uiClearCursor()` Resets the cursor back to the basic pointer.
`void`	`uiDecPlaceVariation()` Decrements the variation to place.
`void`	`uiDeleteSelectedUnit(int keyState)` Deletes selected unit.
`void`	`uiDeleteUnits(int keyState)` Indicates that the delete units button has gone up/down.
`void`	`uiIncPlaceVariation()` Increments the variation to place.
`void`	`uiMoveUnitBackward(int keyState)` Indicates that the move unit backward key has gone up/down.
`void`	`uiMoveUnitDown(int keyState)` Indicates that the move unit down key has gone up/down.
`void`	`uiMoveUnitForward(int keyState)` Indicates that the move unit forward key has gone up/down.
`void`	`uiMoveUnitLeft(int keyState)` Indicates that the move unit left key has gone up/down.
`void`	`uiMoveUnitRight(int keyState)` Indicates that the move unit right key has gone up/down.
`void`	`uiMoveUnitUp(int keyState)` Indicates that the move unit up key has gone up/down.
`void`	`uiPitchUnitDown(int keyState)` Indicates that the pitch unit down key has gone up/down.
`void`	`uiPitchUnitUp(int keyState)` Indicates that the pitch unit up key has gone up/down.
`void`	`uiPlaceAtPointer(bool changeVariation)` Places the currently active cursor protounit.
`void`	`uiRemoveSelectedUnit(int unitID)` Removes specified unit, or selected unit if not ID is specified.
`void`	`uiRollUnitLeft(int keyState)` Indicates that the roll unit left key has gone up/down.
`void`	`uiRollUnitRight(int keyState)` Indicates that the roll unit right key has gone up/down.
`void`	`uiRotateSelection()` Rotates the selected unit.
`void`	`uiScaleUnitDown(int keyState)` Indicates that the unit scale down key has gone up/down.
`void`	`uiScaleUnitUp(int keyState)` Indicates that the unit scale up key has gone up/down.
`void`	`uiSetProtoCursor(string protoName, bool setPlacement)` Sets the cursor to a ProtoUnit.
`void`	`uiSetProtoCursorID(int protoID)` Sets the cursor to a ProtoUnit.
`void`	`uiSetProtoID(int type)` Sets the cursor to a ProtoUnitID.
`void`	`uiStopSelectedUnits()` Stop selected units.
`void`	`uiSummonWorkersToSelectedUnit()` Issues a command to all workers to work on the currently selected building.
`void`	`uiToggleBuildingQueue()` Toggles whether the current building does repeat building on its train queue.
`void`	`uiTransformSelectedUnit(string protoName)` Transforms the selected unit into the specified ProtoUnit.
`void`	`uiUnbuildSelectedUnit()` Enter unbuild mode with selected building.
`void`	`uiUnbuildSelectedUnitAtPointer()` Actually unbuild selected building.
`void`	`uiWheelRotatePlacedUnit()` Rotate placed unit with wheel, i.e.
`void`	`uiWorkAtPointer()` Issues a work (e.g.
`void`	`uiYawUnitLeft(int keyState)` Indicates that the yaw unit left key has gone up/down.
`void`	`uiYawUnitRight(int keyState)` Indicates that the yaw unit right key has gone up/down.
`void`	`unitData(int UnitID)` Deprecated.
`void`	`unitIncVariation(int unitID)` Increments the current variation of the given unitID (current selected unit(s) if unitID is -1).
`void`	`unitReturnToWork()` Issues a return to work for the selected unit(s).
`void`	`unitSetFormationBox()` Sets the formation for all selected units to box.
`void`	`unitSetFormationDefault()` Sets the formation for all selected units to line.
`void`	`unitSetFormationMixed()` Sets the formation for all selected units to mixed.
`void`	`unitSetFormationSpread()` Sets the formation for all selected units to spread.
`void`	`unitSetStanceAggressive()` Sets the unit stance for all selected units to aggressive.
`void`	`unitSetStanceDefensive()` Sets the unit stance for all selected units to defensive.
`void`	`unitSetStancePassive()` Sets the unit stance for all selected units to passive.
`void`	`unitSetVariation(int unitID)` Decrements the current variation of the given unitID (current selected unit(s) if unitID is -1).
`void`	`unitSetVariation(int variation, int unitID)` Sets the current variation of the given UnitID (current selected unit(s) if unitID is -1).
`void`	`unitTownBell()` Issues a town bell for the selected unit(s).

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

- Method Detail
  - unitData
```
public void unitData(int UnitID)
```
    Deprecated.
    
    Spews database values on the specified unit or the selected unit if no argument.
    
    Local Call
  - unitSetVariation
```
public void unitSetVariation(int variation,
                             int unitID)
```
    Sets the current variation of the given UnitID (current selected unit(s) if unitID is -1).
    
    Local Call
    
    Editor Mode Only
  - unitIncVariation
```
public void unitIncVariation(int unitID)
```
    Increments the current variation of the given unitID (current selected unit(s) if unitID is -1).
    
    Local Call
    
    Editor Mode Only
  - unitSetVariation
```
public void unitSetVariation(int unitID)
```
    Decrements the current variation of the given unitID (current selected unit(s) if unitID is -1).
    
    Local Call
    
    Editor Mode Only
  - unitSetStanceAggressive
```
public void unitSetStanceAggressive()
```
    Sets the unit stance for all selected units to aggressive.
    
    Auto Syncs
  - unitSetStanceDefensive
```
public void unitSetStanceDefensive()
```
    Sets the unit stance for all selected units to defensive.
    
    Auto Syncs
  - unitSetStancePassive
```
public void unitSetStancePassive()
```
    Sets the unit stance for all selected units to passive.
    
    Auto Syncs
  - unitSetFormationDefault
```
public void unitSetFormationDefault()
```
    Sets the formation for all selected units to line.
    
    Auto Syncs
  - unitSetFormationBox
```
public void unitSetFormationBox()
```
    Sets the formation for all selected units to box.
    
    Auto Syncs
  - unitSetFormationMixed
```
public void unitSetFormationMixed()
```
    Sets the formation for all selected units to mixed.
    
    Auto Syncs
  - unitSetFormationSpread
```
public void unitSetFormationSpread()
```
    Sets the formation for all selected units to spread.
    
    Auto Syncs
  - unitTownBell
```
public void unitTownBell()
```
    Issues a town bell for the selected unit(s).
    
    Auto Syncs
  - unitReturnToWork
```
public void unitReturnToWork()
```
    Issues a return to work for the selected unit(s).
    
    Auto Syncs
  - uiSetProtoID
```
public void uiSetProtoID(int type)
```
    Sets the cursor to a ProtoUnitID.
    
    Local Call
  - uiIncPlaceVariation
```
public void uiIncPlaceVariation()
```
    Increments the variation to place.
  - uiDecPlaceVariation
```
public void uiDecPlaceVariation()
```
    Decrements the variation to place.
  - uiSetProtoCursor
```
public void uiSetProtoCursor(string protoName,
                             bool setPlacement)
```
    Sets the cursor to a ProtoUnit.
    
    Local Call
  - uiSetProtoCursorID
```
public void uiSetProtoCursorID(int protoID)
```
    Sets the cursor to a ProtoUnit.
    
    Local Call
  - uiClearCursor
```
public void uiClearCursor()
```
    Resets the cursor back to the basic pointer.
    
    Local Call
  - uiBuildAtPointer
```
public void uiBuildAtPointer()
```
    Instructs the currently selected unit(s) to build the currently active cursor protounit at the pointer location. This is typically used in game to build buildings. It is however not limited to buildings, and can be used to place units too.
    
    Auto Syncs
    
    See Also:
    
    uiSetProtoCursor(string, bool), uiPlaceAtPointer(bool)
  - uiPlaceAtPointer
```
public void uiPlaceAtPointer(bool changeVariation)
```
    Places the currently active cursor protounit.
    
    Auto Syncs
    
    Editor Mode Only
    This is typically used to place units in the editor.
    
    See Also:
    
    uiSetProtoCursor(string, bool), uiBuildAtPointer()
  - uiYawUnitRight
```
public void uiYawUnitRight(int keyState)
```
    Indicates that the yaw unit right key has gone up/down.
    
    Single Player Only
  - uiYawUnitLeft
```
public void uiYawUnitLeft(int keyState)
```
    Indicates that the yaw unit left key has gone up/down.
    
    Single Player Only
  - uiPitchUnitDown
```
public void uiPitchUnitDown(int keyState)
```
    Indicates that the pitch unit down key has gone up/down.
    
    Single Player Only
  - uiPitchUnitUp
```
public void uiPitchUnitUp(int keyState)
```
    Indicates that the pitch unit up key has gone up/down.
    
    Single Player Only
  - uiRollUnitRight
```
public void uiRollUnitRight(int keyState)
```
    Indicates that the roll unit right key has gone up/down.
    
    Single Player Only
  - uiRollUnitLeft
```
public void uiRollUnitLeft(int keyState)
```
    Indicates that the roll unit left key has gone up/down.
    
    Single Player Only
  - uiMoveUnitForward
```
public void uiMoveUnitForward(int keyState)
```
    Indicates that the move unit forward key has gone up/down.
    
    Single Player Only
  - uiMoveUnitBackward
```
public void uiMoveUnitBackward(int keyState)
```
    Indicates that the move unit backward key has gone up/down.
    
    Single Player Only
  - uiMoveUnitRight
```
public void uiMoveUnitRight(int keyState)
```
    Indicates that the move unit right key has gone up/down.
    
    Single Player Only
  - uiMoveUnitLeft
```
public void uiMoveUnitLeft(int keyState)
```
    Indicates that the move unit left key has gone up/down.
    
    Single Player Only
  - uiMoveUnitUp
```
public void uiMoveUnitUp(int keyState)
```
    Indicates that the move unit up key has gone up/down.
    
    Single Player Only
  - uiMoveUnitDown
```
public void uiMoveUnitDown(int keyState)
```
    Indicates that the move unit down key has gone up/down.
    
    Single Player Only
  - uiWheelRotatePlacedUnit
```
public void uiWheelRotatePlacedUnit()
```
    Rotate placed unit with wheel, i.e. intended to be mapped to wheel.
  - uiTransformSelectedUnit
```
public void uiTransformSelectedUnit(string protoName)
```
    Transforms the selected unit into the specified ProtoUnit.
    
    Auto Syncs
    This command can be used to manually transfer a series of bits to other players by converting gatherers in ulfsarks or walls in gates and back.
  - protoCount
```
public int protoCount(string typeName)
```
    Deprecated.
    
    Shows how many ProtoUnits that are alive in the scenario.
    
    Local Call
  - uiToggleBuildingQueue
```
public void uiToggleBuildingQueue()
```
    Toggles whether the current building does repeat building on its train queue.
    
    Since:
    
    AoT
    
    Auto Syncs
  - uiSummonWorkersToSelectedUnit
```
public void uiSummonWorkersToSelectedUnit()
```
    Issues a command to all workers to work on the currently selected building.
    
    Auto Syncs
  - trainByID
```
public void trainByID(int protoUnitID,
                      int trainingUnitID,
                      int playerID)
```
    Start the training of a unit of ProtoUnitID from TrainingUnitID. If no player is specified, the current one is used.
    
    Auto Syncs
  - trainInSelected
```
public void trainInSelected(string protoName,
                            int traincount)
```
    Tries to train the selected unit type in any valid selected unit.
    
    Auto Syncs
    
    Note
    
    No algorithm to properly distribute the production over all buildings is used.
  - tis
```
public void tis(string protoName,
                int traincount)
```
    Just like trainInSelected, but more abbreviated.
    
    Auto Syncs
  - tisID
```
public void tisID(int protoID,
                  int traincount)
```
    Just like trainInSelected, but more abbreviated because it takes a protoID.
    
    Auto Syncs
  - trainCancelByButtonIndex
```
public void trainCancelByButtonIndex(int buttonIndex,
                                     int trainingUnitID,
                                     int playerID)
```
    Cancels the training of a unit from TrainingUnitID at the given index. If no player is specified, the current one is used.
    
    Auto Syncs
  - uiDeleteSelectedUnit
```
public void uiDeleteSelectedUnit(int keyState)
```
    Deletes selected unit. This is the default in-game action when the delete button is pressed.
    
    Auto Syncs
  - uiRemoveSelectedUnit
```
public void uiRemoveSelectedUnit(int unitID)
```
    Removes specified unit, or selected unit if not ID is specified. This is the default action in the editor when the delete button is pressed.
  - uiStopSelectedUnits
```
public void uiStopSelectedUnits()
```
    Stop selected units.
    
    Auto Syncs
  - uiUnbuildSelectedUnit
```
public void uiUnbuildSelectedUnit()
```
    Enter unbuild mode with selected building.
    
    Local Call
  - uiUnbuildSelectedUnitAtPointer
```
public void uiUnbuildSelectedUnitAtPointer()
```
    Actually unbuild selected building.
    
    Auto Syncs
  - uiScaleUnitDown
```
public void uiScaleUnitDown(int keyState)
```
    Indicates that the unit scale down key has gone up/down.
    
    Single Player Only
  - uiScaleUnitUp
```
public void uiScaleUnitUp(int keyState)
```
    Indicates that the unit scale up key has gone up/down.
    
    Single Player Only
  - uiWorkAtPointer
```
public void uiWorkAtPointer()
```
    Issues a work (e.g. walk to, empower, garrison, attack, ...) at pointer location.
    
    Auto Syncs
  - uiRotateSelection
```
public void uiRotateSelection()
```
    Rotates the selected unit.
  - uiDeleteUnits
```
public void uiDeleteUnits(int keyState)
```
    Indicates that the delete units button has gone up/down.

Class Unit

Method Summary

Methods inherited from class Object

Method Detail

unitData

unitSetVariation

unitIncVariation

unitSetVariation

unitSetStanceAggressive

unitSetStanceDefensive

unitSetStancePassive

unitSetFormationDefault

unitSetFormationBox

unitSetFormationMixed

unitSetFormationSpread

unitTownBell

unitReturnToWork

uiSetProtoID

uiIncPlaceVariation

uiDecPlaceVariation

uiSetProtoCursor

uiSetProtoCursorID

uiClearCursor

uiBuildAtPointer

uiPlaceAtPointer

uiYawUnitRight

uiYawUnitLeft

uiPitchUnitDown

uiPitchUnitUp

uiRollUnitRight

uiRollUnitLeft

uiMoveUnitForward

uiMoveUnitBackward

uiMoveUnitRight

uiMoveUnitLeft

uiMoveUnitUp

uiMoveUnitDown

uiWheelRotatePlacedUnit

uiTransformSelectedUnit

protoCount

uiToggleBuildingQueue

uiSummonWorkersToSelectedUnit

trainByID

trainInSelected

tis

tisID

trainCancelByButtonIndex

uiDeleteSelectedUnit

uiRemoveSelectedUnit

uiStopSelectedUnits

uiUnbuildSelectedUnit

uiUnbuildSelectedUnitAtPointer

uiScaleUnitDown

uiScaleUnitUp

uiWorkAtPointer

uiRotateSelection

uiDeleteUnits