Changes for page Mission Director Guide

Last modified by Klaus Meyer on 2025/03/31 16:39

From 31075.1 to 31076.1 From 32957.1 to 32958.1

From version 31076.1

edited by Daniel Turner
on 2023/04/14 17:17

Change comment: There is no comment for this version

To version 32957.1

edited by Daniel Turner
on 2023/08/22 19:09

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (4 modified, 0 added, 0 removed)
Attachments (0 modified, 1 added, 0 removed)
- Mission Director Guide - Instantiation.png

Details

Page properties

Title

@@ -1,1 +1,1 @@
--X4:X4 Documentation/X4 Game Design/0 General/Mission Director Guide
++Mission Director Guide

Parent

...	...	@@ -1,0 +1,1 @@
	1	+X Rebirth Wiki.Modding support.WebHome

Tags

@@ -1,1 +1,1 @@
--Broken_macro/anchor
++Broken_macro/anchor|Broken macro/anchor

Content

@@ -1,93 +1,66 @@
--{{info body="Please note that this is officially-maintained documentation.
++The Mission Director (MD) is a subsystem of the game and interprets mission scripts, which are written in an XML-based language. The Mission Director in X Rebirth and X4 is based on the MD in X3: Terran Conflict, with some major changes based on feedback from MD users.
--To ensure that you can rely on the information having been checked by Egosoft, you will not be able to edit this page."/}}
++An introduction to the original MD can be found in the [[Egosoft forums>>url:http://forum.egosoft.com/viewtopic.php?t=196971]]. There is also a PDF guide for the X3 Mission Director, which is partially used as a template for this document.
++This document is primarily supposed to be a guide for MD users (people who use the MD to develop missions or write other MD scripts), not for MD programmers (people who work on the MD engine in C++).
++{{info}}
++The general MD scripting system is the same in XR and X4, so this guide applies to both games. However, each game has its own set of supported script features (i.e. actions, conditions and properties), so in general scripts from different games are not compatible.
++{{/info}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)The Mission Director (MD) is a subsystem of the game and interprets mission scripts, which are written in an XML-based language. The Mission Director in X Rebirth and X4 is based on the MD in X3: Terran Conflict, with some major changes based on feedback from MD users.
--
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)An introduction to the original MD can be found in the(%%)[[(% style="color: rgb(0,0,0);text-decoration: none;" %)┬á(% style="color: rgb(0,0,153);text-decoration: underline;" %)Egosoft forums>>url:http://forum.egosoft.com/viewtopic.php?t=196971]](% style="color: rgb(0,0,0);text-decoration: none;" %). There is also a PDF guide for the X3 Mission Director, which is partially used as a template for this document.
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)This document is primarily supposed to be a guide for MD users (people who use the MD to develop missions or write other MD scripts), not for MD programmers (people who work on the MD engine in C++).
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)(% style="color: rgb(0,0,0);text-decoration: none;" %)The general MD scripting system is the same in XR and X4, so this guide applies to both games. However, each game has its own set of supported script features (i.e. actions, conditions and properties), so in general scripts from different games are not compatible.
--
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)
--
--
--(% id="table-of-contents" %)
--
--= (% style="color: rgb(0,0,0);text-decoration: none;" %)Table of Contents(%%) =
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)
--
  {{toc/}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)
++= MD scripts =
++MD scripts are not necessarily missions. An MD file can contain a part of a mission, multiple missions, or no mission at all, as the MD is used for more than just missions.
--(% id="md-scripts" %)
++MD files are XML files located in the game folder **md**. All XML files in that folder are loaded at game start. The file names are irrelevant, since the internally used script names are read from the XML root nodes. However, it's recommended to keep file name and internal script name identical to avoid having to look up the names.
--= (% style="color: rgb(0,0,0);text-decoration: none;" %)MD scripts(%%) =
++To edit MD scripts, an XML editing tool is needed. Microsoft Visual Studio (if available) or [[Microsoft Visual Web Developer>>url:http://www.microsoft.com/express/vwd/]] (for free) are highly recommended because they have pretty good support for XML schemas (XSD). The provided Mission Director schema files help you create the XML file by displaying all available tags and attributes as you edit the XML.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)MD scripts are not necessarily missions. An MD file can contain a part of a mission, multiple missions, or no mission at all, as the MD is used for more than just missions.
++This functionality is only available if the schema files **md.xsd** and **common.xsd** are in the correct folder. If you are editing the XML in the game folder directly, all is well and the files are loaded from the libraries folder. However, if you are editing in a separate folder, copy those XSD files from the libraries folder directly into the folder where your XML files are located.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)MD files are XML files located in the game folder {{code}}md{{/code}}. All XML files in that folder are loaded at game start. The file names are irrelevant, since the internally used script names are read from the XML root nodes. However, itΓÇÖs recommended to keep file name and internal script name identical to avoid having to look up the names.
++{{info}}
++Even if your script is free of XSD errors, that does not mean that the script syntax is correct. For example, there are XML elements that require at least one of multiple attributes, but this requirement cannot be reflected in a schema (apart from documentation text). Please notice the XSD documentation of the elements and attributes, e.g. displayed via tooltips in Visual Studio / Visual Web Developer. Please also note additional requirements for MD cue attributes in this guide (see [[NULL|Conditions]]).
--(% style="color: rgb(0,0,0);text-decoration: none;" %)To edit MD scripts, an XML editing tool is needed. Microsoft Visual Studio (if available) or (%%)[[(% style="color: rgb(0,0,153);text-decoration: underline;" %)Microsoft Visual Web Developer>>url:http://www.microsoft.com/express/vwd/]](% style="color: rgb(0,0,0);text-decoration: none;" %) (for free) are highly recommended because they have pretty good support for XML schemas (XSD). The provided Mission Director schema files help you create the XML file by displaying all available tags and attributes as you edit the XML.
++To check for errors, please pay attention to in-game error messages that are produced while your script is imported, and run-time errors while the script runs. The XSD files can help you a lot, but you should not rely on the absence of XSD errors."
++{{/info}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)This functionality is only available if the schema files (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)md.xsd(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %) and (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)common.xsd(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %) are in the correct folder. If you are editing the XML in the game folder directly, all is well and the files are loaded from the libraries folder. However, if you are editing in a separate folder, copy those XSD files from the libraries folder directly into the folder where your XML files are located.
++== Script debug output ==
--{{note body="Even if your script is free of XSD errors, that does not mean that the script syntax is correct. For example, there are XML elements that require at least one of multiple attributes, but this requirement cannot be reflected in a schema (apart from documentation text). Please notice the XSD documentation of the elements and attributes, e.g. displayed via tooltips in Visual Studio / Visual Web Developer. Please also note additional requirements for MD cue attributes in this guide (see [[NULL|Conditions]]).
++The game can print error messages and, when enabled, also general messages. Error messages can originate from the scripting system, but also from other game sub-systems. They can be viewed in the in-game [[DebugLog>>url:https://forum.egosoft.com/viewtopic.php?t=366654]].
--To check for errors, please pay attention to in-game error messages that are produced while your script is imported, and run-time errors while the script runs. The XSD files can help you a lot, but you should not rely on the absence of XSD errors."/}}
++To collect all messages in a file, start the game with the following parameters on the command line:
++{{code language="xml"}}
++-logfile debuglog.txt
++{{/code}}
++All messages, including enabled non-error messages, will be written into the log file. You can find it in your personal folder, where your save folder is located. To enable scripting-specific debug messages, add the following to the command line:
--(% id="categorybroken_macroanchorscript-debug-output" %)
++{{code language="xml"}}
++-debug scripts
++{{/code}}
--== (% style="color: rgb(0,0,0);text-decoration: none;" %)Script debug output(%%) ==
++Other debug filters other than "scripts" can be enabled by repeating the -debug command for each filter name, but that is rarely needed for scripting.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)The game can print error messages and, when enabled, also general messages. Error messages can originate from the scripting system, but also from other game sub-systems. They can be viewed in the (% style="color: rgb(0,0,0);text-decoration: none;" %)in-game [[DebugLog>>url:https://forum.egosoft.com/viewtopic.php?t=366654]].
++The script action <debug_text> can be used to print debug messages from within a script.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)(% style="color: rgb(0,0,0);text-decoration: none;" %)To collect all messages(%%) in a file, start the game with the following parameters on the command line:
++= MD script structure =
--(% style="color: rgb(0,0,0);text-decoration: none;" %)(% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}-logfile debuglog.txt{{/code}}
++In this section we will look at how to start the whole process by creating a new MD mission file and the basic steps in producing mission content with XML code. There will be a description of the key elements of the mission file.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)All messages, including enabled non-error messages, will be written into the log file. You can find it in your personal folder, where your save folder is located. To enable scripting-specific debug messages, add the following to the command line:
++The XML root node of an MD file is called "mdscript" and looks like this:
--(% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}-debug scripts{{/code}}
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)(% style="color: rgb(0,0,0);text-decoration: none;" %)Other debug filters other than "scripts" can be enabled by repeating the -debug command for each filter name, but that is rarely needed for scripting.
--
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)(% style="color: rgb(0,0,0);text-decoration: none;" %)The script action <debug_text> can be used to print debug messages from within a script.
--
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)
--
--
--(% id="md-script-structure" %)
--
--= (% style="color: rgb(0,0,0);text-decoration: none;" %)MD script structure(%%) =
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)In this section we will look at how to start the whole process by creating a new MD mission file and the basic steps in producing mission content with XML code. There will be a description of the key elements of the mission file.
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)The XML root node of an MD file is called ΓÇ£mdscriptΓÇ¥ and looks like this:
--
  {{code language="xml"}}
  <?xml version="1.0" encoding="utf-8"?>
  <mdscript name="ScriptName" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="md.xsd">
  {{/code}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)ΓÇ£ScriptNameΓÇ¥ is the name used for this script regardless of the file name. It (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)has to start with an upper case letter and must be unique(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %) among all MD script names. It also should not contain spaces, so other MD scripts can use it as an identifier to access this scriptΓÇÖs contents easily.
++"ScriptName" is the name used for this script regardless of the file name. It **has to start with an upper case letter and must be unique** among all MD script names. It also should not contain spaces, so other MD scripts can use it as an identifier to access this script's contents easily.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)The only allowed sub-node of <mdscript> is <cues>, which can only contain <cue> sub-nodes:
++The only allowed sub-node of <mdscript> is <cues>, which can only contain <cue> sub-nodes:
  {{code language="xml"}}
  <?xml version="1.0" encoding="utf-8"?>
@@ -101,36 +101,26 @@
  </mdscript>
  {{/code}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)┬á
++== Cues ==
--(% id="categorybroken_macroanchorcues" %)
++Cues are the main ingredient of an MD script. A cue consists of a set of **conditions** and a set of **actions**. When the conditions are met, the cue is activated and the actions are performed. A cue can have child cues, or **sub-cues**: A sub-cue exists only when its parent cue has become active, so the activation of the parent cue initiates the condition checks of its child cues.
--== (% style="color: rgb(0,0,0);text-decoration: none;" %)Cues(%%) ==
++A cue can have the following states:
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Cues are the main ingredient of an MD script. A cue consists of a set of (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)conditions(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %) and a set of (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)actions(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %). When the conditions are met, the cue is activated and the actions are performed. A cue can have child cues, or (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)sub-cues(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %): A sub-cue exists only when its parent cue has become active, so the activation of the parent cue initiates the condition checks of its child cues.
++* **Disabled**: The parent cue has not become active yet, so this cue is basically non-existing.
++* **Waiting**: Either this is a root cue, or the parent has become active. The cue is checking its conditions and will become active when they are met.
++* **Active**: The cue is about to perform the actions. Child cues have entered the waiting state.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)A cue can have the following states:
--* **(% style="color: rgb(0,0,0);text-decoration: none;" %)Disabled(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %): The parent cue has not become active yet, so this cue is basically non-existing.
--* **(% style="color: rgb(0,0,0);text-decoration: none;" %)Waiting(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %): Either this is a root cue, or the parent has become active. The cue is checking its conditions and will become active when they are met.
--* **(% style="color: rgb(0,0,0);text-decoration: none;" %)Active(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %): The cue is about to perform the actions. Child cues have entered the waiting state.
--\\
--* **(% style="color: rgb(0,0,0);text-decoration: none;" %)Complete(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %): The cue has finished performing its actions.
--* **(% style="color: rgb(0,0,0);text-decoration: none;" %)Cancelled(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %): The cue has been cancelled. This state cannot normally be reached but only if a cue actively cancels itself or another cue. No condition checks or actions are performed in this cue or any sub-(sub-)cue.
++* **Complete**: The cue has finished performing its actions.
++* **Cancelled**: The cue has been cancelled. This state cannot normally be reached but only if a cue actively cancels itself or another cue. No condition checks or actions are performed in this cue or any sub-(sub-)cue.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)
++{{info}}
++There can be a delay between the activation and performing the actions if the <delay> tag is used. In this case, sub-cues will be enter the waiting state before the parent's actions are performed.
++{{/info}}
++This is how a cue node looks like:
--{{note body="<span style=~"color: rgb(0,0,0);text-decoration: none;~">There can be a delay between the activation and performing the actions if the &lt;delay&gt; tag is used. In this case, sub-cues will be enter the waiting state before the parent's actions are performed.<br />
--</span>"/}}
--
--
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)
--
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)This is how a cue node looks like:
--
  {{code language="xml"}}
  <cue name="CueName">
    <conditions> [...]
@@ -143,23 +143,18 @@
  </cue>
  {{/code}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)The rules for naming cues is the same for MD script names: The name **starts with an upper case letter**, and has to be (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)unique within this file(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %). So it is actually possible to use the same cue name in different scripts, which is different from the MD in X3.
++The rules for naming cues is the same for MD script names: The name **starts with an upper case letter**, and has to be **unique within this file**. So it is actually possible to use the same cue name in different scripts, which is different from the MD in X3.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)
++== Conditions ==
++The <conditions> node can contain one or multiple conditions, all of which must be met to activate the cue. If the node is missing, the cue will become active unconditionally. The conditions are checked in sequence, and if a check fails, the following conditions are ignored. There are two types of conditions: Events and non-event conditions.
--(% id="categorybroken_macroanchorconditions" %)
++**Non-event conditions** are checked either once or repeatedly in a fixed interval. They may be based on simple values or ranges, such as a particular in-game time having been reached or the player having a certain amount of money. They may also be based on more complex player information, such as what ships they own, whether the player is in a particular area or near a particular object.
--== (% style="color: rgb(0,0,0);text-decoration: none;" %)Conditions(%%) ==
++**Event conditions** are triggered when the corresponding event happens, such as the event that a particular object has been targeted, attacked or destroyed. All event nodes have the prefix "event_" so you can easily determine a condition type. After an event condition you can specify one or more non-event conditions, which will be checked additionally whenever the event happens. If a condition uses an event, it must be in the first sub-node of the <conditions> node. It is even possible to define multiple alternative events that should activate the cue. The first sub-node should be <check_any> in this case, so only one of its sub-conditions has to be met.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)The <conditions> node can contain one or multiple conditions, all of which must be met to activate the cue. If the node is missing, the cue will become active unconditionally. The conditions are checked in sequence, and if a check fails, the following conditions are ignored. There are two types of conditions: Events and non-event conditions.
++Example for an event condition:
--**(% style="color: rgb(0,0,0);text-decoration: none;" %)Non-event conditions(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %) are checked either once or repeatedly in a fixed interval. They may be based on simple values or ranges, such as a particular in-game time having been reached or the player having a certain amount of money. They may also be based on more complex player information, such as what ships they own, whether the player is in a particular area or near a particular object.
--
--**(% style="color: rgb(0,0,0);text-decoration: none;" %)Event conditions(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %) are triggered when the corresponding event happens, such as the event that a particular object has been targeted, attacked or destroyed. All event nodes have the prefix ΓÇ£event_ΓÇ¥ so you can easily determine a condition type. After an event condition you can specify one or more non-event conditions, which will be checked additionally whenever the event happens. If a condition uses an event, it must be in the first sub-node of the <conditions> node. It is even possible to define multiple alternative events that should activate the cue. The first sub-node should be <check_any> in this case, so only one of its sub-conditions has to be met.
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Example for an event condition:
--
  {{code language="xml"}}
  <conditions>
    <event_object_destroyed object="$target"/>
@@ -166,7 +166,7 @@
  </conditions>
  {{/code}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Example for an event condition with an additional (non-event) check:
++Example for an event condition with an additional (non-event) check:
  {{code language="xml"}}
  <conditions>
@@ -175,7 +175,7 @@
  </conditions>
  {{/code}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Example for an event condition with two alternative events and a common additional check:
++Example for an event condition with two alternative events and a common additional check:
  {{code language="xml"}}
  <conditions>
@@ -190,22 +190,23 @@
  </conditions>
  {{/code}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)For more information about expressions and event parameters, see below.
++For more information about expressions and event parameters, see below.
--**(% style="color: rgb(0,0,0);text-decoration: none;" %)<check_all>(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %) and (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)<check_any>(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %) can be used with non-event conditions as well, but if <check_any> is the first node of an event condition, all its sub-nodes have to define events. In case of <check_all>, only its first node must be an event (or yet another <check_any>), to make sure that exactly one event is required to activate the cue.
++**<check_all>** and **<check_any>** can be used with non-event conditions as well, but if <check_any> is the first node of an event condition, all its sub-nodes have to define events. In case of <check_all>, only its first node must be an event (or yet another <check_any>), to make sure that exactly one event is required to activate the cue.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)If a cue has a <conditions> node without any event, it must have one of the attributes (%%)//**(% style="color: rgb(0,0,0);text-decoration: none;" %)onfail(%%)**//(% style="color: rgb(0,0,0);text-decoration: none;" %) or (%%)//**(% style="color: rgb(0,0,0);text-decoration: none;" %)checkinterval(%%)**//(% style="color: rgb(0,0,0);text-decoration: none;" %).
++If a cue has a <conditions> node without any event, it must have one of the attributes //**onfail**// or //**checkinterval**//.
--* Use //onfail// if the conditions should be checked only once. The possible attribute values are (% style="color: rgb(0,0,0);text-decoration: none;" %)ΓÇ£(%%)//(% style="color: rgb(0,0,0);text-decoration: none;" %)cancel//ΓÇ¥ and ΓÇ£(%%)//(% style="color: rgb(0,0,0);text-decoration: none;" %)complete//ΓÇ¥. If the conditions are met, the cue will activate and perform the cue actions. Otherwise it's a failure and the cue will be cancelled or completed, based on the onfail attribute. Typically //onfail="cancel"// is used to prevent any further action. //onfail="complete"// can be used to continue with the sub-cues even in case of failure (but skipping the current cue actions).
--\\
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)With (%%)//(% style="color: rgb(0,0,0);text-decoration: none;" %)checkinterval//, you can specify a constant time interval between condition checks. The conditions will be checked regularly forever until they are met, unless the cueΓÇÖs state is changed explicitly by an external event.
++* Use //onfail// if the conditions should be checked only once. The possible attribute values are "//cancel//" and "//complete//". If the conditions are met, the cue will activate and perform the cue actions. Otherwise it's a failure and the cue will be cancelled or completed, based on the onfail attribute. Typically //onfail="cancel"// is used to prevent any further action. //onfail="complete"// can be used to continue with the sub-cues even in case of failure (but skipping the current cue actions).
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Additionally, you can use the attribute (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)checktime(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %) to set the time of the first condition check (also possible in combination with (%%)//(% style="color: rgb(0,0,0);text-decoration: none;" %)onfail//). The (%%)//(% style="color: rgb(0,0,0);text-decoration: none;" %)checktime// can be an expression with variables and is evaluated when the cue is enabled (when the condition checks would normally start ΓÇô for root cues that happens at game start, otherwise after the parent cue becomes active).
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Examples:
++* With //checkinterval//, you can specify a constant time interval between condition checks. The conditions will be checked regularly forever until they are met, unless the cue's state is changed explicitly by an external event.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Check conditions every 5 seconds, but start checking only 1 hour after game start.
++Additionally, you can use the attribute **checktime** to set the time of the first condition check (also possible in combination with //onfail//). The //checktime// can be an expression with variables and is evaluated when the cue is enabled (when the condition checks would normally start ΓÇô for root cues that happens at game start, otherwise after the parent cue becomes active).
++Examples:
++
++Check conditions every 5 seconds, but start checking only 1 hour after game start.
++
  {{code language="xml"}}
  <cue name="Foo" checktime="1h" checkinterval="5s">
    <conditions>
@@ -213,7 +213,7 @@
  </cue>
  {{/code}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Check conditions 3 seconds after the cue is enabled, and cancel the cue in case of failure.
++Check conditions 3 seconds after the cue is enabled, and cancel the cue in case of failure.
  {{code language="xml"}}
  <cue name="Foo" checktime="player.age + 3s" onfail="cancel">
@@ -222,39 +222,32 @@
  </cue>
  {{/code}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)(% style="color: rgb(0,0,0);text-decoration: none;" %)(% style="color: rgb(0,0,0);text-decoration: none;" %)The attributes //onfail//, //checkinterval//, //checktime// are not allowed for cues with event conditions.
++The attributes //onfail//, //checkinterval//, //checktime// are not allowed for cues with event conditions.
--\\
++{{info}}
++**Reminder**
++When using an XSD-capable editor, it's a great help, but you cannot rely on that alone to verify correctness. Please also check the documentation and look for errors in the game debug output. Concretely, the schema cannot tell whether the above cue attributes are used correctly.
++{{/info}}
++== Actions ==
++The <actions> node contains the actions that are performed one after another, without any delay inbetween. You can enforce a delay after activation of the cue and actual action performance, using a <delay> node right before the <actions>:
--{{note body="Reminder: When using an XSD-capable editor, it's a great help, but you cannot rely on that alone to verify correctness. Please also check the documentation and look for errors in the game debug output. Concretely, the schema cannot tell whether the above cue attributes are used correctly."/}}
--
--
--
--\\
--
--(% id="actions" %)
--
--== (% style="color: rgb(0,0,0);text-decoration: none;" %)Actions(%%) ==
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)The <actions> node contains the actions that are performed one after another, without any delay inbetween. You can enforce a delay after activation of the cue and actual action performance, using a <delay> node right before the <actions>:
--
  {{code language="xml"}}
  <delay min="10s" max="30s"/>
  {{/code}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Note that during the delay the cue is already in the active state, and the sub-cues have been enabled! If you want to make sure that a sub-cue only becomes active after this cue is complete, there is a useful event condition for that:
++Note that during the delay the cue is already in the active state, and the sub-cues have been enabled! If you want to make sure that a sub-cue only becomes active after this cue is complete, there is a useful event condition for that:
  {{code language="xml"}}
  <event_cue_completed cue="parent"/>
  {{/code}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)<actions> is optional. Leaving it out may be useful if you only want to enable sub-cues after the cueΓÇÖs condition check. The state transition from active to complete will still take the <delay> node into account.
++<actions> is optional. Leaving it out may be useful if you only want to enable sub-cues after the cue's condition check. The state transition from active to complete will still take the <delay> node into account.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Note that the MD script language is not designed as a programming language. The actions are performed in sequence, although they can be nested to form more complex structures. Loops and conditionals exist to some extent, but not necessarily in the sense that a programmer might expect. Analogously to <check_all> and <check_any>, you can use (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)<do_all>(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %) to perform all the contained sub-node actions, and (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)<do_any>(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %) to perform only one of them. <do_all> is particularly useful when nested in a <do_any>.
++Note that the MD script language is not designed as a programming language. The actions are performed in sequence, although they can be nested to form more complex structures. Loops and conditionals exist to some extent, but not necessarily in the sense that a programmer might expect. Analogously to <check_all> and <check_any>, you can use **<do_all>** to perform all the contained sub-node actions, and **<do_any>** to perform only one of them. <do_all> is particularly useful when nested in a <do_any>.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Example, which selects one of the three texts randomly:
++Example, which selects one of the three texts randomly:
  {{code language="xml"}}
  <actions>
@@ -266,37 +266,32 @@
  <actions>
  {{/code}}
++{{info}}
++Messages printed with <debug_text> are usually only visible when the "scripts" debug filter is enabled, see Script debug output
++{{/info}}
--{{note body="<span style=~"color: rgb(0,0,0);text-decoration: none;~">Messages printed with &lt;debug_text&gt; are usually only visible when the ΓÇ£scriptsΓÇ¥ debug filter is enabled, see [[NULL|Script debug output]].</span>"/}}
++Each child action in a <do_any> node can have a //**weight**// attribute, which can be used to control the random selection of an action node. The default weight of a child node is 1.
++Also available is **<do_if>**, which completes the enclosed action(s) only if one provided value is non-null or matches another. Directly after a <do_if> node, you can add one or more **<do_elseif>** nodes to perform additional checks only in case the previous conditions were not met. The node **<do_else>** can be used directly after a <do_if> or a <do_elseif>. It is executed only if none of the conditions are met.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Each child action in a <do_any> node can have a (%%)//**(% style="color: rgb(0,0,0);text-decoration: none;" %)weight(%%)**//(% style="color: rgb(0,0,0);text-decoration: none;" %) attribute, which can be used to control the random selection of an action node. The default weight of a child node is 1.
++**<do_while>** also exists, but should be used carefully, since it is the only action that could cause an infinite loop, which freezes the game without any chance of recovery.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Also available is (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)<do_if>(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %), which completes the enclosed action(s) only if one provided value is non-null or matches another. Directly after a <do_if> node, you can add one or more (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)<do_elseif>(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %) nodes to perform additional checks only in case the previous conditions were not met. The node (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)<do_else>(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %) can be used directly after a <do_if> or a <do_elseif>. It is executed only if none of the conditions are met.
++Every action can have a //**chance**// attribute, if you only want it to be performed with that chance, given as percentage. Otherwise it will simply be skipped. If chance is used on a conditional action such as <do_if>, the script will behave as if the condition check failed.
--**(% style="color: rgb(0,0,0);text-decoration: none;" %)<do_while>(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %) also exists, but should be used carefully, since it is the only action that could cause an infinite loop, which freezes the game without any chance of recovery.
++= Libraries =
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Every action can have a (%%)//**(% style="color: rgb(0,0,0);text-decoration: none;" %)chance(%%)**//(% style="color: rgb(0,0,0);text-decoration: none;" %) attribute, if you only want it to be performed with that chance, given as percentage. Otherwise it will simply be skipped. If chance is used on a conditional action such as <do_if>, the script will behave as if the condition check failed.
++Libraries are cues which are not created directly but only serve as templates for other cues. This allows for modularisation, so you can re-use library cues in many different missions.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)
++{{info}}
++The syntax of libraries is considerably different from the syntax in the MD of X3TC.
++{{/info}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)┬á
--(% id="libraries" %)
++Library cues are written like normal cues, they are also defined in a <cues> node, just with the difference that the XML tag is called library instead of cue:
--= (% style="color: rgb(0,0,0);text-decoration: none;" %)Libraries(%%) =
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Libraries are cues which are not created directly but only serve as templates for other cues. This allows for modularisation, so you can re-use library cues in many different missions.
--
--{{note body="<span style=~"color: rgb(0,0,0);~">The syntax of libraries is considerably different from the syntax in the MD of X3TC.</span>"/}}
--
--
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Library cues are written like normal cues, they are also defined in a <cues> node, just with the difference that the XML tag is called library instead of cue:
--
  {{code language="xml"}}
  <library name="LibFoo" checktime="1h" checkinterval="5s">
    <conditions>
@@ -304,25 +304,25 @@
  </library>
  {{/code}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Although it is called library, itΓÇÖs basically just a cue that doesnΓÇÖt do anything. You can mix cues and libraries as you want, as root cues or sub-cues - the location within the file is unimportant. All that counts is the library name, which has to be unique within the MD script, like all other cue names.
++Although it is called library, it's basically just a cue that doesn't do anything. You can mix cues and libraries as you want, as root cues or sub-cues - the location within the file is unimportant. All that counts is the library name, which has to be unique within the MD script, like all other cue names.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)To use a library, use the attribute ref:
++To use a library, use the attribute ref:
  {{code language="xml"}}
  <cue name="Foo" ref="LibFoo"/>
  {{/code}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)This will create a cue with the name Foo that behaves just like the library cue LibFoo. In this example, LibFoo has to be a library in the same MD script file. To use a library LibFoo from another script, you have to qualify it with the script name, using the (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)md(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %) prefix:
++This will create a cue with the name Foo that behaves just like the library cue LibFoo. In this example, LibFoo has to be a library in the same MD script file. To use a library LibFoo from another script, you have to qualify it with the script name, using the **md** prefix:
  {{code language="xml"}}
  <cue name="Foo" ref="md.ScriptName.LibFoo"/>
  {{/code}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)When the ref attribute is provided, all other attributes (except for name) will be ignored and taken from the library cue instead. ((% style="color: rgb(0,0,0);text-decoration: none;" %)By default a library creates its own namespace, as if namespace="static" were specified. See the section about namespaces.(%%))
++When the ref attribute is provided, all other attributes (except for name) will be ignored and taken from the library cue instead. (By default a library creates its own namespace, as if namespace="static" were specified. See the section about namespaces.)
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Also all sub-cues of the library will be created as sub-cues of the cue that uses it. They are defined in the library as <cue>, not as <library>. (Although you can define a library as a sub-cue of another library, the location in the file does not matter, as already stated above.) It is even possible to reference other libraries in sub-cues of a library!
++Also all sub-cues of the library will be created as sub-cues of the cue that uses it. They are defined in the library as <cue>, not as <library>. (Although you can define a library as a sub-cue of another library, the location in the file does not matter, as already stated above.) It is even possible to reference other libraries in sub-cues of a library!
--(% style="color: rgb(0,0,0);text-decoration: none;" %)In contrast to X3TC, a cue that references a library also has its own name (Foo in the example above), so other cues can access it in expressions by that name. Sub-cues of Foo cannot be accessed by their name though. Within the library itself, expressions can use all names of cues that belong to the library (the <library> and all sub-cues). They will be translated properly when the library is referenced. Examples:
++In contrast to X3TC, a cue that references a library also has its own name (Foo in the example above), so other cues can access it in expressions by that name. Sub-cues of Foo cannot be accessed by their name though. Within the library itself, expressions can use all names of cues that belong to the library (the <library> and all sub-cues). They will be translated properly when the library is referenced. Examples:
  {{code language="xml"}}
  <cue name="Foo" ref="LibFoo"/>
@@ -344,28 +344,26 @@
  </library>
  {{/code}}
++{{warning}}
++These examples are definitely <u>not</u> examples of good scripting style.
++{{/warning}}
--{{warning body="These examples are definitely <u>not</u> examples of good scripting style."/}}
++So when writing the library, you don't have to worry about name confusion, just use the names of cues in your library and it will work as expected when the library is used. Names of cues that do not belong to the library will not be available in expressions (see Foo in the example above), however, names of other libraries in the file are available when referencing them in the ref attribute.
++Notes:
--(% style="color: rgb(0,0,0);text-decoration: none;" %)So when writing the library, you donΓÇÖt have to worry about name confusion, just use the names of cues in your library and it will work as expected when the library is used. Names of cues that do not belong to the library will not be available in expressions (see Foo in the example above), however, names of other libraries in the file are available when referencing them in the ref attribute.
++* It is //not// possible to directly call a cue which is 'inside' the library from 'outside' of the library, but it is possible to signal the library ref itself (possibly with parameters) and have a sub-cue inside the library listen to the signal on the library ref (possibly checking the parameters).
++* You //can// access variables in the library root but generally this should be avoided in favor of parameterizing the library!
++** there are some cases where you do want to access these variables directly, for example for maintaining savegame compatibility when patching.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Notes:
++== Library Parameters ==
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)It is //not// possible to directly call a cue which is 'inside' the library from 'outside' of the library, but it is possible to signal the library ref itself (possibly with parameters) and have a sub-cue inside the library listen to the signal on the library ref (possibly checking the parameters).
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)You //can// access variables in the library root but generally this should be avoided in favor of parameterizing the library!
--** (% style="color: rgb(0,0,0);text-decoration: none;" %)there are some cases where you do want to access these variables directly, for example for maintaining savegame compatibility when patching.
++A library can be parametrised, so that it can be adapted to the needs of a missions that uses it. You can define required and/or optional parameters for a library, and it will be validated at load time that the user of the library has provided all required parameters.
--(% id="library-parameters" %)
++Parameters are defined like this:
--== (% style="color: rgb(0,0,0);text-decoration: none;" %)Library Parameters(%%) ==
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)A library can be parametrised, so that it can be adapted to the needs of a missions that uses it. You can define required and/or optional parameters for a library, and it will be validated at load time that the user of the library has provided all required parameters.
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Parameters are defined like this:
--
  {{code language="xml"}}
  <library name="Lib" onfail="cancel">
    <params>
@@ -377,7 +377,7 @@
  </library>
  {{/code}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)If a default value is supplied, the parameter is regarded as optional, otherwise itΓÇÖs required. When providing the actual parameters in a referencing cue, note that there is no <params> node:
++If a default value is supplied, the parameter is regarded as optional, otherwise it's required. When providing the actual parameters in a referencing cue, note that there is no <params> node:
  {{code language="xml"}}
  <cue name="Foo" ref="Lib">
@@ -386,7 +386,7 @@
  </cue>
  {{/code}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)The values (including default values) can be variable expressions and will be evaluated when the cue is enabled, i.e. when it starts checking the conditions. They will be available to the cue as variables, using the parameter name with a ΓÇÿ$ΓÇÖ prefix. In the example above, the variables $foo, $bar, and $baz would be created.
++The values (including default values) can be variable expressions and will be evaluated when the cue is enabled, i.e. when it starts checking the conditions. They will be available to the cue as variables, using the parameter name with a ΓÇÿ$' prefix. In the example above, the variables $foo, $bar, and $baz would be created.
  {{code language="xml"}}
  <library name="Lib">
@@ -399,954 +399,870 @@
  </library>
  {{/code}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)If your library is supposed to provide a result to the library user, it is recommended to store a predefined variable in the library cue with a standardised name, e.g. $result. The user will be able to read it via CueName.$result. This variable does not have to be defined as a parameter but should be documented in the library.
++If your library is supposed to provide a result to the library user, it is recommended to store a predefined variable in the library cue with a standardised name, e.g. $result. The user will be able to read it via CueName.$result. This variable does not have to be defined as a parameter but should be documented in the library.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)
++= Instantiation =
++One of the possible cue attributes is //**instantiate**//. If you set it to true, this changes what happens when a cue's conditions are met. Normally, if a cue is not instantiated, the cue's actions are run (taking a delay node into account) and the cue is marked as completed. But with **instantiate'//, a// **copy of the cue** (and all its sub-cues) is made when the conditions are met, and it is this copy in which the actions are performed and it is the copy whose status is set to complete when they are finished - this means that the original cue (the so-called **static cue**) remains in the //waiting// state, and if the conditions are met again then the whole thing happens all over again.**
++\\An instantiating cue should only be used with conditions that are only going to be met once (or a fairly limited number of times), or with conditions that include an event condition. Instantiation should not be used in a cue which, say, just depends on the game time being greater than a specific value as this will result in a copy of the cue being made after each check interval, which could increase memory usage a lot. The most common use of an instantiated cue is in responding to events such as the player ship changing sector, to react every time that event happens.
++\\Instances that are created via //instantiate// are called **instantiated cues**. But sub-cues of instances are also instances (**sub-instances**) - they are created when they enter the waiting state. An instance is removed again (thereby freeing its memory) when it is complete or cancelled, and when all its instance sub-cues have been removed before. The simplest case is an instantiating cue with no sub-cues: The instance is created, the actions are performed, and the instance is removed immediately on completion. A pitfall could be an instance with a sub-cue that is forever in the waiting state (e.g. waiting for an event from an already destroyed object). It can never be removed, so you should clean up such a cue yourself, e.g. by cancelling it explicitly.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)┬á
++== Cleaning up instances explicitly ==
--(% id="instantiation" %)
++Cancelling a cue with **<cancel_cue>** also cancels all its sub-cues, and cancelling a static cue stops it from instantiating more cues - but it does not cancel its instances. Resetting a cue with **<reset_cue>** resets both sub-cues and instantiated cues, but has the (desired) side effect that condition checks will start again if the parent cue's state allows it. Even a sub-instance that has been reset can return to the //waiting// state. Resetting an instantiated cue will stop it forever, because it is not supposed to be in the //waiting// state (only its static cue is). Resetting will also induce the clean-up reliably, but keep in mind that this is not the case for instance sub-cues.
--= (% style="color: rgb(0,0,0);text-decoration: none;" %)Instantiation(%%) =
++{{info}}
++<cancel_cue> and <reset_cue> only take effect after all remaining actions of the current cue are performed. So you can even safely cancel the cue that you are currently in (keyword "'''this'''") or any ancestor cue, and still perform more actions afterwards.
++{{/info}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)One of the possible cue attributes is (%%)//**(% style="color: rgb(0,0,0);text-decoration: none;" %)instantiate(%%)**//(% style="color: rgb(0,0,0);text-decoration: none;" %). If you set it to true, this changes what happens when a cue's conditions are met. Normally, if a cue is (% style="color: rgb(0,0,0);text-decoration: underline;" %)not(% style="color: rgb(0,0,0);text-decoration: none;" %) instantiated, the cue's actions are run (taking a delay node into account) and the cue is marked as completed. But with (%%)//(% style="color: rgb(0,0,0);text-decoration: none;" %)instantiate////, a// (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)copy of the cue(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %) (and all its sub-cues) is made when the conditions are met, and it is this copy in which the actions are performed and it is the copy whose status is set to complete when they are finished - this means that the original cue (the so-called (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)static cue(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)) remains in the (%%)//(% style="color: rgb(0,0,0);text-decoration: none;" %)waiting// state, and if the conditions are met again then the whole thing happens all over again.
++== Access to instances ==
--(% style="color: rgb(0,0,0);text-decoration: none;" %)An instantiating cue should only be used with conditions that are only going to be met once (or a fairly limited number of times), or with conditions that include an event condition. Instantiation should (% style="color: rgb(0,0,0);text-decoration: underline;" %)not(% style="color: rgb(0,0,0);text-decoration: none;" %) be used in a cue which, say, just depends on the game time being greater than a specific value as this will result in a copy of the cue being made after each check interval, which could increase memory usage a lot. The most common use of an instantiated cue is in responding to events such as the player ship changing sector, to react every time that event happens.
++{{info}}
++This sub-section requires basic knowledge of script expressions.
++{{/info}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Instances that are created via (%%)//(% style="color: rgb(0,0,0);text-decoration: none;" %)instantiate// are called **instantiated cues**. But sub-cues of instances are also instances ((%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)sub-instances(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)) - they are created when they enter the waiting state. An instance is removed again (thereby freeing its memory) when it is complete or cancelled, and when all its instance sub-cues have been removed before. The simplest case is an instantiating cue with no sub-cues: The instance is created, the actions are performed, and the instance is removed immediately on completion. A pitfall could be an instance with a sub-cue that is forever in the waiting state (e.g. waiting for an event from an already destroyed object). It can never be removed, so you should clean up such a cue yourself, e.g. by cancelling it explicitly.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)
++In case of instances with sub-instances, you will often want to access a related instance from the current one. Like in the non-instance case, you can simply write the cue name in an expression to reference that cue. However, you should be aware of the pitfalls that are accompanied by this.
--(% id="cleaning-up-instances-explicitly" %)
++When you use a cue name from the same script in an expression, it will always be resolved to some cue - usually a static cue, even if it is still in the disabled state, but it can also be an instance, if it is "related" to the current one.
--== (% style="color: rgb(0,0,0);text-decoration: none;" %)Cleaning up instances explicitly(%%) ==
++Related means that this cue and the referenced cue have a common ancestor instance, and the referenced cue is a direct (non-instantiated) descendant of that common ancestor.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Cancelling a cue with (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)<cancel_cue>(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %) also cancels all its sub-cues, and cancelling a static cue stops it from instantiating more cues - but it does not cancel its instances. Resetting a cue with (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)<reset_cue>(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %) resets both sub-cues and instantiated cues, but has the (desired) side effect that condition checks will start again if the parent cueΓÇÖs state allows it. Even a sub-instance that has been reset can return to the (%%)//(% style="color: rgb(0,0,0);text-decoration: none;" %)waiting// state. Resetting an instantiated cue will stop it forever, because it is not supposed to be in the (%%)//(% style="color: rgb(0,0,0);text-decoration: none;" %)waiting// state (only its static cue is). Resetting will also induce the clean-up reliably, but keep in mind that this is not the case for instance sub-cues.
++Example chart:
--{{info body="<span style=~"color: rgb(0,0,0);text-decoration: none;~">&lt;cancel_cue&gt; and &lt;reset_cue&gt; only take effect after all remaining actions of the current cue are performed. So you can even safely cancel the cue that you are currently in (keyword ΓÇ£</span>'''<span style=~"color: rgb(0,0,0);text-decoration: none;~">this</span>'''<span style=~"color: rgb(0,0,0);text-decoration: none;~">ΓÇ¥) or any ancestor cue, and still perform more actions afterwards.</span>"/}}
++[[~[~[image:Mission Director Guide - Instantiation.png~|~|width="800px"~]~]>>attach:ARCHIVE_XRWIKI_Modding_support_Mission_Director_GuideMission_Director_Guide_-_Instantiation.png]]
++This chart represents a script of 5 cues: Foo, Bar, SubBar, Baz and SubBaz. Continuous arrows denote parent-child relationship. Foo and Baz are instantiating cues (highlighted with red border). The static cues always exist, although static children of instantiating cues can never become active. Instances only exist as long as they are needed.
++Example situations:
--(% id="access-to-instances" %)
++* In the static tree: Cue names in expressions are always resolved to the static cues.
++* In the inst-2 tree: "SubBar" in an expression will be resolved to SubBar (inst 2).
++* In the inst-1 tree: "SubBar" in an expression will be resolved to SubBar (static) (!) because the SubBar child of Bar (inst 1) does not exist yet, or not any more.
++* In the inst-2a tree: "SubBaz" in an expression will be resolved to SubBaz (inst 2a)
++* In the inst-2a tree: "Bar" in an expression will be resolved to Bar (inst 2) because Foo (inst 2) is a common ancestor.
++* In the inst-2 tree: "SubBaz" in an expression will be resolved to SubBaz (static) (!) because SubBaz (inst 2a) is **not** a direct descendant of the common ancestor Foo (inst 2), instead Baz (inst 2a) has been instantiated.
--== (% style="color: rgb(0,0,0);text-decoration: none;" %)Access to instances(%%) ==
++In expressions, you can use the cue property **static** to access the static cue that instantiated a cue. This does not work for sub-cues of other cues, and the result is not necessarily a real static cue! In the example above, it would only work for cues with a dotted arrow pointing at them, and is resolved to the source of the arrow. In other cases the result is null.
++To get the real static cue that always exists and serves as template for instances, use the property **staticbase**. This works for all cues, even for the static cues themselves.
++In general, to access ancestors of the current cue, you can also use the keyword **parent**, also recursively as properties of other cues (such as **parent.parent.parent).**
--{{note body="<span style=~"color: rgb(0,0,0);text-decoration: none;~">This sub-section requires basic knowledge of [[NULL|script expressions]].</span>"/}}
++You can store cue references in variables. But when storing an instance cue in a variable, and later accessing that variable, be aware that the instance may not exist any more. Use the property **exists** to check if an instance is still alive. (In contrast, non-instance cues always exist, but may be in the //disabled// or //cancelled// state.)
++== Pitfalls ==
++Some additional common pitfalls with respect to instantiation are listed here. There may be more.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)In case of instances with sub-instances, you will often want to access a related instance from the current one. Like in the non-instance case, you can simply write the cue name in an expression to reference that cue. However, you should be aware of the pitfalls that are accompanied by this.
++* **Conditions with results:** If the instantiating cue has conditions with results, those results are stored in variables - but in the variables of the static cue, not of the instance! So in the <actions> you have to access the variables via the **static **keyword:
--(% style="color: rgb(0,0,0);text-decoration: none;" %)When you use a cue name from the same script in an expression, it will always be resolved to some cue - usually a static cue, even if it is still in the disabled state, but it can also be an instance, if it is ΓÇ£relatedΓÇ¥ to the current one.
++{{code language="xml"}}  <debug_text text="static.$foo"/>{{/code}}
++It may even be necessary to copy the variables over to the instance because the static variables can be overwritten by the next condition check:
++{{code language="xml"}}<set_value name="$foo" exact="static.$foo"/>{{/code}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Related means that this cue and the referenced cue have a common ancestor instance, and the referenced cue is a direct (non-instantiated) descendant of that common ancestor.
++* **Resetting completed/cancelled instances:** As explained above, sub-instances are only created when needed (when going to the //waiting// state) and are destroyed when they are not needed any more (when they are completed or cancelled, including all sub-cues). There are cases in which you want to access cues that don't exist any more - it simply doesn't work. In some cases you are safe: You can be sure that all your ancestors exist, and instantiating cues won't be removed until they are cancelled. In some other cases you simply don't know and have to check if the instance is already (or still) there.
++* **Lifetime of instances:** Do not make assumptions about when an instance is removed! Just looking at it in the Debug Manager keeps it alive for the time being. So, sometimes you could still have a completed instance that wouldn't exist under other circumstances.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Example chart:
++= Expressions =
--(% style="color: rgb(0,0,0);text-decoration: none;" %)[[~[~[image:ARCHIVE_XRWIKI_Modding_support_Mission_Director_GuideMission_Director_Guide_-_Instantiation.png~|~|width="800px"~]~]>>attach:ARCHIVE_XRWIKI_Modding_support_Mission_Director_GuideMission_Director_Guide_-_Instantiation.png]]
++Most of the attribute values in actions and conditions are interpreted as script expressions and parsed accordingly. An expression is a phrase that can be evaluated to a single value. The simplest expressions are actual numeric values and strings, so called **literals:**
++* {{code language="xml"}}0{{/code}} (integer number)
++* {{code language="xml"}}0772{{/code}} (leading 0 means octal integer number)
++* {{code language="xml"}}3.14159{{/code}} (floating point number)
++* {{code language="xml"}}5e12{{/code}} (float in exponent notation, "times ten to the power of")
++* {{code language="xml"}}0xCAFE{{/code}} (hexadecimal integer number)
--(% style="color: rgb(0,0,0);text-decoration: none;" %)This chart represents a script of 5 cues: Foo, Bar, SubBar, Baz and SubBaz. Continuous arrows denote parent-child relationship. Foo and Baz are instantiating cues (highlighted with red border). The static cues always exist, although static children of instantiating cues can never become active. Instances only exist as long as they are needed.
++{{info}}
++Since octal numbers are hardly ever used (usually unknowingly), the parser is will produce a warning if an octal number is encountered."
++{{/info}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Example situations:
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)In the static tree: Cue names in expressions are always resolved to the static cues.
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)In the inst-2 tree: ΓÇ£SubBarΓÇ¥ in an expression will be resolved to SubBar (inst 2).
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)In the inst-1 tree: ΓÇ£SubBarΓÇ¥ in an expression will be resolved to SubBar (static) (!) because the SubBar child of Bar (inst 1) does not exist yet, or not any more.
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)In the inst-2a tree: ΓÇ£SubBazΓÇ¥ in an expression will be resolved to SubBaz (inst 2a)
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)In the inst-2a tree: ΓÇ£BarΓÇ¥ in an expression will be resolved to Bar (inst 2) because Foo (inst 2) is a common ancestor.
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)In the inst-2 tree: ΓÇ£SubBazΓÇ¥ in an expression will be resolved to SubBaz (static) (!) because SubBaz (inst 2a) is (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)not(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %) a direct descendant of the common ancestor Foo (inst 2), instead Baz (inst 2a) has been instantiated.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)In expressions, you can use the cue property (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)static(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %) to access the static cue that instantiated a cue. This does not work for sub-cues of other cues, and the result is not necessarily a real static cue! In the example above, it would only work for cues with a dotted arrow pointing at them, and is resolved to the source of the arrow. In other cases the result is null.
++You can write string literals by putting the string in single quotes:
--(% style="color: rgb(0,0,0);text-decoration: none;" %)To get the real static cue that always exists and serves as template for instances, use the property (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)staticbase(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %). This works for all cues, even for the static cues themselves.
++* {{code language="xml"}}'Hello world'{{/code}}
++* {{code language="xml"}}''{{/code}} (empty string)
++* {{code language="xml"}}'String with a line break\n'{{/code}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)In general, to access ancestors of the current cue, you can also use the keyword (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)parent(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %), also recursively as properties of other cues (such as (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)parent.parent.parent).(%%)**
++{{info}}
++Since expressions are written in XML attribute values, you have to use the single quotes inside the double quotes for the actual attribute value. To write characters like '''< > " &''' in an expression string (or anywhere else in an XML attribute value), you'll have to escape them as '''&lt; &gt; &quot; &amp;''' respectively. The backslash '''\''' can be used in strings for escape characters like in C/C++. Most important are '''\'''' for a single quote as part of the string, and '''
++''' for the backslash itself.
++{{/info}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)You can store cue references in variables. But when storing an instance cue in a variable, and later accessing that variable, be aware that the instance may not exist any more. Use the property (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)exists(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %) to check if an instance is still alive. (In contrast, non-instance cues always exist, but may be in the (%%)//(% style="color: rgb(0,0,0);text-decoration: none;" %)disabled// or (%%)//(% style="color: rgb(0,0,0);text-decoration: none;" %)cancelled// state.)
++== Numeric data types and suffixes ==
--(% style="color: rgb(0,0,0);text-decoration: none;" %)
++Numbers can have a suffix that determines their numeric type. There are also numerical data types like "money" or "time" which can only be expressed by using an appropriate unit suffix:
++* {{code language="xml"}}5000000000L{{/code}} (large integer)
++* {{code language="xml"}}1f{{/code}} (floating point number, same as 1.0, just 1 would be an integer)
++* {{code language="xml"}}1000Cr{{/code}} (Money in Credits, converted to 100000 cents automatically)
++* {{code language="xml"}}500m{{/code}} (Length in metres)
++* {{code language="xml"}}10s{{/code}} (Time in seconds)
++* {{code language="xml"}}1h{{/code}} (Time in hours, which is converted to 3600s automatically)
--(% id="pitfalls" %)
++A space between number and suffix is allowed.
--== (% style="color: rgb(0,0,0);text-decoration: none;" %)Pitfalls(%%) ==
++Here is the complete list of numeric data types and corresponding unit suffixes:
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Some additional common pitfalls with respect to instantiation are listed here. There may be more.
--
--* **(% style="color: rgb(0,0,0);text-decoration: none;" %)Conditions with results:(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %) If the instantiating cue has conditions with results, those results are stored in variables - but in the variables of the static cue, not of the instance! So in the <actions> you have to access the variables via the (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)static (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)keyword:
--\\{{code}}&lt;debug_text┬átext=&quot;static.$foo&quot;/&gt;{{/code}}(% style="color: rgb(0,0,255);text-decoration: none;" %)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)It may even be necessary to copy the variables over to the instance because the static variables can be overwritten by the next condition check:
--\\{{code}}&lt;set_value┬áname=&quot;$foo&quot;┬áexact=&quot;static.$foo&quot;/&gt;{{/code}}
--* **(% style="color: rgb(0,0,0);text-decoration: none;" %)Resetting completed/cancelled instances:(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %) As explained above, sub-instances are only created when needed (when going to the (%%)//(% style="color: rgb(0,0,0);text-decoration: none;" %)waiting// state) and are destroyed when they are not needed any more (when they are completed or cancelled, including all sub-cues). There are cases in which you want to access cues that donΓÇÖt exist any more - it simply doesnΓÇÖt work. In some cases you are safe: You can be sure that all your ancestors exist, and instantiating cues wonΓÇÖt be removed until they are cancelled. In some other cases you simply donΓÇÖt know and have to check if the instance is already (or still) there.
--* **(% style="color: rgb(0,0,0);text-decoration: none;" %)Lifetime of instances:(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %) Do not make assumptions about when an instance is removed! Just looking at it in the Debug Manager keeps it alive for the time being. So, sometimes you could still have a completed instance that wouldnΓÇÖt exist under other circumstances.
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)┬á
--
--(% id="categorybroken_macroanchorexpressions" %)
--
--= (% style="color: rgb(0,0,0);text-decoration: none;" %)Expressions(%%) =
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Most of the attribute values in actions and conditions are interpreted as script expressions and parsed accordingly. An expression is a phrase that can be evaluated to a single value. The simplest expressions are actual numeric values and strings, so called (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)literals:(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)
--
--
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}0{{/code}} (integer number)
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}0772{{/code}} (leading 0 means octal integer number)
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}3.14159{{/code}} (floating point number)
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}5e12{{/code}} (float in exponent notation, ΓÇ£times ten to the power ofΓÇ¥)
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}0xCAFE{{/code}} (hexadecimal integer number)
--
--
--
--{{note body="<span style=~"color: rgb(0,0,0);text-decoration: none;~">Since octal numbers are hardly ever used (usually unknowingly), the parser is will produce a warning if an octal number is encountered.</span>"/}}
--
--
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)You can write string literals by putting the string in single quotes:
--
--* {{code}}'Hello world'{{/code}}
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}''{{/code}} (empty string)
--* {{code}}'String with a line break\n'{{/code}}
--
--
--
--{{note body="<span style=~"color: rgb(0,0,0);text-decoration: none;~">Since expressions are written in XML attribute values, you have to use the single quotes inside the double quotes for the actual attribute value. To write characters like </span>'''<span style=~"color: rgb(0,0,0);text-decoration: none;~">&lt; &gt; &quot; &amp;</span>'''<span style=~"color: rgb(0,0,0);text-decoration: none;~"> in an expression string (or anywhere else in an XML attribute value), youΓÇÖll have to escape them as </span>'''<span style=~"color: rgb(0,0,0);text-decoration: none;~">&amp;lt; &amp;gt; &amp;quot; &amp;amp;</span>'''<span style=~"color: rgb(0,0,0);text-decoration: none;~"> respectively. The backslash '''\''' can be used in strings for escape characters like in C/C++. Most important are </span>'''<span style=~"color: rgb(0,0,0);text-decoration: none;~">\'</span>'''<span style=~"color: rgb(0,0,0);text-decoration: none;~"> for a single quote as part of the string, and </span>'''<span style=~"color: rgb(0,0,0);text-decoration: none;~">\\</span>'''<span style=~"color: rgb(0,0,0);text-decoration: none;~"> for the backslash itself.</span>"/}}
--
--
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)
--
--
--(% id="numeric-data-types-and-suffixes" %)
--
--== (% style="color: rgb(0,0,0);text-decoration: none;" %)Numeric data types and suffixes(%%) ==
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Numbers can have a suffix that determines their numeric type. There are also numerical data types like ΓÇ£moneyΓÇ¥ or ΓÇ£timeΓÇ¥ which can only be expressed by using an appropriate unit suffix:
--
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}5000000000L{{/code}} (large integer)
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}1f{{/code}} (floating point number, same as 1.0, just 1 would be an integer)
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}1000Cr{{/code}} (Money in Credits, converted to 100000 cents automatically)
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}500m{{/code}} (Length in metres)
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}10s{{/code}} (Time in seconds)
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}1h{{/code}} (Time in hours, which is converted to 3600s automatically)
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)A space between number and suffix is allowed.
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Here is the complete list of numeric data types and corresponding unit suffixes:
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)
--
--
  (% style="margin-left: 0.0px;" %)
  (((
--\\
--
--
--
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Data type|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Suffix|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Examples|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Description
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)null|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)(none)|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)null|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Converted to non-null data type of value 0 when needed.
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)integer|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)i|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)42|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)32-bit signed integer. Default for integer literals, so the suffix is not required for them.
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)largeint|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)L|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)0x1ffffffffL|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Large 64-bit signed integer.
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)float|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)f|
--(% style="color: rgb(0,0,0);text-decoration: none;" %)3.14(%%)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)0x100f|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)32-bit float (single precision). Default for floating point literals, so the suffix is not required for them.
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)largefloat|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)LF|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)1.5e300 LF|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Large 64-bit floating point number (double precision).
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)money|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)ct (default)
--\\Cr|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)200Cr
--\\50ct|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Money in Credits or cents, always stored in cents. Do not forget to write Cr when working with Credits.
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)length|
--(% style="color: rgb(0,0,0);text-decoration: none;" %)m (default)(%%)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)km|
--(% style="color: rgb(0,0,0);text-decoration: none;" %)500m(%%)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)2.3km|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Length in metres or kilometres, respectively. A length value is always stored in metres.
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)angle|
--(% style="color: rgb(0,0,0);text-decoration: none;" %)rad (default)(%%)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)deg|
--(% style="color: rgb(0,0,0);text-decoration: none;" %)90deg(%%)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)3.14159rad|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Angle in radians or degrees, respectively. An angle value is always stored in radians.
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)hitpoints|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)hp|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)100hp|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Hit points
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)time|
--(% style="color: rgb(0,0,0);text-decoration: none;" %)ms(%%)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)s (default)(%%)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)min(%%)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)h|
--(% style="color: rgb(0,0,0);text-decoration: none;" %)800ms(%%)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)1.5s(%%)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)10min(%%)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)24h|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Time in milliseconds, seconds, minutes, or hours, respectively. A time value is always stored in seconds.
++|Data type|Suffix|Examples|Description
++|null|(none)|null|Converted to non-null data type of value 0 when needed.
++|integer|i|42|32-bit signed integer. Default for integer literals, so the suffix is not required for them.
++|largeint|L|0x1ffffffffL|Large 64-bit signed integer.
++|float|f|
++3.14
++\\0x100f|32-bit float (single precision). Default for floating point literals, so the suffix is not required for them.
++|largefloat|LF|1.5e300 LF|Large 64-bit floating point number (double precision).
++|money|ct (default)
++\\Cr|200Cr
++\\50ct|Money in Credits or cents, always stored in cents. Do not forget to write Cr when working with Credits.
++|length|
++m (default)
++\\km|
++500m
++\\2.3km|Length in metres or kilometres, respectively. A length value is always stored in metres.
++|angle|
++rad (default)
++\\deg|
++90deg
++\\3.14159rad|Angle in radians or degrees, respectively. An angle value is always stored in radians.
++|hitpoints|hp|100hp|Hit points
++|time|
++ms
++\\s (default)
++\\min
++\\h|
++800ms
++\\1.5s
++\\10min
++\\24h|Time in milliseconds, seconds, minutes, or hours, respectively. A time value is always stored in seconds.
  )))
--{{note body="<span style=~"color: rgb(0,0,0);text-decoration: none;~">All unit data types are floating point types, except for money, which is an integer data type.</span>"/}}
++{{info}}
++All unit data types are floating point types, except for money, which is an integer data type.
++{{/info}}
--\\
++== Operators ==
++You can build expressions by combining sub-expressions with operators. For Boolean operations, expressions are considered "false" if they are equal to zero, "true" otherwise. The following operators, delimiters, and constants are supported
--
--(% id="categorybroken_macroanchoroperators" %)
--
--== (% style="color: rgb(0,0,0);text-decoration: none;" %)Operators(%%) ==
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)You can build expressions by combining sub-expressions with operators. For Boolean operations, expressions are considered ΓÇ£falseΓÇ¥ if they are equal to zero, ΓÇ£trueΓÇ¥ otherwise. The following operators, delimiters, and constants are supported:
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)
--
--
  (% style="margin-left: 0.0px;" %)
  (((
--\\
--
--
--
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Operator / Delimiter / Constant|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Type|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Example|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Result of example|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Description
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)null|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)constant|{{code}}null + 1{{/code}}|{{code}}1{{/code}}|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Null value, see above
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)false|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)constant|{{code}}1 == 0{{/code}}|{{code}}false{{/code}}|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Integer value 0, useful in Boolean expressions
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)true|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)constant|{{code}}null == 0{{/code}}|{{code}}true{{/code}}|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Integer value 1, useful in Boolean expressions
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)pi|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)constant|{{code}}2 * pi{{/code}}|{{code}}6.2831853rad{{/code}}|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)╧Ç as an angle (same as 180deg)
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)()|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)delimiter|{{code}}(2 + 4) * (6 + 1){{/code}}|{{code}}42{{/code}}|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Parentheses for arithmetic grouping
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)[]|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)delimiter|{{code}}[1, 2, 2+1, 'string']{{/code}}|{{code}}[1, 2, 3, 'string']{{/code}}|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)[[List>>MediaWiki.NULL]] of values
--|table[]|delimiter|{{code}}table[$foo='bar', {1+1}=40+2]{{/code}}|{{code}}table[$foo='bar', {2}=42]{{/code}}|[[Table>>MediaWiki.NULL]] of values
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %){}|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)delimiter|{{code}}{101, 3}{{/code}}|{{code}}'Some text'{{/code}}|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Text lookup (page ID and text ID) from TextDB
++|Operator / Delimiter / Constant|Type|Example|Result of example|Description
++|null|constant|{{code language="xml"}}null + 1{{/code}}|{{code language="xml"}}1{{/code}}|Null value, see above
++|false|constant|{{code language="xml"}}1 == 0{{/code}}|{{code language="xml"}}false{{/code}}|Integer value 0, useful in Boolean expressions
++|true|constant|{{code language="xml"}}null == 0{{/code}}|{{code language="xml"}}true{{/code}}|Integer value 1, useful in Boolean expressions
++|pi|constant|{{code language="xml"}}2 * pi{{/code}}|{{code language="xml"}}6.2831853rad{{/code}}|╧Ç as an angle (same as 180deg)
++|()|delimiter|{{code language="xml"}}(2 + 4) * (6 + 1){{/code}}|{{code language="xml"}}42{{/code}}|Parentheses for arithmetic grouping
++|[]|delimiter|{{code language="xml"}}[1, 2, 2+1, 'string']{{/code}}|{{code language="xml"}}[1, 2, 3, 'string']{{/code}}|[[List>>MediaWiki.NULL]] of values
++|table[]|delimiter|{{code language="xml"}}table[$foo='bar', {1+1}=40+2]{{/code}}|{{code language="xml"}}table[$foo='bar', {2}=42]{{/code}}|[[Table>>MediaWiki.NULL]] of values
++|{}|delimiter|{{code language="xml"}}{101, 3}{{/code}}|{{code language="xml"}}'Some text'{{/code}}|Text lookup (page ID and text ID) from TextDB
  \\(Note: Braces are also used for [[property lookups>>MediaWiki.NULL]])
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)+|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)unary|{{code}}+21 * (+2){{/code}}|{{code}}42{{/code}}|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Denotes positive number (no effect)
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)-|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)unary|{{code}}-(21 * -2){{/code}}|{{code}}42{{/code}}|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Negates the following number
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)not|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)unary|{{code}}not (21 == 42){{/code}}|{{code}}true{{/code}}|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Yields true if the following expression is false (equal to zero), false otherwise
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)typeof|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)unary|
--{{code}}typeof null{{/code}}
--\\{{code}}typeof 0{{/code}}
--\\{{code}}typeof 'Hello world'{{/code}}|
--{{code}}datatype.null{{/code}}
--\\{{code}}datatype.integer{{/code}}
--\\{{code}}datatype.string{{/code}}|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Yields the [[data type of the following sub-expression>>MediaWiki.NULL]]
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)sin|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)unary|
--{{code}}sin(30deg){{/code}}
--\\{{code}}sin(pi){{/code}}|
--{{code}}0.5{{/code}}
--\\{{code}}1.0{{/code}}|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Sine (function-style, parentheses required)
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)cos|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)unary|
--{{code}}cos(60deg){{/code}}
--\\{{code}}cos(pi){{/code}}|
--{{code}}0.5{{/code}}
--\\{{code}}0.0{{/code}}|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Cosine (function-style, parentheses required)
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)sqrt|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)unary|{{code}}sqrt(2){{/code}}|{{code}}1.414213LF{{/code}}|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Square root (function-style, parentheses required)
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)exp|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)unary|{{code}}exp(1){{/code}}|{{code}}2.71828LF{{/code}}|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Exponential function (function-style, parentheses required)
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)log|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)unary|{{code}}log(8) / log(2){{/code}}|{{code}}3.0LF{{/code}}|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Natural logarithm (function-style, parentheses required)
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)^|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)binary|{{code}}10 ^ 3{{/code}}|{{code}}1000.0LF{{/code}}|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Power
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)*|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)binary|{{code}}21 * 2{{/code}}|{{code}}42{{/code}}|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Multiplication
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)/|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)binary|{{code}}42 / 1042.0 / 10.0{{/code}}|{{code}}44.2{{/code}}|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Division
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)%|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)binary|{{code}}42 % 10{{/code}}|{{code}}2{{/code}}|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Modulus (remainder of integer division)
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)+|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)binary|
--{{code}}1 + 1{{/code}}
--\\{{code}}'Hello' + ' world'{{/code}}|
--{{code}}2{{/code}}
--\\{{code}}'Hello world'{{/code}}|
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Addition(%%)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)String concatenation
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)-|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)binary|{{code}}1 - 1{{/code}}|{{code}}0{{/code}}|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Subtraction
++|+|unary|{{code language="xml"}}+21 * (+2){{/code}}|{{code language="xml"}}42{{/code}}|Denotes positive number (no effect)
++|-|unary|{{code language="xml"}}-(21 * -2){{/code}}|{{code language="xml"}}42{{/code}}|Negates the following number
++|not|unary|{{code language="xml"}}not (21 == 42){{/code}}|{{code language="xml"}}true{{/code}}|Yields true if the following expression is false (equal to zero), false otherwise
++|typeof|unary|
++{{code language="xml"}}typeof null{{/code}}
++\\{{code language="xml"}}typeof 0{{/code}}
++\\{{code language="xml"}}typeof 'Hello world'{{/code}}|
++{{code language="xml"}}datatype.null{{/code}}
++\\{{code language="xml"}}datatype.integer{{/code}}
++\\{{code language="xml"}}datatype.string{{/code}}|Yields the [[data type of the following sub-expression>>MediaWiki.NULL]]
++|sin|unary|
++{{code language="xml"}}sin(30deg){{/code}}
++\\{{code language="xml"}}sin(pi){{/code}}|
++{{code language="xml"}}0.5{{/code}}
++\\{{code language="xml"}}1.0{{/code}}|Sine (function-style, parentheses required)
++|cos|unary|
++{{code language="xml"}}cos(60deg){{/code}}
++\\{{code language="xml"}}cos(pi){{/code}}|
++{{code language="xml"}}0.5{{/code}}
++\\{{code language="xml"}}0.0{{/code}}|Cosine (function-style, parentheses required)
++|sqrt|unary|{{code language="xml"}}sqrt(2){{/code}}|{{code language="xml"}}1.414213LF{{/code}}|Square root (function-style, parentheses required)
++|exp|unary|{{code language="xml"}}exp(1){{/code}}|{{code language="xml"}}2.71828LF{{/code}}|Exponential function (function-style, parentheses required)
++|log|unary|{{code language="xml"}}log(8) / log(2){{/code}}|{{code language="xml"}}3.0LF{{/code}}|Natural logarithm (function-style, parentheses required)
++|^|binary|{{code language="xml"}}10 ^ 3{{/code}}|{{code language="xml"}}1000.0LF{{/code}}|Power
++|*|binary|{{code language="xml"}}21 * 2{{/code}}|{{code language="xml"}}42{{/code}}|Multiplication
++|/|binary|{{code language="xml"}}42 / 1042.0 / 10.0{{/code}}|{{code language="xml"}}44.2{{/code}}|Division
++|%|binary|{{code language="xml"}}42 % 10{{/code}}|{{code language="xml"}}2{{/code}}|Modulus (remainder of integer division)
++|+|binary|
++{{code language="xml"}}1 + 1{{/code}}
++\\{{code language="xml"}}'Hello' + ' world'{{/code}}|
++{{code language="xml"}}2{{/code}}
++\\{{code language="xml"}}'Hello world'{{/code}}|
++Addition
++\\String concatenation
++|-|binary|{{code language="xml"}}1 - 1{{/code}}|{{code language="xml"}}0{{/code}}|Subtraction
  |
--(% style="color: rgb(0,0,0);text-decoration: none;" %)lt(%%)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)&lt; (<)|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)binary|
--{{code}}1 lt 3{{/code}}
--\\{{code}}1 &amp;lt; 3{{/code}}|{{code}}true{{/code}}|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Less than
++lt
++\\< (<)|binary|
++{{code language="xml"}}1 lt 3{{/code}}
++\\{{code language="xml"}}1 < 3{{/code}}|{{code language="xml"}}true{{/code}}|Less than
  |
--(% style="color: rgb(0,0,0);text-decoration: none;" %)le(%%)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)&lt;=|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)binary|
--{{code}}1 le 3{{/code}}
--\\{{code}}1 &amp;lt;= 3{{/code}}|{{code}}true{{/code}}|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Less than or equal to
++le
++\\<=|binary|
++{{code language="xml"}}1 le 3{{/code}}
++\\{{code language="xml"}}1 <= 3{{/code}}|{{code language="xml"}}true{{/code}}|Less than or equal to
  |
--(% style="color: rgb(0,0,0);text-decoration: none;" %)gt(%%)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)&gt; (>)|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)binary|
--{{code}}1 gt 3{{/code}}
--\\{{code}}1 &amp;gt; 3{{/code}}|{{code}}false{{/code}}|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Greater than
++gt
++\\> (>)|binary|
++{{code language="xml"}}1 gt 3{{/code}}
++\\{{code language="xml"}}1 < 3{{/code}}|{{code language="xml"}}false{{/code}}|Greater than
  |
--(% style="color: rgb(0,0,0);text-decoration: none;" %)ge(%%)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)&gt;=|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)binary|
--{{code}}1 ge 3{{/code}}
--\\{{code}}1 &amp;gt;= 3{{/code}}|{{code}}false{{/code}}|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Greater than or equal to
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)==|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)binary|{{code}}1 + 1 == 2.0{{/code}}|{{code}}true{{/code}}|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Equal to
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)~!=|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)binary|{{code}}1 + 1 != 2.0{{/code}}|{{code}}false{{/code}}|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Not equal to
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)and|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)binary|{{code}}true and false{{/code}}|{{code}}false{{/code}}|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Logical AND (short-circuit semantics)
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)or|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)binary|{{code}}true or false{{/code}}|{{code}}true{{/code}}|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Logical OR (short-circuit semantics)
++ge
++\\>=|binary|
++{{code language="xml"}}1 ge 3{{/code}}
++\\{{code language="xml"}}1 <= 3{{/code}}|{{code language="xml"}}false{{/code}}|Greater than or equal to
++|(((
++=  =
++)))|binary|{{code language="xml"}}1 + 1 == 2.0{{/code}}|{{code language="xml"}}true{{/code}}|Equal to
++|~!=|binary|{{code language="xml"}}1 + 1 != 2.0{{/code}}|{{code language="xml"}}false{{/code}}|Not equal to
++|and|binary|{{code language="xml"}}true and false{{/code}}|{{code language="xml"}}false{{/code}}|Logical AND (short-circuit semantics)
++|or|binary|{{code language="xml"}}true or false{{/code}}|{{code language="xml"}}true{{/code}}|Logical OR (short-circuit semantics)
  |
  if ... then ...
  \\if ... then ... else ...|ternary|
--{{code}}if 1 == 2 then 'F'{{/code}}
--\\{{code}}if 1 == 2 then 'F' else 'T'{{/code}}|
--{{code}}null{{/code}}
--\\{{code}}'T'{{/code}}|Conditional operator ("inline if")
--
--
--\\
--
--
++{{code language="xml"}}if 1 == 2 then 'F'{{/code}}
++\\{{code language="xml"}}if 1 == 2 then 'F' else 'T'{{/code}}|
++{{code language="xml"}}null{{/code}}
++\\{{code language="xml"}}'T'{{/code}}|Conditional operator ("inline if")
  )))
--(% id="operator-precedence-rules" %)
--=== (% style="color: rgb(0,0,0);text-decoration: none;" %)Operator precedence rules(%%) ===
++=== Operator precedence rules ===
--(% style="color: rgb(0,0,0);text-decoration: none;" %)You can group sub-expressions using parentheses, but if you donΓÇÖt, the following order of operations is applied, so that 5-1+2*3 == 10 as you would expect. The order is the same as in the table above, but there are operators with the same precedence - these are applied from left to right.
++You can group sub-expressions using parentheses, but if you don't, the following order of operations is applied, so that 5-1+2*3 == 10 as you would expect. The order is the same as in the table above, but there are operators with the same precedence - these are applied from left to right.
++* Unary operators: +, -, not, typeof, function-style operators (highest precedence)
++* Power operator: ^
++* Multiplicative: *, /, %
++* Additive: +, -
++* Comparison: lt, le, gt, ge
++* Equality: ==, !=
++* and
++* or
++* if/then/else (lowest precedence)
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)Unary operators: +, -, not, typeof, function-style operators (highest precedence)
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)Power operator: ^
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)Multiplicative: *, /, %
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)Additive: +, -
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)Comparison: lt, le, gt, ge
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)Equality: ==, !=
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)and
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)or
--* if/then/else(% style="color: rgb(0,0,0);text-decoration: none;" %) (lowest precedence)
--(% id="type-conversion" %)
++=== Type conversion ===
--=== (% style="color: rgb(0,0,0);text-decoration: none;" %)Type conversion(%%) ===
++When a binary arithmetic operator is used on numbers of different types, they will be converted to a suitable output type. The resulting type depends on whether a unit data type is involved (types that are not plain integers or floats). The following cases may occur:
--(% style="color: rgb(0,0,0);text-decoration: none;" %)When a binary arithmetic operator is used on numbers of different types, they will be converted to a suitable output type. The resulting type depends on whether a unit data type is involved (types that are not plain integers or floats). The following cases may occur:
++* Null and something else: The null value will be interpreted as "0" of the other type.
++* Two non-unit integers: The result will be an integer of the largest involved type.
++* Two non-unit numbers, not all integers: The result will be the largest involved float type.
++* Non-unit and unit: The result will be the unit type.
++* Two different units: The types are incompatible. This is an error, the result is undefined.
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)Null and something else: The null value will be interpreted as ΓÇ£0ΓÇ¥ of the other type.
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)Two non-unit integers: The result will be an integer of the largest involved type.
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)Two non-unit numbers, not all integers: The result will be the largest involved float type.
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)Non-unit and unit: The result will be the unit type.
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)Two different units: The types are incompatible. This is an error, the result is undefined.
++For multiplication and division, this may not be intuitive in all cases: Dividing a length by another length results in a length - so if you want to have a simple float as a result, you will have to convert it manually.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)For multiplication and division, this may not be intuitive in all cases: Dividing a length by another length results in a length - so if you want to have a simple float as a result, you will have to convert it manually.
++There is a way to convert a number into a different type manually: You append the corresponding suffix to a sub-expression in parentheses, like this:
--(% style="color: rgb(0,0,0);text-decoration: none;" %)There is a way to convert a number into a different type manually: You append the corresponding suffix to a sub-expression in parentheses, like this:
++* {{code language="xml"}}(1 + 1)f{{/code}} ⟹ {{code language="xml"}}2f{{/code}} ⟹ {{code language="xml"}}2.0{{/code}}
++* {{code language="xml"}}(1h) m / (180deg) i{{/code}} ⟹ {{code language="xml"}}(3600s) m / (3.14rad) i{{/code}} ⟹ {{code language="xml"}}3600m / 3{{/code}} ⟹ {{code language="xml"}}1200m{{/code}}
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}(1 + 1)f{{/code}} Γƒ╣ {{code}}2f{{/code}} Γƒ╣ {{code}}2.0{{/code}}
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}(1h) m / (180deg) i{{/code}} Γƒ╣ {{code}}(3600s) m / (3.14rad) i{{/code}} Γƒ╣ {{code}}3600m / 3{{/code}} Γƒ╣ {{code}}1200m{{/code}}
++When converting to a non-default unit type, this means you interpret the number as in the given units: "{{code language="xml"}}(1km + 500m)h{{/code}}" means that you interpret 1500m as 1500 hours, so the resulting value will be 1500x3600 seconds. (As stated above, the default unit for a length is metres.)
--(% style="color: rgb(0,0,0);text-decoration: none;" %)When converting to a non-default unit type, this means you interpret the number as in the given units: ΓÇ£{{code}}(1km + 500m)h{{/code}}ΓÇ¥ means that you interpret 1500m as 1500 hours, so the resulting value will be 1500x3600 seconds. (As stated above, the default unit for a length is metres.)
++The division operation will be an integer division (rounding towards zero) if both operands are integers (see the example in the table above). So if you want to get a floating point result, you have to make sure that at least one of the operands is a floating point type.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)The division operation will be an integer division (rounding towards zero) if both operands are integers (see the example in the table above). So if you want to get a floating point result, you have to make sure that at least one of the operands is a floating point type.
++Every data type can be combined with a string with the + operator, and will be converted to a string representation. That way you can also concatenate strings and numbers:
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Every data type can be combined with a string with the + operator, and will be converted to a string representation. That way you can also concatenate strings and numbers:
++* {{code language="xml"}}'One plus one is equal to ' + (1+1) + '.'{{/code}} ⟹ {{code language="xml"}}'One plus one is equal to 2.'{{/code}}
++* {{code language="xml"}}'One plus one is not equal to ' + 1 + 1 + '.'{{/code}} ⟹ {{code language="xml"}}'One plus one is not equal to 11.'{{/code}}
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}'One plus one is equal to ' + (1+1) + '.'{{/code}} Γƒ╣ {{code}}'One plus one is equal to 2.'{{/code}}
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}'One plus one is not equal to ' + 1 + 1 + '.'{{/code}} Γƒ╣ {{code}}'One plus one is not equal to 11.'{{/code}}
++As you can see, operators of the same precedence (+ in this case) are always evaluated from left to right.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)As you can see, operators of the same precedence (+ in this case) are always evaluated from left to right.
--(% id="boolean-operators" %)
++=== Boolean operators ===
--=== (% style="color: rgb(0,0,0);text-decoration: none;" %)Boolean operators(%%) ===
++Some additional notes on Boolean operators (such as and, or, not, ==):
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Some additional notes on Boolean operators (such as and, or, not, ==):
++* Of course a Boolean operation always results in true or false (integer 1 or 0).
++* Values of any type can be used as Boolean operands, e.g. for "and". They will be interpreted as "true" if they are **non-zero** or **non-numeric**.
++* != and == can be used with any data types, even non-numeric ones. When comparing two numeric values, they are converted using the rules above. Values of non-numeric types are never equal to null, or to any other numbers.
++* "and" and "or" use short-circuit semantics: The right side of the operation can be skipped if the left side already determines the outcome of the operation
++** Example:{{code language="xml"}} false and $foo{{/code}} ⟹ {{code language="xml"}}false{{/code}} (the value of $foo is not checked at all)
++* Unlike != and ==, the comparison operators <, <=, >, >= are only supported **for numeric values**, **difficulty levels**, and **attention levels**. Comparing other non-numeric values will result in an error and an undefined result.
++* <, <=, >, >= cannot be used in XML directly, so lt, le, gt, ge are provided as alternatives. In some cases you won't have to use them, though - using [[range checks>>MediaWiki.NULL]] with additional XML attributes can be more readable.
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)Of course a Boolean operation always results in true or false (integer 1 or 0).
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)Values of any type can be used as Boolean operands, e.g. for ΓÇ£andΓÇ¥. They will be interpreted as ΓÇ£trueΓÇ¥ if they are (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)non-zero(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %) or (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)non-numeric(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %).
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)!= and == can be used with any data types, even non-numeric ones. When comparing two numeric values, they are converted using the rules above. Values of non-numeric types are never equal to null, or to any other numbers.
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)ΓÇ£andΓÇ¥ and ΓÇ£orΓÇ¥ use short-circuit semantics: The right side of the operation can be skipped if the left side already determines the outcome of the operation
--** Example:(% style="color: rgb(0,0,0);text-decoration: none;" %){{code}} false and $foo{{/code}} (% style="color: rgb(0,0,0);text-decoration: none;" %)Γƒ╣(%%) {{code}}false{{/code}} (the value of $foo is not checked at all)
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)Unlike != and ==, the comparison operators <, <=, >, >= are only supported (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)for numeric values(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %), (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)difficulty levels(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %), and (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)attention levels(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %). Comparing other non-numeric values will result in an error and an undefined result.
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)<, <=, >, >= cannot be used in XML directly, so lt, le, gt, ge are provided as alternatives. In some cases you wonΓÇÖt have to use them, though - using [[range checks>>MediaWiki.NULL]] with additional XML attributes can be more readable.
++(% id="categorybroken_macroanchorstrings-and-formatting" %)== Strings and formatting==
--(% style="color: rgb(0,0,0);text-decoration: none;" %)
++{{{==}}}
--(% id="categorybroken_macroanchorstrings-and-formatting" %)(%%)
--~== (% style="color: rgb(0,0,0);text-decoration: none;" %)Strings and formatting
--\\(%%) ==
++You can concatenate string literals using the + operator, but there is also a printf-like formatting syntax, which is easier to use than concatenating lots of small pieces:
--(% style="color: rgb(0,0,0);text-decoration: none;" %)You can concatenate string literals using the + operator, but there is also a printf-like formatting syntax, which is easier to use than concatenating lots of small pieces:
++* {{code language="xml"}}'The %1 %2 %3 jumps over the %5 %4'.['quick', 'brown', 'fox', 'dog', 'lazy']{{/code}}
++* {{code language="xml"}}'%1 + %2 = %3'.[$a, $b, $a + $b]{{/code}}
--* {{code}}'The %1 %2 %3 jumps over the %5 %4'.['quick', 'brown', 'fox', 'dog', 'lazy']{{/code}}
--* {{code}}'%1 + %2 = %3'.[$a, $b, $a + $b]{{/code}}
++See also the section about [[value properties>>MediaWiki.NULL]].
--(% style="color: rgb(0,0,0);text-decoration: none;" %)See also the section about [[value properties>>MediaWiki.NULL]].
++Instead of ΓÇÿ%1 %2 %3', you can also use ΓÇÿ%s %s %s', which is also compatible with Lua string formatting in the UI system. However, this should only be used if you are sure that the order is the same in all supported languages. If you want to make translators aware that they can change the order of parameters, you should prefer '%1 %2 %3'.
++\\To get a percent character in the result string, use '%%' in the format string.
++\\\\\\If you need a more sophisticated method for text substitution, try **<substitute_text>**. See the XML schema documentation for this script action.
++\\**[New as of X Rebirth 4.0]**
++\\ With the formatting syntax above, it is even possible to control how the parameter is formatted, using modifiers between "%" and the parameter specifier ("s" or the parameter number):
--Instead of ΓÇÿ%1 %2 %3ΓÇÖ, you can also use ΓÇÿ%s %s %sΓÇÖ, which is also compatible with Lua string formatting in the UI system. However, this should only be used if you are sure that the order is the same in all supported languages. If you want to make translators aware that they can change the order of parameters, you should prefer '%1 %2 %3'.
++* {{code language="xml"}}'%,s'.[12345678]{{/code}} ⟹ {{code language="xml"}}'12,345,678'{{/code}} (the "," modifier shows a number with thousands separators, correctly localised)
++* {{code language="xml"}}'%.3s'.[123.4]{{/code}} ⟹ {{code language="xml"}}'123.400'{{/code}} (show 3 fractional digits, rounding half away from zero - decimal point correctly localised)
++* {{code language="xml"}}'%,.1s'.[12345.67]'{{/code}} ⟹ {{code language="xml"}}'12,345.7'{{/code}} (combination of the above)
--To get a percent character in the result string, use '%%' in the format string.
--
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)If you need a more sophisticated method for text substitution, try (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)<substitute_text>(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %). See the XML schema documentation for this script action.
--
--**[New as of X Rebirth 4.0]**
--
--With the formatting syntax above, it is even possible to control how the parameter is formatted, using modifiers between "%" and the parameter specifier ("s" or the parameter number):
--
--* {{code}}'%,s'.[12345678]{{/code}} (% style="color: rgb(0,0,0);text-decoration: none;" %)Γƒ╣(%%) {{code}}'12,345,678'{{/code}} (the "," modifier shows a number with thousands separators, correctly localised)
--* {{code}}'%.3s'.[123.4]{{/code}} (% style="color: rgb(0,0,0);text-decoration: none;" %)Γƒ╣(%%) {{code}}'123.400'{{/code}} (show 3 fractional digits, rounding half away from zero - decimal point correctly localised)
--* {{code}}'%,.1s'.[12345.67]'{{/code}} (% style="color: rgb(0,0,0);text-decoration: none;" %)Γƒ╣(%%) {{code}}'12,345.7'{{/code}} (combination of the above)
--
  Additional remarks:
  * The "," and "." formatting modifiers only apply to numbers. They are ignored if used on values of other types.
--* ┬áIf "," is used without "." then any fractional digits are discarded.
++*  If "," is used without "." then any fractional digits are discarded.
  * "." must be followed by a single digit (0-9). In case of ".0" any fractional digits are discarded (rounding towards zero, not half away from zero).
++{{info}}
++There are also special methods to [[NULL|format money values and time values]] using the "formatted" property.
++{{/info}}
++== Lists ==
--{{info body="<span style=~"color: rgb(0,0,0);text-decoration: none;~">There are also special methods to [[NULL|format money values and time values]] using the &quot;formatted&quot; property.</span>"/}}
++Another example for a non-numeric value is a list: It is an ordered collection of other arbitrary values (called array or vector in other languages). It can be constructed within an expression using the [[~[~] syntax>>MediaWiki.NULL]]. It may also be generated by special actions and conditions, and there are actions that can [[insert or remove values>>MediaWiki.NULL]].
++A list can contain values of arbitrary data types, even mixed in the same list - so a list can actually contain other lists. However, some of the things that you can do with lists require that all contained elements are of a certain type. The contents of a list can be accessed via properties, see the section about [[value properties>>MediaWiki.NULL]]. Lists can be empty, these are written as "[ ]".
++{{info}}
++When accessing a list's elements, the numbering is '''1-based''', so the first element has number 1. This is intuitive but different from 0-based numbering in most programming languages."
++{{/info}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)
++Lists are stored in variables as references, so multiple variables can refer to the same **shared list**: If you change a shared list through a variable, e.g. by changing the value of an element, you change it as well for all other variables. However, the operators == and != can also be used on two distinct lists to compare their elements.
++{{info}}
++When using <remove_from_list/>, be aware that all elements are checked and potentially removed during the action. Do not provide this action with a index lookup of that list as it may become out of bounds.
--(% id="categorybroken_macroanchorlists" %)
++Bad usage attempting to remove the last element of the list: <remove_from_list name="$List" exact="$List.{$List.count}"/>
--== (% style="color: rgb(0,0,0);text-decoration: none;" %)Lists(%%) ==
++If you know the index, simply use <remove_value/> e.g. <remove_value name="$List.{$List.count}"/>
++{{/info}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Another example for a non-numeric value is a list: It is an ordered collection of other arbitrary values (called array or vector in other languages). It can be constructed within an expression using the [[~[~] syntax>>MediaWiki.NULL]]. It may also be generated by special actions and conditions, and there are actions that can [[insert or remove values>>MediaWiki.NULL]].
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)A list can contain values of arbitrary data types, even mixed in the same list - so a list can actually contain other lists. However, some of the things that you can do with lists require that all contained elements are of a certain type. The contents of a list can be accessed via properties, see the section about [[value properties>>MediaWiki.NULL]]. Lists can be empty, these are written as ΓÇ£[ ]ΓÇ¥.
--
--{{note body="<span style=~"color: rgb(0,0,0);text-decoration: none;~">When accessing a listΓÇÖs elements, the numbering is </span>'''<span style=~"color: rgb(0,0,0);text-decoration: none;~">1-based</span>'''<span style=~"color: rgb(0,0,0);text-decoration: none;~">, so the first element has number 1. This is intuitive but different from 0-based numbering in most programming languages.</span>"/}}
--
--
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Lists are stored in variables as references, so multiple variables can refer to the same (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)shared list(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %): If you change a shared list through a variable, e.g. by changing the value of an element, you change it as well for all other variables. However, the operators == and != can also be used on two distinct lists to compare their elements.
--
--{{note body="When using &lt;remove_from_list/&gt;, be aware that all elements are checked and potentially removed during the action. Do not provide this action with a index lookup of that list as it may become out of bounds.
--
--Bad usage attempting to remove the last element of the list: &lt;remove_from_list name=&quot;$List&quot; exact=&quot;$List.{$List.count}&quot;/&gt;
--
--If you know the index, simply use &lt;remove_value/&gt; e.g. &lt;remove_value name=&quot;$List.{$List.count}&quot;/&gt;"/}}
--
--
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)
--
--
  (% id="categorybroken_macroanchortables" %)
++== Tables ==
--== (% style="color: rgb(0,0,0);text-decoration: none;" %)Tables(%%) ==
++Tables are associative arrays - they are like lists, but you can assign values to (almost) arbitrary keys, not just to index numbers. A table is constructed within an expression using the [[table~[~] syntax>>MediaWiki.NULL]]. See the section about [[value properties>>MediaWiki.NULL]] for how to access the contents of a table. [[Creating and removing entries>>MediaWiki.NULL]] works similarly to lists, but instead of inserting, you simply assign a value to a table key. If the key does not exist yet, it will be created.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Tables are associative arrays - they are like lists, but you can assign values to (almost) arbitrary keys, not just to index numbers. A table is constructed within an expression using the [[table~[~] syntax>>MediaWiki.NULL]]. See the section about [[value properties>>MediaWiki.NULL]] for how to access the contents of a table. [[Creating and removing entries>>MediaWiki.NULL]] works similarly to lists, but instead of inserting, you simply assign a value to a table key. If the key does not exist yet, it will be created.
++Almost all values are allowed as table keys, but there are a few exceptions:
++* Strings must start with '$', like variables
++* null cannot be used as table key (but the number 0 is valid)
++* Lists, tables, groups and buildplans cannot be used as table keys
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Almost all values are allowed as table keys, but there are a few exceptions:
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)Strings must start with '$', like variables
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)null cannot be used as table key (but the number 0 is valid)
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)Lists, tables, groups and buildplans cannot be used as table keys
--\\
++These restrictions only apply to the keys, there are no restrictions for values that you assign to them. For example:
--(% style="color: rgb(0,0,0);text-decoration: none;" %)These restrictions only apply to the keys, there are no restrictions for values that you assign to them. For example:
++* {{code language="xml"}}table[]{{/code}} ⟹ creates an empty table
++* {{code language="xml"}}table[{0} = null]{{/code}} ⟹ creates a table that maps the number 0 to null
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}table[]{{/code}} (% style="color: rgb(0,0,0);text-decoration: none;" %)Γƒ╣(%%) creates an empty table
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}table[{0} = null]{{/code}} (% style="color: rgb(0,0,0);text-decoration: none;" %)Γƒ╣(%%) creates a table that maps the number 0 to null
++* {{code language="xml"}}table[{'$foo'} = 'bar']{{/code}} ⟹ a table that maps the string '$foo' to the string 'bar'
++* {{code language="xml"}}table[$foo = 'bar']{{/code}} ⟹ exactly the same, just a shorter notation for string keys
++* {{code language="xml"}}table[foo = 'bar']{{/code}} ⟹ error, 'foo' does not start with a '$'
++* {{code language="xml"}}table[{1} = [], {2} = table[]] {{/code}} ⟹ a table that maps 1 to an empty list and 2 to an empty table
++Just like lists, tables are stored as references, so it's possible that multiple variables reference the same table (see above).
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}table[{'$foo'} = 'bar']{{/code}} (% style="color: rgb(0,0,0);text-decoration: none;" %)Γƒ╣(%%) a table that maps the string '$foo' to the string 'bar'
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}table[$foo = 'bar']{{/code}} (% style="color: rgb(0,0,0);text-decoration: none;" %)(% style="color: rgb(0,0,0);text-decoration: none;" %)Γƒ╣(%%) exactly the same, just a shorter notation(%%) for string keys
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}table[foo = 'bar']{{/code}} (% style="color: rgb(0,0,0);text-decoration: none;" %)Γƒ╣(%%) error, 'foo' does not start with a '$'
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}table[{1} = [], {2} = table[]] {{/code}} (% style="color: rgb(0,0,0);text-decoration: none;" %)Γƒ╣(%%) a table that maps 1 to an empty list and 2 to an empty table
++== Value properties ==
++Properties are a crucial concept in script expressions. In the previous sections you have seen mostly constant expressions, which are already evaluated when they are parsed at game start. For reading and writing variables and evaluating the game's state, properties are used.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Just like lists, tables are stored as references, so it's possible that multiple variables reference the same table (see above).
++Numbers don't have any properties. Lists, for example, have quite a few of them: You can access the number of elements; and each element is also a property of the list. A ship can have properties like its name, the ship class, its position etc.
++You can imagine properties as key/value pairs in an associative mapping: You pass the key, and you get the value as result. For example, the list [42, null, 'text'] has the following mapping:
--(% style="color: rgb(0,0,0);text-decoration: none;" %)
++* 1 ⟹ 42
++* 2 ⟹ null
++* 3 ⟹ 'text'
++* 'count' ⟹ 3
++As you can see, a property key can be a number or a string. Actually there is no restriction regarding the data type of the key.
--(% id="categorybroken_macroanchorvalue-properties" %)
++You can look up a property by appending a dot and the key in curly braces:
--== (% style="color: rgb(0,0,0);text-decoration: none;" %)Value properties(%%) ==
++* {{code language="xml"}}[100, 200, 300, 400].{1}{{/code}} ⟹ 100 (reading the first element)
++* {{code language="xml"}}[100, 200, ['Hello ', 'world']] .{3}.{2}{{/code}} ⟹ 'world' (second element of the inner list, which is the third element of the outer list)
++* {{code language="xml"}}[].{'count'}{{/code}} ⟹ 0
++* {{code language="xml"}}table[{21} = 42].{21}{{/code}} ⟹ 42
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Properties are a crucial concept in script expressions. In the previous sections you have seen mostly constant expressions, which are already evaluated when they are parsed at game start. For reading and writing variables and evaluating the gameΓÇÖs state, properties are used.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Numbers donΓÇÖt have any properties. Lists, for example, have quite a few of them: You can access the number of elements; and each element is also a property of the list. A ship can have properties like its name, the ship class, its position etc.
++In most cases the property key is a fixed string, like "name" or "class". You can write this like above:
--(% style="color: rgb(0,0,0);text-decoration: none;" %)You can imagine properties as key/value pairs in an associative mapping: You pass the key, and you get the value as result. For example, the list [42, null, 'text'] has the following mapping:
++* {{code language="xml"}}[42].{'count'}{{/code}}
++* {{code language="xml"}}$ship.{'name'}{{/code}}
++* {{code language="xml"}}$ship.{'class'}{{/code}}
++* {{code language="xml"}}table[$foo='bar'].{'$foo'}{{/code}}
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)1 Γƒ╣ 42
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)2 Γƒ╣ null
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)3 Γƒ╣ 'text'
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)'count' Γƒ╣ 3
--(% style="color: rgb(0,0,0);text-decoration: none;" %)As you can see, a property key can be a number or a string. Actually there is no restriction regarding the data type of the key.
++But it is easier just to write the property key without braces, which is equivalent:
--(% style="color: rgb(0,0,0);text-decoration: none;" %)You can look up a property by appending a dot and the key in curly braces:
++* {{code language="xml"}}[0].count{{/code}}
++* {{code language="xml"}}$ship.name{{/code}}
++* {{code language="xml"}}$ship.class{{/code}}
++* {{code language="xml"}}table[$foo='bar'].$foo{{/code}}
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}[100, 200, 300, 400].{1}{{/code}} Γƒ╣ 100 (reading the first element)
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}[100, 200, ['Hello ', 'world']] .{3}.{2}{{/code}} Γƒ╣ 'world' (second element of the inner list, which is the third element of the outer list)
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}[].{'count'}{{/code}} Γƒ╣ 0
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}table[{21} = 42].{21}{{/code}} (% style="color: rgb(0,0,0);text-decoration: none;" %)Γƒ╣(%%) 42
++(In this case, $ship is a variable. All variables start with a "$", so they cannot be confused with keywords.)
--(% style="color: rgb(0,0,0);text-decoration: none;" %)In most cases the property key is a fixed string, like ΓÇ£nameΓÇ¥ or ΓÇ£classΓÇ¥. You can write this like above:
++A list has even more properties:
--* {{code}}[42].{'count'}{{/code}}
--* {{code}}$ship.{'name'}{{/code}}
--* {{code}}$ship.{'class'}┬á{{/code}}
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}table[$foo='bar'].{'$foo'}{{/code}}
--\\
++**random'** returns a randomly chosen element (which requires that the list is non-empty)
--(% style="color: rgb(0,0,0);text-decoration: none;" %)But it is easier just to write the property key without braces, which is equivalent:
++**min'** and '**max'** return the minimum or maximum (all elements have to be numeric)
--* {{code}}[0].count{{/code}}
--* {{code}}$ship.name{{/code}}
--* {{code}}$ship.class{{/code}}
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}table[$foo='bar'].$foo{{/code}}
--\\
++* {{code language="xml"}}[1, 6, 8].min{{/code}} ⟹ 1
--(% style="color: rgb(0,0,0);text-decoration: none;" %)(In this case, $ship is a variable. All variables start with a ΓÇ£$ΓÇ¥, so they cannot be confused with keywords.)
++**average'** returns the average (but all element types have to be compatible)
--(% style="color: rgb(0,0,0);text-decoration: none;" %)A list has even more properties:
++* {{code language="xml"}}[1, 6, 8].average{{/code}} ⟹ 5
--(% style="color: rgb(0,0,0);text-decoration: none;" %)'(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)random(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)' returns a randomly chosen element (which requires that the list is non-empty)
++**indexof'** is followed by another property, and the index of the first occurence of that key in the list is returned, or 0 if it's not in the list
--(% style="color: rgb(0,0,0);text-decoration: none;" %)'(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)min(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)' and '(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)max(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)' return the minimum or maximum (all elements have to be numeric)
++* {{code language="xml"}}[1, 6, 8].indexof.{8}{{/code}} ⟹ 3
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}[1, 6, 8].min{{/code}} Γƒ╣ 1
++**clone'** creates a shallow copy of the list (i.e. lists that are contained as elements in the list are not copied, only the reference to them)
--(% style="color: rgb(0,0,0);text-decoration: none;" %)'(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)average(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)' returns the average (but all element types have to be compatible)
++* {{code language="xml"}}[1, 6, 8].clone{{/code}} ⟹ {{code language="xml"}}[1, 6, 8]{{/code}}
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}[1, 6, 8].average{{/code}} Γƒ╣ 5
++A table has different properties:
--(% style="color: rgb(0,0,0);text-decoration: none;" %)'(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)indexof(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)' is followed by another property, and the index of the first occurence of that key in the list is returned, or 0 if itΓÇÖs not in the list
++* '**clone'** creates a shallow copy of the table
++* '**keys'** allows you to access data about the table's keys
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}[1, 6, 8].indexof.{8}{{/code}} Γƒ╣ 3
++However, 'keys' alone will not give you a result. 'keys' must be followed by another keyword to retrieve the desired information, for example:
--(% style="color: rgb(0,0,0);text-decoration: none;" %)'(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)clone(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)' creates a shallow copy of the list (i.e. lists that are contained as elements in the list are not copied, only the reference to them)
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}[1, 6, 8].clone{{/code}} Γƒ╣ {{code}}[1, 6, 8]{{/code}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)A table has different properties:
++* {{code language="xml"}}$table.keys.list{{/code}}: Yields a list of all keys in the table (reliably sorted by key if all keys are numeric)
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)'**clone'** creates a shallow copy of the table
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)'**keys'** allows you to access data about the table's keys
--(% style="color: rgb(0,0,0);text-decoration: none;" %)However, 'keys' alone will not give you a result. 'keys' must be followed by another keyword to retrieve the desired information, for example:
++* {{code language="xml"}}$table.keys.sorted{{/code}}: Yields a list of all keys in the table, sorted by their associated values (which requires that all values are numeric)
++* {{code language="xml"}}$table.keys.random{{/code}}: A randomly chosen key (which requires that the table is non-empty)
++{{info}}
++The string formatting syntax that you have seen [[NULL|above]] is also based on the property system. You basically pass a list as property key to a string. Braces around the brackets are not required, so 'foo'.[...] is just a convenient alternative notation for 'foo'.{[...]}.
++{{/info}}
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}$table.keys.list{{/code}}: Yields a list of all keys in the table (reliably sorted by key if all keys are numeric)
--\\
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}$table.keys.sorted{{/code}}: Yields a list of all keys in the table, sorted by their associated values (which requires that all values are numeric)
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}$table.keys.random{{/code}}: A randomly chosen key (which requires that the table is non-empty)
++=== (% id="lookup-tests-and-suppressing-errors" %)Lookup tests and suppressing errors(%%) ===
++If you look up a property that does not exist, there will be an error, and the result will be null. To test whether a property exists, you can append a question mark "?" to the lookup, which yields true or false:
++* {{code language="xml"}}$list.{5}{{/code}} ⟹ The fifth element of a list - however, if $list has less than 5 elements (and if it's also not a table with the key 5), there will be an error
++* {{code language="xml"}}$list.{5}?{{/code}} ⟹ true if $list exists and has the property 5, false otherwise
++* {{code language="xml"}}$table.$key?{{/code}} ⟹ Analogously, true if $table exists and has the string property '$key'
--{{note body="<span style=~"color: rgb(0,0,0);text-decoration: none;~">The string formatting syntax that you have seen [[NULL|above]] is also based on the property system. You basically pass a list as property key to a string. Braces around the brackets are not required, so 'foo'.[...] is just a convenient alternative notation for 'foo'.{[...]}.</span>"/}}
++The question mark can even be applied to variables:
++* {{code language="xml"}}$list{{/code}} ⟹ The value stored under the name $list, or an error if there is no such variable
++* {{code language="xml"}}$list?{{/code}} ⟹ true if the variable exists, false otherwise
--(% id="lookup-tests-and-suppressing-errors" %)(%%)
--~=== (% style="color: rgb(0,0,0);text-decoration: none;" %)Lookup tests and suppressing errors
--\\(%%) ===
++To look up the value of a property although it may not exist, you can use the at-sign "@" as prefix:
--(% style="color: rgb(0,0,0);text-decoration: none;" %)If you look up a property that does not exist, there will be an error, and the result will be null. To test whether a property exists, you can append a question mark ΓÇ£?ΓÇ¥ to the lookup, which yields true or false:
++* {{code language="xml"}}@$list.{5}{{/code}} ⟹ The result of the $list lookup if $list exists and has the property 5, otherwise null (without error message)
++* {{code language="xml"}}@$list{{/code}} ⟹ The list if this variable exists, null otherwise
++* {{code language="xml"}}@$list.{5}.{1}{{/code}} ⟹ The first element of the fifth element of $list, if it exists, null otherwise
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}$list.{5}{{/code}} Γƒ╣ The fifth element of a list - however, if $list has less than 5 elements (and if it's also not a table with the key 5), there will be an error
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}$list.{5}?{{/code}} Γƒ╣ true if $list exists and has the property 5, false otherwise
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}$table.$key?{{/code}} (% style="color: rgb(0,0,0);text-decoration: none;" %)Γƒ╣ Analogously, (%%)true if $table exists and has the string property '$key'
++As you can see, an error is already prevented if any link in the property chain does not exist. But use the @ prefix with care, since error messages are really helpful for detecting problems in your scripts. The @ prefix only suppresses property-related error messages and does not change any in-game behaviour.
++=== Static lookups ===
--(% style="color: rgb(0,0,0);text-decoration: none;" %)The question mark can even be applied to variables:
++There are a few data types which are basically enumerations: They only consist of a set of named values, e.g. the "class" data type, which is used for the component classes that exist in the game. For all these static enumeration classes there is a lookup value of the same name, from which you can get the named values as properties by their name. So for the type "class", there is a value "class" that can be used to access the classes.
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}$list{{/code}} Γƒ╣ The value stored under the name $list, or an error if there is no such variable
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}$list?{{/code}} Γƒ╣ true if the variable exists, false otherwise
++Here are a few enumeration classes and corresponding example lookup values:
--(% style="color: rgb(0,0,0);text-decoration: none;" %)To look up the value of a property although it may not exist, you can use the at-sign ΓÇ£@ΓÇ¥ as prefix:
--
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}@$list.{5}{{/code}} Γƒ╣ The result of the $list lookup if $list exists and has the property 5, otherwise null (without error message)
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}@$list{{/code}} Γƒ╣ The list if this variable exists, null otherwise
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}@$list.{5}.{1}{{/code}} Γƒ╣ The first element of the fifth element of $list, if it exists, null otherwise
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)As you can see, an error is already prevented if any link in the property chain does not exist. But use the @ prefix with care, since error messages are really helpful for detecting problems in your scripts. The @ prefix only suppresses property-related error messages and does not change any in-game behaviour.
--
--\\
--
--(% id="static-lookups" %)
--
--=== (% style="color: rgb(0,0,0);text-decoration: none;" %)Static lookups(%%) ===
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)There are a few data types which are basically enumerations: They only consist of a set of named values, e.g. the ΓÇ£classΓÇ¥ data type, which is used for the component classes that exist in the game. For all these static enumeration classes there is a lookup value of the same name, from which you can get the named values as properties by their name. So for the type ΓÇ£classΓÇ¥, there is a value ΓÇ£classΓÇ¥ that can be used to access the classes.
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Here are a few enumeration classes and corresponding example lookup values:
--
  (% style="margin-left: 0.0px;" %)
  (((
--\\
--
--
--
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Data type (= value name)|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Examples|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Description
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)class|
--(% style="color: rgb(0,0,0);text-decoration: none;" %)class.ship(%%)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)class.ship_xl(%%)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)class.space(%%)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)class.weapon|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Component classes
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)purpose|
--(% style="color: rgb(0,0,0);text-decoration: none;" %)purpose.combat(%%)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)purpose.transportation|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Purposes
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)killmethod|
--(% style="color: rgb(0,0,0);text-decoration: none;" %)killmethod.hitbybullet(%%)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)killmethod.hitbymissile|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Ways to die (already used before destruction)
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)datatype|
--(% style="color: rgb(0,0,0);text-decoration: none;" %)datatype.float(%%)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)datatype.component(%%)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)datatype.class(%%)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)datatype.datatype|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Script value datatypes
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)profile|
--(% style="color: rgb(0,0,0);text-decoration: none;" %)profile.flat(%%)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)profile.increasing(%%)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)profile.bell|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Probability distribution profile (see [[random ranges>>MediaWiki.NULL]])
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)cuestate|
--(% style="color: rgb(0,0,0);text-decoration: none;" %)cuestate.waiting(%%)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)cuestate.active(%%)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)cuestate.complete|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)[[Cue states>>MediaWiki.NULL]]
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)level|
--(% style="color: rgb(0,0,0);text-decoration: none;" %)level.easy(%%)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)level.medium(%%)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)level.veryhard|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Mission difficulty levels (comparable with each other using lt, gt, etc.)
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)attention|
--(% style="color: rgb(0,0,0);text-decoration: none;" %)attention.insector(%%)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)attention.visible(%%)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)attention.adjacentzone|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Attention levels (comparable with each other using lt, gt, etc.)
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)ware|
--(% style="color: rgb(0,0,0);text-decoration: none;" %)ware.ore(%%)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)ware.silicon|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Wares
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)race|
--(% style="color: rgb(0,0,0);text-decoration: none;" %)race.argon(%%)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)race.boron|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Races
--|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)faction|
--(% style="color: rgb(0,0,0);text-decoration: none;" %)faction.player(%%)
--\\(% style="color: rgb(0,0,0);text-decoration: none;" %)faction.argongovernment|(%%)(% style="color: rgb(0,0,0);text-decoration: none;" %)Factions
++|Data type (= value name)|Examples|Description
++|class|
++class.ship
++\\class.ship_xl
++\\class.space
++\\class.weapon|Component classes
++|purpose|
++purpose.combat
++\\purpose.transportation|Purposes
++|killmethod|
++killmethod.hitbybullet
++\\killmethod.hitbymissile|Ways to die (already used before destruction)
++|datatype|
++datatype.float
++\\datatype.component
++\\datatype.class
++\\datatype.datatype|Script value datatypes
++|profile|
++profile.flat
++\\profile.increasing
++\\profile.bell|Probability distribution profile (see [[random ranges>>MediaWiki.NULL]])
++|cuestate|
++cuestate.waiting
++\\cuestate.active
++\\cuestate.complete|[[Cue states>>MediaWiki.NULL]]
++|level|
++level.easy
++\\level.medium
++\\level.veryhard|Mission difficulty levels (comparable with each other using lt, gt, etc.)
++|attention|
++attention.insector
++\\attention.visible
++\\attention.adjacentzone|Attention levels (comparable with each other using lt, gt, etc.)
++|ware|
++ware.ore
++\\ware.silicon|Wares
++|race|
++race.argon
++\\race.boron|Races
++|faction|
++faction.player
++\\faction.argongovernment|Factions
  )))
--{{note body="[[Category:Broken_macro/anchor]]With the ''typeof'' operator you can get the datatype of any expression and compare it with what you expect, for example:
++{{info}}
++With the ''typeof'' operator you can get the datatype of any expression and compare it with what you expect, for example:
  <code>typeof $value == datatype.faction</code>
--However, you should not compare the type to datatype.string because there are strings that have different data types. To check for a string you should use the datatype's property &quot;'''isstring'''&quot; instead. For example, to check if the variable $value is a string, use the following term:
++However, you should not compare the type to datatype.string because there are strings that have different data types. To check for a string you should use the datatype's property "'''isstring'''" instead. For example, to check if the variable $value is a string, use the following term:
--<code>(typeof $value).isstring</code>"/}}
++<code>(typeof $value).isstring</code>"
++{{/info}}
--{{info body="<span style=~"color: rgb(0,0,0);text-decoration: none;~">There is also the datatype ΓÇ£tagΓÇ¥ with the lookup name ΓÇ£tagΓÇ¥ - however, this is not an enumeration type. Looking up a value by name never fails, you actually create a tag value for a given name if it does not exist. For example, if you have a typo, like ΓÇ£tag.misionΓÇ¥ instead of ΓÇ£tag.missionΓÇ¥, there wonΓÇÖt be an error because any name is valid for a tag, and the tag ΓÇ£misionΓÇ¥ is created on its first use.</span>"/}}
++{{info}}
++There is also the datatype "tag" with the lookup name "tag" - however, this is not an enumeration type. Looking up a value by name never fails, you actually create a tag value for a given name if it does not exist. For example, if you have a typo, like "tag.mision" instead of "tag.mission", there won't be an error because any name is valid for a tag, and the tag "mision" is created on its first use."
++{{/info}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)
++=== Player properties ===
++You can access many player-related game properties via the keyword "player":
--(% id="player-properties" %)
++* player.**name**: The player's name
++* player.**age**: The passed in-game time since game start
++* player.**money**: The money in the player's account
++* player.**ship**: The ship the player is currently on (not necessarily the player's ship), or null if the player is on a station
--=== (% style="color: rgb(0,0,0);text-decoration: none;" %)Player properties(%%) ===
--(% style="color: rgb(0,0,0);text-decoration: none;" %)You can access many player-related game properties via the keyword ΓÇ£playerΓÇ¥:
++* player.**primaryship**: The player's own ship (but the player is not necessarily on board)
++* player.**entity**: The actual player object
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)player.(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)name(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %): The playerΓÇÖs name
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)player.(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)age(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %): The passed in-game time since game start
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)player.(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)money(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %): The money in the playerΓÇÖs account
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)player.(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)ship(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %): The ship the player is currently on (not necessarily the player's ship), or null if the player is on a station
--\\
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)player.**primaryship**: The player's own ship (but the player is not necessarily on board)
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)player.**entity**: The actual player object
--\\
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)player.(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)zone(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %), player.(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)sector(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %), player.(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)cluster(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %), player.(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)galaxy(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %): Location of the player entity
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)player.(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)copilot(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %): The co-pilot NPC
++* player.**zone**, player.**sector**, player.**cluster**, player.**galaxy**: Location of the player entity
++* player.**copilot**: The co-pilot NPC
++
  The game consists of objects of different classes (zones, ships, stations, NPCs). They have the common datatype "component", however, they have different properties, e.g. NPCs have the property "race", but ships don't.
--(% id="safe-properties" %)
++=== Safe properties ===
--=== (% style="color: rgb(0,0,0);text-decoration: none;" %)Safe properties(%%) ===
++Most properties cause errors if you use them on non-existing objects, such as destroyed ships. There are a few exceptions:
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Most properties cause errors if you use them on non-existing objects, such as destroyed ships. There are a few exceptions:
++* exists
++* isoperational
++* iswreck
++* isconstruction
++* available
++* isclass.(...)
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)exists
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)isoperational
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)iswreck
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)isconstruction
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)available
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)isclass.(...)
++These properties will not cause errors when used on "null" or on a destroyed object (which may still be accessible from scripts in some cases), and produce null or false as results, respectively. (The keyword "available" is used for trades, not for objects. Trades can also become invalid.) However, when using such a property on a different data type like a number, there will still be an error.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)These properties will not cause errors when used on ΓÇ£nullΓÇ¥ or on a destroyed object (which may still be accessible from scripts in some cases), and produce null or false as results, respectively. (The keyword ΓÇ£availableΓÇ¥ is used for trades, not for objects. Trades can also become invalid.) However, when using such a property on a different data type like a number, there will still be an error.
++=== (% id="categorybroken_macroanchormoney-and-time-formatting" %)Money and time formatting(%%) ===
--(% id="categorybroken_macroanchormoney-and-time-formatting" %)(%%)
--~=== (% style="color: rgb(0,0,0);text-decoration: none;" %)Money and time formatting
--\\(%%) ===
++**[New as of X Rebirth 4.0]**
++\\Numbers don't have any properties, except for money and time: They have a "**formatted**" property, which allows you to get a custom string representation with more advanced options than the [[generic formatting method>>MediaWiki.NULL]] for numbers.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)**[New as of X Rebirth 4.0]**
++* {{code language="xml"}}$money.formatted.{'formatstring'}{{/code}}
++* {{code language="xml"}}$money.formatted.default{{/code}} (using default format string '%s')
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Numbers don't have any properties, except for money and time: They have a "**formatted**" property, which allows you to get a custom string representation with more advanced options than the [[generic formatting method>>MediaWiki.NULL]] for numbers.
--* {{code}}$money.formatted.{'formatstring'}┬á{{/code}}
--* (% style="color: rgb(0,0,0);text-decoration: none;" %){{code}}$money.formatted.default{{/code}} (using default format string '%s')
--\\
--* {{code}}$time.formatted.{'formatstring'}{{/code}}
--* {{code}}$time.formatted.default{{/code}}(% style="color: rgb(0,0,0);text-decoration: none;" %)┬á(%%) (using default format string '%T')
++* {{code language="xml"}}$time.formatted.{'formatstring'}{{/code}}
++* {{code language="xml"}}$time.formatted.default{{/code}} (using default format string '%T')
--(% style="color: rgb(0,0,0);text-decoration: none;" %)In scripts, money is stored in cents, not Credits. The formatted representation always shows the value in Credits, including thousands separators.
++In scripts, money is stored in cents, not Credits. The formatted representation always shows the value in Credits, including thousands separators.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)When formatting the money value, any specifier (such as '%s') in the format string is replaced by the money value, so usually the format string only consists of this one specifier. The following modifiers can be used between '%' and the specifier character, to enable formatting options:
++When formatting the money value, any specifier (such as '%s') in the format string is replaced by the money value, so usually the format string only consists of this one specifier. The following modifiers can be used between '%' and the specifier character, to enable formatting options:
--
  |1-9|Truncation|To enable truncation, specify the number of relevant digits that should be displayed. If the money string is too long, it can be truncated and a metric unit prefix (e.g. k = kilo) is appended. (All digits are shown unless truncation is enabled.)
  |c|Colouring|If truncation is enabled, the metric unit prefixes (e.g. k, M, G) can be coloured when displayed on the screen, using the escape sequence '\033C'.
  |.|Cents|Usually money values have no cent part, since cents are not used in accounts or trades. However, single ware prices can have a non-zero cent part. (Cents are not displayed if money is truncated)
  |_|Spaces|An underscore adds trailing spaces to the result string for better right-aligned display in a tabular layout.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)By default, these options are disabled.
++By default, these options are disabled.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)More available specifiers (in addition to %s):
++More available specifiers (in addition to %s):
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)%k: Credits (truncated) in kilo format
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)%M: Credits (truncated) in Mega format
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)%G: Credits (truncated) in Giga format
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)%T: Credits (truncated) in Tera format
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)%Cr: Localised "Cr" string
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)%%: A % sign
--\\
++* %k: Credits (truncated) in kilo format
++* %M: Credits (truncated) in Mega format
++* %G: Credits (truncated) in Giga format
++* %T: Credits (truncated) in Tera format
++* %Cr: Localised "Cr" string
++* %%: A % sign
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Examples:
++Examples:
--* {{code}}(1234Cr).formatted.{'%s'}{{/code}}(% style="color: rgb(0,0,0);text-decoration: none;" %)Γƒ╣{{code}}'1,234'{{/code}}
--* {{code}}(1234Cr).formatted.default{{/code}}(% style="color: rgb(0,0,0);text-decoration: none;" %)Γƒ╣{{code}}'1,234'{{/code}}(%%) (same as {'%s'})
--* {{code}}(1234Cr).formatted.{'%.s %Cr'}{{/code}}(% style="color: rgb(0,0,0);text-decoration: none;" %)Γƒ╣{{code}}'1,234.00 Cr'{{/code}}
--* {{code}}(1234Cr).formatted.{'%1s'}{{/code}}(% style="color: rgb(0,0,0);text-decoration: none;" %)Γƒ╣{{code}}'1 k'{{/code}}(%%) (rounding towards zero)
--* {{code}}(1234Cr).formatted.{'%cM'}{{/code}}(% style="color: rgb(0,0,0);text-decoration: none;" %)Γƒ╣{{code}}'0 M'{{/code}}
++* {{code language="xml"}}(1234Cr).formatted.{'%s'}{{/code}}⟹{{code language="xml"}}'1,234'{{/code}}
++* {{code language="xml"}}(1234Cr).formatted.default{{/code}}⟹{{code language="xml"}}'1,234'{{/code}} (same as {'%s'})
++* {{code language="xml"}}(1234Cr).formatted.{'%.s %Cr'}{{/code}}⟹{{code language="xml"}}'1,234.00 Cr'{{/code}}
++* {{code language="xml"}}(1234Cr).formatted.{'%1s'}{{/code}}⟹{{code language="xml"}}'1 k'{{/code}} (rounding towards zero)
++* {{code language="xml"}}(1234Cr).formatted.{'%cM'}{{/code}}⟹{{code language="xml"}}'0 M'{{/code}}
  For documentation of time format strings, see the Lua function ConvertTimeString() in the [[MediaWiki.ARCHIVE.XRWIKIModding_supportUI_Modding_supportLua_function_overview]].
  Examples:
--* {{code}}(151s).formatted.{'%T'}{{/code}} (% style="color: rgb(0,0,0);text-decoration: none;" %)Γƒ╣(%%) {{code}}'00:02:31'{{/code}}
--* {{code}}(151s).formatted.default{{/code}} (% style="color: rgb(0,0,0);text-decoration: none;" %)Γƒ╣(%%) {{code}}'00:02:31'{{/code}} (same as {'%T'})
--* {{code}}(151s).formatted.{'%.3T'}{{/code}} (% style="color: rgb(0,0,0);text-decoration: none;" %)Γƒ╣(%%) {{code}}'00:02:31.000'{{/code}}
--* {{code}}(151s).formatted.{'%h:%M'}{{/code}} (% style="color: rgb(0,0,0);text-decoration: none;" %)Γƒ╣(%%) {{code}}'0:02'{{/code}}
++* {{code language="xml"}}(151s).formatted.{'%T'}{{/code}} ⟹ {{code language="xml"}}'00:02:31'{{/code}}
++* {{code language="xml"}}(151s).formatted.default{{/code}} ⟹ {{code language="xml"}}'00:02:31'{{/code}} (same as {'%T'})
++* {{code language="xml"}}(151s).formatted.{'%.3T'}{{/code}} ⟹ {{code language="xml"}}'00:02:31.000'{{/code}}
++* {{code language="xml"}}(151s).formatted.{'%h:%M'}{{/code}} ⟹ {{code language="xml"}}'0:02'{{/code}}
--(% id="complete-property-documentation" %)
++=== Complete property documentation ===
--=== (% style="color: rgb(0,0,0);text-decoration: none;" %)Complete property documentation(%%) ===
++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>>url:https://forum.egosoft.com/viewtopic.php?t=363625]]. Extract the HTML file __scriptproperties.html__ in the game's root folder, and all files in the "libraries" sub-folder. For resolving text references in the browser automatically, also extract 0001-L044.xml in the "t" sub-folder.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)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>>url:https://forum.egosoft.com/viewtopic.php?t=363625]]. Extract the HTML file __scriptproperties.html__ in the game's root folder, and all files in the "libraries" sub-folder. 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.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)The raw documentation data is located in libraries/scriptproperties.xml, but it is recommended to open scriptproperties.html in a browser.
++{{info}}
++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--
++{{/info}}
--{{note body="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:
++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:
--* Firefox: On the about:config page, the value of &quot;security.fileuri.strict_origin_policy&quot; has to be changed to &quot;false&quot;.
--* Chrome: The Chrome launcher has to be started with the command-line parameter --allow-file-access-from-files"/}}
++* Enter the beginning of a base keyword
++* Enter $ followed by the data type you are looking for (e.g. "$ship"), as if it were a variable
++* To see the properties of a base keyword or data type, enter a dot (".")
++* After the dot, you can enter a property name
++* You can also enter a dot (".") as first character to search globally for a property
++{{info}}
++The documentation contains some data types that are no real script data types, but which are useful for documentation purposes. For example, ships and stations are both of datatype "component", but have different properties based on their component class.
++{{/info}}
++= MD refreshing and patching =
--(% style="color: rgb(0,0,0);text-decoration: none;" %)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:
++When a saved game is loaded, the saved MD state is restored, but also all MD files are reloaded and changes in them are applied to the MD state. This is called "refresh". It is also possible to refresh the MD at run-time using the command "refreshmd" on the in-game command line. This is a convenient way to update MD scripts while the game is already running.
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)Enter the beginning of a base keyword
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)Enter $ followed by the data type you are looking for (e.g. ΓÇ£$shipΓÇ¥), as if it were a variable
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)To see the properties of a base keyword or data type, enter a dot (ΓÇ£.ΓÇ¥)
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)After the dot, you can enter a property name
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)You can also enter a dot (ΓÇ£.ΓÇ¥) as first character to search globally for a property
++== Details and restrictions ==
--(% style="color: rgb(0,0,0);text-decoration: none;" %)
++Here are some noteworthy facts about refreshing scripts and cues, and the restrictions:
++* MD scripts and cues are identified by their names. So a script can only be refreshed if it has the same script name as before (file name is irrelevant).
++* If there are new script files or new cue nodes (i.e. scripts/cues with new names) they are created and added properly. If you remove script files or cue nodes, the corresponding scripts/cues are removed from the game, including instances.
++* As a consequence, you CANNOT rename scripts or cues if you want to refresh them. Doing so would remove the old script or cue and add a new one with the new name.
++* You CANNOT change a <cue> to a <library> or vice versa.
++* You CANNOT add, remove, or change the "ref" attribute of a cue. But it is possible to remove the whole cue. (If all references to a library are removed you can also remove the library itself.)
++* You CANNOT change the cue tree structure, i.e. if you move a cue out of its <cues> node, you also have to change its name (see above). Changing the order of cues within the same <cues> node is possible, however, the order of execution is not reliable anyway.
++* You CAN change a library and change/add/remove its sub-cues. This automatically updates all cues that use the library.
++* You CAN change library parameters (both in libraries and in referencing cues). However, this does not change the variables of a referencing cue if it is already enabled.
++* You CAN change conditions without restrictions. You can even change between event and non-event conditions. If a cue has enabled condition checks, they are aborted and restarted (even if there is no change).
++* Adding root cues enables their condition checks immediately (if the module attribute allows it).
++* Adding sub-cues to active or complete cues enables their condition checks immediately.
++* You CAN change/add/remove <actions>, <force>, <delay>, and all attributes without restrictions, except for the "ref" attribute (see above). You can even change the <delay> while the cue is already active and the timer is running.
++* Changing instantiate="false" to "true" turns the cue into "waiting" state if it was active or complete before.
++* Changing instantiate="true" to "false" removes all instantiated cues and their descendants.
--{{note body="<span style=~"color: rgb(0,0,0);text-decoration: none;~">The documentation contains some data types that are no real script data types, but which are useful for documentation purposes. For example, ships and stations are both of datatype ΓÇ£componentΓÇ¥, but have different properties based on their component class.</span>"/}}
++{{warning}}
++Be aware that completed instances can be auto-deleted, and so added sub-cues will not become active in such a case.
++{{/warning}}
++{{warning}}
++When adding a variable in a new MD script version and using that variable in multiple places, be aware that the variable doesn't exist yet in older savegames. You may have to check the existence of the variable before accessing it, or add some patch logic that initiailses the variable after loading the savegame, if necessary.
++{{/warning}}
++== Patching ==
--\\
++Cues can have **<patch>** elements with actions that will be performed when an old savegame is loaded. To control which savegames should be affected, you can add a //**version **//attribute to the <cue> node and a //**sinceversion**// attribute in the patch. When a cue is loaded from a savegame that has an older version than //sinceversion//, the <patch> actions will be performed immediately after loading.
--(% id="md-refreshing-and-patching" %)
++{{code language="xml"}}
++  <cue [...] version="42">
++    <conditions> [...] </conditions>
++    <actions> [...] </actions>
++    <patch sinceversion="42">
++      [patch actions]
++    </patch>
++  </cue>
++{{/code}}
--= (% style="color: rgb(0,0,0);text-decoration: none;" %)MD refreshing and patching(%%) =
++The patch actions are only performed if the cue is in a certain state, "complete" by default. Use the //**state**// attribute to change this requirement. For more information, see the XML schema documentation of the <patch> element.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)When a saved game is loaded, the saved MD state is restored, but also all MD files are reloaded and changes in them are applied to the MD state. This is called ΓÇ£refreshΓÇ¥. It is also possible to refresh the MD at run-time using the command ΓÇ£refreshmdΓÇ¥ on the in-game command line. This is a convenient way to update MD scripts while the game is already running.
++A sequence of multiple <patch> elements is possible. They will be performed in order of appearance, checking the //sinceversion// and //state// attributes in each case. Patches are also applied to all users of a library and to instances.
--\\
++{{info}}
++The <patch> elements will be ignored when refreshing the MD at run-time. They only affect loaded savegames."
++{{/info}}
--(% id="details-and-restrictions" %)
++= Common attribute groups =
--== (% style="color: rgb(0,0,0);text-decoration: none;" %)Details and restrictions(%%) ==
++There are many commonly used actions and conditions which share groups of attributes. The most important ones are explained here.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Here are some noteworthy facts about refreshing scripts and cues, and the restrictions:
++== Value comparisons ==
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)MD scripts and cues are identified by their names. So a script can only be refreshed if it has the same script name as before (file name is irrelevant).
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)If there are new script files or new cue nodes (i.e. scripts/cues with new names) they are created and added properly. If you remove script files or cue nodes, the corresponding scripts/cues are removed from the game, including instances.
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)As a consequence, you CANNOT rename scripts or cues if you want to refresh them. Doing so would remove the old script or cue and add a new one with the new name.
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)You CANNOT change a <cue> to a <library> or vice versa.
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)You CANNOT add, remove, or change the "ref" attribute of a cue. But it is possible to remove the whole cue. (If all references to a library are removed you can also remove the library itself.)
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)You CANNOT change the cue tree structure, i.e. if you move a cue out of its <cues> node, you also have to change its name (see above). Changing the order of cues within the same <cues> node is possible, however, the order of execution is not reliable anyway.
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)You CAN change a library and change/add/remove its sub-cues. This automatically updates all cues that use the library.
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)You CAN change library parameters (both in libraries and in referencing cues). However, this does not change the variables of a referencing cue if it is already enabled.
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)You CAN change conditions without restrictions. You can even change between event and non-event conditions. If a cue has enabled condition checks, they are aborted and restarted (even if there is no change).
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)Adding root cues enables their condition checks immediately (if the module attribute allows it).
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)Adding sub-cues to active or complete cues enables their condition checks immediately.
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)You CAN change/add/remove <actions>, <force>, <delay>, and all attributes without restrictions, except for the "ref" attribute (see above). You can even change the <delay> while the cue is already active and the timer is running.
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)Changing instantiate="false" to "true" turns the cue into "waiting" state if it was active or complete before.
--* (% style="color: rgb(0,0,0);text-decoration: none;" %)Changing instantiate="true" to "false" removes all instantiated cues and their descendants.
++There are many conditions and conditional actions that require a value comparison, for example the condition <check_value>:
--(% style="color: rgb(0,0,0);text-decoration: none;" %)
++{{code language="xml"}}
++  <check_value value="$ware == ware.silicon and $amount != 0"/>
++{{/code}}
++In the value attribute you specify a boolean expression, and if it is true (that is, not equal to zero), the condition is met. This is a special case: This condition and all other nodes that support a value comparison allows you to specify an upper limit, a lower limit, a number range, or a list of allowed values. Examples:
--{{warning body="<span style=~"color: rgb(0,0,0);text-decoration: none;~">Be aware that completed instances can be auto-deleted, and so added sub-cues will not become active in such a case.</span>"/}}
++{{code language="xml"}}
++  <check_value value="FooCue.state" exact="cuestate.complete"/>
++  <check_value value="$foo.count" min="5"/>
++  <check_value value="$foo" max="player.age + 1min"/>
++  <check_value value="player.money" min="300Cr" max="600Cr"/>
++  <check_value value="$method" list="[killmethod.hitbymissile, killmethod.collected]"/>
++  <check_value value="$attention" min="attention.visible"/>
++{{/code}}
--{{warning body="<span style=~"color: rgb(0,0,0);text-decoration: none;~">When adding a variable in a new MD script version and using that variable in multiple places, be aware that the variable doesn't exist yet in older savegames. You may have to check the existence of the variable before accessing it, or add some patch logic that initiailses the variable after loading the savegame, if necessary.</span>"/}}
++{{info}}
++Values of most enumeration types cannot be compared via ''min'' or ''max'' (also not via lt, gt, etc.). The only data types that can be used with ''min'' and ''max'' are numbers and the enumeration types ''level'' and ''attention'' (see Boolean operators). The ''exact'' attribute can be used with any type, and is equivalent to using the == operator."
++{{/info}}
++== Random ranges ==
++If an action requires a value, e.g. when you set a variable to a value, you can have some randomisation. To specify an exact value, e.g. in <set_value>, you can write this:
--\\
++{{code language="xml"}}
++  <set_value name="$race" exact="race.teladi"/>
++{{/code}}
--(% id="patching" %)
++To select a random element from a list, this syntax can be used:
--== (% style="color: rgb(0,0,0);text-decoration: none;" %)Patching(%%) ==
++{{code language="xml"}}
++  <set_value name="$prime" list="[2, 3, 5, 7, 11]"/>
++{{/code}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Cues can have **<patch>** elements with actions that will be performed when an old savegame is loaded. To control which savegames should be affected, you can add a (%%)//**(% style="color: rgb(0,0,0);text-decoration: none;" %)version (%%)**//(% style="color: rgb(0,0,0);text-decoration: none;" %)attribute to the <cue> node and a (%%)//**(% style="color: rgb(0,0,0);text-decoration: none;" %)sinceversion(%%)**//(% style="color: rgb(0,0,0);text-decoration: none;" %) attribute in the patch. When a cue is loaded from a savegame that has an older version than (%%)//(% style="color: rgb(0,0,0);text-decoration: none;" %)sinceversion//, the <patch> actions will be performed immediately after loading.
++To get a random number within a given range, you can use min/max:
--{{code}}&lt;cue┬á[...] version=&quot;42&quot;&gt;┬á &lt;conditions&gt; [...] &lt;/conditions&gt;┬á &lt;actions&gt; [...] &lt;/actions&gt;┬á &lt;patch┬ásinceversion=&quot;42&quot;&gt;┬á┬á┬á [patch actions]┬á &lt;/patch&gt;&lt;/cue&gt;{{/code}}
++{{code language="xml"}}
++  <set_value name="$foo" min="-20" max="20"/>
++  <set_value name="$timeout" max="20s"/>
++{{/code}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)The patch actions are only performed if the cue is in a certain state, ΓÇ£completeΓÇ¥ by default. Use the (%%)//**(% style="color: rgb(0,0,0);text-decoration: none;" %)state(%%)**//(% style="color: rgb(0,0,0);text-decoration: none;" %) attribute to change this requirement. For more information, see the XML schema documentation of the <patch> element.
++min and max have to be compatible number types. Enumeration types are not allowed, not even level and attention. The min attribute is optional and defaults to 0 (of the number type used in max).
--(% style="color: rgb(0,0,0);text-decoration: none;" %)A sequence of multiple <patch> elements is possible. They will be performed in order of appearance, checking the (%%)//(% style="color: rgb(0,0,0);text-decoration: none;" %)sinceversion// and (%%)//(% style="color: rgb(0,0,0);text-decoration: none;" %)state// attributes in each case. Patches are also applied to all users of a library and to instances.
++You can select one of 5 different probability distribution profiles for the random range, "flat" being the default (all values in the range are equally likely). If you select another profile, e.g. "increasing" to make higher numbers more likely, you also have to specify a scale value (integer) that is greater or equal to 2. Higher scale values result in higher peaks in the distribution profiles (probable values become even more probable).
--{{note body="<span style=~"color: rgb(0,0,0);text-decoration: none;~">The &lt;patch&gt; elements will be ignored when refreshing the MD at run-time. They only affect loaded savegames.</span>"/}}
++{{code language="xml"}}
++  <set_value name="$foo" min="-20" max="20" profile="profile.increasing" scale="4"/>
++{{/code}}
++= Variables and namespaces =
--\\
++As you have seen above, you can easily access variables by writing their name (including $ prefix) in an expression. Namespaces define in which cue the variables are actually stored (and from which cue they are read).
--(% id="common-attribute-groups" %)
++== Creating and removing variables ==
--= (% style="color: rgb(0,0,0);text-decoration: none;" %)Common attribute groups(%%) =
++You can create variables with certain actions and conditions, such as the <set_value> action:
--(% style="color: rgb(0,0,0);text-decoration: none;" %)There are many commonly used actions and conditions which share groups of attributes. The most important ones are explained here.
++{{code language="xml"}}
++  <set_value name="$foo" exact="$bar + 1" />
++{{/code}}
--\\
++<set_value> also exists as a "condition", which can be useful if you want to pass information about the conditions to the actions, that would otherwise be lost - like in a complex <check_any> event condition, where you want to create a variable only if you are in a certain check branch. (Other pseudo-conditions are <remove_value> and <debug_text>.)
--(% id="categorybroken_macroanchorvalue-comparisons" %)
++The default operation of <set_value> is "**set**", but there are more: "**add**", "**subtract**", and "**insert**". //add// and //subtract// change the value of an existing variable, which is created as 0 if it didn't exist before. If neither //min//, //max// nor //exact// attribute is provided, an exact value of 1 is assumed.
--== (% style="color: rgb(0,0,0);text-decoration: none;" %)Value comparisons(%%) ==
++{{code language="xml"}}
++  <set_value name="$foo" operation="add" />
++{{/code}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)There are many conditions and conditional actions that require a value comparison, for example the condition <check_value>:
++The trick is that <set_value> not only works on variables, but also on list elements and table keys:
--{{code}}&lt;check_value┬ávalue=&quot;$ware == ware.silicon and $amount != 0&quot;/&gt;{{/code}}
++{{code language="xml"}}
++  <set_value name="$list.{1}" exact="42" />
++  <set_value name="$table.$foo" exact="42" />
++{{/code}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)In the value attribute you specify a boolean expression, and if it is true (that is, not equal to zero), the condition is met. This is a special case: This condition and all other nodes that support a value comparison allows you to specify an upper limit, a lower limit, a number range, or a list of allowed values. Examples:
++The operation //insert// is special, and it only works on lists. It inserts the value at the specified position (note that the position beyond the last element is also valid here):
--{{code}}&lt;check_value┬ávalue=&quot;FooCue.state&quot;┬áexact=&quot;cuestate.complete&quot;/&gt;&lt;check_value┬ávalue=&quot;$foo.count&quot;┬ámin=&quot;5&quot;/&gt;&lt;check_value┬ávalue=&quot;$foo&quot;┬ámax=&quot;player.age + 1min&quot;/&gt;&lt;check_value┬ávalue=&quot;player.money&quot;┬ámin=&quot;300Cr&quot; max=&quot;600Cr&quot;/&gt;&lt;check_value┬ávalue=&quot;$method&quot;┬álist=&quot;[killmethod.hitbymissile, killmethod.collected]&quot;/&gt;&lt;check_value┬ávalue=&quot;$attention&quot;┬ámin=&quot;attention.visible&quot;/&gt;{{/code}}
++{{code language="xml"}}
++  <set_value name="$list.{1}" exact="42" operation="insert" />
++{{/code}}
--{{note body="<span style=~"color: rgb(0,0,0);text-decoration: none;~">Values of most enumeration types cannot be compared via </span>''<span style=~"color: rgb(0,0,0);text-decoration: none;~">min</span>''<span style=~"color: rgb(0,0,0);text-decoration: none;~"> or </span>''<span style=~"color: rgb(0,0,0);text-decoration: none;~">max</span>''<span style=~"color: rgb(0,0,0);text-decoration: none;~"> (also not via lt, gt, etc.). The only data types that can be used with </span>''<span style=~"color: rgb(0,0,0);text-decoration: none;~">min</span>''<span style=~"color: rgb(0,0,0);text-decoration: none;~"> and </span>''<span style=~"color: rgb(0,0,0);text-decoration: none;~">max</span>''<span style=~"color: rgb(0,0,0);text-decoration: none;~"> are numbers and the enumeration types </span>''<span style=~"color: rgb(0,0,0);text-decoration: none;~">level</span>''<span style=~"color: rgb(0,0,0);text-decoration: none;~"> and </span>''<span style=~"color: rgb(0,0,0);text-decoration: none;~">attention</span>''<span style=~"color: rgb(0,0,0);text-decoration: none;~"> (see Boolean operators). The </span>''<span style=~"color: rgb(0,0,0);text-decoration: none;~">exact</span>''<span style=~"color: rgb(0,0,0);text-decoration: none;~"> attribute can be used with any type, and is equivalent to using the == operator.</span>"/}}
++This shifts the positions of all following elements up by one. If min/max/exact are missing, the default value is null for insertions, not 1 like in other cases.
++Appending is easier than that. The following actions are equivalent:
++{{code language="xml"}}
++  <set_value name="$list.{$list.count + 1}" exact="42" operation="insert" />
++  <append_to_list name="$list" exact="42" />
++{{/code}}
--\\
++Inserting at a position below 1 or above $list.count + 1 is not possible.
--(% id="categorybroken_macroanchorrandom-ranges" %)
++To remove variables or list/table entries, use <remove_value>:
--== (% style="color: rgb(0,0,0);text-decoration: none;" %)Random ranges(%%) ==
++{{code language="xml"}}
++  <remove_value name="$foo" />
++  <remove_value name="$list.{1}" />
++  <remove_value name="$table.$foo" />
++{{/code}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)If an action requires a value, e.g. when you set a variable to a value, you can have some randomisation. To specify an exact value, e.g. in <set_value>, you can write this:
++Removing an entry from a list shifts all following elements down by one. If you want to clear an entry without removing it from the list, just use <set_value> instead.
--{{code}}&lt;set_value┬áname=&quot;$race&quot;┬áexact=&quot;race.teladi&quot;/&gt;{{/code}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)To select a random element from a list, this syntax can be used:
++== Accessing remote variables ==
--{{code}}&lt;set_value┬áname=&quot;$prime&quot;┬álist=&quot;[2, 3, 5, 7, 11]&quot;/&gt;{{/code}}
++You can also read and write variables in other cues by using the variable name as property key:
--(% style="color: rgb(0,0,0);text-decoration: none;" %)To get a random number within a given range, you can use min/max:
++{{code language="xml"}}
++  <set_value name="OtherCue.$foo" min="0.0" max="1.0" />
++  <set_value name="md.OtherScript.YetAnotherCue.$bar" exact="OtherCue.$foo" />
++{{/code}}
--{{code}}&lt;set_value┬áname=&quot;$foo&quot;┬ámin=&quot;-20&quot;┬ámax=&quot;20&quot;/&gt;&lt;set_value┬áname=&quot;$timeout&quot;┬ámax=&quot;20s&quot;/&gt;{{/code}}
++Instead of referencing a cue by name, you could also reference it via a keyword or another variable:
--(% style="color: rgb(0,0,0);text-decoration: none;" %)min and max have to be compatible number types. Enumeration types are not allowed, not even level and attention. The min attribute is optional and defaults to 0 (of the number type used in max).
++{{code language="xml"}}
++  <set_value name="static.$counter" operation="add" />
++  <set_value name="parent.$foo" exact="42" />
++  <set_value name="this.$bar" exact="parent" />
++  <set_value name="$baz" exact="this.$bar.$foo" />
++{{/code}}
--(% style="color: rgb(0,0,0);text-decoration: none;" %)You can select one of 5 different probability distribution profiles for the random range, ΓÇ£flatΓÇ¥ being the default (all values in the range are equally likely). If you select another profile, e.g. ΓÇ£increasingΓÇ¥ to make higher numbers more likely, you also have to specify a scale value (integer) that is greater or equal to 2. Higher scale values result in higher peaks in the distribution profiles (probable values become even more probable).
++== Namespaces ==
--{{code}}&lt;set_value┬áname=&quot;$foo&quot;┬ámin=&quot;-20&quot;┬ámax=&quot;20&quot; profile=&quot;profile.increasing&quot; scale=&quot;4&quot;/&gt;{{/code}}
++In the examples above, a variable was written to and read from the "this" cue. This can be necessary: the expression "$foo" may be different from the expression "this.$foo". The reason for that are namespaces.
--(% style="color: rgb(0,0,255);text-decoration: none;" %)(% style="color: rgb(0,0,0);text-decoration: none;" %)┬á
++Consider this case:
--(% id="variables-and-namespaces" %)
++{{code language="xml"}}
++<cue name="Root">
++  <actions>
++    <set_value name="$foo" />
++  </actions>
++  <cues>
++    <cue name="SubCue"> [...]
++    </cue>
++  </cues>
++</cue>
++{{/code}}
--= (% style="color: rgb(0,0,0);text-decoration: none;" %)Variables and namespaces(%%) =
++When the root cue creates $foo, the variable is stored in the Root cue directly. But SubCue and its descendants will also need access to $foo. Of course they could write "parent.$foo" or "Root.$foo", but since it's very common to have a single location for most variables in the whole cue tree, the easy solution is to write just "$foo" - because variable names are looked up in the **namespace cue**, which is the root by default. Also newly created variables end up in the namespace, and not in "this" cue.
--(% style="color: rgb(0,0,0);text-decoration: none;" %)As you have seen above, you can easily access variables by writing their name (including $ prefix) in an expression. Namespaces define in which cue the variables are actually stored (and from which cue they are read).
++You can also use the keyword "**namespace**" in expressions to get the namespace cue.
--(% style="color: rgb(0,0,255);text-decoration: none;" %)(% style="color: rgb(0,0,0);text-decoration: none;" %)
++=== Defining a cue's namespace ===
++When writing a cue, you can specify what the namespace of the cue should be, by adding the //**namespace**// attribute. The following values are possible:
--(% id="categorybroken_macroanchorcreating-and-removing-variables" %)
++* **this**: Use "this" cue as namespace, even for instances: $foo == this.$foo
++* **static**: Same as "this", but when instantiated, use the static cue: $foo == static.$foo
++* **default**: The namespace is inherited from the parent cue. The default for root cues and for libraries is the same as "static".
--== (% style="color: rgb(0,0,0);text-decoration: none;" %)Creating and removing variables(%%) ==
++{{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:
--(% style="color: rgb(0,0,0);text-decoration: none;" %)You can create variables with certain actions and conditions, such as the (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)<set_value>(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %) action:
--
--{{code}}┬á&lt;set_value┬áname=&quot;$foo&quot;┬áexact=&quot;$bar + 1&quot; /&gt;{{/code}}
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)<set_value> also exists as a ΓÇ£conditionΓÇ¥, which can be useful if you want to pass information about the conditions to the actions, that would otherwise be lost - like in a complex <check_any> event condition, where you want to create a variable only if you are in a certain check branch. (Other pseudo-conditions are <remove_value> and <debug_text>.)
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)The default operation of <set_value> is ΓÇ£(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)set(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)ΓÇ¥, but there are more: ΓÇ£(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)add(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)ΓÇ¥, ΓÇ£(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)subtract(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)ΓÇ¥, and ΓÇ£(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)insert(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)ΓÇ¥. (%%)//(% style="color: rgb(0,0,0);text-decoration: none;" %)add// and (%%)//(% style="color: rgb(0,0,0);text-decoration: none;" %)subtract// change the value of an existing variable, which is created as 0 if it didnΓÇÖt exist before. If neither (%%)//(% style="color: rgb(0,0,0);text-decoration: none;" %)min//, (%%)//(% style="color: rgb(0,0,0);text-decoration: none;" %)max// nor (%%)//(% style="color: rgb(0,0,0);text-decoration: none;" %)exact// attribute is provided, an exact value of 1 is assumed.
--
--{{code}}&lt;set_value┬áname=&quot;$foo&quot;┬áoperation=&quot;add&quot; /&gt;{{/code}}
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)The trick is that <set_value> not only works on variables, but also on list elements and table keys:
--
--{{code}}&lt;set_value┬áname=&quot;$list.{1}&quot;┬áexact=&quot;42&quot; /&gt;&lt;set_value┬áname=&quot;$table.$foo&quot;┬áexact=&quot;42&quot; /&gt;{{/code}}\\
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)The operation (%%)//(% style="color: rgb(0,0,0);text-decoration: none;" %)insert// is special, and it only works on lists. It inserts the value at the specified position (note that the position beyond the last element is also valid here):
--
--{{code}}&lt;set_value┬áname=&quot;$list.{1}&quot;┬áexact=&quot;42&quot;┬áoperation=&quot;insert&quot; /&gt;{{/code}}
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)This shifts the positions of all following elements up by one. If min/max/exact are missing, the default value is null for insertions, not 1 like in other cases.
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Appending is easier than that. The following actions are equivalent:
--
--{{code}}&lt;set_value┬áname=&quot;$list.{$list.count + 1}&quot;┬áexact=&quot;42&quot;┬áoperation=&quot;insert&quot; /&gt;&lt;append_to_list┬áname=&quot;$list&quot;┬áexact=&quot;42&quot; /&gt;{{/code}}
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Inserting at a position below 1 or above $list.count + 1 is not possible.
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)To remove variables or list/table entries, use <remove_value>:
--
--{{code}}&lt;remove_value┬áname=&quot;$foo&quot; /&gt;&lt;remove_value┬áname=&quot;$list.{1}&quot; /&gt;&lt;remove_value┬áname=&quot;$table.$foo&quot; /&gt;{{/code}}\\
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Removing an entry from a list shifts all following elements down by one. If you want to clear an entry without removing it from the list, just use <set_value> instead.
--
--(% style="color: rgb(0,0,255);text-decoration: none;" %)(% style="color: rgb(0,0,0);text-decoration: none;" %)
--
--
--(% id="accessing-remote-variables" %)
--
--== (% style="color: rgb(0,0,0);text-decoration: none;" %)Accessing remote variables(%%) ==
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)You can also read and write variables in other cues by using the variable name as property key:
--
--{{code}}&lt;set_value┬áname=&quot;OtherCue.$foo&quot;┬ámin=&quot;0.0&quot;┬ámax=&quot;1.0&quot; /&gt;&lt;set_value┬áname=&quot;md.OtherScript.YetAnotherCue.$bar&quot;┬áexact=&quot;OtherCue.$foo&quot; /&gt;{{/code}}
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Instead of referencing a cue by name, you could also reference it via a keyword or another variable:
--
--{{code}}&lt;set_value┬áname=&quot;static.$counter&quot;┬áoperation=&quot;add&quot; /&gt;&lt;set_value┬áname=&quot;parent.$foo&quot;┬áexact=&quot;42&quot; /&gt;&lt;set_value┬áname=&quot;this.$bar&quot;┬áexact=&quot;parent&quot; /&gt;&lt;set_value┬áname=&quot;$baz&quot;┬áexact=&quot;this.$bar.$foo&quot; /&gt;{{/code}}
--
--(% style="color: rgb(0,0,255);text-decoration: none;" %)(% style="color: rgb(0,0,0);text-decoration: none;" %)
--
--
--(% id="namespaces" %)
--
--== (% style="color: rgb(0,0,0);text-decoration: none;" %)Namespaces(%%) ==
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)In the examples above, a variable was written to and read from the ΓÇ£thisΓÇ¥ cue. This can be necessary: the expression ΓÇ£$fooΓÇ¥ may be different from the expression ΓÇ£this.$fooΓÇ¥. The reason for that are namespaces.
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)Consider this case:
--
--{{code}}&lt;cue┬áname=&quot;Root&quot;&gt;┬á &lt;actions&gt;┬á ┬á &lt;set_value┬áname=&quot;$foo&quot; /&gt;┬á &lt;/actions&gt;┬á &lt;cues&gt;┬á ┬á &lt;cue┬áname=&quot;SubCue&quot;&gt; [...]┬á ┬á &lt;/cue&gt;┬á &lt;/cues&gt;&lt;/cue&gt;{{/code}}
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)When the root cue creates $foo, the variable is stored in the Root cue directly. But SubCue and its descendants will also need access to $foo. Of course they could write ΓÇ£parent.$fooΓÇ¥ or ΓÇ£Root.$fooΓÇ¥, but since itΓÇÖs very common to have a single location for most variables in the whole cue tree, the easy solution is to write just ΓÇ£$fooΓÇ¥ - because variable names are looked up in the (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)namespace cue(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %), which is the root by default. Also newly created variables end up in the namespace, and not in ΓÇ£thisΓÇ¥ cue.
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)You can also use the keyword ΓÇ£(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)namespace(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)ΓÇ¥ in expressions to get the namespace cue.
--
--(% id="defining-a-cues-namespace" %)
--
--=== (% style="color: rgb(0,0,0);text-decoration: none;" %)Defining a cueΓÇÖs namespace(%%) ===
--
--(% style="color: rgb(0,0,0);text-decoration: none;" %)When writing a cue, you can specify what the namespace of the cue should be, by adding the (%%)//**(% style="color: rgb(0,0,0);text-decoration: none;" %)namespace(%%)**//(% style="color: rgb(0,0,0);text-decoration: none;" %) attribute. The following values are possible:
--
--* **(% style="color: rgb(0,0,0);text-decoration: none;" %)this(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %): Use ΓÇ£thisΓÇ¥ cue as namespace, even for instances: $foo == this.$foo
--* **(% style="color: rgb(0,0,0);text-decoration: none;" %)static(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %): Same as ΓÇ£thisΓÇ¥, but when instantiated, use the static cue: $foo == static.$foo
--* **(% style="color: rgb(0,0,0);text-decoration: none;" %)default(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %): The namespace is inherited from the parent cue. The default for root cues and for libraries is the same as ΓÇ£staticΓÇ¥.
--
--(% style="color: rgb(0,0,255);text-decoration: none;" %)
--
--
--{{warning body="<span style=~"color: rgb(0,0,0);text-decoration: none;~">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 </span><span style=~"color: rgb(0,0,0);text-decoration: none;~">namespace</span><span style=~"color: rgb(0,0,0);text-decoration: none;~"> keyword already points to the library, not to the parentΓÇÖs namespace. Example:</span>
--
--<code>&lt;cue┬áname=&quot;LibRef&quot;┬áref=&quot;Lib&quot;&gt;┬á &lt;param┬áname=&quot;Param1&quot;┬ávalue=&quot;$foo&quot; /&gt; &lt;!-- $foo from parent namespace --&gt;┬á &lt;param┬áname=&quot;Param2&quot;┬ávalue=&quot;namespace.$foo&quot; /&gt; &lt;!-- LibRef.$foo (error) --&gt;&lt;/cue&gt;</code>"/}}
++{{code language="xml"}}
++<cue name="LibRef" ref="Lib">
++  <cke:param name="Param1" value="$foo" ></cke:param> <!-- $foo from parent namespace -->
++  <cke:param name="Param2" value="namespace.$foo" ></cke:param> <!-- LibRef.$foo (error) -->
++</cue>
++{{/code}}
++{{/warning}}

Mission Director Guide - Instantiation.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+xwiki:XWiki.Daniel

Size

...	...	@@ -1,0 +1,1 @@
	1	+47.0 KB

Content

Changes for page Mission Director Guide

Summary

Details

Navigation

Applications