Plan

Object
- Plan

```
public class Plan
extends Object
```
This class provides a collection of AI commands concerning Plans.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

See Also:

AoM Reference or AoT Reference for a complete list of all plan constants and more.

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`cPlanAttack`
`int`	`cPlanAttackStrategy`
`int`	`cPlanBuild`
`int`	`cPlanBuildWall`
`int`	`cPlanData`
`int`	`cPlanDefend`
`int`	`cPlanDropoffResource`
`int`	`cPlanEmpower`
`int`	`cPlanEventDone`
`int`	`cPlanEventFailed`
`int`	`cPlanEventIdle`
`int`	`cPlanEventPoll`
`int`	`cPlanExplore`
`int`	`cPlanFarm`
`int`	`cPlanFish`
`int`	`cPlanGather`
`int`	`cPlanGatherGoal`
`int`	`cPlanGatherRelic`
`int`	`cPlanGoal`
`int`	`cPlanGodPower`
`int`	`cPlanHerd`
`int`	`cPlanHunt`
`int`	`cPlanHuntAggressive`
`int`	`cPlanMove`
`int`	`cPlanProgression`
`int`	`cPlanRepair`
`int`	`cPlanResearch`
`int`	`cPlanReserve`
`int`	`cPlanStateAttack`
`int`	`cPlanStateBuild`
`int`	`cPlanStateCast`
`int`	`cPlanStateDone`
`int`	`cPlanStateDualPlace`
`int`	`cPlanStateEmpower`
`int`	`cPlanStateEnter`
`int`	`cPlanStateEvaluate`
`int`	`cPlanStateExit`
`int`	`cPlanStateExplore`
`int`	`cPlanStateFailed`
`int`	`cPlanStateGather`
`int`	`cPlanStateGoto`
`int`	`cPlanStateNone`
`int`	`cPlanStatePatrol`
`int`	`cPlanStatePlace`
`int`	`cPlanStateResearch`
`int`	`cPlanStateRetreat`
`int`	`cPlanStateTrain`
`int`	`cPlanStateTransport`
`int`	`cPlanStateUnknown`
`int`	`cPlanStateVillagerAttack`
`int`	`cPlanStateWait`
`int`	`cPlanStateWorking`
`int`	`cPlanTower`
`int`	`cPlanTrade`
`int`	`cPlanTrain`
`int`	`cPlanTransport`
`int`	`cPlanWork`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`aiGetNumberIdlePlans(int planType)` Gets the of idle plans of the given type.
`bool`	`aiPlanAddUnit(int planID, int unitID)` Adds a unit to the plan.
`bool`	`aiPlanAddUnitType(int planID, int unitTypeID, int numberNeed, int numberWant, int numberMax)` Adds a unit type to the plan.
`bool`	`aiPlanAddUserVariableBool(int planID, int planVariableIndex, string name, int numberValues)` Adds the variable to the given plan.
`bool`	`aiPlanAddUserVariableFloat(int planID, int planVariableIndex, string name, int numberValues)` Adds the variable to the given plan.
`bool`	`aiPlanAddUserVariableInt(int planID, int planVariableIndex, string name, int numberValues)` Adds the variable to the given plan.
`bool`	`aiPlanAddUserVariableString(int planID, int planVariableIndex, string name, int numberValues)` Adds the variable to the given plan.
`bool`	`aiPlanAddUserVariableVector(int planID, int planVariableIndex, string name, int numberValues)` Adds the variable to the given plan.
`bool`	`aiPlanAddWaypoint(int planID, vector waypoint)` Adds the waypoint to the given plan.
`int`	`aiPlanCreate(string planName, int typeName)` Creates a plan of the given name and type.
`bool`	`aiPlanDestroy(int planID)` Destroys the given plan.
`bool`	`aiPlanDestroyByName(string name)` Destroys the plan of the given name.
`bool`	`aiPlanGetActive(int planID)` Gets the active-ness of the given plan.
`int`	`aiPlanGetActualPriority(int planID)` Returns the priority of the given plan.
`bool`	`aiPlanGetAllowUnderAttackResponse(int planID)` Gets the UA response-ness of the given plan.
`bool`	`aiPlanGetAttack(int planID)` Gets the attack flag of the given plan.
`int`	`aiPlanGetBaseID(int planID)` Gets the plan's base id.
`int`	`aiPlanGetDesiredPriority(int planID)` Returns the priority of the given plan.
`bool`	`aiPlanGetEconomy(int planID)` Gets the economy flag of the given plan.
`int`	`aiPlanGetEscrowID(int planID)` Gets the escrow for the plan.
`int`	`aiPlanGetID(string name)` Returns the ID of the plan with the given name.
`int`	`aiPlanGetIDByActiveIndex(int activeIndex)` Returns the ID of the plan with the given active index.
`int`	`aiPlanGetIDByIndex(int planType, int planState, bool active, int index)` Returns the ID of matching plan.
`int`	`aiPlanGetIDByTypeAndVariableType(int planType, int varType, int varID, bool active)` Returns the ID of the plan with the given parms.
`vector`	`aiPlanGetInitialPosition(int planID)` Returns the initial positon that was set for this plan.
`vector`	`aiPlanGetLocation(int planID)` Returns the location for this plan.
`bool`	`aiPlanGetMilitary(int planID)` Gets the military flag of the given plan.
`string`	`aiPlanGetName(int planID)` Returns the name of the given plan.
`bool`	`aiPlanGetNoMoreUnits(int planID)` Gets the noMoreUnits-ness of the given plan.
`int`	`aiPlanGetNumber(int planType, int planState, bool active)` Returns the number of matching plans.
`int`	`aiPlanGetNumberUnits(int planID, int unitTypeID)` Returns the number of units currently assigned in the given plan.
`int`	`aiPlanGetNumberUserVariableValues(int planID, int planVariableIndex)` Returns the number of values for this variable index.
`int`	`aiPlanGetNumberVariableValues(int planID, int planVariableIndex)` Returns the number of values for this variable index.
`bool`	`aiPlanGetOrphan(int planID)` Gets the orphan-ness of the given plan.
`int`	`aiPlanGetState(int planID)` Returns the state of the given plan.
`int`	`aiPlanGetType(int planID)` Returns the type of the given plan.
`long`	`aiPlanGetUnitByIndex(int planID, int index)` Returns the unit ID of a particular unit in the plan
`int`	`aiPlanGetUnitStance(int planID)` Gets the unit stance of the given plan.
`bool`	`aiPlanGetUserVariableBool(int planID, int planVariableIndex, int valueIndex)` Gets the given variable of the given plan.
`float`	`aiPlanGetUserVariableFloat(int planID, int planVariableIndex, int valueIndex)` Gets the given variable of the given plan.
`int`	`aiPlanGetUserVariableInt(int planID, int planVariableIndex, int valueIndex)` Gets the given variable of the given plan.
`string`	`aiPlanGetUserVariableString(int planID, int planVariableIndex, int valueIndex)` Gets the given variable of the given plan.
`vector`	`aiPlanGetUserVariableVector(int planID, int planVariableIndex, int valueIndex)` Gets the given variable of the given plan.
`bool`	`aiPlanGetVariableBool(int planID, int planVariableIndex, int valueIndex)` Gets the given variable of the given plan.
`float`	`aiPlanGetVariableFloat(int planID, int planVariableIndex, int valueIndex)` Gets the given variable of the given plan.
`int`	`aiPlanGetVariableInt(int planID, int planVariableIndex, int valueIndex)` Gets the given variable of the given plan.
`string`	`aiPlanGetVariableString(int planID, int planVariableIndex)` Gets the given variable of the given plan.
`vector`	`aiPlanGetVariableVector(int planID, int planVariableIndex, int valueIndex)` Gets the given variable of the given plan.
`bool`	`aiPlanRemoveUserVariable(int planID, int planVariableIndex)` Removes the user variable.
`bool`	`aiPlanRemoveUserVariables(int planID)` Removes all of the user variables from the given plan.
`bool`	`aiPlanRemoveUserVariableValue(int planID, int planVariableIndex, int variableIndex)` Removes the index-th value of the user variable.
`bool`	`aiPlanRemoveVariableValue(int planID, int planVariableIndex, int variableIndex)` Removes the index-th value of the variable.
`bool`	`aiPlanSetActive(int planID, bool active)` Sets active on/off for the given plan.
`bool`	`aiPlanSetAllowUnderAttackResponse(int planID, bool uAR)` Sets under attack response on/off for the given plan.
`bool`	`aiPlanSetAttack(int planID, bool v)` Sets attack flag on/off for the given plan.
`bool`	`aiPlanSetBaseID(int planID, int baseID)` Sets the plan's base id.
`bool`	`aiPlanSetDesiredPriority(int planID, int priority)` Sets the priority of the given plan.
`bool`	`aiPlanSetEconomy(int planID, bool v)` Sets economy on/off for the given plan.
`bool`	`aiPlanSetEscrowID(int planID, int escrowID)` Sets the escrow for the plan.
`bool`	`aiPlanSetEventHandler(int planID, int eventType, string handlerName)` Sets event handler function for the given plan and event.
`void`	`aiPlanSetInitialPosition(int planID, vector initialPosition)` Sets the initial positon for this plan.
`bool`	`aiPlanSetMilitary(int planID, bool v)` Sets military on/off for the given plan.
`bool`	`aiPlanSetNoMoreUnits(int planID, bool v)` Sets noMoreUnits on/off for the given plan.
`bool`	`aiPlanSetNumberUserVariableValues(int planID, int planVariableIndex, int numberValues, bool clearCurrentValues)` Sets the number of values for this variable.
`bool`	`aiPlanSetNumberVariableValues(int planID, int planVariableIndex, int numberValues, bool clearCurrentValues)` Sets the number of values for this variable.
`bool`	`aiPlanSetOrphan(int planID, bool orphan)` Sets orphan on/off for the given plan.
`bool`	`aiPlanSetRequiresAllNeedUnits(int planID, bool rANU)` Sets 'requiresAllNeedUnits' on/off for the given plan.
`bool`	`aiPlanSetUnitStance(int planID, int stance)` Sets unit stance for the given plan.
`bool`	`aiPlanSetUserVariableBool(int planID, int planVariableIndex, int valueIndex, bool value)` Sets the given variable of the given plan.
`bool`	`aiPlanSetUserVariableFloat(int planID, int planVariableIndex, int valueIndex, float value)` Sets the given variable of the given plan.
`bool`	`aiPlanSetUserVariableInt(int planID, int planVariableIndex, int valueIndex, int value)` Sets the given variable of the given plan.
`bool`	`aiPlanSetUserVariableString(int planID, int planVariableIndex, int valueIndex, string value)` Sets the given variable of the given plan.
`bool`	`aiPlanSetUserVariableVector(int planID, int planVariableIndex, int valueIndex, vector value)` Sets the given variable of the given plan.
`bool`	`aiPlanSetVariableBool(int planID, int planVariableIndex, int valueIndex, bool value)` Sets the given variable of the given plan.
`bool`	`aiPlanSetVariableFloat(int planID, int planVariableIndex, int valueIndex, float value)` Sets the given variable of the given plan.
`bool`	`aiPlanSetVariableInt(int planID, int planVariableIndex, int valueIndex, int value)` Sets the given variable of the given plan.
`bool`	`aiPlanSetVariableString(int planID, int planVariableIndex, int valueIndex, string value)` Sets the given variable of the given plan.
`bool`	`aiPlanSetVariableVector(int planID, int planVariableIndex, int valueIndex, vector value)` Sets the given variable of the given plan.
`bool`	`aiPlanSetWaypoints(int planID, int pathID)` Sets the waypoints of the given plan to the waypoints of the given path.

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- cPlanMove
```
public final int cPlanMove
```
  See Also:
  
  Constant Field Values
- cPlanAttack
```
public final int cPlanAttack
```
  See Also:
  
  Constant Field Values
- cPlanBuild
```
public final int cPlanBuild
```
  See Also:
  
  Constant Field Values
- cPlanTrain
```
public final int cPlanTrain
```
  See Also:
  
  Constant Field Values
- cPlanResearch
```
public final int cPlanResearch
```
  See Also:
  
  Constant Field Values
- cPlanWork
```
public final int cPlanWork
```
  See Also:
  
  Constant Field Values
- cPlanGather
```
public final int cPlanGather
```
  See Also:
  
  Constant Field Values
- cPlanExplore
```
public final int cPlanExplore
```
  See Also:
  
  Constant Field Values
- cPlanData
```
public final int cPlanData
```
  See Also:
  
  Constant Field Values
- cPlanProgression
```
public final int cPlanProgression
```
  See Also:
  
  Constant Field Values
- cPlanBuildWall
```
public final int cPlanBuildWall
```
  See Also:
  
  Constant Field Values
- cPlanFarm
```
public final int cPlanFarm
```
  See Also:
  
  Constant Field Values
- cPlanHunt
```
public final int cPlanHunt
```
  See Also:
  
  Constant Field Values
- cPlanHuntAggressive
```
public final int cPlanHuntAggressive
```
  See Also:
  
  Constant Field Values
- cPlanFish
```
public final int cPlanFish
```
  See Also:
  
  Constant Field Values
- cPlanHerd
```
public final int cPlanHerd
```
  See Also:
  
  Constant Field Values
- cPlanEmpower
```
public final int cPlanEmpower
```
  See Also:
  
  Constant Field Values
- cPlanTransport
```
public final int cPlanTransport
```
  See Also:
  
  Constant Field Values
- cPlanDropoffResource
```
public final int cPlanDropoffResource
```
  See Also:
  
  Constant Field Values
- cPlanGatherRelic
```
public final int cPlanGatherRelic
```
  See Also:
  
  Constant Field Values
- cPlanAttackStrategy
```
public final int cPlanAttackStrategy
```
  See Also:
  
  Constant Field Values
- cPlanGodPower
```
public final int cPlanGodPower
```
  See Also:
  
  Constant Field Values
- cPlanDefend
```
public final int cPlanDefend
```
  See Also:
  
  Constant Field Values
- cPlanReserve
```
public final int cPlanReserve
```
  See Also:
  
  Constant Field Values
- cPlanGoal
```
public final int cPlanGoal
```
  See Also:
  
  Constant Field Values
- cPlanTower
```
public final int cPlanTower
```
  See Also:
  
  Constant Field Values
- cPlanGatherGoal
```
public final int cPlanGatherGoal
```
  See Also:
  
  Constant Field Values
- cPlanRepair
```
public final int cPlanRepair
```
  See Also:
  
  Constant Field Values
- cPlanTrade
```
public final int cPlanTrade
```
  See Also:
  
  Constant Field Values
- cPlanEventDone
```
public final int cPlanEventDone
```
  See Also:
  
  Constant Field Values
- cPlanEventFailed
```
public final int cPlanEventFailed
```
  See Also:
  
  Constant Field Values
- cPlanEventPoll
```
public final int cPlanEventPoll
```
  See Also:
  
  Constant Field Values
- cPlanEventIdle
```
public final int cPlanEventIdle
```
  See Also:
  
  Constant Field Values
- cPlanStateNone
```
public final int cPlanStateNone
```
  See Also:
  
  Constant Field Values
- cPlanStateDone
```
public final int cPlanStateDone
```
  See Also:
  
  Constant Field Values
- cPlanStateFailed
```
public final int cPlanStateFailed
```
  See Also:
  
  Constant Field Values
- cPlanStateBuild
```
public final int cPlanStateBuild
```
  See Also:
  
  Constant Field Values
- cPlanStateGather
```
public final int cPlanStateGather
```
  See Also:
  
  Constant Field Values
- cPlanStatePlace
```
public final int cPlanStatePlace
```
  See Also:
  
  Constant Field Values
- cPlanStateExplore
```
public final int cPlanStateExplore
```
  See Also:
  
  Constant Field Values
- cPlanStateTrain
```
public final int cPlanStateTrain
```
  See Also:
  
  Constant Field Values
- cPlanStateResearch
```
public final int cPlanStateResearch
```
  See Also:
  
  Constant Field Values
- cPlanStateAttack
```
public final int cPlanStateAttack
```
  See Also:
  
  Constant Field Values
- cPlanStateGoto
```
public final int cPlanStateGoto
```
  See Also:
  
  Constant Field Values
- cPlanStateEmpower
```
public final int cPlanStateEmpower
```
  See Also:
  
  Constant Field Values
- cPlanStateEnter
```
public final int cPlanStateEnter
```
  See Also:
  
  Constant Field Values
- cPlanStateExit
```
public final int cPlanStateExit
```
  See Also:
  
  Constant Field Values
- cPlanStateEvaluate
```
public final int cPlanStateEvaluate
```
  See Also:
  
  Constant Field Values
- cPlanStatePatrol
```
public final int cPlanStatePatrol
```
  See Also:
  
  Constant Field Values
- cPlanStateRetreat
```
public final int cPlanStateRetreat
```
  See Also:
  
  Constant Field Values
- cPlanStateWorking
```
public final int cPlanStateWorking
```
  See Also:
  
  Constant Field Values
- cPlanStateTransport
```
public final int cPlanStateTransport
```
  See Also:
  
  Constant Field Values
- cPlanStateDualPlace
```
public final int cPlanStateDualPlace
```
  See Also:
  
  Constant Field Values
- cPlanStateWait
```
public final int cPlanStateWait
```
  See Also:
  
  Constant Field Values
- cPlanStateCast
```
public final int cPlanStateCast
```
  See Also:
  
  Constant Field Values
- cPlanStateVillagerAttack
```
public final int cPlanStateVillagerAttack
```
  See Also:
  
  Constant Field Values
- cPlanStateUnknown
```
public final int cPlanStateUnknown
```
  See Also:
  
  Constant Field Values

Method Detail

aiPlanAddUnit

public bool aiPlanAddUnit(int planID,
                          int unitID)

Adds a unit to the plan.

aiPlanGetLocation
```
public vector aiPlanGetLocation(int planID)
```
Returns the location for this plan.

aiPlanGetInitialPosition
```
public vector aiPlanGetInitialPosition(int planID)
```
Returns the initial positon that was set for this plan.

aiPlanSetInitialPosition

public void aiPlanSetInitialPosition(int planID,
                                     vector initialPosition)

Sets the initial positon for this plan.

aiPlanSetWaypoints

public bool aiPlanSetWaypoints(int planID,
                               int pathID)

Sets the waypoints of the given plan to the waypoints of the given path.

aiPlanAddWaypoint

public bool aiPlanAddWaypoint(int planID,
                              vector waypoint)

Adds the waypoint to the given plan.

aiPlanGetNumberVariableValues

public int aiPlanGetNumberVariableValues(int planID,
                                         int planVariableIndex)

Returns the number of values for this variable index.

aiPlanSetNumberVariableValues

public bool aiPlanSetNumberVariableValues(int planID,
                                          int planVariableIndex,
                                          int numberValues,
                                          bool clearCurrentValues)

Sets the number of values for this variable.

aiPlanRemoveVariableValue

public bool aiPlanRemoveVariableValue(int planID,
                                      int planVariableIndex,
                                      int variableIndex)

Removes the index-th value of the variable.

aiPlanSetVariableInt

public bool aiPlanSetVariableInt(int planID,
                                 int planVariableIndex,
                                 int valueIndex,
                                 int value)

Sets the given variable of the given plan.

aiPlanGetVariableInt

public int aiPlanGetVariableInt(int planID,
                                int planVariableIndex,
                                int valueIndex)

Gets the given variable of the given plan.

aiPlanSetVariableFloat

public bool aiPlanSetVariableFloat(int planID,
                                   int planVariableIndex,
                                   int valueIndex,
                                   float value)

Sets the given variable of the given plan.

aiPlanGetVariableFloat

public float aiPlanGetVariableFloat(int planID,
                                    int planVariableIndex,
                                    int valueIndex)

Gets the given variable of the given plan.

aiPlanSetVariableVector

public bool aiPlanSetVariableVector(int planID,
                                    int planVariableIndex,
                                    int valueIndex,
                                    vector value)

Sets the given variable of the given plan.

aiPlanGetVariableVector

public vector aiPlanGetVariableVector(int planID,
                                      int planVariableIndex,
                                      int valueIndex)

Gets the given variable of the given plan.

aiPlanSetVariableBool

public bool aiPlanSetVariableBool(int planID,
                                  int planVariableIndex,
                                  int valueIndex,
                                  bool value)

Sets the given variable of the given plan.

aiPlanGetVariableBool

public bool aiPlanGetVariableBool(int planID,
                                  int planVariableIndex,
                                  int valueIndex)

Gets the given variable of the given plan.

aiPlanSetVariableString

public bool aiPlanSetVariableString(int planID,
                                    int planVariableIndex,
                                    int valueIndex,
                                    string value)

Sets the given variable of the given plan.

aiPlanGetVariableString

public string aiPlanGetVariableString(int planID,
                                      int planVariableIndex)

Gets the given variable of the given plan.

aiPlanGetNumberUserVariableValues

public int aiPlanGetNumberUserVariableValues(int planID,
                                             int planVariableIndex)

Returns the number of values for this variable index.

aiPlanSetNumberUserVariableValues

public bool aiPlanSetNumberUserVariableValues(int planID,
                                              int planVariableIndex,
                                              int numberValues,
                                              bool clearCurrentValues)

Sets the number of values for this variable.

aiPlanRemoveUserVariables
```
public bool aiPlanRemoveUserVariables(int planID)
```
Removes all of the user variables from the given plan.

aiPlanRemoveUserVariable

public bool aiPlanRemoveUserVariable(int planID,
                                     int planVariableIndex)

Removes the user variable.

aiPlanRemoveUserVariableValue

public bool aiPlanRemoveUserVariableValue(int planID,
                                          int planVariableIndex,
                                          int variableIndex)

Removes the index-th value of the user variable.

aiPlanAddUserVariableInt

public bool aiPlanAddUserVariableInt(int planID,
                                     int planVariableIndex,
                                     string name,
                                     int numberValues)

Adds the variable to the given plan.

aiPlanSetUserVariableInt

public bool aiPlanSetUserVariableInt(int planID,
                                     int planVariableIndex,
                                     int valueIndex,
                                     int value)

Sets the given variable of the given plan.

aiPlanGetUserVariableInt

public int aiPlanGetUserVariableInt(int planID,
                                    int planVariableIndex,
                                    int valueIndex)

Gets the given variable of the given plan.

aiPlanAddUserVariableFloat

public bool aiPlanAddUserVariableFloat(int planID,
                                       int planVariableIndex,
                                       string name,
                                       int numberValues)

Adds the variable to the given plan.

aiPlanSetUserVariableFloat

public bool aiPlanSetUserVariableFloat(int planID,
                                       int planVariableIndex,
                                       int valueIndex,
                                       float value)

Sets the given variable of the given plan.

aiPlanGetUserVariableFloat

public float aiPlanGetUserVariableFloat(int planID,
                                        int planVariableIndex,
                                        int valueIndex)

Gets the given variable of the given plan.

aiPlanAddUserVariableVector

public bool aiPlanAddUserVariableVector(int planID,
                                        int planVariableIndex,
                                        string name,
                                        int numberValues)

Adds the variable to the given plan.

aiPlanSetUserVariableVector

public bool aiPlanSetUserVariableVector(int planID,
                                        int planVariableIndex,
                                        int valueIndex,
                                        vector value)

Sets the given variable of the given plan.

aiPlanGetUserVariableVector

public vector aiPlanGetUserVariableVector(int planID,
                                          int planVariableIndex,
                                          int valueIndex)

Gets the given variable of the given plan.

aiPlanAddUserVariableBool

public bool aiPlanAddUserVariableBool(int planID,
                                      int planVariableIndex,
                                      string name,
                                      int numberValues)

Adds the variable to the given plan.

aiPlanSetUserVariableBool

public bool aiPlanSetUserVariableBool(int planID,
                                      int planVariableIndex,
                                      int valueIndex,
                                      bool value)

Sets the given variable of the given plan.

aiPlanGetUserVariableBool

public bool aiPlanGetUserVariableBool(int planID,
                                      int planVariableIndex,
                                      int valueIndex)

Gets the given variable of the given plan.

aiPlanAddUserVariableString

public bool aiPlanAddUserVariableString(int planID,
                                        int planVariableIndex,
                                        string name,
                                        int numberValues)

Adds the variable to the given plan.

aiPlanSetUserVariableString

public bool aiPlanSetUserVariableString(int planID,
                                        int planVariableIndex,
                                        int valueIndex,
                                        string value)

Sets the given variable of the given plan.

aiPlanGetUserVariableString

public string aiPlanGetUserVariableString(int planID,
                                          int planVariableIndex,
                                          int valueIndex)

Gets the given variable of the given plan.

aiPlanGetActive
```
public bool aiPlanGetActive(int planID)
```
Gets the active-ness of the given plan.

aiPlanSetActive

public bool aiPlanSetActive(int planID,
                            bool active)

Sets active on/off for the given plan.

aiPlanGetNoMoreUnits
```
public bool aiPlanGetNoMoreUnits(int planID)
```
Gets the noMoreUnits-ness of the given plan.

aiPlanSetNoMoreUnits

public bool aiPlanSetNoMoreUnits(int planID,
                                 bool v)

Sets noMoreUnits on/off for the given plan.

aiPlanGetOrphan
```
public bool aiPlanGetOrphan(int planID)
```
Gets the orphan-ness of the given plan.

aiPlanSetOrphan

public bool aiPlanSetOrphan(int planID,
                            bool orphan)

Sets orphan on/off for the given plan.

aiPlanGetAllowUnderAttackResponse
```
public bool aiPlanGetAllowUnderAttackResponse(int planID)
```
Gets the UA response-ness of the given plan.

aiPlanSetAllowUnderAttackResponse

public bool aiPlanSetAllowUnderAttackResponse(int planID,
                                              bool uAR)

Sets under attack response on/off for the given plan.

aiPlanGetUnitStance
```
public int aiPlanGetUnitStance(int planID)
```
Gets the unit stance of the given plan.

aiPlanSetUnitStance

public bool aiPlanSetUnitStance(int planID,
                                int stance)

Sets unit stance for the given plan.

aiPlanSetRequiresAllNeedUnits

public bool aiPlanSetRequiresAllNeedUnits(int planID,
                                          bool rANU)

Sets 'requiresAllNeedUnits' on/off for the given plan.

aiPlanSetEventHandler

public bool aiPlanSetEventHandler(int planID,
                                  int eventType,
                                  string handlerName)

Sets event handler function for the given plan and event.

aiPlanSetEscrowID

public bool aiPlanSetEscrowID(int planID,
                              int escrowID)

Sets the escrow for the plan.

aiPlanGetEscrowID
```
public int aiPlanGetEscrowID(int planID)
```
Gets the escrow for the plan.

aiPlanGetEconomy
```
public bool aiPlanGetEconomy(int planID)
```
Gets the economy flag of the given plan.

aiPlanSetEconomy

public bool aiPlanSetEconomy(int planID,
                             bool v)

Sets economy on/off for the given plan.

aiPlanGetMilitary
```
public bool aiPlanGetMilitary(int planID)
```
Gets the military flag of the given plan.

aiPlanSetMilitary

public bool aiPlanSetMilitary(int planID,
                              bool v)

Sets military on/off for the given plan.

aiPlanGetAttack
```
public bool aiPlanGetAttack(int planID)
```
Gets the attack flag of the given plan.

aiPlanSetAttack

public bool aiPlanSetAttack(int planID,
                            bool v)

Sets attack flag on/off for the given plan.

aiPlanSetBaseID

public bool aiPlanSetBaseID(int planID,
                            int baseID)

Sets the plan's base id.

aiPlanGetBaseID

public int aiPlanGetBaseID(int planID)

Gets the plan's base id.

aiGetNumberIdlePlans
```
public int aiGetNumberIdlePlans(int planType)
```
Gets the of idle plans of the given type.

aiPlanAddUnitType

public bool aiPlanAddUnitType(int planID,
                              int unitTypeID,
                              int numberNeed,
                              int numberWant,
                              int numberMax)

Adds a unit type to the plan.

aiPlanGetUnitByIndex

public long aiPlanGetUnitByIndex(int planID,
                                 int index)

Returns the unit ID of a particular unit in the plan

Since:: AoT

aiPlanGetNumberUnits

public int aiPlanGetNumberUnits(int planID,
                                int unitTypeID)

Returns the number of units currently assigned in the given plan.

aiPlanCreate

public int aiPlanCreate(string planName,
                        int typeName)

Creates a plan of the given name and type.

aiPlanDestroy

public bool aiPlanDestroy(int planID)

Destroys the given plan.

aiPlanDestroyByName
```
public bool aiPlanDestroyByName(string name)
```
Destroys the plan of the given name.

aiPlanGetID
```
public int aiPlanGetID(string name)
```
Returns the ID of the plan with the given name.

aiPlanGetIDByTypeAndVariableType

public int aiPlanGetIDByTypeAndVariableType(int planType,
                                            int varType,
                                            int varID,
                                            bool active)

Returns the ID of the plan with the given parms.

aiPlanGetIDByActiveIndex
```
public int aiPlanGetIDByActiveIndex(int activeIndex)
```
Returns the ID of the plan with the given active index.

aiPlanGetName
```
public string aiPlanGetName(int planID)
```
Returns the name of the given plan.

aiPlanGetType
```
public int aiPlanGetType(int planID)
```
Returns the type of the given plan.

aiPlanGetState
```
public int aiPlanGetState(int planID)
```
Returns the state of the given plan.

aiPlanGetActualPriority
```
public int aiPlanGetActualPriority(int planID)
```
Returns the priority of the given plan.

aiPlanGetDesiredPriority
```
public int aiPlanGetDesiredPriority(int planID)
```
Returns the priority of the given plan.

aiPlanSetDesiredPriority

public bool aiPlanSetDesiredPriority(int planID,
                                     int priority)

Sets the priority of the given plan.

aiPlanGetNumber

public int aiPlanGetNumber(int planType,
                           int planState,
                           bool active)

Returns the number of matching plans.

aiPlanGetIDByIndex

public int aiPlanGetIDByIndex(int planType,
                              int planState,
                              bool active,
                              int index)

Returns the ID of matching plan.

Class Plan

Field Summary

Method Summary

Methods inherited from class Object

Field Detail

cPlanMove

cPlanAttack

cPlanBuild

cPlanTrain

cPlanResearch

cPlanWork

cPlanGather

cPlanExplore

cPlanData

cPlanProgression

cPlanBuildWall

cPlanFarm

cPlanHunt

cPlanHuntAggressive

cPlanFish

cPlanHerd

cPlanEmpower

cPlanTransport

cPlanDropoffResource

cPlanGatherRelic

cPlanAttackStrategy

cPlanGodPower

cPlanDefend

cPlanReserve

cPlanGoal

cPlanTower

cPlanGatherGoal

cPlanRepair

cPlanTrade

cPlanEventDone

cPlanEventFailed

cPlanEventPoll

cPlanEventIdle

cPlanStateNone

cPlanStateDone

cPlanStateFailed

cPlanStateBuild

cPlanStateGather

cPlanStatePlace

cPlanStateExplore

cPlanStateTrain

cPlanStateResearch

cPlanStateAttack

cPlanStateGoto

cPlanStateEmpower

cPlanStateEnter

cPlanStateExit

cPlanStateEvaluate

cPlanStatePatrol

cPlanStateRetreat

cPlanStateWorking

cPlanStateTransport

cPlanStateDualPlace

cPlanStateWait

cPlanStateCast

cPlanStateVillagerAttack

cPlanStateUnknown

Method Detail

aiPlanAddUnit

aiPlanGetLocation

aiPlanGetInitialPosition

aiPlanSetInitialPosition

aiPlanSetWaypoints

aiPlanAddWaypoint

aiPlanGetNumberVariableValues

aiPlanSetNumberVariableValues

aiPlanRemoveVariableValue

aiPlanSetVariableInt

aiPlanGetVariableInt

aiPlanSetVariableFloat

aiPlanGetVariableFloat

aiPlanSetVariableVector

aiPlanGetVariableVector

aiPlanSetVariableBool

aiPlanGetVariableBool