aom.scripting.xs.kb

Class BuildingPlacement

Object

BuildingPlacement

public class BuildingPlacement
extends Object

This class provides a collection of KB commands concerning BuildingPlacements. Building Placements are an high level way to define where new structures should be built.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
int	cBuildingPlacementEventDone
int	cBuildingPlacementEventFailed
int	cBuildingPlacementPreferenceBack
int	cBuildingPlacementPreferenceFront
int	cBuildingPlacementPreferenceLeft
int	cBuildingPlacementPreferenceNone

Method Summary

Modifier and Type	Method and Description
bool	kbBuildingPlacementAddAreaGroupID(int areaGroupID) Adds the AreaGroup ID to the current Building Placement.
bool	kbBuildingPlacementAddAreaID(int areaID, int numberBorderAreaLayers, bool addCenterInfluence) Adds the Area ID - with the given number of border area layers - to the current Building Placement.
bool	kbBuildingPlacementAddPositionInfluence(vector position, float value, float distance) Adds the position influence for the current building placement.
bool	kbBuildingPlacementAddUnitInfluence(int typeID, float value, float distance, long kbResourceID) Adds the unit influence for the current building placement.
int	kbBuildingPlacementCreate(string name) Creates a building placement; returns the ID.
bool	kbBuildingPlacementDestroy(int id) Destroys the given building placement.
vector	kbBuildingPlacementGetResultPosition(int bpID) Returns the vector result position for given Building Placement ID.
float	kbBuildingPlacementGetResultValue(int bpID) Returns the result value for given Building Placement ID.
bool	kbBuildingPlacementResetResults() Resets the current building placement.
bool	kbBuildingPlacementSelect(int id) Selects the given building placement.
bool	kbBuildingPlacementSetBaseID(int baseID, int locationPref) Sets the base ID and location preference for the current building placement.
bool	kbBuildingPlacementSetBuildingType(int buildingTypeID) Sets the building type for the current building placement.
bool	kbBuildingPlacementSetCenterPosition(vector position, float distance, float obstructionRadius) Sets up center position-based Building Placement.
bool	kbBuildingPlacementSetEventHandler(int eventType, string handlerName) Sets event handler function for the current Building Placement and event.
bool	kbBuildingPlacementSetMinimumValue(float minimumValue) Sets the minimum acceptable value for evaluated spots in the Building Placement.
bool	kbBuildingPlacementStart() Starts the placement of current building.

Methods inherited from class Object

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

Field Detail

cBuildingPlacementPreferenceNone

public final int cBuildingPlacementPreferenceNone

See Also:

Constant Field Values

cBuildingPlacementPreferenceBack

public final int cBuildingPlacementPreferenceBack

See Also:

Constant Field Values

cBuildingPlacementPreferenceFront

public final int cBuildingPlacementPreferenceFront

See Also:

Constant Field Values

cBuildingPlacementPreferenceLeft

public final int cBuildingPlacementPreferenceLeft

See Also:

Constant Field Values

cBuildingPlacementEventDone

public final int cBuildingPlacementEventDone

See Also:

Constant Field Values

cBuildingPlacementEventFailed

public final int cBuildingPlacementEventFailed

See Also:

Constant Field Values

Method Detail

kbBuildingPlacementCreate

public int kbBuildingPlacementCreate(string name)

Creates a building placement; returns the ID.

kbBuildingPlacementDestroy

public bool kbBuildingPlacementDestroy(int id)

Destroys the given building placement.

kbBuildingPlacementResetResults

public bool kbBuildingPlacementResetResults()

Resets the current building placement.

kbBuildingPlacementSelect

public bool kbBuildingPlacementSelect(int id)

Selects the given building placement.

kbBuildingPlacementSetEventHandler

public bool kbBuildingPlacementSetEventHandler(int eventType,
                                               string handlerName)

Sets event handler function for the current Building Placement and event.

kbBuildingPlacementSetBuildingType

public bool kbBuildingPlacementSetBuildingType(int buildingTypeID)

Sets the building type for the current building placement.

kbBuildingPlacementSetBaseID

public bool kbBuildingPlacementSetBaseID(int baseID,
                                         int locationPref)

Sets the base ID and location preference for the current building placement.

kbBuildingPlacementAddAreaID

public bool kbBuildingPlacementAddAreaID(int areaID,
                                         int numberBorderAreaLayers,
                                         bool addCenterInfluence)

Adds the Area ID - with the given number of border area layers - to the current Building Placement. addCenterInfluence adds a positional influence from the area center.

kbBuildingPlacementAddAreaGroupID

public bool kbBuildingPlacementAddAreaGroupID(int areaGroupID)

Adds the AreaGroup ID to the current Building Placement.

kbBuildingPlacementSetCenterPosition

public bool kbBuildingPlacementSetCenterPosition(vector position,
                                                 float distance,
                                                 float obstructionRadius)

Sets up center position-based Building Placement.

kbBuildingPlacementAddUnitInfluence

public bool kbBuildingPlacementAddUnitInfluence(int typeID,
                                                float value,
                                                float distance,
                                                long kbResourceID)

Adds the unit influence for the current building placement.

kbBuildingPlacementAddPositionInfluence

public bool kbBuildingPlacementAddPositionInfluence(vector position,
                                                    float value,
                                                    float distance)

Adds the position influence for the current building placement.

kbBuildingPlacementSetMinimumValue

public bool kbBuildingPlacementSetMinimumValue(float minimumValue)

Sets the minimum acceptable value for evaluated spots in the Building Placement.

kbBuildingPlacementStart

public bool kbBuildingPlacementStart()

Starts the placement of current building.

kbBuildingPlacementGetResultPosition

public vector kbBuildingPlacementGetResultPosition(int bpID)

Returns the vector result position for given Building Placement ID.

kbBuildingPlacementGetResultValue

public float kbBuildingPlacementGetResultValue(int bpID)

Returns the result value for given Building Placement ID.