Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Complete property documentation

The game files include To access the script property documentation that is included in the game, you can extract the required files from the game's catalog files using the X Catalog Tool. Extract the HTML file scriptproperties.html in the game’s game's root folder, and more scriptproperties.* all files in the "libraries" sub-folder. Open the HTML file in a browser (only Firefox is officially supported, there may be problems with Chrome). For resolving text references in the browser automatically, also extract 0001-L044.xml in the "t" sub-folder.

The raw documentation data is located in libraries/scriptproperties.xml, but it is recommended to open scriptproperties.html in a browser.

Note

scriptproperties.html has to load files from different folders, which modern browsers do not allow by default for security reasons. In order to open scriptproperties.html, the following is required:

  • Firefox: On the about:config page, the value of "security.fileuri.strict_origin_policy" has to be changed to "false".
  • Chrome: The Chrome launcher has to be started with the command-line parameter --allow-file-access-from-files

This provides you with a complete list of all supported “base keywords” and properties. To filter in this list, you can enter an expression in the text field:

...

Warning

Although in general the expression “$foo == namespace.$foo” is true, there is one exception: When library parameters are evaluated in the referencing cue, variables are resolved using the parent’s namespace. However, the referencing cue creates a new namespace, so the namespace keyword already points to the library, not to the parent’s namespace. Example:

<cue name="LibRef" ref="Lib">
  <
param name="Param1" value="$foo" /> <!-- $foo from parent namespace -->
  <
param name="Param2" value="namespace.$foo" /> <!-- LibRef.$foo (error) -->
https://forum.egosoft.com/viewtopic.php?t=363625</
cue>