Go to the first, previous, next, last section, table of contents.

Unit Plan

UnitProperty: plan type [creation-turn] properties...

This property describes the unit's current plan.

PlanType: none

A unit with this type of plan does nothing. It is used when a side has no player.

PlanType: passive

This plan type is for units on a side that is being run directly by the side.

PlanType: defensive

This plan type is for units that defend areas or other units.

PlanType: offensive

This plan type is for units that are to be aggressive.

PlanType: exploratory

This plan type is for units that explore the world.

PlanType: random

A unit with this plan type will act randomly.

PlanProperty: goal goal

This property is the main goal of a unit's plan. Defaults to ().

PlanProperty: formation goal

This property is the formation goal of a unit's plan. If defined, it is a position goal that the unit should try to achieve when it is not trying to achieve the main goal. Defaults to ().

[also support some kind of hook for specific AIs?]

PlanProperty: tasks tasks...

This property is the complete task agenda for the unit's plan. It is a list of tasks. Defaults to ().

PlanProperty: asleep t/f

This property is true if the unit is asleep. Defaults to false.

PlanProperty: reserve t/f

This property is true if the unit is in reserve. Defaults to false.

PlanProperty: delayed t/f

This property is true if the unit's activity has been delayed until all others have acted. Defaults to false.

PlanProperty: wait t/f

This property is true if the unit is waiting for orders. Defaults to false.

PlanProperty: ai-control t/f

This property is true if the unit can be controlled by any AI associated with the side. Defaults to true.

PlanProperty: supply-alarm t/f

This property is true if the unit should react when supply is low. Defaults to false.

PlanProperty: supply-is-low t/f

This property is true if the unit considers its supply to be low. Defaults to false.

PlanProperty: wait-transport t/f

This property is true if the unit is waiting for transport. Defaults to false.

PlanProperty: initial-turn turn

This property is the turn upon which a plan should go into effect. Defaults to 0.

PlanProperty: final-turn turn

This property is the turn upon which a plan should be removed. If the value is 0, then the plan is not scheduled to be removed. Defaults to 0.


Go to the first, previous, next, last section, table of contents.