Changes for page Mission Director Guide

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

From 32944.2 to 32944.3 From 32945.1 to 32946.1

From version 32944.3

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

Change comment: Update document after refactoring.

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

@@ -1,6 +1,6 @@
  The Mission Director (MD) is a subsystem of the game and interprets mission scripts, which are written in an XML-based language. The Mission Director in X Rebirth and X4 is based on the MD in X3: Terran Conflict, with some major changes based on feedback from MD users.\\
--An introduction to the original MD can be found in the[[(% style="color: rgb(0,0,153);text-decoration: underline;" %)Egosoft forums>>url:http://forum.egosoft.com/viewtopic.php?t=196971]](%%). There is also a PDF guide for the X3 Mission Director, which is partially used as a template for this document.
++An introduction to the original MD can be found in the[[(% &text-decoration: underline;" %)Egosoft forums>>url:http://forum.egosoft.com/viewtopic.php?t=196971]](%%). There is also a PDF guide for the X3 Mission Director, which is partially used as a template for this document.
  This document is primarily supposed to be a guide for MD users (people who use the MD to develop missions or write other MD scripts), not for MD programmers (people who work on the MD engine in C++).
@@ -8,7 +8,6 @@
  (% id="md-scripts" %)
--
  {{toc/}}
  = MD scripts =
@@ -17,12 +17,12 @@
  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 [[(% style="color: rgb(0,0,153);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.
++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.
  {{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 [[xwiki:MediaWiki.X4.X4_DocumentationX4_Game_Design0_GeneralMission_Director_Guide.NULL|Conditions.WebHome]]).
++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}}
@@ -33,15 +33,11 @@
  To collect all messages in a file, start the game with the following parameters on the command line:
--{{code}}
---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}}
---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.\\
@@ -85,14 +85,13 @@
  * **Active**: The cue is about to perform the actions. Child cues have entered the waiting state.\\
++
  * **Complete**: The cue has finished performing its actions.
  * **Cancelled**: The cue has been cancelled. This state cannot normally be reached but only if a cue actively cancels itself or another cue. No condition checks or actions are performed in this cue or any sub-(sub-)cue.
  \\
--{{info}}
--There can be a delay between the activation and performing the actions if the <delay> tag is used. In this case, sub-cues will be enter the waiting state before the parent's actions are performed.
--{{/info}}
++{{info}}There can be a delay between the activation and performing the actions if the <delay> tag is used. In this case, sub-cues will be enter the waiting state before the parent's actions are performed.{{/info}}
  This is how a cue node looks like:
@@ -159,6 +159,7 @@
  * Use //onfail// if the conditions should be checked only once. The possible attribute values are "//cancel//" and "//complete//". If the conditions are met, the cue will activate and perform the cue actions. Otherwise it's a failure and the cue will be cancelled or completed, based on the onfail attribute. Typically //onfail="cancel"// is used to prevent any further action. //onfail="complete"// can be used to continue with the sub-cues even in case of failure (but skipping the current cue actions).\\
++
  * 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).
@@ -221,9 +221,7 @@
--{{info}}
--Messages printed with <debug_text> are usually only visible when the "scripts" debug filter is enabled, see Script debug output
--{{/info}}
++{{info}}Messages printed with <debug_text> are usually only visible when the "scripts" debug filter is enabled, see Script debug output{{/info}}
@@ -239,9 +239,7 @@
  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.
--{{info}}
--The syntax of libraries is considerably different from the syntax in the MD of X3TC.
--{{/info}}
++{{info}}The syntax of libraries is considerably different from the syntax in the MD of X3TC.{{/info}}
@@ -295,9 +295,7 @@
  {{/code}}
--{{warning}}
--These examples are definitely <u>not</u> examples of good scripting style.
--{{/warning}}
++{{warning}}These examples are definitely <u>not</u> examples of good scripting style.{{/warning}}
@@ -307,7 +307,7 @@
  * It is //not// possible to directly call a cue which is 'inside' the library from 'outside' of the library, but it is possible to signal the library ref itself (possibly with parameters) and have a sub-cue inside the library listen to the signal on the library ref (possibly checking the parameters).
  * You //can// access variables in the library root but generally this should be avoided in favor of parameterizing the library!
--** there are some cases where you do want to access these variables directly, for example for maintaining savegame compatibility when patching.
++** there are some cases where you do want to access these variables directly, for example for maintaining savegame compatibility when patching.(% id="library-parameters" %)
  == Library Parameters ==
@@ -352,7 +352,7 @@
  = Instantiation =
--One of the possible cue attributes is //**instantiate**//. If you set it to true, this changes what happens when a cue's conditions are met. Normally, if a cue is (% style="color: rgb(0,0,0);text-decoration: underline;" %)not instantiated, the cue's actions are run (taking a delay node into account) and the cue is marked as completed. But with **instantiate'//, a// **copy of the cue** (and all its sub-cues) is made when the conditions are met, and it is this copy in which the actions are performed and it is the copy whose status is set to complete when they are finished - this means that the original cue (the so-called **static cue**) remains in the //waiting// state, and if the conditions are met again then the whole thing happens all over again.**
++One of the possible cue attributes is //**instantiate**//. If you set it to true, this changes what happens when a cue's conditions are met. Normally, if a cue is not instantiated, the cue's actions are run (taking a delay node into account) and the cue is marked as completed. But with **instantiate'//, a// **copy of the cue** (and all its sub-cues) is made when the conditions are met, and it is this copy in which the actions are performed and it is the copy whose status is set to complete when they are finished - this means that the original cue (the so-called **static cue**) remains in the //waiting// state, and if the conditions are met again then the whole thing happens all over again.**
  \\An instantiating cue should only be used with conditions that are only going to be met once (or a fairly limited number of times), or with conditions that include an event condition. Instantiation should not be used in a cue which, say, just depends on the game time being greater than a specific value as this will result in a copy of the cue being made after each check interval, which could increase memory usage a lot. The most common use of an instantiated cue is in responding to events such as the player ship changing sector, to react every time that event happens.
  \\Instances that are created via //instantiate// are called **instantiated cues**. But sub-cues of instances are also instances (**sub-instances**) - they are created when they enter the waiting state. An instance is removed again (thereby freeing its memory) when it is complete or cancelled, and when all its instance sub-cues have been removed before. The simplest case is an instantiating cue with no sub-cues: The instance is created, the actions are performed, and the instance is removed immediately on completion. A pitfall could be an instance with a sub-cue that is forever in the waiting state (e.g. waiting for an event from an already destroyed object). It can never be removed, so you should clean up such a cue yourself, e.g. by cancelling it explicitly.
@@ -360,15 +360,13 @@
  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 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 "/}}
++{{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 ==
--{{info}}
--This sub-section requires basic knowledge of script expressions.
--{{/info}}
++{{info}}This sub-section requires basic knowledge of script expressions.{{/info}}
@@ -407,7 +407,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:\\
--(% style="color: rgb(0,0,255);text-decoration: none;" %){{code}}<debug_text text="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}}
@@ -425,12 +425,11 @@
  * {{code}}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}}
++{{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}}'Hello world'{{/code}}
@@ -438,10 +438,9 @@
  * {{code}}'String with a line break\n'{{/code}}
--{{info}}
--Since expressions are written in XML attribute values, you have to use the single quotes inside the double quotes for the actual attribute value. To write characters like '''< > " &''' in an expression string (or anywhere else in an XML attribute value), you'll have to escape them as '''&lt; &gt; &quot; &amp;''' respectively. The backslash '''\''' can be used in strings for escape characters like in C/C++. Most important are '''\'''' for a single quote as part of the string, and '''\\''' for the backslash itself.
--{{/info}}
++{{info}}Since expressions are written in XML attribute values, you have to use the single quotes inside the double quotes for the actual attribute value. To write characters like '''< > " &''' in an expression string (or anywhere else in an XML attribute value), you'll have to escape them as '''&lt; &gt; &quot; &amp;''' respectively. The backslash '''\''' can be used in strings for escape characters like in C/C++. Most important are '''\'''' for a single quote as part of the string, and '''\\''' for the backslash itself.{{/info}}
++
  == Numeric data types and suffixes ==
  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:
@@ -492,9 +492,7 @@
  \\24h|Time in milliseconds, seconds, minutes, or hours, respectively. A time value is always stored in seconds.
  )))
--{{info}}
--All unit data types are floating point types, except for money, which is an integer data type.
--{{/info}}
++{{info}}All unit data types are floating point types, except for money, which is an integer data type.{{/info}}
  == Operators ==
@@ -508,10 +508,10 @@
  |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>>xwiki:MediaWiki.NULL.WebHome]] of values
--|table[]|delimiter|{{code}}table[$foo='bar', {1+1}=40+2]{{/code}}|{{code}}table[$foo='bar', {2}=42]{{/code}}|[[Table>>xwiki:MediaWiki.NULL.WebHome]] of values
++|[]|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>>xwiki:MediaWiki.NULL.WebHome]])
++\\(Note: Braces are also used for [[property lookups>>MediaWiki.NULL]])
  |+|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
@@ -521,7 +521,7 @@
  \\{{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>>xwiki:MediaWiki.NULL.WebHome]]
++\\{{code}}datatype.string{{/code}}|Yields the [[data type of the following sub-expression>>MediaWiki.NULL]]
  |sin|unary|
  {{code}}sin(30deg){{/code}}
  \\{{code}}sin(pi){{/code}}|
@@ -580,10 +580,10 @@
  \\{{code}}if 1 == 2 then 'F' else 'T'{{/code}}|
  {{code}}null{{/code}}
  \\{{code}}'T'{{/code}}|Conditional operator ("inline if")
--)))
++)))(% id="operator-precedence-rules" %)
++(%%)
--
  === Operator precedence rules ===
  You can group sub-expressions using parentheses, but if you don't, the following order of operations is applied, so that 5-1+2*3 == 10 as you would expect. The order is the same as in the table above, but there are operators with the same precedence - these are applied from left to right.
@@ -600,7 +600,6 @@
  (% id="type-conversion" %)
--
  === Type conversion ===
  When a binary arithmetic operator is used on numbers of different types, they will be converted to a suitable output type. The resulting type depends on whether a unit data type is involved (types that are not plain integers or floats). The following cases may occur:
@@ -631,7 +631,6 @@
  (% id="boolean-operators" %)
--
  === Boolean operators ===
  Some additional notes on Boolean operators (such as and, or, not, ==):
@@ -642,14 +642,13 @@
  * "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}} 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>>xwiki:MediaWiki.NULL.WebHome]] 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==
  (% id="categorybroken_macroanchorstrings-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:
@@ -657,7 +657,7 @@
  * {{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>>xwiki:MediaWiki.NULL.WebHome]].
++See also the section about [[value properties>>MediaWiki.NULL]].
  Instead of ΓÇÿ%1 %2 %3', you can also use ΓÇÿ%s %s %s', which is also compatible with Lua string formatting in the UI system. However, this should only be used if you are sure that the order is the same in all supported languages. If you want to make translators aware that they can change the order of parameters, you should prefer '%1 %2 %3'.
  \\To get a percent character in the result string, use '%%' in the format string.
@@ -676,36 +676,32 @@
  * "." 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 body="There are also special methods to [[NULL|format money values and time values]] using the "/}}
++{{info body="There are also special methods to [[NULL|format money values and time values]] using the "formatted" property."/}}
++
  \\
  (% id="categorybroken_macroanchorlists" %)
--
  == 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>>xwiki:MediaWiki.NULL.WebHome]]. It may also be generated by special actions and conditions, and there are actions that can [[insert or remove values>>xwiki:MediaWiki.NULL.WebHome]].
++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>>xwiki:MediaWiki.NULL.WebHome]]. 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."
--{{/info}}
++{{info}}When accessing a list's elements, the numbering is '''1-based''', so the first element has number 1. This is intuitive but different from 0-based numbering in most programming languages."{{/info}}
  Lists are stored in variables as references, so multiple variables can refer to the same **shared list**: If you change a shared list through a variable, e.g. by changing the value of an element, you change it as well for all other variables. However, the operators == and != can also be used on two distinct lists to compare their elements.
--{{info}}
--When using <remove_from_list/>, be aware that all elements are checked and potentially removed during the action. Do not provide this action with a index lookup of that list as it may become out of bounds.
++{{info}}When using <remove_from_list/>, be aware that all elements are checked and potentially removed during the action. Do not provide this action with a index lookup of that list as it may become out of bounds.
  Bad usage attempting to remove the last element of the list: <remove_from_list name="$List" exact="$List.{$List.count}"/>
--If you know the index, simply use <remove_value/> e.g. <remove_value name="$List.{$List.count}"/>
--{{/info}}
++If you know the index, simply use <remove_value/> e.g. <remove_value name="$List.{$List.count}"/>{{/info}}
@@ -713,10 +713,9 @@
  (% 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>>xwiki:MediaWiki.NULL.WebHome]]. See the section about [[value properties>>xwiki:MediaWiki.NULL.WebHome]] for how to access the contents of a table. [[Creating and removing entries>>xwiki:MediaWiki.NULL.WebHome]] 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:
@@ -725,6 +725,7 @@
  * 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}}table[]{{/code}} ⟹ creates an empty table
@@ -731,6 +731,7 @@
  * {{code}}table[{0} = null]{{/code}} ⟹ creates a table that maps the number 0 to null\\
++
  * {{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 '$'
@@ -737,6 +737,7 @@
  * {{code}}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).\\
  \\
@@ -743,7 +743,6 @@
  (% id="categorybroken_macroanchorvalue-properties" %)
--
  == Value properties ==
  Properties are a crucial concept in script expressions. In the previous sections you have seen mostly constant expressions, which are already evaluated when they are parsed at game start. For reading and writing variables and evaluating the game's state, properties are used.
@@ -767,6 +767,7 @@
  * {{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}}[42].{'count'}{{/code}}
@@ -775,6 +775,7 @@
  * {{code}}table[$foo='bar'].{'$foo'}{{/code}}\\
++
  But it is easier just to write the property key without braces, which is equivalent:
  * {{code}}[0].count{{/code}}
@@ -783,6 +783,7 @@
  * {{code}}table[$foo='bar'].$foo{{/code}}\\
++
  (In this case, $ship is a variable. All variables start with a "$", so they cannot be confused with keywords.)
  A list has even more properties:
@@ -817,16 +817,16 @@
  * {{code}}$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.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)
--{{info}}
--The string formatting syntax that you have seen [[xwiki:MediaWiki.X4.X4_DocumentationX4_Game_Design0_GeneralMission_Director_Guide.NULL|above.WebHome]] 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}}
++{{info}}The string formatting syntax that you have seen [[NULL|above]] is also based on the property system. You basically pass a list as property key to a string. Braces around the brackets are not required, so 'foo'.[...] is just a convenient alternative notation for 'foo'.{[...]}.{{/info}}
++
  (% id="lookup-tests-and-suppressing-errors" %)=== Lookup tests and suppressing errors
@@ -839,6 +839,7 @@
  * {{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}}$list{{/code}} ⟹ The value stored under the name $list, or an error if there is no such variable
@@ -856,7 +856,6 @@
  (% id="static-lookups" %)
--
  === Static lookups ===
  There are a few data types which are basically enumerations: They only consist of a set of named values, e.g. the "class" data type, which is used for the component classes that exist in the game. For all these static enumeration classes there is a lookup value of the same name, from which you can get the named values as properties by their name. So for the type "class", there is a value "class" that can be used to access the classes.
@@ -889,11 +889,11 @@
  |profile|
  profile.flat
  \\profile.increasing
--\\profile.bell|Probability distribution profile (see [[random ranges>>xwiki:MediaWiki.NULL.WebHome]])
++\\profile.bell|Probability distribution profile (see [[random ranges>>MediaWiki.NULL]])
  |cuestate|
  cuestate.waiting
  \\cuestate.active
--\\cuestate.complete|[[Cue states>>xwiki:MediaWiki.NULL.WebHome]]
++\\cuestate.complete|[[Cue states>>MediaWiki.NULL]]
  |level|
  level.easy
  \\level.medium
@@ -913,19 +913,15 @@
  \\faction.argongovernment|Factions
  )))
--{{info}}
--With the ''typeof'' operator you can get the datatype of any expression and compare it with what you expect, for example:
++{{info}}With the ''typeof'' operator you can get the datatype of any expression and compare it with what you expect, for example:
  <code>typeof $value == datatype.faction</code>
  However, you should not compare the type to datatype.string because there are strings that have different data types. To check for a string you should use the datatype's property "'''isstring'''" instead. For example, to check if the variable $value is a string, use the following term:
--<code>(typeof $value).isstring</code>"
--{{/info}}
++<code>(typeof $value).isstring</code>"{{/info}}
--{{info}}
--There is also the datatype "tag" with the lookup name "tag" - however, this is not an enumeration type. Looking up a value by name never fails, you actually create a tag value for a given name if it does not exist. For example, if you have a typo, like "tag.mision" instead of "tag.mission", there won't be an error because any name is valid for a tag, and the tag "mision" is created on its first use."
--{{/info}}
++{{info}}There is also the datatype "tag" with the lookup name "tag" - however, this is not an enumeration type. Looking up a value by name never fails, you actually create a tag value for a given name if it does not exist. For example, if you have a typo, like "tag.mision" instead of "tag.mission", there won't be an error because any name is valid for a tag, and the tag "mision" is created on its first use."{{/info}}
  \\
@@ -933,7 +933,6 @@
  (% id="player-properties" %)
--
  === Player properties ===
  You can access many player-related game properties via the keyword "player":
@@ -944,15 +944,17 @@
  * player.**ship**: The ship the player is currently on (not necessarily the player's ship), or null if the player is on a station\\
++
  * player.**primaryship**: The player's own ship (but the player is not necessarily on board)
  * player.**entity**: The actual player object\\
++
  * player.**zone**, player.**sector**, player.**cluster**, player.**galaxy**: Location of the player entity
  * player.**copilot**: The co-pilot NPC
  The game consists of objects of different classes (zones, ships, stations, NPCs). They have the common datatype "component", however, they have different properties, e.g. NPCs have the property "race", but ships don't.
--\\
++\\(% id="safe-properties" %)
  === Safe properties ===
@@ -973,12 +973,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>>xwiki:MediaWiki.NULL.WebHome]] 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}}$money.formatted.{'formatstring'}{{/code}}
  * {{code}}$money.formatted.default{{/code}} (using default format string '%s')\\
++
  * {{code}}$time.formatted.{'formatstring'}{{/code}}
  * {{code}}$time.formatted.default{{/code}} (using default format string '%T')
@@ -1005,6 +1005,7 @@
  * %%: A % sign\\
++
  Examples:\\
@@ -1015,7 +1015,7 @@
  * {{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 [[xwiki:MediaWiki.ARCHIVE.XRWIKIModding_supportUI_Modding_supportLua_function_overview.WebHome]].
++For documentation of time format strings, see the Lua function ConvertTimeString() in the [[MediaWiki.ARCHIVE.XRWIKIModding_supportUI_Modding_supportLua_function_overview]].
  Examples:
@@ -1026,7 +1026,6 @@
  (% id="complete-property-documentation" %)
--
  === Complete property documentation ===
  To access the script property documentation that is included in the game, you can extract the required files from the game's catalog files using the [[X Catalog Tool>>url:https://forum.egosoft.com/viewtopic.php?t=363625]]. Extract the HTML file __scriptproperties.html__ in the game's root folder, and all files in the "libraries" sub-folder. For resolving text references in the browser automatically, also extract 0001-L044.xml in the "t" sub-folder.
@@ -1035,12 +1035,10 @@
--{{info}}
--scriptproperties.html has to load files from different folders, which modern browsers do not allow by default for security reasons. In order to open scriptproperties.html, the following is required:
++{{info}}scriptproperties.html has to load files from different folders, which modern browsers do not allow by default for security reasons. In order to open scriptproperties.html, the following is required:
  * Firefox: On the about:config page, the value of "security.fileuri.strict_origin_policy" has to be changed to "false".
--* Chrome: The Chrome launcher has to be started with the command-line parameter --allow-file-access-from-files
--{{/info}}
++* Chrome: The Chrome launcher has to be started with the command-line parameter --allow-file-access-from-files{{/info}}
@@ -1056,9 +1056,7 @@
--{{info}}
--The documentation contains some data types that are no real script data types, but which are useful for documentation purposes. For example, ships and stations are both of datatype "component", but have different properties based on their component class.
--{{/info}}
++{{info}}The documentation contains some data types that are no real script data types, but which are useful for documentation purposes. For example, ships and stations are both of datatype "component", but have different properties based on their component class.{{/info}}
@@ -1066,7 +1066,6 @@
  (% id="md-refreshing-and-patching" %)
--
  = MD refreshing and patching =
  When a saved game is loaded, the saved MD state is restored, but also all MD files are reloaded and changes in them are applied to the MD state. This is called "refresh". It is also possible to refresh the MD at run-time using the command "refreshmd" on the in-game command line. This is a convenient way to update MD scripts while the game is already running.
@@ -1075,7 +1075,6 @@
  (% id="details-and-restrictions" %)
--
  == Details and restrictions ==
  Here are some noteworthy facts about refreshing scripts and cues, and the restrictions:
@@ -1099,13 +1099,9 @@
--{{warning}}
--Be aware that completed instances can be auto-deleted, and so added sub-cues will not become active in such a case.
--{{/warning}}
++{{warning}}Be aware that completed instances can be auto-deleted, and so added sub-cues will not become active in such a case.{{/warning}}
--{{warning}}
--When adding a variable in a new MD script version and using that variable in multiple places, be aware that the variable doesn't exist yet in older savegames. You may have to check the existence of the variable before accessing it, or add some patch logic that initiailses the variable after loading the savegame, if necessary.
--{{/warning}}
++{{warning}}When adding a variable in a new MD script version and using that variable in multiple places, be aware that the variable doesn't exist yet in older savegames. You may have to check the existence of the variable before accessing it, or add some patch logic that initiailses the variable after loading the savegame, if necessary.{{/warning}}
@@ -1113,22 +1113,17 @@
  (% id="patching" %)
--
  == 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.
--{{code}}
--<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.
  A sequence of multiple <patch> elements is possible. They will be performed in order of appearance, checking the //sinceversion// and //state// attributes in each case. Patches are also applied to all users of a library and to instances.
--{{info}}
--The <patch> elements will be ignored when refreshing the MD at run-time. They only affect loaded savegames."
--{{/info}}
++{{info}}The <patch> elements will be ignored when refreshing the MD at run-time. They only affect loaded savegames."{{/info}}
@@ -1136,7 +1136,6 @@
  (% id="common-attribute-groups" %)
--
  = Common attribute groups =
  There are many commonly used actions and conditions which share groups of attributes. The most important ones are explained here.
@@ -1145,86 +1145,62 @@
  (% id="categorybroken_macroanchorvalue-comparisons" %)
--
  == Value comparisons ==
  There are many conditions and conditional actions that require a value comparison, for example the condition <check_value>:
--{{code}}
--<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}}
--<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}}
++{{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}}
  \\
--(% id="categorybroken_macroanchorrandom-ranges" %)
--
--
  == Random ranges ==
  If an action requires a value, e.g. when you set a variable to a value, you can have some randomisation. To specify an exact value, e.g. in <set_value>, you can write this:
--{{code}}
--<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}}
--<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}}
--<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}}
--<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}}
--(% style="color: rgb(0,0,255);text-decoration: none;" %)
--\\
++\\(% id="variables-and-namespaces" %)
  = 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).
--(% style="color: rgb(0,0,255);text-decoration: none;" %)
--\\\\
++\\\\\\(% id="categorybroken_macroanchorcreating-and-removing-variables" %)
  == Creating and removing variables ==
  {{{You can create variables with certain actions and conditions, such as the <set_value> action:}}}
--{{code}}
--<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}}
--<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:
@@ -1232,17 +1232,13 @@
  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}}
--<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}}
--<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.
@@ -1252,28 +1252,20 @@
  Removing an entry from a list shifts all following elements down by one. If you want to clear an entry without removing it from the list, just use <set_value> instead.
--(% style="color: rgb(0,0,255);text-decoration: none;" %)
++\\\\\\(% id="accessing-remote-variables" %)
--\\\\
--
  == Accessing remote variables ==
  You can also read and write variables in other cues by using the variable name as property key:
--{{code}}
--<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}}
--<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}}
--(% style="color: rgb(0,0,255);text-decoration: none;" %)
++\\\\\\(% id="namespaces" %)
--\\\\
--
  == Namespaces ==
  In the examples above, a variable was written to and read from the "this" cue. This can be necessary: the expression "$foo" may be different from the expression "this.$foo". The reason for that are namespaces.
@@ -1280,9 +1280,7 @@
  Consider this case:
--{{code}}
--<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.
@@ -1290,7 +1290,6 @@
  (% id="defining-a-cues-namespace" %)
--
  === Defining a cue's namespace ===
  When writing a cue, you can specify what the namespace of the cue should be, by adding the //**namespace**// attribute. The following values are possible:
@@ -1299,12 +1299,7 @@
  * **static**: Same as "this", but when instantiated, use the static cue: $foo == static.$foo
  * **default**: The namespace is inherited from the parent cue. The default for root cues and for libraries is the same as "static".
--(% style="color: rgb(0,0,255);text-decoration: none;" %)
++{{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:
--
--{{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><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