aom.scripting.xs.ai

Class Economy

Object

Economy

public class Economy
extends Object

This class provides a collection of AI commands concerning Economy.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
int	cRGPActual
int	cRGPCost
int	cRGPScript

Method Summary

Modifier and Type	Method and Description
bool	aiBuyResourceOnMarket(int resourceID) Buys (+100) the given resource.
bool	aiGetAllowAutoDropsites() Returns allow auto dropsites on/off.
int	aiGetAutoFarmEscrowID() Returns the auto Farm escrow ID.
bool	aiGetAutoFavorGather() Returns auto favor gather on/off.
int	aiGetAutoGatherEscrowID() Returns the auto gather escrow ID.
int	aiGetAvailableEconomyPop() Returns the available economy pop for this player.
void	aiGetCurrentResourceNeed(int resourceID) Returns the current resource need for the given resource.
float	aiGetEconomyPercentage() Returns the economy priority percentage.
int	aiGetEconomyPop() Returns the script-defined economy pop for this player.
int	aiGetFarmLimit() Returns the per plan farm build limit.
float	aiGetMarketBuyCost(int resourceID) Returns the amount required to buy 100 units of the given resource.
float	aiGetMarketSellCost(int resourceID) Returns the amount received for selling 100 units of the given resource.
int	aiGetMinNumberNeedForGatheringAggressives() Gets the min number of needed units to gather aggressive animals.
int	aiGetMinNumberWantForGatheringAggressives() Gets the min number of wanted units to gather aggressive animals.
int	aiGetResourceBreakdownNumberPlans(int resourceTypeID, int resourceSubTypeID, int baseID) Gets the number of plans for the given breakdown.
float	aiGetResourceBreakdownPercentage(int resourceTypeID, int resourceSubTypeID, int baseID) Gets the percentage for the given breakdown.
int	aiGetResourceBreakdownPlanPriority(int resourceTypeID, int resourceSubTypeID, int baseID) Gets the priority of the plans for the given breakdown.
float	aiGetResourceGathererPercentage(int resourceID, int rgpIndex) Returns the resource gatherer percentage for the given resource.
float	aiGetResourceGathererPercentageWeight(int rgpIndex) Returns the RGP weight.
int	aiGetTrainedDropsiteUnitTypeID() Returns the trained dropsite PUID.
void	aiNormalizeResourceGathererPercentages(int rgpIndex) Normalizes all of the resource gatherer percentages to 1.0.
void	aiNormalizeResourceGathererPercentageWeights() Normalizes all of the resource gatherer percentages weights to 1.0.
bool	aiRemoveResourceBreakdown(int resourceTypeID, int resourceSubTypeID, int baseID) Removes the given breakdown.
void	aiResourceCheat(int playerID, int resourceID, float amount) Gives your wimpy CP AI free resources because it can't handle the truth, or something like that.
bool	aiSellResourceOnMarket(int resourceID) Sells (+100) the given resource.
void	aiSetAllowAutoDropsites(bool v) Sets allow auto dropsites on/off.
void	aiSetAutoFarmEscrowID(int escrowID) Sets the auto Farm escrow ID.
void	aiSetAutoFavorGather(bool v) Sets auto favor gather on/off.
void	aiSetAutoGatherEscrowID(int escrowID) Sets the auto gather escrow ID.
void	aiSetEconomyPercentage(float v) Set the economy priority percentage.
void	aiSetEconomyPop(int v) Set the script-defined economy pop for this player.
void	aiSetFarmLimit(int limit) Sets the per plan farm build limit.
void	aiSetFavorNeedModifier(float v) Sets favor need modifier.
void	aiSetMinNumberNeedForGatheringAggressvies(long v) Sets the min number of needed units to gather aggressive animals.
void	aiSetMinNumberWantForGatheringAggressives(long v) Sets the min number of wanted units to gather aggressive animals.
bool	aiSetResourceBreakdown(int resourceTypeID, int resourceSubTypeID, int numberPlans, int planPriority, float percentage, int baseID) Sets a subtype breakdown for a resource.
void	aiSetResourceGathererPercentage(int resourceID, float value, bool normalize, int rgpIndex) Sets the resource gatherer percentage for the given resource (if normalized is true, the percentages will be normalized to 1.0).
void	aiSetResourceGathererPercentageWeight(int rgpIndex, float weight) Sets the RGP weight.
void	aiSetTrainedDropsiteUnitTypeID(int v) Sets the trained dropsite PUID.
bool	aiSetUpdateResourceEventHandler(string handlerFunctionName) Sets the handler for the update resource event (invalid name unsets the handler).
bool	aiSetUpdateResourceLimit(int resourceID, float limit) Sets the limit for the given resource for the update resource event.
bool	aiTribute(int playerID, int resourceID, float amount) Tributes the given player.

Methods inherited from class Object

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

Field Detail

cRGPScript

public final int cRGPScript

See Also:

Constant Field Values

cRGPCost

public final int cRGPCost

See Also:

Constant Field Values

cRGPActual

public final int cRGPActual

See Also:

Constant Field Values

Method Detail

aiSellResourceOnMarket

public bool aiSellResourceOnMarket(int resourceID)

Sells (+100) the given resource.

aiBuyResourceOnMarket

public bool aiBuyResourceOnMarket(int resourceID)

Buys (+100) the given resource.

aiGetMarketBuyCost

public float aiGetMarketBuyCost(int resourceID)

Returns the amount required to buy 100 units of the given resource.

aiGetMarketSellCost

public float aiGetMarketSellCost(int resourceID)

Returns the amount received for selling 100 units of the given resource.

aiGetResourceBreakdownNumberPlans

public int aiGetResourceBreakdownNumberPlans(int resourceTypeID,
                                             int resourceSubTypeID,
                                             int baseID)

Gets the number of plans for the given breakdown.

aiGetResourceBreakdownPlanPriority

public int aiGetResourceBreakdownPlanPriority(int resourceTypeID,
                                              int resourceSubTypeID,
                                              int baseID)

Gets the priority of the plans for the given breakdown.

aiGetResourceBreakdownPercentage

public float aiGetResourceBreakdownPercentage(int resourceTypeID,
                                              int resourceSubTypeID,
                                              int baseID)

Gets the percentage for the given breakdown.

aiSetResourceBreakdown

public bool aiSetResourceBreakdown(int resourceTypeID,
                                   int resourceSubTypeID,
                                   int numberPlans,
                                   int planPriority,
                                   float percentage,
                                   int baseID)

Sets a subtype breakdown for a resource.

aiRemoveResourceBreakdown

public bool aiRemoveResourceBreakdown(int resourceTypeID,
                                      int resourceSubTypeID,
                                      int baseID)

Removes the given breakdown.

aiGetResourceGathererPercentage

public float aiGetResourceGathererPercentage(int resourceID,
                                             int rgpIndex)

Returns the resource gatherer percentage for the given resource.

aiSetResourceGathererPercentage

public void aiSetResourceGathererPercentage(int resourceID,
                                            float value,
                                            bool normalize,
                                            int rgpIndex)

Sets the resource gatherer percentage for the given resource (if normalized is true, the percentages will be normalized to 1.0).

aiNormalizeResourceGathererPercentages

public void aiNormalizeResourceGathererPercentages(int rgpIndex)

Normalizes all of the resource gatherer percentages to 1.0.

aiTribute

public bool aiTribute(int playerID,
                      int resourceID,
                      float amount)

Tributes the given player.

aiSetResourceGathererPercentageWeight

public void aiSetResourceGathererPercentageWeight(int rgpIndex,
                                                  float weight)

Sets the RGP weight.

aiGetAllowAutoDropsites

public bool aiGetAllowAutoDropsites()

Returns allow auto dropsites on/off.

aiSetUpdateResourceEventHandler

public bool aiSetUpdateResourceEventHandler(string handlerFunctionName)

Sets the handler for the update resource event (invalid name unsets the handler).

aiSetUpdateResourceLimit

public bool aiSetUpdateResourceLimit(int resourceID,
                                     float limit)

Sets the limit for the given resource for the update resource event.

aiGetResourceGathererPercentageWeight

public float aiGetResourceGathererPercentageWeight(int rgpIndex)

Returns the RGP weight.

aiNormalizeResourceGathererPercentageWeights

public void aiNormalizeResourceGathererPercentageWeights()

Normalizes all of the resource gatherer percentages weights to 1.0.

aiGetAutoGatherEscrowID

public int aiGetAutoGatherEscrowID()

Returns the auto gather escrow ID.

aiSetAutoGatherEscrowID

public void aiSetAutoGatherEscrowID(int escrowID)

Sets the auto gather escrow ID.

aiGetAutoFarmEscrowID

public int aiGetAutoFarmEscrowID()

Returns the auto Farm escrow ID.

aiSetAutoFarmEscrowID

public void aiSetAutoFarmEscrowID(int escrowID)

Sets the auto Farm escrow ID.

aiGetFarmLimit

public int aiGetFarmLimit()

Returns the per plan farm build limit.

aiSetFarmLimit

public void aiSetFarmLimit(int limit)

Sets the per plan farm build limit.

aiGetTrainedDropsiteUnitTypeID

public int aiGetTrainedDropsiteUnitTypeID()

Returns the trained dropsite PUID.

aiSetTrainedDropsiteUnitTypeID

public void aiSetTrainedDropsiteUnitTypeID(int v)

Sets the trained dropsite PUID. In particular, this should register an ox cart as a valid dropsite.

aiSetFavorNeedModifier

public void aiSetFavorNeedModifier(float v)

Sets favor need modifier.

aiGetAutoFavorGather

public bool aiGetAutoFavorGather()

Returns auto favor gather on/off.

aiSetAutoFavorGather

public void aiSetAutoFavorGather(bool v)

Sets auto favor gather on/off.

aiSetAllowAutoDropsites

public void aiSetAllowAutoDropsites(bool v)

Sets allow auto dropsites on/off.

aiGetAvailableEconomyPop

public int aiGetAvailableEconomyPop()

Returns the available economy pop for this player.

aiGetCurrentResourceNeed

public void aiGetCurrentResourceNeed(int resourceID)

Returns the current resource need for the given resource.

aiResourceCheat

public void aiResourceCheat(int playerID,
                            int resourceID,
                            float amount)

Gives your wimpy CP AI free resources because it can't handle the truth, or something like that.

aiGetEconomyPercentage

public float aiGetEconomyPercentage()

Returns the economy priority percentage.

aiSetEconomyPercentage

public void aiSetEconomyPercentage(float v)

Set the economy priority percentage.

aiGetEconomyPop

public int aiGetEconomyPop()

Returns the script-defined economy pop for this player.

aiSetEconomyPop

public void aiSetEconomyPop(int v)

Set the script-defined economy pop for this player.

aiSetMinNumberNeedForGatheringAggressvies

public void aiSetMinNumberNeedForGatheringAggressvies(long v)

Sets the min number of needed units to gather aggressive animals.

aiGetMinNumberNeedForGatheringAggressives

public int aiGetMinNumberNeedForGatheringAggressives()

Gets the min number of needed units to gather aggressive animals.

aiSetMinNumberWantForGatheringAggressives

public void aiSetMinNumberWantForGatheringAggressives(long v)

Sets the min number of wanted units to gather aggressive animals.

aiGetMinNumberWantForGatheringAggressives

public int aiGetMinNumberWantForGatheringAggressives()

Gets the min number of wanted units to gather aggressive animals.