Changes for page Mission Director Guide

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

From 32958.1 to 32957.1

From version 32984.1

edited by Klaus Meyer
on 2025/03/31 16:39

Change comment: There is no comment for this version

To version 32958.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 (2 modified, 0 added, 0 removed)

Details

Page properties

Author

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

Content

@@ -22,7 +22,7 @@
  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.
  {{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 [[Conditions>>doc:||anchor="HConditions" style="outline-width: 0px !important; user-select: auto !important;"]]).
++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]]).
  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}}
@@ -157,7 +157,7 @@
  * 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.
--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).
++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:
@@ -217,9 +217,11 @@
  {{/code}}
  {{info}}
--Messages printed with <debug_text> are usually only visible when the "scripts" debug filter is enabled, see [[Script debug output>>doc:||anchor="HScriptdebugoutput"]]
++Messages printed with <debug_text> are usually only visible when the "scripts" debug filter is enabled, see Script debug output
  {{/info}}
++
++
  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.
@@ -226,11 +226,8 @@
  **<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.
--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.
++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.
--* If chance is used on a conditional action such as <do_if>, the script will behave as if the condition check failed.
--* If chance is provided on an action within a <do_any>, it will have no effect on the random selection of the action. Only when the action gets selected, the chance will determine whether the action actually gets performed or skipped.
--
  = Libraries =
  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.
@@ -240,6 +240,7 @@
  {{/info}}
++
  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"}}
@@ -290,9 +290,11 @@
  {{/code}}
  {{warning}}
--These examples are definitely **__not__ **examples of good scripting style.
++These examples are definitely <u>not</u> examples of good scripting style.
  {{/warning}}
++
++
  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:
@@ -327,7 +327,7 @@
  </cue>
  {{/code}}
--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">
@@ -362,6 +362,8 @@
  This sub-section requires basic knowledge of script expressions.
  {{/info}}
++
++
  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.
  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.
@@ -397,7 +397,7 @@
  * **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}}
++{{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}}
@@ -408,20 +408,22 @@
  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 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)
  {{info}}
  Since octal numbers are hardly ever used (usually unknowingly), the parser is will produce a warning if an octal number is encountered."
  {{/info}}
++
++
  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"}}''{{/code}} (empty string)
  * {{code language="xml"}}'String with a line break\n'{{/code}}
  {{info}}
@@ -433,12 +433,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 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)
  A space between number and suffix is allowed.
@@ -495,10 +495,10 @@
  |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>>doc:||anchor="HLists" style="outline-width: 0px !important; user-select: auto !important;"]] 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>>doc:||anchor="HTables" style="outline-width: 0px !important; user-select: auto !important;"]] of values
++|[]|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>>doc:||anchor="HValueproperties" style="outline-width: 0px !important; user-select: auto !important;"]])
++\\(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
@@ -508,7 +508,7 @@
  \\{{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>>||anchor="typeof" style="outline-width: 0px !important; user-select: auto !important;"]]
++\\{{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}}|
@@ -518,41 +518,7 @@
  {{code language="xml"}}cos(60deg){{/code}}
  \\{{code language="xml"}}cos(pi){{/code}}|
  {{code language="xml"}}0.5{{/code}}
--\\{{code language="xml"}}-1.0{{/code}}|Cosine (function-style, parentheses required)
--|tan|unary|
--{{code language="xml"}}tan(-45deg){{/code}}
--\\{{code language="xml"}}tan(45deg){{/code}}|
--{{code language="xml"}}-1.0{{/code}}
--\\{{code language="xml"}}1.0{{/code}}|(((
--Tangent (function-style, parentheses required)
--
--Available from X4 v7.0
--)))
--|asin|unary|
--{{code language="xml"}}asin(-0.5f){{/code}}
--\\{{code language="xml"}}asin(1){{/code}}|
--{{code language="xml"}}-0.523599rad{{/code}}
--\\{{code language="xml"}}1.5708rad{{/code}}|(((
--Inverse sine (function-style, parentheses required)
--
--Available from X4 v7.0
--)))
--|acos|unary|
--{{code language="xml"}}acos(-0.5f){{/code}}
--\\{{code language="xml"}}acos(1.0f){{/code}}|
--{{code language="xml"}}2.0944rad{{/code}}
--\\{{code language="xml"}}0rad{{/code}}|(((
--Inverse cosine (function-style, parentheses required)
--
--Available from X4 v7.0
--)))
--|atan|unary|
--{{code language="xml"}}atan(1.0f){{/code}}|
--{{code language="xml"}}0.785398rad{{/code}}|(((
--Inverse tangent (function-style, parentheses required)
--
--Available from X4 v7.0
--)))
++\\{{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)
@@ -570,22 +570,26 @@
  |-|binary|{{code language="xml"}}1 - 1{{/code}}|{{code language="xml"}}0{{/code}}|Subtraction
  |
  lt
--\\&lt; (<)|binary|
--{{code language="xml"}}1 lt 3{{/code}}|{{code language="xml"}}true{{/code}}|Less than
++\\< (<)|binary|
++{{code language="xml"}}1 lt 3{{/code}}
++\\{{code language="xml"}}1 < 3{{/code}}|{{code language="xml"}}true{{/code}}|Less than
  |
  le
--\\&lt;=|binary|
--{{code language="xml"}}1 le 3{{/code}}|{{code language="xml"}}true{{/code}}|Less than or equal to
++\\<=|binary|
++{{code language="xml"}}1 le 3{{/code}}
++\\{{code language="xml"}}1 <= 3{{/code}}|{{code language="xml"}}true{{/code}}|Less than or equal to
  |
  gt
--\\&gt; (>)|binary|
--{{code language="xml"}}1 gt 3{{/code}}|{{code language="xml"}}false{{/code}}|Greater than
++\\> (>)|binary|
++{{code language="xml"}}1 gt 3{{/code}}
++\\{{code language="xml"}}1 < 3{{/code}}|{{code language="xml"}}false{{/code}}|Greater than
  |
  ge
--\\&gt;=|binary|
--{{code language="xml"}}1 ge 3{{/code}}|{{code language="xml"}}false{{/code}}|Greater than or equal to
++\\>=|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)
@@ -627,8 +627,8 @@
  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 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}}
  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.)
@@ -636,8 +636,8 @@
  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 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}}
  As you can see, operators of the same precedence (+ in this case) are always evaluated from left to right.
@@ -652,26 +652,29 @@
  * "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>>doc:||anchor="HValuecomparisons"]] with additional XML attributes can be more readable.
++* <, <=, >, >= 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(%%) ==
++(% id="categorybroken_macroanchorstrings-and-formatting" %)== 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:
  * {{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}}
--See also the section about [[value properties>>doc:||anchor="HValueproperties" style="outline-width: 0px !important; user-select: auto !important;"]].
++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'.
++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):
--* {{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 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)
  Additional remarks:
@@ -680,14 +680,14 @@
  * "." 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 [[format money values and time values>>doc:||anchor="HMoneyandtimeformatting" style="outline-width: 0px !important; user-select: auto !important;"]] using the "formatted" property.
++There are also special methods to [[NULL|format money values and time values]] using the "formatted" property.
  {{/info}}
  == Lists ==
--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>>doc:||anchor="HOperators"]]. It may also be generated by special actions and conditions, and there are actions that can [[insert or remove values>>doc:||anchor="HCreatingandremovingvariables" style="outline-width: 0px !important; user-select: auto !important;"]].
++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>>doc:||anchor="HValueproperties"]]. Lists can be empty, these are written as "[ ]".
++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."
@@ -706,25 +706,23 @@
  (% id="categorybroken_macroanchortables" %)
  == 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>>doc:||anchor="HOperators" style="outline-width: 0px !important; user-select: auto !important;"]]. See the section about [[value properties>>doc:||anchor="HValueproperties" style="outline-width: 0px !important; user-select: auto !important;"]] for how to access the contents of a table. [[Creating and removing entries>>doc:||anchor="HCreatingandremovingvariables" style="outline-width: 0px !important; user-select: auto !important;"]] 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.
++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, buildplans, loadouts and constructionsequences cannot be used as table keys
++* 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:
--* {{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 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 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 language="xml"}}table[faction.argon = 'bar']{{/code}}⟹ error, the expression faction.argon will not be resolved into a key value. Requires { } braces.
--* {{code language="xml"}}table[{faction.argon} = 'bar'] {{/code}}⟹ a table that maps the value faction.argon to the string 'bar'
++* {{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).
@@ -745,10 +745,10 @@
  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 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
  In most cases the property key is a fixed string, like "name" or "class". You can write this like above:
@@ -772,19 +772,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 language="xml"}}[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 language="xml"}}[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 language="xml"}}[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 language="xml"}}[1, 6, 8].clone{{/code}} ⟹ {{code language="xml"}}[1, 6, 8]{{/code}}
  A table has different properties:
@@ -801,7 +801,7 @@
  * {{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 [[above>>doc:||anchor="HStringsandformatting" style="outline-width: 0px !important; user-select: auto !important;"]] 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'.{[...]}.
++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}}
  === (% id="lookup-tests-and-suppressing-errors" %)Lookup tests and suppressing errors(%%) ===
@@ -808,20 +808,20 @@
  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 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'
  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 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
  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 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
  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.
@@ -853,11 +853,11 @@
  |profile|
  profile.flat
  \\profile.increasing
--\\profile.bell|Probability distribution profile (see [[random ranges>>doc:||anchor="HRandomranges" style="outline-width: 0px !important; user-select: auto !important;"]])
++\\profile.bell|Probability distribution profile (see [[random ranges>>MediaWiki.NULL]])
  |cuestate|
  cuestate.waiting
  \\cuestate.active
--\\cuestate.complete|[[Cue states>>||anchor="HCues" style="outline-width: 0px !important; user-select: auto !important;"]]
++\\cuestate.complete|[[Cue states>>MediaWiki.NULL]]
  |level|
  level.easy
  \\level.medium
@@ -877,8 +877,6 @@
  \\faction.argongovernment|Factions
  )))
--{{id name="typeof"/}}
--
  {{info}}
  With the ''typeof'' operator you can get the datatype of any expression and compare it with what you expect, for example:
@@ -926,13 +926,13 @@
  === (% id="categorybroken_macroanchormoney-and-time-formatting" %)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>>||anchor="HStringsandformatting" style="outline-width: 0px !important; user-select: auto !important;"]] for numbers.
++\\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 language="xml"}}$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 language="xml"}}$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.
@@ -962,14 +962,14 @@
  * {{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 [[Lua function overview>>doc:X Rebirth Wiki.Modding support.UI Modding support.Lua function overview.WebHome||style="outline-width: 0px !important; user-select: auto !important;"]].
++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 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}}
  === Complete property documentation ===
@@ -981,7 +981,7 @@
  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
++* Chrome: The Chrome launcher has to be started with the command-line parameter --allow-file-access-from-files--
  {{/info}}
  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:
@@ -1006,7 +1006,6 @@
  * 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.
--** (!) Pitfall: It is recommended that cues are not removed if they were previously released in public builds, to prevent future cues with the same name leading to errors (see example below). Instead they can be emptied and marked as deprecated.
  * 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.)
@@ -1028,34 +1028,6 @@
  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}}
--{{warning}}
--(% id="cke_bm_221021S" style="display:none" %) (%%)Cue Removal Pitfall:
--If you remove a cue and then later add another cue with the same name, old save files will not know that the cue has been removed inbetween. In the following example the first cue was created setting $val_1 and the game is saved.
--{{code language="xml"}}<cue name="Deprecated_Test1">
--  <actions>
--    <set_value name="$val_1" exact="'old value'"/>
--    <debug_text text="$val_1"/>
--  </actions>
--</cue>{{/code}}
--\\If the Cue is deleted and years later a new cue with the same name appears, the old save will consider the new cue as already completed without executing its actions. The Cue PrintValue will fail to find a variable set up in its parent.
--{{code language="xml"}}<cue name="Deprecated_Test1">
--  <actions>
--    <set_value name="$val_2" exact="'new value'"/>
--    <debug_text text="$val_2"/>
--  </actions>
--  <cues>
--    <cue name="PrintValue">
--      <actions>
--        <debug_text text="$val_2"/>
--      </actions>
--    </cue>
--  </cues>
--</cue>{{/code}}
--\\To avoid this, do not delete any cues (once they are public for save game compatibility), but empty them out and mark them as deprecated. This will prevent new cues with the same name in the script.
--{{code language="xml"}}<!-- Deprecated Cues, kept to not duplicate names in future cues -->
--<cue name="Deprecated_Test1" comment="deprecated"></cue>{{/code}}
--{{/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.
@@ -1134,6 +1134,7 @@
    <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).
@@ -1188,6 +1188,7 @@
  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.
++
  == Accessing remote variables ==
  You can also read and write variables in other cues by using the variable name as property key:

Changes for page Mission Director Guide

Summary

Details

Navigation

Applications