aom.scripting.xs.kb

Class Army

Object

Army

public class Army
extends Object

This class provides a collection of KB commands concerning Armies. An army is a logical grouping of units. Units can only be part of 1 army and an army can only consist of 30 unit max.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Method Summary

Modifier and Type	Method and Description
bool	kbArmyAddUnit(int armyID, int unitID) Adds the unitID to the given army.
int	kbArmyCreate(string name, bool exclusiveUnits) Creates a army with the given name.
bool	kbArmyDestroy(int armyID) Destroys the given army.
float	kbArmyGetAPSDamageGiven(int armyID, float timeSpan) Returns the APS damage given by the given army.
float	kbArmyGetAPSDamageTaken(int armyID, float timeSpan) Returns the APS damage taken by the given army.
float	kbArmyGetAPSResourcesGathered(int armyID, float timeSpan, int resourceID) Returns the APS resources gathered by the given army.
int	kbArmyGetCreationTime(int armyID) Returns the creation time for the given army.
float	kbArmyGetCurrentAICost(int armyID) Returns the current AI cost (worth) for the given army.
float	kbArmyGetCurrentHitpoints(int armyID) Returns the current total hitpoints for the given army.
float	kbArmyGetHealth(int armyID) Returns the health for the given army.
int	kbArmyGetID(string name) Returns the ID of the given army.
int	kbArmyGetIDByIndex(long index) Returns the index'th army ID.
vector	kbArmyGetLocation(int armyID) Returns the vector location for the given army.
float	kbArmyGetMaximumAICost(int armyID) Returns the maximum AI cost (worth) for the given army.
float	kbArmyGetMaximumHitpoints(int armyID) Returns the maximum total hitpoints for the given army.
int	kbArmyGetMembershipTime(int armyID) Returns the creation time for the given army.
string	kbArmyGetName(int amryID) Returns the name of the given army.
int	kbArmyGetNumber() Returns the number of armies.
int	kbArmyGetNumberUnits(int armyID) Returns the number of units in the given army.
int	kbArmyGetNumberWithHealth(int armyID, float minimumHealth) Returns the number of units with at least the minimum amount of health specified for the given army.
int	kbArmyGetNumberWithinLocation(int armyID, vector point, float range) Returns the number of units within range of the given point in the given army.
int	kbArmyGetPlanID(int armyID) Returns the planID for the given army.
int	kbArmyGetUnitID(int armyID, long unitNumber) Returns the appropriate unitID from the given army.
bool	kbArmyRemoveUnit(int armyID, int unitID) Removes the unitID from the given army.
bool	kbArmyRemoveUnitByIndex(int armyID, int unitIndex) Removes the unitIndex'th unit from the given army.
bool	kbArmyRemoveUnits(int armyID) Removes all units from the given army.

Methods inherited from class Object

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

Method Detail

kbArmyCreate

public int kbArmyCreate(string name,
                        bool exclusiveUnits)

Creates a army with the given name.

kbArmyDestroy

public bool kbArmyDestroy(int armyID)

Destroys the given army.

kbArmyGetNumber

public int kbArmyGetNumber()

Returns the number of armies.

kbArmyGetID

public int kbArmyGetID(string name)

Returns the ID of the given army.

kbArmyGetIDByIndex

public int kbArmyGetIDByIndex(long index)

Returns the index'th army ID.

kbArmyGetName

public string kbArmyGetName(int amryID)

Returns the name of the given army.

kbArmyGetNumberUnits

public int kbArmyGetNumberUnits(int armyID)

Returns the number of units in the given army.

kbArmyGetUnitID

public int kbArmyGetUnitID(int armyID,
                           long unitNumber)

Returns the appropriate unitID from the given army.

kbArmyAddUnit

public bool kbArmyAddUnit(int armyID,
                          int unitID)

Adds the unitID to the given army.

kbArmyRemoveUnit

public bool kbArmyRemoveUnit(int armyID,
                             int unitID)

Removes the unitID from the given army.

kbArmyRemoveUnitByIndex

public bool kbArmyRemoveUnitByIndex(int armyID,
                                    int unitIndex)

Removes the unitIndex'th unit from the given army.

kbArmyRemoveUnits

public bool kbArmyRemoveUnits(int armyID)

Removes all units from the given army.

kbArmyGetPlanID

public int kbArmyGetPlanID(int armyID)

Returns the planID for the given army.

kbArmyGetCreationTime

public int kbArmyGetCreationTime(int armyID)

Returns the creation time for the given army.

kbArmyGetMembershipTime

public int kbArmyGetMembershipTime(int armyID)

Returns the creation time for the given army.

kbArmyGetLocation

public vector kbArmyGetLocation(int armyID)

Returns the vector location for the given army.

kbArmyGetNumberWithinLocation

public int kbArmyGetNumberWithinLocation(int armyID,
                                         vector point,
                                         float range)

Returns the number of units within range of the given point in the given army.

kbArmyGetCurrentHitpoints

public float kbArmyGetCurrentHitpoints(int armyID)

Returns the current total hitpoints for the given army.

kbArmyGetMaximumHitpoints

public float kbArmyGetMaximumHitpoints(int armyID)

Returns the maximum total hitpoints for the given army.

kbArmyGetHealth

public float kbArmyGetHealth(int armyID)

Returns the health for the given army.

kbArmyGetNumberWithHealth

public int kbArmyGetNumberWithHealth(int armyID,
                                     float minimumHealth)

Returns the number of units with at least the minimum amount of health specified for the given army.

kbArmyGetCurrentAICost

public float kbArmyGetCurrentAICost(int armyID)

Returns the current AI cost (worth) for the given army.

kbArmyGetMaximumAICost

public float kbArmyGetMaximumAICost(int armyID)

Returns the maximum AI cost (worth) for the given army.

kbArmyGetAPSDamageTaken

public float kbArmyGetAPSDamageTaken(int armyID,
                                     float timeSpan)

Returns the APS damage taken by the given army.

kbArmyGetAPSDamageGiven

public float kbArmyGetAPSDamageGiven(int armyID,
                                     float timeSpan)

Returns the APS damage given by the given army.

kbArmyGetAPSResourcesGathered

public float kbArmyGetAPSResourcesGathered(int armyID,
                                           float timeSpan,
                                           int resourceID)

Returns the APS resources gathered by the given army.