Unit

Object
- Unit

```
public class Unit
extends Object
```
This class provides a collection of Trigger commands concerning Units.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`trDamageUnit(float amt)` Does a specific amount of damage to HP in instant typeless damage.
`void`	`trDamageUnitPercent(float percent)` Does % percent of a unit's total HP in instant typeless damage.
`void`	`trDamageUnitsInArea(int playerID, int unitType, float dist, float damage)` All units within distance of the selected reference object that match type take damage.
`void`	`trImmediateUnitGarrison(string unitScenarioName)` Instantly garrisons units inside another unit without considering distance.
`void`	`trSetUnitIdleProcessing(bool b)` Sets whether or not units can do their idle processing.
`bool`	`trUnitAlive()` Returns true if all selected units are alive
`void`	`trUnitBuildUnit(string protoUnit, vector position)` Selects units and makes the build a unit at specified location.
`void`	`trUnitChangeInArea(int fromID, int toID, string fromProto, string toProto, float Dist)` Changes all units in a given radius around the selected units.
`void`	`trUnitChangeName(string name)` Set an override name for a specific unit.
`void`	`trUnitChangeProtoUnit(string protoUnit)` Changes the proto unit for a given set of units.
`void`	`trUnitConvert(int playerID)` Converts the selected units to player.
`void`	`trUnitCreate(string protoName, string scenarioName, float x, float y, float z, int heading, int playerID)` Creates a new unit.
`bool`	`trUnitDead()` Returns true if all selected units are dead.
`void`	`trUnitDelete(bool remove)` Removes or kills the selected unit(s)
`void`	`trUnitDestroy()` Destroys the selected unit(s).
`float`	`trUnitDistanceToPoint(float x, float y, float z)` Returns the shortest distance between the trRT units and the point.
`float`	`trUnitDistanceToUnit(string unitScenarioName)` Returns the shortest distance between the trRT units and the given unit.
`float`	`trUnitDistanceToUnitID(int unitID)` Returns the shortest distance between the selected units and the given unit.
`void`	`trUnitDoWorkOnUnit(string unitScenarioName, int eventID)` Tasks the selected unit(s) to perform work on the given unit.
`void`	`trUnitEjectContained()` Ejects all contained units
`void`	`trUnitGarrison(string unitScenarioName, int eventID)` Tasks the selected unit(s) to garrison into another unit.
`int`	`trUnitGetContained()` Returns the number of units contained.
`int`	`trUnitGetHeading(string scenarioName)` Returns the units heading.
`bool`	`trUnitGetIsContained(string matchType)` Returns true if this unit is contained by a matching type unit.
`bool`	`trUnitHasLOS(int playerID)` Returns true if the player can see the selected unit, otherwise returns false.
`void`	`trUnitHighlight(int seconds)` Does something to highlight the units selected
`bool`	`trUnitIsOwnedBy(int playerID)` Determines if the selected units are owned by the player specified
`bool`	`trUnitIsSelected()` Returns if the specified unit is selected.
`void`	`trUnitMoveFromArea(float x, float y, float z, int eventID, bool attackMove, int playerID, string unitType, float radius)` Moves all matching units near the selected unit(s) to the given position.
`void`	`trUnitMoveToPoint(float x, float y, float z, int eventID, bool attackMove)` Moves the selected unit(s) to the given position.
`void`	`trUnitMoveToUnit(string unitScenarioName, int eventID, bool attackMove)` Moves the selected unit(s) to the spot occupied by the given unit.
`bool`	`trUnitOnLush(bool lush, int playerID)` Checks whether the selected units location matches lush for the given player.
`int`	`trUnitPercentComplete()` Returns the percent complete as 0 to 100.
`int`	`trUnitPercentDamaged()` Returns the percent damaged as 0 to 100.
`void`	`trUnitSetAnimation(string animationName, bool loop, int eventID)` Sets the animations for the selected unit(s) to the given animation.
`void`	`trUnitSetHeading(int degrees)` Sets the units heading.
`void`	`trUnitSetHP(float hitpoints)` Set the hit points for all selected units.
`void`	`trUnitSetStance(string stance)` Set the stance for the given set of units.
`void`	`trUnitTeleport(float x, float y, float z)` Moves units from current position to position specified.
`bool`	`trUnitTypeIsSelected(string protoUnit)` Returns true if the specified unit is selected.
`bool`	`trUnitVisToPlayer(int playerID)` Returns true if the player can see the selected unit, and it is on screen.

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

Method Detail

trDamageUnit
```
public void trDamageUnit(float amt)
```
Does a specific amount of damage to HP in instant typeless damage.

trDamageUnitPercent
```
public void trDamageUnitPercent(float percent)
```
Does % percent of a unit's total HP in instant typeless damage.

trDamageUnitsInArea

public void trDamageUnitsInArea(int playerID,
                                int unitType,
                                float dist,
                                float damage)

All units within distance of the selected reference object that match type take damage.

trUnitAlive
```
public bool trUnitAlive()
```
Returns true if all selected units are alive

trUnitBuildUnit

public void trUnitBuildUnit(string protoUnit,
                            vector position)

Selects units and makes the build a unit at specified location.

trUnitChangeInArea

public void trUnitChangeInArea(int fromID,
                               int toID,
                               string fromProto,
                               string toProto,
                               float Dist)

Changes all units in a given radius around the selected units.

Since:: AoT

trUnitChangeName
```
public void trUnitChangeName(string name)
```
Set an override name for a specific unit. Only works in scenarios, not in RMS.

trUnitChangeProtoUnit
```
public void trUnitChangeProtoUnit(string protoUnit)
```
Changes the proto unit for a given set of units.

trUnitConvert
```
public void trUnitConvert(int playerID)
```
Converts the selected units to player.

trUnitCreate

public void trUnitCreate(string protoName,
                         string scenarioName,
                         float x,
                         float y,
                         float z,
                         int heading,
                         int playerID)

Creates a new unit. Does not work online.

trUnitDead
```
public bool trUnitDead()
```
Returns true if all selected units are dead.

trUnitDelete
```
public void trUnitDelete(bool remove)
```
Removes or kills the selected unit(s)

trUnitDestroy
```
public void trUnitDestroy()
```
Destroys the selected unit(s).

trUnitDistanceToPoint

public float trUnitDistanceToPoint(float x,
                                   float y,
                                   float z)

Returns the shortest distance between the trRT units and the point.

trUnitDistanceToUnit
```
public float trUnitDistanceToUnit(string unitScenarioName)
```
Returns the shortest distance between the trRT units and the given unit.

trUnitDistanceToUnitID
```
public float trUnitDistanceToUnitID(int unitID)
```
Returns the shortest distance between the selected units and the given unit.

trUnitDoWorkOnUnit

public void trUnitDoWorkOnUnit(string unitScenarioName,
                               int eventID)

Tasks the selected unit(s) to perform work on the given unit.

trUnitEjectContained
```
public void trUnitEjectContained()
```
Ejects all contained units

trUnitGarrison

public void trUnitGarrison(string unitScenarioName,
                           int eventID)

Tasks the selected unit(s) to garrison into another unit.

trUnitGetContained
```
public int trUnitGetContained()
```
Returns the number of units contained.

trUnitGetHeading
```
public int trUnitGetHeading(string scenarioName)
```
Returns the units heading. The angle returned is the angle the unit's face makes with the z-axis of the map. Unfortunately it does not say which side, so the result is always in the [0-180] interval.

trUnitGetIsContained
```
public bool trUnitGetIsContained(string matchType)
```
Returns true if this unit is contained by a matching type unit.

trUnitHasLOS
```
public bool trUnitHasLOS(int playerID)
```
Returns true if the player can see the selected unit, otherwise returns false. OoS Danger.

trUnitHighlight
```
public void trUnitHighlight(int seconds)
```
Does something to highlight the units selected

trUnitIsOwnedBy
```
public bool trUnitIsOwnedBy(int playerID)
```
Determines if the selected units are owned by the player specified

trUnitIsSelected
```
public bool trUnitIsSelected()
```
Returns if the specified unit is selected.

trUnitMoveFromArea

public void trUnitMoveFromArea(float x,
                               float y,
                               float z,
                               int eventID,
                               bool attackMove,
                               int playerID,
                               string unitType,
                               float radius)

Moves all matching units near the selected unit(s) to the given position.

trUnitMoveToPoint

public void trUnitMoveToPoint(float x,
                              float y,
                              float z,
                              int eventID,
                              bool attackMove)

Moves the selected unit(s) to the given position. Does not work online. Does not work for mother nature.

trUnitMoveToUnit

public void trUnitMoveToUnit(string unitScenarioName,
                             int eventID,
                             bool attackMove)

Moves the selected unit(s) to the spot occupied by the given unit. Does not work online. Does not work for mother nature.

trUnitOnLush
```
public bool trUnitOnLush(bool lush,
                         int playerID)
```
Checks whether the selected units location matches lush for the given player.

trUnitPercentComplete
```
public int trUnitPercentComplete()
```
Returns the percent complete as 0 to 100.

trUnitPercentDamaged
```
public int trUnitPercentDamaged()
```
Returns the percent damaged as 0 to 100.

trUnitSetAnimation

public void trUnitSetAnimation(string animationName,
                               bool loop,
                               int eventID)

Sets the animations for the selected unit(s) to the given animation. Does not work online.

trUnitSetHeading
```
public void trUnitSetHeading(int degrees)
```
Sets the units heading. Does not work online. The input can range from 0 to 360 degrees.

trUnitSetHP
```
public void trUnitSetHP(float hitpoints)
```
Set the hit points for all selected units. Does not work online.

trUnitSetStance
```
public void trUnitSetStance(string stance)
```
Set the stance for the given set of units.

trUnitTeleport

public void trUnitTeleport(float x,
                           float y,
                           float z)

Moves units from current position to position specified. Does not work online.

trUnitTypeIsSelected
```
public bool trUnitTypeIsSelected(string protoUnit)
```
Returns true if the specified unit is selected.

trUnitVisToPlayer
```
public bool trUnitVisToPlayer(int playerID)
```
Returns true if the player can see the selected unit, and it is on screen.

trSetUnitIdleProcessing
```
public void trSetUnitIdleProcessing(bool b)
```
Sets whether or not units can do their idle processing.

trImmediateUnitGarrison
```
public void trImmediateUnitGarrison(string unitScenarioName)
```
Instantly garrisons units inside another unit without considering distance.

Class Unit

Method Summary

Methods inherited from class Object

Method Detail

trDamageUnit

trDamageUnitPercent

trDamageUnitsInArea

trUnitAlive

trUnitBuildUnit

trUnitChangeInArea

trUnitChangeName

trUnitChangeProtoUnit

trUnitConvert

trUnitCreate

trUnitDead

trUnitDelete

trUnitDestroy

trUnitDistanceToPoint

trUnitDistanceToUnit

trUnitDistanceToUnitID

trUnitDoWorkOnUnit

trUnitEjectContained

trUnitGarrison

trUnitGetContained

trUnitGetHeading

trUnitGetIsContained

trUnitHasLOS

trUnitHighlight

trUnitIsOwnedBy

trUnitIsSelected

trUnitMoveFromArea

trUnitMoveToPoint

trUnitMoveToUnit

trUnitOnLush

trUnitPercentComplete

trUnitPercentDamaged

trUnitSetAnimation

trUnitSetHeading

trUnitSetHP

trUnitSetStance

trUnitTeleport

trUnitTypeIsSelected

trUnitVisToPlayer

trSetUnitIdleProcessing

trImmediateUnitGarrison