ModEnc is currently in Maintenance Mode: Changes could occur at any given moment, without advance warning.

ScriptTypes

From ModEnc
Revision as of 09:35, 2 September 2018 by Crimsonum (talk | contribs) (Made a slight correction regarding the -G suffix.)
Jump to: navigation, search
This page should correctly be named "[ScriptTypes]"; it is wrong due to technical restrictions.



In Tiberian Sun through Yuri's Revenge, this section defines a list of all AI Scripts in the game. AI Scripts control what the AI controlled units actually do, like "attack enemy buildings", "gather just outside our own base", "move to nearest GACNST", and so on. Consider it a primitive programming language which supports two kinds of loops and no conditional statements. Each AI Script needs its own section in the same file. That section should contain a zero-based list of actual Script Actions with arguments for the TaskForce to execute. Unlike most other object lists, the list containing the script's actions does care about its ordering - it reads the lines indexed from 0 to 49 in ascending order. No other flags are read from that section, so nothing is stopping you from adding stuff like Name= for your own reference, which third party tools such as FinalAlert 2 or AI Editor V2 usually can use as well.

Format

[ScriptTypes]
0 = 0438CD41-G
1 = 0438CD42-G

[0438CD41-G]
Index = action,argument
Index = action,argument

[0438CD42-G]
Index = action,argument
Index = action,argument

Both action and argument are numbers, the meaning of arguments is different for each Action.

Note again: Index is read from 0 to 49 inclusive in ascending order, unlike other object lists which read the contained items without paying attention to the keys on the left side.

Possible Actions

List of possible Script Actions

Additional information

  • This section is read from ai(md).ini and the current map file.
  • Unlike AITriggerTypes, there is no difference on where a ScriptType is declared, they are compiled into a single list after reading both files. The game does keep track of which ones were declared in the "global" scope (ai(md).ini) and which - in the "local" scope (map itself), but the only usage of that seems to be the unused functions to save them back to the source file.
  • The infamous -G suffix is used to distinguish global (ai(md).ini) ScriptTypes from local (map) ones (which have no suffix). It has no effect however.
  • Unlike TaskForces, there is no effect to prefixing a ScriptType's ID with a hexadecimal prefix.