Strategic AI

Index

• CreateScript
  
  • InitialState
    
  • CrateVarInteger
    
  • CreateVarFloat
    
  • CreateVarString
    
  • Op
    
  • State
    
    • Settings
      
      • Setting
        
        • Op
          
        • Flag
          
        • Tactical
          
        • Tag
          
        • Recruiter
          
        • ClearRecruiter
          
        • Reserve
          
        • Unreserve
          
        • InstallConditon
          
        • UnInstallCondition
          
        • PurgeConditions
          
        • InstallRadioReceiver
          
        • UnInstallRadioReceiver
          
        • PurgeRadioReceiver
          
    • Action
      
      • Recruit
        
      • Spawn
        
      • Move
        
      • Explore
        
      • Stop
        
      • Trail
        
      • Formation
        
      • FollowTag
        
      • Discharge
        
      • Delete
        
      • AttackTag
        
      • Defect
        
    • Conditions
      
      • Status
        
      • Condition
        
        • Proximity
        • Threat
          
        • ObjectiveCondition
          
        • HitPoints
          
        • Count
          
  • CreateBase
    
  • CreateBase::Orderer
    
  • CreateBase::Plan
    
  • CreateRecruitForce
    
  • CreateRecruitType
    

CreateScript(string name)
name: Name of the script.

InitialState(string state)
Required
state: Name of the state to start in.

CreateVarInteger(string var, integer initial, integer min, integer max)
Multiple, Optional min(integer min), max(integer max)
var: Name of the var to be created. Must be a script var, i.e. start with '%'.
initial: The inital value to give the var.
min: The minimum value this var can ever have.
max: The maximum value this var can ever have.

CreateVarFloat(string var, float initial, float min, float max)
Multiple, Optional min(float min), max(float max)
var: Name of the var to be created. Must be a script var, i.e. start with '%'.
initial: The initial value to give the var.
min: The minimum value this var can ever have.
max: The maximum value this var can ever have.

CreateVarString(string var, string initial)
Multiple
var: Name of the var to be created. Must be a script var, i.e. start with '%'.
initial: The initial value to give the var.

Op()
See Op form more information.

State(string name)
Multiple
name: Name of the state.

Settings()
Required
Settings are applied when the state is entered.

Setting(string type)
Multiple
name: Setting type. The contents of the setting scope are dependent on the setting type.
The following setting types are defined:

• ObjectiveAction
  All commands which are available in an Action scope inside an Objective can be used. Refer to ObjectiveObj for more information.
  
  
• OP
  See Op form more information.
  
  
• Flag
  Set (or clear) a flag in the script.
  

  Flag(string flag)
  Required
  flag: Name of the flag to set. The following flags are available:
  

  • Keep
    Default(1)
    Scripts attempt to keep the units assigned to them when an asset reshuffle occurs.
    

  Value(bool flag)
  Required
  flag: Set or clear the named flag.
  

• Tactical
  Change the tactical settings of the units in the squad.
  

  ModifierSettings
  Required
  

  Set(string modifier, string value)
  Multiple
  modifier: tactical modifier to set the value of.
  setting: tactical setting of the modifier.
  

• Tag
  Place all of the object in the squad into a tag.
  

  Tag(string tag)
  Required
  tag: Name of the tag to place the objects in.
  

  Clear(bool flag)
  Optional(FALSE)
  flag: If set, then each unit in the squad is removes from all other tags before bein placed in this tag.
  

  Append(bool flag)
  Optional(FALSE)
  flag: If set, the units in the squad are appended to the given tag. If not set then the given tag is emptied before the units in the squad are added.
  

• Recruiter
  See Recruit for more information
  
  
• ClearRecruiter
  Clear the recruiter. The squad will attempt to keep the units it has when other squads are recruiting. If this is not desired then you can either reduce the priority of the script so that other squads can take its units or discharge the squad so that it has no units at all.
  
  
• Reserve
  Reserve the units currently in the squad so that the strategic AI will NOT assign them to any other squads.
  
  
• Unreserve
  If any of the units currently in the squad are reserved from the strategic AI, unreserved them so that they can be assigned to other squads.
  
  
• InstallCondition
  Install a condition.
  

  Ident(string ident)
  Required
  ident: Identifier which can be used to uninstall.
  

  Condition(string type)
  Required
  The condition. Refer to Condition for more information
  

• UnInstallCondition
  UnInstall a condition.
  

  Ident(string ident)
  Required
  ident: Identifier of radio receiver to uninstall.
  

• PurgeConditions
  Purge installed conditions.
  
• InstallRadioReceiver
  Install a radio receiver.
  

  Ident(string ident)
  Required
  ident: Identifier which can be used to uninstall.
  

  Event(string event)
  Required
  event: Name of the radio event to handle.
  

  Transition()
  Required
  The transition to perform when the event is handled. See below.
  

• UnInstallRadioReceiver
  UnInstall a radio receiver.
  

  Ident(string ident)
  Required
  ident: Identifier of radio receiver to uninstall.
  

• PurgeRadioReceivers
  Purge radio receivers which were installed by this script.
  
  

Action(string type)
Optional
type: Action type. The contents of the action scope are dependent on the action type.
If no Action is present, this is known as a NULL Action. A NULL action will use the has the status "Completed" immediately. The following action types are defined:

• Recruit(string type)
  Recruit units from a tag into the squad.
  type: Type of recruitment.
  
  • Tag
    Recrtuit from a Tag.
    

    Tag(string tag)
    Required
    tag: Name of the tag to recruit into the squad.
    

  • Squad
    Recruit units from another squad into the squad.
    

    Script(string script)
    Required
    script: Name of the script to recruit from.
    

  • Force
    Recruit units into the squad via a force matching.
    

    Config(string config)
    Required
    config: Name of the force matching configuration to use. Use CreateRecruitForce to create these configurations.
    

    Location()
    Required
    Location to centre the force matching about.
    Refer to Locations for more information.
    

    Range(float range)
    Required
    range: Range around the centre point of the region to consider for forcematching.
    

    AcceptInsufficient(bool flag)
    Optional(0)
    flag: If the force matching results in an insufficient number of units, take what we can even though the force is less than requested.
    

  • ForceMap
    Recruit units into the squad via a map wide force matching.
    

    Config(string config)
    Required
    config: Name of the force matching configiration to use. Use CreateConfigRequestForce to create these configurations.
    

    Location()
    Required
    Location to centre the force matching about.
    Refer to Locations for more information.
    

    AcceptInsufficient(bool flag)
    Optional(0)
    flag: If the force matching results in an insufficient number of units, take what we can even though the force is less than requested.
    

  • Type
    Recruit units into the squad by getting the specific types in the type configuration.
    

    Config(string config)
    Required
    config: Name of the type configuration to use. Use CreateRecruitType to create these configurations.
    

    Location()
    Required
    Location to centre the force matching about.
    Refer to Locations for more information.
    

    AcceptInsufficient(bool flag)
    Optional(0)
    flag: If we can't get all the units listed in the configuration, go with what we got.
    

• Spawn
  Spawns new units into the squad.
  

  Location()
  Required
  Location to spawn at.
  Refer to Locations for more information.
  

  Formation(string formation)
  Required
  formation: Name of the formation to used.
  

  Direction(float angle)
  Required
  angle: Angle to orient the formation. This is a compass angle.
  

  Config(string config)
  Required
  config: Name of the type configuration to use. Use CreateRecruitType to create these configurations.
  

• Delete
  Delete the units in the squad.
  
  
• Discharge
  Discharge the unis in the squad back to the strategic AI.
  
  
• Move
  Move the squad to the given location.
  

  Location()
  Required
  Location to move to.
  Refer to Locations for more information.
  

• Explore
  Tell the squad to explore. This never completes.
  
• Stop
  Stops what ever the squad is currently doing.
  
• Trail
  Move the squad onto the given trail.
  

  Trail(string trail)
  Required
  trail: name of the trail to use. Trail MUST be on the same team!
  

  Index(integer index)
  Optional(0)
  index: Index of the trail to start on.
  

• Formation
  Move the units in the squad into formation.
  

  Formation(string formation)
  Required
  formation: Name of the formation to used.
  

  Direction(float angle)
  Required
  angle: Angle to orient the formation. This is a compass angle.
  

• AttackTag
  Get the squad to attack a tag. The squad destroys the map objects in the tag selecting the closest one destroying it and then selecting the next closest object and so on.
  

  Tag(string tag)
  Required
  tag: Tag to attack.
  

• FollowTag
  Follow the tag. This action never completes so the "Completed" status will NEVER occur.
  

  Tag(string tag)
  Required
  tag: Tag to follow.
  

• Defect()
  Units in the squad defect to another team.
  

  Team(string team)
  Required
  team: Name of the team to defect to.
  

Conditions()
Optional

Status(string status)
Multiple
Status scopes define transitions to be performed based on the status of the Action being executed in this state. The contents of Completed are identical to Transition(). See below.
status: Name of the status to pefrorm the transition on. Different actions produce different statuses but there are some common ones.

• Completed
  When the action is completed the status is completed.
  

Condition(string type)
Multiple
type: Condition type. The contents of the condition scope are dependent upon the type with the exception of the Transition scope which is required in all conditions. The following types are defined.

• ObjectiveCondition
  

  Conditon(string type)
  Required
  A condition as used in the Objective system. Refer to ObjectiveObj for more information.
  

• Count
  Condition is true when the number of units in the squad relative to the amount given using the operator given becomes true.
  

  Operator(string operator)
  Required
  operator: Relational operator. See RelationalOperators for more information.
  

  Amount(integer amount)
  Requred (if Percentage not present)
  amount: Amount to compare against.
  

  Percentage(float percentage)
  Required (if Percentage not present)
  percentage: Percentage of the squad to compare against.
  

• HitPoints
  Condition is true when the number of combined hitpoints in the squad relative to the amount given using the operator given becomes true.
  

  Operator(string operator)
  Required
  operator: Relational operator. See RelationalOperators for more information.
  

  Amount(integer amount)
  Requred (if Percentage not present)
  amount: Amount to compare against.
  

  Percentage(float percentage)
  Required (if Percentage not present)
  percentage: Percentage of the squad hitpoints to compare against.
  

• Proximity
  Condition is true when the squads proximity to the location using the operator becomes true.
  

  Location()
  Required
  Location to test proximity against.
  Refer to Locations for more information.
  

  Operator(string operator)
  Required
  operator: Relational operator. See RelationalOperators for more information.
  

  Range(float range)
  Required
  range: Range to test proximity against.
  

• Threat
  Condition is true when the enemy threat at the squads location using the operator becomes true.
  

  Operator(string operator)
  Required
  operator: Relational operator. See RelationalOperators for more information.
  

  Amount(integer amount)
  Required
  amount: Amount of threat to test against.
  

Transition()
Required
A transition must include one of the following scopes.

End()
End the script. Note that the units in the squad are NOT discharged and that the AI won't use the units in the squad ever again.

GotoState(string state)
state: State to go to.

GotoRandomState()
Go to a state at random from the given states. At least one state must be defined.

Add(string state, float weight)
state: Name of the state to go to.
weight: Weighting to give to this branch.

CallState(string state)
state: State to call. The called state can use the return state transition to return to the calling state (this one).

CallRandomState()
Call a state at random from the given states. At least one state must be defined.

Add(string state, float weight)
state: Name of the state to call.
weight: Weighting to give to this branch.

ReturnState()
Return from this state. There must be at least one state on the "stack" otherwise this will fail.

CreateBase(string name)
Multiple
name: Name of the base.

Location
Required
Location of the base.
Refer to Locations for more information.

InitialState(string state)
Required
state: Name of the state to start in.

State
Multiple

State
Multiple

Orderers()
Required The orderers to use in this base state.

Add(string orderer, integer resource, integer priority)
Multiple
orderer: name of the orderer to use.
resource: resource weighting of the orderer.
priority: priority of the orderer.

CreateBase::Orderer(string name)
Multiple
name: Name of the base orderer.

Reserve(integer amount)
Optional(0)
amount: This orderer won't spend resource if the total resource is less than this amount.

Manifest(string type)
Required type: Type of the manifest. The following types are defined.

• Direct
  Build the the types presented.
  
• Level
  Ensure that number of units is maintained at the given level.
  
• BaseLevel
  Ensure that number of units is maintained at the given level within the base which owns this orderer.
  
• Ratio
  Continue building the types in the ratio defined by the types.
  
• Power
  Build more units depending on the current power level.
  

  Preparation(float time)
  Optional(10%)
  time: Amount of time to look ahead for power changed based on time of day.
  

  Over(integer amount)
  Optional(100)
  amount: Amount of power to overbuild by.
  

Types()
Required

Add(string type, integer amount)
Multiple, Optional amount(1)
type: Type name to use.
amount: Amount of type.

Random(boolean flag)
Optional(0)
flag: Whether the types are applied randomly or in the order listed.

Plan(string plan)
Required
plan: Name of the base plan to use when placing objects built by this manifest.

CreateBase::Plan
Multiple
name: Name of the base building plan.

Extents(float distance)
Required
distance: Distance to the perimiter of the base.

Front(float angle)
Required
angle: Compass angle to the front of the base.

DefaultEvaluation()
Required

Weighting()
Multiple
Weighting allows for multiple configurations which are chosen from via a random weighint (using the weighting values no less).

Orientation(float angle)
Optional
angle: Angle relative to the front of the base.

Weighting(float weighting)
Required
weighting: The weighting this parameter has.

Cutoff(float cutoff)
Required, Range(0.0, 1.0)
cutoff: Cells below this cutoff will not be considered.

Centre()
Optional Prefer cells which are close to the centre of the base. The contents are Weighting and Cutoff as per Orientation.

Perimeter()
Optional Prefer cells which are close to the perimeter of the base. The contents are Weighting and Cutoff as per Orientation.

WaterEdge()
Optional Prefer cells which are close to the edge of water. The contents are Weighting and Cutoff as per Orientation.

PropertyEvaluations()
Configurations based on properties in the types.

Add(string property)
Multiple
property: Property this configuration is for.
The contents are identical to the contents of DefaultEvaluation.

TypeEvaluations()
Configuratiosn based on types.

Add(string type)
Multiple
type: Type this configuration is for.
The contents are identical to the contents of DefaultEvaluation.

CreateRecruitForce(string name)
name: Name of the force matching configuration.

Evaluation()
Required
Parameters used during the evaluation of the available units. Each unit is given a score from 0 to 1 for each of the five types and those five scores are combined using the importances of each score.

Constitution(float importance)
Required
importance: Importance to give to constitution.
Constitution is determined by how long the given unit can survive in the area speficied by comparing the armour class and hit points of the units against the threats to that armour class in the area of interest.

Effectiveness(float importance)
Required
importance: Importance to give to effectiveness.
Effectiveness is determined by how effective the weapons the unit has are against the armour classes in the area of interest.

Time(float importance)
importance: Importance to give to time.
The amount of time required for the given unit to get to area of interest. The longer a unit will take to get to the area, the lower its time value.

Cost(float importance)
importance: Importance to give to cost.
The higher the cost of replacing the given unit the lower its cost value.

Tweak(float importance)
importance: Importance to give to tweak.

Type(string type, float tweak)
Multiple, tweak Range(0, 1)
type: Unit type to assign tweak to.
tweak: Tweak value to use with units of this type.

Default(float tweak)
Required, Range(0, 1)
tweak: Default tweak value given to non specified types.

Allocation()
Required

Defense(float value)
Required
value: Amount of defense to allocate to threat. This translates to the number of seconds the units could survive is all of the threat in the area is brought to bear on all units simultaneously. Experiment with values between 1 and 10.

Threat(float value)
Required
value: Amount of threat to allocate to defense. This translates to the the amount of threat required to destroy all of the defeneses in the area in one second. Experiment with values below zero.

CreateRecruitType(string name)
name: Name of the type configuration.

Type(string type, integer amount)
Multiple
type: Unit type recruit.
amount: Number of units to recruit.

Locations
Locations are used whenever the AI needs to know about a location on the map. Different circumstances will use locations differently and may require/use different parts of locations.

Base(string type)
Optional(none)
type: The type of the base part of a location which can be

• Region(string region)
  region: Name of the region to use for a location.
  
  
• Tag(string tag)
  tag: Name of the tag to use for a location.
  
  
• Squad(string squad)
  squad: Name of the squad script to use for a location.
  
  
• LastRadioEvent
  Uses the location of the last handled radio event.
  
  

Offset(string type)
Optional(none)

• Polar(float distance, float direction)
  distance: distance (in metres) to offset by.
  direction: compass angle direction to offset by.
  
• Orthogonal(float Xoffset, float Zoffset)
  Xoffset: distance to offset along x axis (in metres).
  Zoffset: distance to offset along z axis (in metres).
  

Rule(string type)
Optional(none)