aom.scripting.xs.kb

Class Base

Object

Base

public class Base
extends Object

This class provides a collection of KB commands concerning Bases. Bases are virtual areas used by the AI to locate the most important places on the map.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Method Summary

Modifier and Type	Method and Description
bool	kbBaseAddUnit(int playerID, int baseID, int unitID) Adds the given unit to the base.
int	kbBaseCreate(int playerID, string name, vector position, float distance) Creates a base.
bool	kbBaseDestroy(int playerID, int baseID) Destroys the given base.
void	kbBaseDestroyAll(int playerID) Destroys all of the bases for the given player.
int	kbBaseFindCreateResourceBase(int enemyPlayerID, int enemyBaseID) Finds/Creates a 'forward' military base against the given enemy base.
int	kbBaseFindCreateResourceBase(int resourceType, int resourceSubType, int parentBaseID) Finds/Creates a resource base.
bool	kbBaseGetActive(int playerID, int baseID) Gets the active flag of the base.
vector	kbBaseGetBackVector(int playerID, int baseID) Gets the back vector of the base.
bool	kbBaseGetEconomy(int playerID, int baseID) Gets the economy flag of the base.
bool	kbBaseGetForward(int playerID, int baseID) Gets the forward flag of the base.
vector	kbBaseGetFrontVector(int playerID, int baseID) Gets the front vector of the base.
int	kbBaseGetIDByIndex(int playerID, int index) Returns the BaseID for the given base.
vector	kbBaseGetLocation(int playerID, int baseID) Gets the location of the base.
bool	kbBaseGetMain(int playerID, int baseID) Gets the main flag of the base.
int	kbBaseGetMainID(int playerID) Gets the main base ID for the player.
float	kbBaseGetMaximumResourceDistance(int playerID, int baseID) Gets the maximum resource distance of the base.
bool	kbBaseGetMilitary(int playerID, int baseID) Gets the military flag of the base.
vector	kbBaseGetMilitaryGatherPoint(int playerID, int baseID) Gets the military gather point of the base.
int	kbBaseGetNextID() Returns the ID of the next base that will be created.
int	kbBaseGetNumber(int playerID) Returns the number of bases for the given player.
int	kbBaseGetNumberUnits(int playerID, int baseID, int relation, int unitTypeID) Returns the number of units that match the criteria.
bool	kbBaseGetSettlement(int playerID, int baseID) Gets the settlement flag of the base.
int	kbBaseGetTimeUnderAttack(int playerID, int baseID) Returns the number of continuous seconds the base has been under attack.
bool	kbBaseGetUnderAttack(int playerID, int baseID) Gets the under attack flag of the base.
bool	kbBaseRemoveUnit(int playerID, int baseID, int unitID) Removes the given unit to the base.
bool	kbBaseSetActive(int playerID, int baseID, bool active) Sets the active flag of the base.
bool	kbBaseSetEconomy(int playerID, int baseID, bool Economy) Sets the economy flag of the base.
bool	kbBaseSetForward(int playerID, int baseID, bool forward) Sets the forward flag of the base.
bool	kbBaseSetFrontVector(int playerID, int baseID, vector frontVector) Sets the front (and back) of the base.
bool	kbBaseSetMain(int playerID, int baseID, bool main) Sets the main flag of the base.
void	kbBaseSetMaximumResourceDistance(int playerID, int baseID, float distance) Sets the maximum resource distance of the base.
bool	kbBaseSetMilitary(int playerID, int baseID, bool military) Sets the military flag of the base.
bool	kbBaseSetMilitaryGatherPoint(int playerID, int baseID, vector gatherPoint) Sets the military gather point of the base.
bool	kbBaseSetSettlement(int playerID, int baseID, bool settlement) Sets the settlement flag of the base.
bool	kbGetAutoBaseCreate() Returns the auto base creation value.
float	kbGetAutoBaseCreateDistance() Returns the auto base creation distance.
bool	kbGetAutoBaseDetect() Returns the auto base detection value.
float	kbGetAutoBaseDetectDistance() Returns the auto base creation distance.
void	kbSetAutoBaseCreate(bool v) Sets the auto base creation value.
void	kbSetAutoBaseCreateDistance(float v) Sets the auto base creation distance.
void	kbSetAutoBaseDetect(bool v) Sets the auto base detection value.
void	kbSetAutoBaseDetectDistance(float v) Sets the auto base creation distance.
void	kbSetForwardBasePosition(vector position) Set the explicit position that every forward base will use.

Methods inherited from class Object

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

Method Detail

kbSetForwardBasePosition

public void kbSetForwardBasePosition(vector position)

Set the explicit position that every forward base will use.

kbBaseAddUnit

public bool kbBaseAddUnit(int playerID,
                          int baseID,
                          int unitID)

Adds the given unit to the base.

kbBaseRemoveUnit

public bool kbBaseRemoveUnit(int playerID,
                             int baseID,
                             int unitID)

Removes the given unit to the base.

kbBaseGetNumberUnits

public int kbBaseGetNumberUnits(int playerID,
                                int baseID,
                                int relation,
                                int unitTypeID)

Returns the number of units that match the criteria.

kbBaseFindCreateResourceBase

public int kbBaseFindCreateResourceBase(int enemyPlayerID,
                                        int enemyBaseID)

Finds/Creates a 'forward' military base against the given enemy base.

kbBaseDestroy

public bool kbBaseDestroy(int playerID,
                          int baseID)

Destroys the given base.

kbBaseDestroyAll

public void kbBaseDestroyAll(int playerID)

Destroys all of the bases for the given player.

kbBaseGetLocation

public vector kbBaseGetLocation(int playerID,
                                int baseID)

Gets the location of the base.

kbBaseSetFrontVector

public bool kbBaseSetFrontVector(int playerID,
                                 int baseID,
                                 vector frontVector)

Sets the front (and back) of the base.

kbBaseGetFrontVector

public vector kbBaseGetFrontVector(int playerID,
                                   int baseID)

Gets the front vector of the base.

kbBaseGetBackVector

public vector kbBaseGetBackVector(int playerID,
                                  int baseID)

Gets the back vector of the base.

kbBaseGetTimeUnderAttack

public int kbBaseGetTimeUnderAttack(int playerID,
                                    int baseID)

Returns the number of continuous seconds the base has been under attack.

kbBaseGetUnderAttack

public bool kbBaseGetUnderAttack(int playerID,
                                 int baseID)

Gets the under attack flag of the base.

kbBaseSetActive

public bool kbBaseSetActive(int playerID,
                            int baseID,
                            bool active)

Sets the active flag of the base.

kbBaseGetActive

public bool kbBaseGetActive(int playerID,
                            int baseID)

Gets the active flag of the base.

kbBaseGetMainID

public int kbBaseGetMainID(int playerID)

Gets the main base ID for the player.

kbBaseSetMain

public bool kbBaseSetMain(int playerID,
                          int baseID,
                          bool main)

Sets the main flag of the base.

kbBaseGetMain

public bool kbBaseGetMain(int playerID,
                          int baseID)

Gets the main flag of the base.

kbBaseSetForward

public bool kbBaseSetForward(int playerID,
                             int baseID,
                             bool forward)

Sets the forward flag of the base.

kbBaseGetForward

public bool kbBaseGetForward(int playerID,
                             int baseID)

Gets the forward flag of the base.

kbBaseSetSettlement

public bool kbBaseSetSettlement(int playerID,
                                int baseID,
                                bool settlement)

Sets the settlement flag of the base.

kbBaseGetSettlement

public bool kbBaseGetSettlement(int playerID,
                                int baseID)

Gets the settlement flag of the base.

kbBaseSetMilitary

public bool kbBaseSetMilitary(int playerID,
                              int baseID,
                              bool military)

Sets the military flag of the base.

kbBaseGetMilitary

public bool kbBaseGetMilitary(int playerID,
                              int baseID)

Gets the military flag of the base.

kbBaseGetMilitaryGatherPoint

public vector kbBaseGetMilitaryGatherPoint(int playerID,
                                           int baseID)

Gets the military gather point of the base.

kbBaseSetMilitaryGatherPoint

public bool kbBaseSetMilitaryGatherPoint(int playerID,
                                         int baseID,
                                         vector gatherPoint)

Sets the military gather point of the base.

kbBaseSetEconomy

public bool kbBaseSetEconomy(int playerID,
                             int baseID,
                             bool Economy)

Sets the economy flag of the base.

kbBaseGetEconomy

public bool kbBaseGetEconomy(int playerID,
                             int baseID)

Gets the economy flag of the base.

kbBaseGetMaximumResourceDistance

public float kbBaseGetMaximumResourceDistance(int playerID,
                                              int baseID)

Gets the maximum resource distance of the base.

kbBaseSetMaximumResourceDistance

public void kbBaseSetMaximumResourceDistance(int playerID,
                                             int baseID,
                                             float distance)

Sets the maximum resource distance of the base.

kbGetAutoBaseCreate

public bool kbGetAutoBaseCreate()

Returns the auto base creation value.

kbSetAutoBaseCreate

public void kbSetAutoBaseCreate(bool v)

Sets the auto base creation value.

kbGetAutoBaseCreateDistance

public float kbGetAutoBaseCreateDistance()

Returns the auto base creation distance.

kbSetAutoBaseCreateDistance

public void kbSetAutoBaseCreateDistance(float v)

Sets the auto base creation distance.

kbGetAutoBaseDetect

public bool kbGetAutoBaseDetect()

Returns the auto base detection value.

kbSetAutoBaseDetect

public void kbSetAutoBaseDetect(bool v)

Sets the auto base detection value.

kbGetAutoBaseDetectDistance

public float kbGetAutoBaseDetectDistance()

Returns the auto base creation distance.

kbSetAutoBaseDetectDistance

public void kbSetAutoBaseDetectDistance(float v)

Sets the auto base creation distance.

kbBaseGetNextID

public int kbBaseGetNextID()

Returns the ID of the next base that will be created.

kbBaseGetNumber

public int kbBaseGetNumber(int playerID)

Returns the number of bases for the given player.

kbBaseGetIDByIndex

public int kbBaseGetIDByIndex(int playerID,
                              int index)

Returns the BaseID for the given base.

kbBaseCreate

public int kbBaseCreate(int playerID,
                        string name,
                        vector position,
                        float distance)

Creates a base.

kbBaseFindCreateResourceBase

public int kbBaseFindCreateResourceBase(int resourceType,
                                        int resourceSubType,
                                        int parentBaseID)

Finds/Creates a resource base.