Changes for page Mission Director Guide

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

From 32969.1 to 32970.1 From 32970.10 to 32970.11

From version 32970.1

edited by Owen Lake
on 2023/10/10 15:22

Change comment: There is no comment for this version

To version 32970.10

edited by Heinrich Unrau
on 2024/10/17 12:54

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.Owen
++xwiki:XWiki.Heinrich

Content

@@ -407,11 +407,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 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."
@@ -420,7 +420,7 @@
  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}}
@@ -432,12 +432,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.
@@ -518,21 +518,40 @@
  \\{{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}}(((
++|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)
--{{code language="xml"}}tan(45deg){{/code}}
--)))|(((
--(% id="cke_bm_767206S" style="display:none" %) {{code language="xml"}}-1.0{{/code}}
++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)
--{{code language="xml"}}
--1.0
--{{/code}}
--)))|Tangent (function-style, parentheses required)
--|asin|unary|{{code language="xml"}}asin(-0.5f){{/code}}{{code language="xml"}}asin(1){{/code}}|{{code language="xml"}}-0.523599rad{{/code}}(((
--
--))){{code language="xml" width="70"}}1.5708rad{{/code}}|Inverse sine (function-style, parentheses required)
--|acos|unary|{{code language="xml"}}acos(0.5f){{/code}}{{code language="xml"}}acos(1.0f){{/code}}|{{code language="xml"}}asin(2.0944rad){{/code}}{{code language="xml"}}0rad{{/code}}|Inverse cosine (function-style, parentheses required)
--|atan|unary| | |Inverse tangent (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
++)))
  |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)
@@ -611,8 +611,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.)
@@ -620,8 +620,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.
@@ -653,9 +653,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 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:
@@ -700,13 +700,13 @@
  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[{'$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).
@@ -727,10 +727,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:
@@ -754,19 +754,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:
@@ -790,20 +790,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.
@@ -911,10 +911,10 @@
  \\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.
  * {{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.
@@ -948,10 +948,10 @@
  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 ===
@@ -963,7 +963,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:
@@ -988,6 +988,13 @@
  * 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.
++** 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.{{code language="xml"}}  <cue [...] version="42">
++    <conditions> [...] </conditions>
++    <actions> [...] </actions>
++    <patch sinceversion="42">
++      [patch actions]
++    </patch>
++  </cue>{{/code}}
  * 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.)

Changes for page Mission Director Guide

Summary

Details

Navigation

Applications