Unit

Object
- Unit

```
public class Unit
extends Object
```
This class provides a collection of KB commands concerning Units and Protounits.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

See Also:

AoM Reference or AoT Reference for a complete list of all unit constants and more.

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`cUnitFunctionBuilder`
`int`	`cUnitFunctionEmpower`
`int`	`cUnitFunctionFish`
`int`	`cUnitFunctionGatherer`
`int`	`cUnitFunctionTrade`
`int`	`cUnitFunctionUnknown`
`int`	`cUnitFunctionWaterTransport`
`int`	`cUnitStateAlive`
`int`	`cUnitStateAliveOrBuilding`
`int`	`cUnitStateAny`
`int`	`cUnitStateBuilding`
`int`	`cUnitStateDead`
`int`	`cUnitStateNone`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`bool`	`kbCanAffordUnit(int protoUnitTypeID, int escrowID)` Returns true if the player can afford the proto unit.
`void`	`kbDump(int player1, int player2)` KB dump for player2's units from player1's perspective.
`void`	`kbDumpType(int player1, int player2, string typeName)` KB dump for player2's units of the given type from player1's perspective.
`int`	`kbFindBestBuildingToRepair(vector position, float distance, float healthRatio, int repairUnderAttackUnitTypeID)` Returns the id of the best building to repair.
`int`	`kbGetBlockID(string unitName)` Returns the UnitID of the given unit.
`vector`	`kbGetBlockPosition(string blockName)` Returns the position of the given unit.
`int`	`kbGetBuildLimit(int player, int baseUnitTypeID)` Returns the number of the unit type you are allowed to have.
`float`	`kbGetCombatEfficiency(int playerID1, int unitTypeID1, int playerID2, int unitTypeID2)` Returns the combat efficiency of the comparison (in terms of playerID1's units).
`int`	`kbGetPopCapAddition(int player, int baseUnitTypeID)` Returns amount of pop cap addition provided by the given unit type.
`int`	`kbGetPopSlots(int player, int baseUnitTypeID)` Returns the number of pop slots this unit takes.
`int`	`kbGetPopulationSlotsByUnitTypeID(int playerID, int unitTypeID)` Returns the number of pop slots currently occupied by this unit type.
`float`	`kbGetProtoUnitAICost(int protoUnitTypeID)` Returns the AI cost for the given protoUnit type ID.
`int`	`kbGetProtoUnitID(string name)` Returns the ID of the protounit.
`string`	`kbGetProtoUnitName(int protoUnitTypeID)` Returns the name of the protounit ID.
`int`	`kbGetRandomEnabledPUID(int unitTypeID, int escrowID)` Returns a random, valid protounit ID that's of the given type.
`int`	`kbGetUnitBaseTypeID(int unitID)` Returns the base type ID of the unit.
`string`	`kbGetUnitTypeName(int unitTypeID)` Returns the name of the unit type.
`void`	`kbLookAtAllUnitsOnMap()` Updates the knowledge base for all players with the latest info.
`bool`	`kbProtoUnitAvailable(int protoUnitID)` Returns true if the protoUnit is currently available.
`float`	`kbUnitCostPerResource(int protoUnitID, int resourceID)` Returns the cost of the protounit for the given resource.
`int`	`kbUnitCount(int player, int unitTypeID, int stateID)` Returns a quick unit count of units for a player.
`void`	`kbUnitCountConsole(int playerID1, int playerID2, string unitType, string state)` Returns a quick unit count of player2's units from player1's perspective.
`int`	`kbUnitGetActionType(int unitID)` Returns the actionTypeID of the unit.
`int`	`kbUnitGetAreaID(int unitID)` Returns the area ID for this unit ID.
`int`	`kbUnitGetArmyID(int unitID)` Returns the army ID for this unit ID.
`int`	`kbUnitGetBaseID(int unitID)` Returns the base ID for this unit ID.
`float`	`kbUnitGetCurrentAICost(int unitID)` Returns the current AI cost (worth) for this unit ID.
`float`	`kbUnitGetCurrentHitpoints(int unitID)` Returns the current hitpoints for this unit ID.
`float`	`kbUnitGetHealth(int unitID)` Returns the health for this unit ID.
`float`	`kbUnitGetMaximumAICost(int unitID)` Returns the maximum AI cost (worth) for this unit ID.
`float`	`kbUnitGetMaximumHitpoints(int unitID)` Returns the maximum hitpoints for this unit ID.
`int`	`kbUnitGetMovementType(int unitTypeID)` Returns the movementType for this unitTypeID.
`int`	`kbUnitGetNumberWorkers(int unitID)` Returns the number of units currently working on the given unit.
`int`	`kbUnitGetPlanID(int unitID)` Returns the plan ID for this unit ID.
`vector`	`kbUnitGetPosition(int unitID)` Returns the position for this unit ID.
`int`	`kbUnitGetTargetUnitID(int unitID)` Returns the target unit ID of the given unit.
`int`	`kbUnitGetWorkerID(int unitID, int index)` Returns the index'th worker unit ID.
`bool`	`kbUnitIsType(int unitID, long unitTypeID)` Returns true if the unit is of the unitTypeID.
`bool`	`kbUnitVisible(int unitID)` Returns true if the unit is currently visible to the player.

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

- Field Detail
  - cUnitStateNone
```
public final int cUnitStateNone
```
    See Also:
    
    Constant Field Values
  - cUnitStateBuilding
```
public final int cUnitStateBuilding
```
    See Also:
    
    Constant Field Values
  - cUnitStateAlive
```
public final int cUnitStateAlive
```
    See Also:
    
    Constant Field Values
  - cUnitStateDead
```
public final int cUnitStateDead
```
    See Also:
    
    Constant Field Values
  - cUnitStateAny
```
public final int cUnitStateAny
```
    See Also:
    
    Constant Field Values
  - cUnitStateAliveOrBuilding
```
public final int cUnitStateAliveOrBuilding
```
    See Also:
    
    Constant Field Values
  - cUnitFunctionBuilder
```
public final int cUnitFunctionBuilder
```
    See Also:
    
    Constant Field Values
  - cUnitFunctionGatherer
```
public final int cUnitFunctionGatherer
```
    See Also:
    
    Constant Field Values
  - cUnitFunctionEmpower
```
public final int cUnitFunctionEmpower
```
    See Also:
    
    Constant Field Values
  - cUnitFunctionFish
```
public final int cUnitFunctionFish
```
    See Also:
    
    Constant Field Values
  - cUnitFunctionWaterTransport
```
public final int cUnitFunctionWaterTransport
```
    See Also:
    
    Constant Field Values
  - cUnitFunctionTrade
```
public final int cUnitFunctionTrade
```
    See Also:
    
    Constant Field Values
  - cUnitFunctionUnknown
```
public final int cUnitFunctionUnknown
```
    See Also:
    
    Constant Field Values
- Method Detail
  - kbGetPopCapAddition
```
public int kbGetPopCapAddition(int player,
                               int baseUnitTypeID)
```
    Returns amount of pop cap addition provided by the given unit type. This only works on base types.
  - kbGetPopSlots
```
public int kbGetPopSlots(int player,
                         int baseUnitTypeID)
```
    Returns the number of pop slots this unit takes. This only works on base types.
  - kbGetPopulationSlotsByUnitTypeID
```
public int kbGetPopulationSlotsByUnitTypeID(int playerID,
                                            int unitTypeID)
```
    Returns the number of pop slots currently occupied by this unit type.
  - kbFindBestBuildingToRepair
```
public int kbFindBestBuildingToRepair(vector position,
                                      float distance,
                                      float healthRatio,
                                      int repairUnderAttackUnitTypeID)
```
    Returns the id of the best building to repair.
  - kbGetCombatEfficiency
```
public float kbGetCombatEfficiency(int playerID1,
                                   int unitTypeID1,
                                   int playerID2,
                                   int unitTypeID2)
```
    Returns the combat efficiency of the comparison (in terms of playerID1's units).
  - kbLookAtAllUnitsOnMap
```
public void kbLookAtAllUnitsOnMap()
```
    Updates the knowledge base for all players with the latest info. If something's not working, put this in front of it and the problem usually magically disappears.
    
    See Also:
    
    xsSetContextPlayer(int player)
  - kbDump
```
public void kbDump(int player1,
                   int player2)
```
    KB dump for player2's units from player1's perspective.
  - kbDumpType
```
public void kbDumpType(int player1,
                       int player2,
                       string typeName)
```
    KB dump for player2's units of the given type from player1's perspective.
  - kbGetProtoUnitAICost
```
public float kbGetProtoUnitAICost(int protoUnitTypeID)
```
    Returns the AI cost for the given protoUnit type ID.
  - kbGetBuildLimit
```
public int kbGetBuildLimit(int player,
                           int baseUnitTypeID)
```
    Returns the number of the unit type you are allowed to have. This only works on base types. Returns -1 if there is no limit.
  - kbGetRandomEnabledPUID
```
public int kbGetRandomEnabledPUID(int unitTypeID,
                                  int escrowID)
```
    Returns a random, valid protounit ID that's of the given type.
  - kbUnitCostPerResource
```
public float kbUnitCostPerResource(int protoUnitID,
                                   int resourceID)
```
    Returns the cost of the protounit for the given resource.
    
    Since:
    
    AoT
  - kbGetProtoUnitName
```
public string kbGetProtoUnitName(int protoUnitTypeID)
```
    Returns the name of the protounit ID.
  - kbGetUnitBaseTypeID
```
public int kbGetUnitBaseTypeID(int unitID)
```
    Returns the base type ID of the unit.
  - kbGetUnitTypeName
```
public string kbGetUnitTypeName(int unitTypeID)
```
    Returns the name of the unit type.
  - kbGetBlockPosition
```
public vector kbGetBlockPosition(string blockName)
```
    Returns the position of the given unit. This was intended to only work for cinematic blocks, but it turns out to work fine for every unit.
  - kbGetBlockID
```
public int kbGetBlockID(string unitName)
```
    Returns the UnitID of the given unit. This was intended to only work for cinematic blocks, but it turns out to work fine for every unit.
  - kbProtoUnitAvailable
```
public bool kbProtoUnitAvailable(int protoUnitID)
```
    Returns true if the protoUnit is currently available.
  - kbGetProtoUnitID
```
public int kbGetProtoUnitID(string name)
```
    Returns the ID of the protounit.
  - kbCanAffordUnit
```
public bool kbCanAffordUnit(int protoUnitTypeID,
                            int escrowID)
```
    Returns true if the player can afford the proto unit.
  - kbUnitCount
```
public int kbUnitCount(int player,
                       int unitTypeID,
                       int stateID)
```
    Returns a quick unit count of units for a player.
  - kbUnitCountConsole
```
public void kbUnitCountConsole(int playerID1,
                               int playerID2,
                               string unitType,
                               string state)
```
    Returns a quick unit count of player2's units from player1's perspective.
  - kbUnitGetPlanID
```
public int kbUnitGetPlanID(int unitID)
```
    Returns the plan ID for this unit ID.
  - kbUnitGetBaseID
```
public int kbUnitGetBaseID(int unitID)
```
    Returns the base ID for this unit ID.
  - kbUnitGetAreaID
```
public int kbUnitGetAreaID(int unitID)
```
    Returns the area ID for this unit ID.
  - kbUnitGetArmyID
```
public int kbUnitGetArmyID(int unitID)
```
    Returns the army ID for this unit ID.
  - kbUnitGetMovementType
```
public int kbUnitGetMovementType(int unitTypeID)
```
    Returns the movementType for this unitTypeID.
  - kbUnitGetCurrentHitpoints
```
public float kbUnitGetCurrentHitpoints(int unitID)
```
    Returns the current hitpoints for this unit ID.
  - kbUnitGetMaximumHitpoints
```
public float kbUnitGetMaximumHitpoints(int unitID)
```
    Returns the maximum hitpoints for this unit ID.
  - kbUnitGetHealth
```
public float kbUnitGetHealth(int unitID)
```
    Returns the health for this unit ID.
  - kbUnitGetCurrentAICost
```
public float kbUnitGetCurrentAICost(int unitID)
```
    Returns the current AI cost (worth) for this unit ID.
  - kbUnitGetMaximumAICost
```
public float kbUnitGetMaximumAICost(int unitID)
```
    Returns the maximum AI cost (worth) for this unit ID.
  - kbUnitGetPosition
```
public vector kbUnitGetPosition(int unitID)
```
    Returns the position for this unit ID.
  - kbUnitIsType
```
public bool kbUnitIsType(int unitID,
                         long unitTypeID)
```
    Returns true if the unit is of the unitTypeID.
  - kbUnitGetActionType
```
public int kbUnitGetActionType(int unitID)
```
    Returns the actionTypeID of the unit.
  - kbUnitGetTargetUnitID
```
public int kbUnitGetTargetUnitID(int unitID)
```
    Returns the target unit ID of the given unit.
  - kbUnitGetNumberWorkers
```
public int kbUnitGetNumberWorkers(int unitID)
```
    Returns the number of units currently working on the given unit.
  - kbUnitGetWorkerID
```
public int kbUnitGetWorkerID(int unitID,
                             int index)
```
    Returns the index'th worker unit ID.
  - kbUnitVisible
```
public bool kbUnitVisible(int unitID)
```
    Returns true if the unit is currently visible to the player.

Class Unit

Field Summary

Method Summary

Methods inherited from class Object

Field Detail

cUnitStateNone

cUnitStateBuilding

cUnitStateAlive

cUnitStateDead

cUnitStateAny

cUnitStateAliveOrBuilding

cUnitFunctionBuilder

cUnitFunctionGatherer

cUnitFunctionEmpower

cUnitFunctionFish

cUnitFunctionWaterTransport

cUnitFunctionTrade

cUnitFunctionUnknown

Method Detail

kbGetPopCapAddition

kbGetPopSlots

kbGetPopulationSlotsByUnitTypeID

kbFindBestBuildingToRepair

kbGetCombatEfficiency

kbLookAtAllUnitsOnMap

kbDump

kbDumpType

kbGetProtoUnitAICost

kbGetBuildLimit

kbGetRandomEnabledPUID

kbUnitCostPerResource

kbGetProtoUnitName

kbGetUnitBaseTypeID

kbGetUnitTypeName

kbGetBlockPosition

kbGetBlockID

kbProtoUnitAvailable

kbGetProtoUnitID

kbCanAffordUnit

kbUnitCount

kbUnitCountConsole

kbUnitGetPlanID

kbUnitGetBaseID

kbUnitGetAreaID

kbUnitGetArmyID

kbUnitGetMovementType

kbUnitGetCurrentHitpoints

kbUnitGetMaximumHitpoints

kbUnitGetHealth

kbUnitGetCurrentAICost

kbUnitGetMaximumAICost

kbUnitGetPosition

kbUnitIsType

kbUnitGetActionType

kbUnitGetTargetUnitID

kbUnitGetNumberWorkers

kbUnitGetWorkerID

kbUnitVisible