aom.scripting.xs.kb

Class UnitPick

Object

UnitPick

public class UnitPick
extends Object

This class provides a collection of KB commands concerning Unit Picks. Unit Picks are a high level way to decide what kind of units you wish to train.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Method Summary

Modifier and Type	Method and Description
bool	kbUnitPickAddCombatEfficiencyType(int upID, int typeID, float weight) Adds an enemy unit typeID to the unit pick combat efficiency calculation.
bool	kbUnitPickAdjustPreferenceFactor(int upID, int unitTypeID, float baseFactorAdjustment) Adjusts the preferenceFactor for that unit type (uses 50.0 as the base if the unit pick doesn't exist yet).
int	kbUnitPickCreate(string name) Creates a unit pick.
bool	kbUnitPickDestroy(int upID) Destroys the given unit pick.
int	kbUnitPickGetAttackUnitType(int upID) Gets the unit pick attack unit type.
int	kbUnitPickGetDesiredNumberBuildings(int upID, int index) Gets the unit pick desired number buildings for the index'th unit type.
int	kbUnitPickGetDesiredNumberUnitTypes(int upID) Gets the unit pick desired number unit types.
int	kbUnitPickGetGoalCombatEfficiencyType(int upID) Gets the unit pick attack unit type.
int	kbUnitPickGetMaximumNumberUnits(int upID) Gets the unit pick maximum number units.
int	kbUnitPickGetMaximumPop(int upID) Gets the unit pick maximum pop.
int	kbUnitPickGetMinimumNumberUnits(int upID) Gets the unit pick minimum number units.
int	kbUnitPickGetMinimumPop(int upID) Gets the unit pick minimum pop.
int	kbUnitPickGetNumberResults(int upID) Returns the number of unit pick results.
float	kbUnitPickGetPreferenceWeight(int upID) Gets the unit pick preference weight.
int	kbUnitPickGetResult(int upID, int index) Returns the index'th ProtoUnitID.
bool	kbUnitPickResetAll(int upID) Resets all of the unit pick data.
bool	kbUnitPickResetCombatEfficiencyTypes(int upID) Resets the enemy unit typeIDs for the unit pick combat efficiency calculation.
bool	kbUnitPickResetResults(int upID) Resets the unit pick results.
int	kbUnitPickRun(int upID) Runs the unit pick.
bool	kbUnitPickSetAttackUnitType(int upID, int type) Sets the unit pick attack unit type.
bool	kbUnitPickSetCombatEfficiencyWeight(int upID) Sets the unit pick combat efficiency weight.
bool	kbUnitPickSetCostWeight(int upID) Sets the unit pick cost weight.
bool	kbUnitPickSetDesiredNumberBuildings(int upID, int index, int numberBuildings) Sets the unit pick desired number buildings for the index'th unit type.
bool	kbUnitPickSetDesiredNumberUnitTypes(int upID, int number, int numberBuildings, bool degradeNumberBuildings) Sets the unit pick desired number unit types.
bool	kbUnitPickSetEnemyPlayerID(int upID) Sets the unit pick enemy player ID.
bool	kbUnitPickSetGoalCombatEfficiencyType(int upID, int type) Sets the unit pick attack unit type.
bool	kbUnitPickSetMaximumNumberUnits(int upID, int number) Sets the unit pick desired number unit types.
bool	kbUnitPickSetMaximumPop(int upID, int number) Sets the unit pick desired max pop.
bool	kbUnitPickSetMinimumNumberUnits(int upID, int number) Sets the unit pick desired number unit types.
bool	kbUnitPickSetMinimumPop(int upID, int number) Sets the unit pick desired minimum pop.
bool	kbUnitPickSetMovementType(int upID, int movementType) Sets the unit pick movement type.
bool	kbUnitPickSetPreferenceFactor(int upID, int unitTypeID, float preferenceFactor) Sets the preferenceFactor for that unit type.
bool	kbUnitPickSetPreferenceWeight(int upID, float v) Sets the unit pick preference weight.

Methods inherited from class Object

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

Method Detail

kbUnitPickCreate

public int kbUnitPickCreate(string name)

Creates a unit pick.

kbUnitPickDestroy

public bool kbUnitPickDestroy(int upID)

Destroys the given unit pick.

kbUnitPickResetAll

public bool kbUnitPickResetAll(int upID)

Resets all of the unit pick data.

kbUnitPickResetResults

public bool kbUnitPickResetResults(int upID)

Resets the unit pick results.

kbUnitPickGetPreferenceWeight

public float kbUnitPickGetPreferenceWeight(int upID)

Gets the unit pick preference weight.

kbUnitPickSetPreferenceWeight

public bool kbUnitPickSetPreferenceWeight(int upID,
                                          float v)

Sets the unit pick preference weight.

kbUnitPickSetEnemyPlayerID

public bool kbUnitPickSetEnemyPlayerID(int upID)

Sets the unit pick enemy player ID.

kbUnitPickSetCombatEfficiencyWeight

public bool kbUnitPickSetCombatEfficiencyWeight(int upID)

Sets the unit pick combat efficiency weight.

kbUnitPickResetCombatEfficiencyTypes

public bool kbUnitPickResetCombatEfficiencyTypes(int upID)

Resets the enemy unit typeIDs for the unit pick combat efficiency calculation.

kbUnitPickAddCombatEfficiencyType

public bool kbUnitPickAddCombatEfficiencyType(int upID,
                                              int typeID,
                                              float weight)

Adds an enemy unit typeID to the unit pick combat efficiency calculation.

kbUnitPickSetCostWeight

public bool kbUnitPickSetCostWeight(int upID)

Sets the unit pick cost weight.

kbUnitPickSetMovementType

public bool kbUnitPickSetMovementType(int upID,
                                      int movementType)

Sets the unit pick movement type.

kbUnitPickSetDesiredNumberUnitTypes

public bool kbUnitPickSetDesiredNumberUnitTypes(int upID,
                                                int number,
                                                int numberBuildings,
                                                bool degradeNumberBuildings)

Sets the unit pick desired number unit types.

kbUnitPickGetDesiredNumberUnitTypes

public int kbUnitPickGetDesiredNumberUnitTypes(int upID)

Gets the unit pick desired number unit types.

kbUnitPickSetDesiredNumberBuildings

public bool kbUnitPickSetDesiredNumberBuildings(int upID,
                                                int index,
                                                int numberBuildings)

Sets the unit pick desired number buildings for the index'th unit type.

kbUnitPickGetDesiredNumberBuildings

public int kbUnitPickGetDesiredNumberBuildings(int upID,
                                               int index)

Gets the unit pick desired number buildings for the index'th unit type.

kbUnitPickSetMinimumNumberUnits

public bool kbUnitPickSetMinimumNumberUnits(int upID,
                                            int number)

Sets the unit pick desired number unit types.

kbUnitPickGetMinimumNumberUnits

public int kbUnitPickGetMinimumNumberUnits(int upID)

Gets the unit pick minimum number units.

kbUnitPickSetMaximumNumberUnits

public bool kbUnitPickSetMaximumNumberUnits(int upID,
                                            int number)

Sets the unit pick desired number unit types.

kbUnitPickGetMaximumNumberUnits

public int kbUnitPickGetMaximumNumberUnits(int upID)

Gets the unit pick maximum number units.

kbUnitPickSetMinimumPop

public bool kbUnitPickSetMinimumPop(int upID,
                                    int number)

Sets the unit pick desired minimum pop.

kbUnitPickGetMinimumPop

public int kbUnitPickGetMinimumPop(int upID)

Gets the unit pick minimum pop.

kbUnitPickSetMaximumPop

public bool kbUnitPickSetMaximumPop(int upID,
                                    int number)

Sets the unit pick desired max pop.

kbUnitPickGetMaximumPop

public int kbUnitPickGetMaximumPop(int upID)

Gets the unit pick maximum pop.

kbUnitPickSetAttackUnitType

public bool kbUnitPickSetAttackUnitType(int upID,
                                        int type)

Sets the unit pick attack unit type.

kbUnitPickGetAttackUnitType

public int kbUnitPickGetAttackUnitType(int upID)

Gets the unit pick attack unit type.

kbUnitPickSetGoalCombatEfficiencyType

public bool kbUnitPickSetGoalCombatEfficiencyType(int upID,
                                                  int type)

Sets the unit pick attack unit type.

kbUnitPickGetGoalCombatEfficiencyType

public int kbUnitPickGetGoalCombatEfficiencyType(int upID)

Gets the unit pick attack unit type.

kbUnitPickSetPreferenceFactor

public bool kbUnitPickSetPreferenceFactor(int upID,
                                          int unitTypeID,
                                          float preferenceFactor)

Sets the preferenceFactor for that unit type.

kbUnitPickAdjustPreferenceFactor

public bool kbUnitPickAdjustPreferenceFactor(int upID,
                                             int unitTypeID,
                                             float baseFactorAdjustment)

Adjusts the preferenceFactor for that unit type (uses 50.0 as the base if the unit pick doesn't exist yet).

kbUnitPickRun

public int kbUnitPickRun(int upID)

Runs the unit pick.

kbUnitPickGetNumberResults

public int kbUnitPickGetNumberResults(int upID)

Returns the number of unit pick results.

kbUnitPickGetResult

public int kbUnitPickGetResult(int upID,
                               int index)

Returns the index'th ProtoUnitID.