Changes for page Mission Director Guide

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

From 32945.1 to 32944.3 From 32951.1 to 32950.1

From version 32950.1

edited by Daniel Turner
on 2023/08/22 18:56

Change comment: There is no comment for this version

To version 32945.1

edited by Daniel Turner
on 2023/08/22 17:32

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -4,7 +4,7 @@
  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}}
++{{{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.}}}
  (% id="md-scripts" %)
@@ -14,9 +14,9 @@
  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.
--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.
++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.
--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.
++To edit MD scripts, an XML editing tool is needed. Microsoft Visual Studio (if available) or [[(% &text-decoration: underline;" %)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.
  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.
@@ -32,11 +32,11 @@
  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}}
++{{code}}-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:
--{{code language="xml"}}-debug scripts{{/code}}
++{{code}}-debug scripts{{/code}}
  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.\\
@@ -182,9 +182,7 @@
--{{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}}
++{{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 ==
@@ -351,7 +351,7 @@
  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.
--{{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}}
++{{info body="<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."/}}
  == Access to instances ==
@@ -396,13 +396,9 @@
  * **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:\\
--{{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}}
++{{code}}<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}}<set_value name="$foo" exact="static.$foo"/>{{/code}}
  * **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.
@@ -411,11 +411,11 @@
  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)
++* {{code}}0{{/code}} (integer number)
++* {{code}}0772{{/code}} (leading 0 means octal integer number)
++* {{code}}3.14159{{/code}} (floating point number)
++* {{code}}5e12{{/code}} (float in exponent notation, "times ten to the power of")
++* {{code}}0xCAFE{{/code}} (hexadecimal integer number)
@@ -425,9 +425,9 @@
  You can write string literals by putting the string in single quotes:
--* {{code language="xml"}}'Hello world'{{/code}}
--* {{code language="xml"}}''{{/code}} (empty string)
--* {{code language="xml"}}'String with a line break\n'{{/code}}
++* {{code}}'Hello world'{{/code}}
++* {{code}}''{{/code}} (empty string)
++* {{code}}'String with a line break\n'{{/code}}
@@ -437,12 +437,12 @@
  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)
++* {{code}}5000000000L{{/code}} (large integer)
++* {{code}}1f{{/code}} (floating point number, same as 1.0, just 1 would be an integer)
++* {{code}}1000Cr{{/code}} (Money in Credits, converted to 100000 cents automatically)
++* {{code}}500m{{/code}} (Length in metres)
++* {{code}}10s{{/code}} (Time in seconds)
++* {{code}}1h{{/code}} (Time in hours, which is converted to 3600s automatically)
  A space between number and suffix is allowed.
@@ -492,83 +492,83 @@
  (% style="margin-left: 0.0px;" %)
  (((
  |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
++|null|constant|{{code}}null + 1{{/code}}|{{code}}1{{/code}}|Null value, see above
++|false|constant|{{code}}1 == 0{{/code}}|{{code}}false{{/code}}|Integer value 0, useful in Boolean expressions
++|true|constant|{{code}}null == 0{{/code}}|{{code}}true{{/code}}|Integer value 1, useful in Boolean expressions
++|pi|constant|{{code}}2 * pi{{/code}}|{{code}}6.2831853rad{{/code}}|╧Ç as an angle (same as 180deg)
++|()|delimiter|{{code}}(2 + 4) * (6 + 1){{/code}}|{{code}}42{{/code}}|Parentheses for arithmetic grouping
++|[]|delimiter|{{code}}[1, 2, 2+1, 'string']{{/code}}|{{code}}[1, 2, 3, 'string']{{/code}}|[[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
++|{}|delimiter|{{code}}{101, 3}{{/code}}|{{code}}'Some text'{{/code}}|Text lookup (page ID and text ID) from TextDB
  \\(Note: Braces are also used for [[property lookups>>MediaWiki.NULL]])
--|+|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
++|+|unary|{{code}}+21 * (+2){{/code}}|{{code}}42{{/code}}|Denotes positive number (no effect)
++|-|unary|{{code}}-(21 * -2){{/code}}|{{code}}42{{/code}}|Negates the following number
++|not|unary|{{code}}not (21 == 42){{/code}}|{{code}}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]]
++{{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}}|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)
++{{code}}sin(30deg){{/code}}
++\\{{code}}sin(pi){{/code}}|
++{{code}}0.5{{/code}}
++\\{{code}}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)
++{{code}}cos(60deg){{/code}}
++\\{{code}}cos(pi){{/code}}|
++{{code}}0.5{{/code}}
++\\{{code}}0.0{{/code}}|Cosine (function-style, parentheses required)
++|sqrt|unary|{{code}}sqrt(2){{/code}}|{{code}}1.414213LF{{/code}}|Square root (function-style, parentheses required)
++|exp|unary|{{code}}exp(1){{/code}}|{{code}}2.71828LF{{/code}}|Exponential function (function-style, parentheses required)
++|log|unary|{{code}}log(8) / log(2){{/code}}|{{code}}3.0LF{{/code}}|Natural logarithm (function-style, parentheses required)
++|^|binary|{{code}}10 ^ 3{{/code}}|{{code}}1000.0LF{{/code}}|Power
++|*|binary|{{code}}21 * 2{{/code}}|{{code}}42{{/code}}|Multiplication
++|/|binary|{{code}}42 / 1042.0 / 10.0{{/code}}|{{code}}44.2{{/code}}|Division
++|%|binary|{{code}}42 % 10{{/code}}|{{code}}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}}|
++{{code}}1 + 1{{/code}}
++\\{{code}}'Hello' + ' world'{{/code}}|
++{{code}}2{{/code}}
++\\{{code}}'Hello world'{{/code}}|
  Addition
  \\String concatenation
--|-|binary|{{code language="xml"}}1 - 1{{/code}}|{{code language="xml"}}0{{/code}}|Subtraction
++|-|binary|{{code}}1 - 1{{/code}}|{{code}}0{{/code}}|Subtraction
  |
  lt
  \\< (<)|binary|
--{{code language="xml"}}1 lt 3{{/code}}
--\\{{code language="xml"}}1 &lt; 3{{/code}}|{{code language="xml"}}true{{/code}}|Less than
++{{code}}1 lt 3{{/code}}
++\\{{code}}1 &lt; 3{{/code}}|{{code}}true{{/code}}|Less than
  |
  le
  \\<=|binary|
--{{code language="xml"}}1 le 3{{/code}}
--\\{{code language="xml"}}1 &lt;= 3{{/code}}|{{code language="xml"}}true{{/code}}|Less than or equal to
++{{code}}1 le 3{{/code}}
++\\{{code}}1 &lt;= 3{{/code}}|{{code}}true{{/code}}|Less than or equal to
  |
  gt
  \\> (>)|binary|
--{{code language="xml"}}1 gt 3{{/code}}
--\\{{code language="xml"}}1 &gt; 3{{/code}}|{{code language="xml"}}false{{/code}}|Greater than
++{{code}}1 gt 3{{/code}}
++\\{{code}}1 &gt; 3{{/code}}|{{code}}false{{/code}}|Greater than
  |
  ge
  \\>=|binary|
--{{code language="xml"}}1 ge 3{{/code}}
--\\{{code language="xml"}}1 &gt;= 3{{/code}}|{{code language="xml"}}false{{/code}}|Greater than or equal to
++{{code}}1 ge 3{{/code}}
++\\{{code}}1 &gt;= 3{{/code}}|{{code}}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)
++)))|binary|{{code}}1 + 1 == 2.0{{/code}}|{{code}}true{{/code}}|Equal to
++|~!=|binary|{{code}}1 + 1 != 2.0{{/code}}|{{code}}false{{/code}}|Not equal to
++|and|binary|{{code}}true and false{{/code}}|{{code}}false{{/code}}|Logical AND (short-circuit semantics)
++|or|binary|{{code}}true or false{{/code}}|{{code}}true{{/code}}|Logical OR (short-circuit semantics)
  |
  if ... then ...
  \\if ... then ... else ...|ternary|
--{{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")
++{{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")
  )))(% id="operator-precedence-rules" %)
  (%%)
@@ -603,17 +603,17 @@
  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}}
++* {{code}}(1 + 1)f{{/code}} ⟹ {{code}}2f{{/code}} ⟹ {{code}}2.0{{/code}}
++* {{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.)
++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.
  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}}
++* {{code}}'One plus one is equal to ' + (1+1) + '.'{{/code}} ⟹ {{code}}'One plus one is equal to 2.'{{/code}}
++* {{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.
@@ -627,7 +627,7 @@
  * 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)
++** Example:{{code}} false and $foo{{/code}} ⟹ {{code}}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.
@@ -640,8 +640,8 @@
  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]].
@@ -651,9 +651,9 @@
  \\**[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 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)
++* {{code}}'%,s'.[12345678]{{/code}} ⟹ {{code}}'12,345,678'{{/code}} (the "," modifier shows a number with thousands separators, correctly localised)
++* {{code}}'%.3s'.[123.4]{{/code}} ⟹ {{code}}'123.400'{{/code}} (show 3 fractional digits, rounding half away from zero - decimal point correctly localised)
++* {{code}}'%,.1s'.[12345.67]'{{/code}} ⟹ {{code}}'12,345.7'{{/code}} (combination of the above)
  Additional remarks:
@@ -709,15 +709,15 @@
  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\\
++* {{code}}table[]{{/code}} ⟹ creates an empty table
++* {{code}}table[{0} = null]{{/code}} ⟹ 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\\
++* {{code}}table[{'$foo'} = 'bar']{{/code}} ⟹ a table that maps the string '$foo' to the string 'bar'
++* {{code}}table[$foo = 'bar']{{/code}} ⟹ exactly the same, just a shorter notation for string keys
++* {{code}}table[foo = 'bar']{{/code}} ⟹ error, 'foo' does not start with a '$'
++* {{code}}table[{1} = [], {2} = table[]] {{/code}} ⟹ a table that maps 1 to an empty list and 2 to an empty table\\
@@ -744,28 +744,28 @@
  You can look up a property by appending a dot and the key in curly braces:
--* {{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\\
++* {{code}}[100, 200, 300, 400].{1}{{/code}} ⟹ 100 (reading the first element)
++* {{code}}[100, 200, ['Hello ', 'world']] .{3}.{2}{{/code}} ⟹ 'world' (second element of the inner list, which is the third element of the outer list)
++* {{code}}[].{'count'}{{/code}} ⟹ 0
++* {{code}}table[{21} = 42].{21}{{/code}} ⟹ 42\\
  In most cases the property key is a fixed string, like "name" or "class". You can write this like above:
--* {{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}}\\
++* {{code}}[42].{'count'}{{/code}}
++* {{code}}$ship.{'name'}{{/code}}
++* {{code}}$ship.{'class'}{{/code}}
++* {{code}}table[$foo='bar'].{'$foo'}{{/code}}\\
  But it is easier just to write the property key without braces, which is equivalent:
--* {{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}}\\
++* {{code}}[0].count{{/code}}
++* {{code}}$ship.name{{/code}}
++* {{code}}$ship.class{{/code}}
++* {{code}}table[$foo='bar'].$foo{{/code}}\\
@@ -777,19 +777,19 @@
  **min'** and '**max'** return the minimum or maximum (all elements have to be numeric)
--* {{code language="xml"}}[1, 6, 8].min{{/code}} ⟹ 1
++* {{code}}[1, 6, 8].min{{/code}} ⟹ 1
  **average'** returns the average (but all element types have to be compatible)
--* {{code language="xml"}}[1, 6, 8].average{{/code}} ⟹ 5
++* {{code}}[1, 6, 8].average{{/code}} ⟹ 5
  **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
--* {{code language="xml"}}[1, 6, 8].indexof.{8}{{/code}} ⟹ 3
++* {{code}}[1, 6, 8].indexof.{8}{{/code}} ⟹ 3
  **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)
--* {{code language="xml"}}[1, 6, 8].clone{{/code}} ⟹ {{code language="xml"}}[1, 6, 8]{{/code}}
++* {{code}}[1, 6, 8].clone{{/code}} ⟹ {{code}}[1, 6, 8]{{/code}}
  A table has different properties:
@@ -800,12 +800,12 @@
--* {{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)\\
++* {{code}}$table.keys.list{{/code}}: Yields a list of all keys in the table (reliably sorted by key if all keys are numeric)\\
--* {{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)
++* {{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)
++* {{code}}$table.keys.random{{/code}}: A randomly chosen key (which requires that the table is non-empty)
@@ -820,22 +820,22 @@
  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'\\
++* {{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
++* {{code}}$list.{5}?{{/code}} ⟹ true if $list exists and has the property 5, false otherwise
++* {{code}}$table.$key?{{/code}} ⟹ Analogously, true if $table exists and has the string property '$key'\\
  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
++* {{code}}$list{{/code}} ⟹ The value stored under the name $list, or an error if there is no such variable
++* {{code}}$list?{{/code}} ⟹ true if the variable exists, false otherwise
  To look up the value of a property although it may not exist, you can use the at-sign "@" as prefix:
--* {{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
++* {{code}}@$list.{5}{{/code}} ⟹ The result of the $list lookup if $list exists and has the property 5, otherwise null (without error message)
++* {{code}}@$list{{/code}} ⟹ The list if this variable exists, null otherwise
++* {{code}}@$list.{5}.{1}{{/code}} ⟹ The first element of the fifth element of $list, if it exists, null otherwise
  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.
@@ -958,13 +958,13 @@
  **[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.
--* {{code language="xml"}}$money.formatted.{'formatstring'}{{/code}}
--* {{code language="xml"}}$money.formatted.default{{/code}} (using default format string '%s')\\
++* {{code}}$money.formatted.{'formatstring'}{{/code}}
++* {{code}}$money.formatted.default{{/code}} (using default format string '%s')\\
--* {{code language="xml"}}$time.formatted.{'formatstring'}{{/code}}
--* {{code language="xml"}}$time.formatted.default{{/code}} (using default format string '%T')
++* {{code}}$time.formatted.{'formatstring'}{{/code}}
++* {{code}}$time.formatted.default{{/code}} (using default format string '%T')
  In scripts, money is stored in cents, not Credits. The formatted representation always shows the value in Credits, including thousands separators.
@@ -994,20 +994,20 @@
--* {{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}}
++* {{code}}(1234Cr).formatted.{'%s'}{{/code}}⟹{{code}}'1,234'{{/code}}
++* {{code}}(1234Cr).formatted.default{{/code}}⟹{{code}}'1,234'{{/code}} (same as {'%s'})
++* {{code}}(1234Cr).formatted.{'%.s %Cr'}{{/code}}⟹{{code}}'1,234.00 Cr'{{/code}}
++* {{code}}(1234Cr).formatted.{'%1s'}{{/code}}⟹{{code}}'1 k'{{/code}} (rounding towards zero)
++* {{code}}(1234Cr).formatted.{'%cM'}{{/code}}⟹{{code}}'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 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}}
++* {{code}}(151s).formatted.{'%T'}{{/code}} ⟹ {{code}}'00:02:31'{{/code}}
++* {{code}}(151s).formatted.default{{/code}} ⟹ {{code}}'00:02:31'{{/code}} (same as {'%T'})
++* {{code}}(151s).formatted.{'%.3T'}{{/code}} ⟹ {{code}}'00:02:31.000'{{/code}}
++* {{code}}(151s).formatted.{'%h:%M'}{{/code}} ⟹ {{code}}'0:02'{{/code}}
  (% id="complete-property-documentation" %)
@@ -1091,7 +1091,7 @@
  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.
--{{code language="xml"}}<cue [...] version="42"> <conditions> [...] </conditions> <actions> [...] </actions> <patch sinceversion="42">    [patch actions] </patch></cue>{{/code}}
++{{code}}<cue [...] version="42"> <conditions> [...] </conditions> <actions> [...] </actions> <patch sinceversion="42">    [patch actions] </patch></cue>{{/code}}
  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.
@@ -1117,11 +1117,11 @@
  There are many conditions and conditional actions that require a value comparison, for example the condition <check_value>:
--{{code language="xml"}}<check_value value="$ware == ware.silicon and $amount != 0"/>{{/code}}
++{{code}}<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:
--{{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}}
++{{code}}<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}}
  {{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}}
@@ -1133,21 +1133,21 @@
  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}}
++{{code}}<set_value name="$race" exact="race.teladi"/>{{/code}}
  To select a random element from a list, this syntax can be used:
--{{code language="xml"}}<set_value name="$prime" list="[2, 3, 5, 7, 11]"/>{{/code}}
++{{code}}<set_value name="$prime" list="[2, 3, 5, 7, 11]"/>{{/code}}
  To get a random number within a given range, you can use min/max:
--{{code language="xml"}}<set_value name="$foo" min="-20" max="20"/><set_value name="$timeout" max="20s"/>{{/code}}
++{{code}}<set_value name="$foo" min="-20" max="20"/><set_value name="$timeout" max="20s"/>{{/code}}
  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).
  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).
--{{code language="xml"}}<set_value name="$foo" min="-20" max="20" profile="profile.increasing" scale="4"/>{{/code}}
++{{code}}<set_value name="$foo" min="-20" max="20" profile="profile.increasing" scale="4"/>{{/code}}
  \\(% id="variables-and-namespaces" %)
@@ -1160,35 +1160,35 @@
  == Creating and removing variables ==
--You can create variables with certain actions and conditions, such as the <set_value> action:
++{{{You can create variables with certain actions and conditions, such as the <set_value> action:}}}
--{{code language="xml"}}<set_value name="$foo" exact="$bar + 1" />{{/code}}
++{{code}}<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>.)
  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.
--{{code language="xml"}}<set_value name="$foo" operation="add" />{{/code}}
++{{code}}<set_value name="$foo" operation="add" />{{/code}}
  The trick is that <set_value> not only works on variables, but also on list elements and table keys:
--{{code language="xml"}}<set_value name="$list.{1}" exact="42" /><set_value name="$table.$foo" exact="42" />{{/code}}\\
++{{code}}<set_value name="$list.{1}" exact="42" /><set_value name="$table.$foo" exact="42" />{{/code}}\\
  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 language="xml"}}<set_value name="$list.{1}" exact="42" operation="insert" />{{/code}}
++{{code}}<set_value name="$list.{1}" exact="42" operation="insert" />{{/code}}
  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}}
++{{code}}<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.
  To remove variables or list/table entries, use <remove_value>:
--{{code language="xml"}}<remove_value name="$foo" /><remove_value name="$list.{1}" /><remove_value name="$table.$foo" />{{/code}}\\
++{{code}}<remove_value name="$foo" /><remove_value name="$list.{1}" /><remove_value name="$table.$foo" />{{/code}}\\
  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.
@@ -1198,11 +1198,11 @@
  You can also read and write variables in other cues by using the variable name as property key:
--{{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}}<set_value name="OtherCue.$foo" min="0.0" max="1.0" /><set_value name="md.OtherScript.YetAnotherCue.$bar" exact="OtherCue.$foo" />{{/code}}
  Instead of referencing a cue by name, you could also reference it via a keyword or another variable:
--{{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}}
++{{code}}<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}}
  \\\\\\(% id="namespaces" %)
@@ -1212,7 +1212,7 @@
  Consider this case:
--{{code language="xml"}}<cue name="Root"> <actions>  <set_value name="$foo" /> </actions> <cues>  <cue name="SubCue"> [...]  </cue> </cues></cue>{{/code}}
++{{code}}<cue name="Root"> <actions>  <set_value name="$foo" /> </actions> <cues>  <cue name="SubCue"> [...]  </cue> </cues></cue>{{/code}}
  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.
@@ -1231,4 +1231,4 @@
  {{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:
--<code language="xml"><cue name="LibRef" ref="Lib"> <param name="Param1" value="$foo" /> <!-- $foo from parent namespace --> <param name="Param2" value="namespace.$foo" /> <!-- LibRef.$foo (error) --></cue></code>{{/warning}}
++<code><cue name="LibRef" ref="Lib"> <param name="Param1" value="$foo" /> <!-- $foo from parent namespace --> <param name="Param2" value="namespace.$foo" /> <!-- LibRef.$foo (error) --></cue></code>{{/warning}}

Changes for page Mission Director Guide

Summary

Details

Navigation

Applications