aom.scripting.xs.kb

Class Escrow

Object

Escrow

public class Escrow
extends Object

This class provides a collection of KB commands concerning Escrows. Escrows are used by the AI to seperate the available resources in virtual slices. Each of those slices can be used for its own goals. Typically, an AI will have 3 escrows: a root escrow, an economic escrow and a military escrow.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
int	cEconomyEscrowID
int	cMilitaryEscrowID
int	cRootEscrowID

Method Summary

Modifier and Type	Method and Description
bool	kbEscrowAllocateCurrentResources() Reallocates the current resource stockpile into the escrows.
int	kbEscrowCreate(string name, int resourceID, float percentage, int parentID) Creates an escrow.
bool	kbEscrowDestroy(int escrowID, bool promoteChildren) Destroys an escrow.
bool	kbEscrowFlush(int escrowID, int resourceID, bool flushChildren) Removes all credits (and puts them into the root escrow) of the given resource type from the given escrow.
float	kbEscrowGetAmount(int escrowID, int resourceID) Returns the amount of credits in the given escrow for the given resource.
int	kbEscrowGetID(string name) Returns the ID of the named escrow.
float	kbEscrowGetPercentage(int escrowID, int resourceID) Returns the percentage of the escrow.
bool	kbEscrowSetCap(int escrowID, int resourceID, float cap) Sets the cap of the escrow.
bool	kbEscrowSetPercentage(int escrowID, int resourceID, float percentage) Sets the percentage of the escrow.

Methods inherited from class Object

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

Field Detail

cRootEscrowID

public final int cRootEscrowID

See Also:

Constant Field Values

cEconomyEscrowID

public final int cEconomyEscrowID

See Also:

Constant Field Values

cMilitaryEscrowID

public final int cMilitaryEscrowID

See Also:

Constant Field Values

Method Detail

kbEscrowCreate

public int kbEscrowCreate(string name,
                          int resourceID,
                          float percentage,
                          int parentID)

Creates an escrow.

kbEscrowDestroy

public bool kbEscrowDestroy(int escrowID,
                            bool promoteChildren)

Destroys an escrow.

kbEscrowGetID

public int kbEscrowGetID(string name)

Returns the ID of the named escrow.

kbEscrowGetPercentage

public float kbEscrowGetPercentage(int escrowID,
                                   int resourceID)

Returns the percentage of the escrow.

kbEscrowSetPercentage

public bool kbEscrowSetPercentage(int escrowID,
                                  int resourceID,
                                  float percentage)

Sets the percentage of the escrow.

kbEscrowSetCap

public bool kbEscrowSetCap(int escrowID,
                           int resourceID,
                           float cap)

Sets the cap of the escrow.

kbEscrowGetAmount

public float kbEscrowGetAmount(int escrowID,
                               int resourceID)

Returns the amount of credits in the given escrow for the given resource.

kbEscrowFlush

public bool kbEscrowFlush(int escrowID,
                          int resourceID,
                          bool flushChildren)

Removes all credits (and puts them into the root escrow) of the given resource type from the given escrow.

kbEscrowAllocateCurrentResources

public bool kbEscrowAllocateCurrentResources()

Reallocates the current resource stockpile into the escrows.