aom.scripting.xs.kb

Class Resource

Object

Resource

public class Resource
extends Object

This class provides a collection of KB commands concerning Resources.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
int	cAIResourceSubTypeEasy
int	cAIResourceSubTypeFarm
int	cAIResourceSubTypeFish
int	cAIResourceSubTypeHunt
int	cAIResourceSubTypeHuntAggressive
int	cAIResourceSubTypeTrade
int	cAllResources
int	cResourceFavor
int	cResourceFood
int	cResourceGold
int	cResourceWood

Method Summary

Modifier and Type	Method and Description
float	kbGetAICostWeight(int resourceID) Returns the AI cost weight for the given resource.
float	kbGetAmountValidResources(int baseID, int resourceTypeID, int resourceSubTypeID, float distance) Returns the resource amount of valid KB resources for the resource types.
int	kbGetNumberValidResources(int baseID, int resourceTypeID, int resourceSubTypeID, float distance) Returns the number of valid KB resources for the resource types.
int	kbGetNumberValidResourcesByPlan(int planID, int baseID) Returns the number of valid KB resources for the given plan/base.
float	kbGetResourceIncome(int resourceID, float seconds, bool relative) Returns the resource income over the last X seconds.
float	kbMaximumResourceGet(int resourceID) Returns the maximum amount of the given resource you can have.
float	kbResourceGet(int resourceID) Returns the current amount of the given resource.
bool	kbSetAICostWeight(int resourceID, float weight) Sets the weight this resource type is given during AI cost calculations.
bool	kbSetupForResource(int baseID, int resourceID, float distance, float amount) Returns true if amount of resource is within distance of a drop site.
float	kbTotalResourceGet(int resourceID) Returns the total amount of the given resource gathered to this point in the game.

Methods inherited from class Object

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

Field Detail

cResourceGold

public final int cResourceGold

See Also:

Constant Field Values

cResourceWood

public final int cResourceWood

See Also:

Constant Field Values

cResourceFood

public final int cResourceFood

See Also:

Constant Field Values

cResourceFavor

public final int cResourceFavor

See Also:

Constant Field Values

cAllResources

public final int cAllResources

See Also:

Constant Field Values

cAIResourceSubTypeEasy

public final int cAIResourceSubTypeEasy

See Also:

Constant Field Values

cAIResourceSubTypeHunt

public final int cAIResourceSubTypeHunt

See Also:

Constant Field Values

cAIResourceSubTypeHuntAggressive

public final int cAIResourceSubTypeHuntAggressive

See Also:

Constant Field Values

cAIResourceSubTypeFarm

public final int cAIResourceSubTypeFarm

See Also:

Constant Field Values

cAIResourceSubTypeFish

public final int cAIResourceSubTypeFish

See Also:

Constant Field Values

cAIResourceSubTypeTrade

public final int cAIResourceSubTypeTrade

See Also:

Constant Field Values

Method Detail

kbSetupForResource

public bool kbSetupForResource(int baseID,
                               int resourceID,
                               float distance,
                               float amount)

Returns true if amount of resource is within distance of a drop site.

kbResourceGet

public float kbResourceGet(int resourceID)

Returns the current amount of the given resource.

kbMaximumResourceGet

public float kbMaximumResourceGet(int resourceID)

Returns the maximum amount of the given resource you can have.

kbTotalResourceGet

public float kbTotalResourceGet(int resourceID)

Returns the total amount of the given resource gathered to this point in the game.

kbGetNumberValidResourcesByPlan

public int kbGetNumberValidResourcesByPlan(int planID,
                                           int baseID)

Returns the number of valid KB resources for the given plan/base.

kbGetNumberValidResources

public int kbGetNumberValidResources(int baseID,
                                     int resourceTypeID,
                                     int resourceSubTypeID,
                                     float distance)

Returns the number of valid KB resources for the resource types.

kbGetAmountValidResources

public float kbGetAmountValidResources(int baseID,
                                       int resourceTypeID,
                                       int resourceSubTypeID,
                                       float distance)

Returns the resource amount of valid KB resources for the resource types.

kbGetResourceIncome

public float kbGetResourceIncome(int resourceID,
                                 float seconds,
                                 bool relative)

Returns the resource income over the last X seconds.

kbGetAICostWeight

public float kbGetAICostWeight(int resourceID)

Returns the AI cost weight for the given resource.

kbSetAICostWeight

public bool kbSetAICostWeight(int resourceID,
                              float weight)

Sets the weight this resource type is given during AI cost calculations.