Changes for page Mission Director Guide

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

From 32205.1 to 32206.1 From 32941.1 to 32942.1

From version 32206.1

edited by Daniel Turner
on 2023/05/09 17:28

Change comment: There is no comment for this version

To version 32941.1

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

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Tags

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

Content

@@ -1,25 +1,15 @@
  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[[(% 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.
  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++).
  {{{The general MD scripting system is the same in XR and X4, so this guide applies to both games. However, each game has its own set of supported script features (i.e. actions, conditions and properties), so in general scripts from different games are not compatible.}}}
--\\
++(% id="md-scripts" %)
--(% id="table-of-contents" %)
--
  {{toc/}}
--= Table of Contents =
--
--{{{__TOC__ }}}
--
--\\
--
--(% id="md-scripts" %)
--
  = MD scripts =
  MD scripts are not necessarily missions. An MD file can contain a part of a mission, multiple missions, or no mission at all, as the MD is used for more than just missions.
@@ -30,14 +30,12 @@
  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.
--{{note body="Even if your script is free of XSD errors, that does not mean that the script syntax is correct. For example, there are XML elements that require at least one of multiple attributes, but this requirement cannot be reflected in a schema (apart from documentation text). Please notice the XSD documentation of the elements and attributes, e.g. displayed via tooltips in Visual Studio / Visual Web Developer. Please also note additional requirements for MD cue attributes in this guide (see [[NULL|Conditions]]).
++{{info}}
++Even if your script is free of XSD errors, that does not mean that the script syntax is correct. For example, there are XML elements that require at least one of multiple attributes, but this requirement cannot be reflected in a schema (apart from documentation text). Please notice the XSD documentation of the elements and attributes, e.g. displayed via tooltips in Visual Studio / Visual Web Developer. Please also note additional requirements for MD cue attributes in this guide (see [[NULL|Conditions]]).
--To check for errors, please pay attention to in-game error messages that are produced while your script is imported, and run-time errors while the script runs. The XSD files can help you a lot, but you should not rely on the absence of XSD errors."/}}
++To 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}}
--
--
--(% id="categorybroken_macroanchorscript-debug-output" %)
--
  == Script debug output ==
  The game can print error messages and, when enabled, also general messages. Error messages can originate from the scripting system, but also from other game sub-systems. They can be viewed in the in-game [[DebugLog>>url:https://forum.egosoft.com/viewtopic.php?t=366654]].
@@ -54,10 +54,6 @@
  The script action <debug_text> can be used to print debug messages from within a script.\\
--\\
--
--(% id="md-script-structure" %)
--
  = MD script structure =
  In this section we will look at how to start the whole process by creating a new MD mission file and the basic steps in producing mission content with XML code. There will be a description of the key elements of the mission file.
@@ -85,10 +85,6 @@
  </mdscript>
  {{/code}}
--┬á
--
--(% id="categorybroken_macroanchorcues" %)
--
  == Cues ==
  Cues are the main ingredient of an MD script. A cue consists of a set of **conditions** and a set of **actions**. When the conditions are met, the cue is activated and the actions are performed. A cue can have child cues, or **sub-cues**: A sub-cue exists only when its parent cue has become active, so the activation of the parent cue initiates the condition checks of its child cues.
@@ -106,14 +106,8 @@
  \\
++{{info}}There can be a delay between the activation and performing the actions if the &lt;delay&gt; tag is used. In this case, sub-cues will be enter the waiting state before the parent's actions are performed.{{/info}}
--
--{{note body="There can be a delay between the activation and performing the actions if the &lt;delay&gt; tag is used. In this case, sub-cues will be enter the waiting state before the parent's actions are performed.<br />"/}}
--
--
--
--\\
--
  This is how a cue node looks like:
  {{code language="xml"}}
@@ -130,10 +130,6 @@
  The rules for naming cues is the same for MD script names: The name **starts with an upper case letter**, and has to be **unique within this file**. So it is actually possible to use the same cue name in different scripts, which is different from the MD in X3.
--\\
--
--(% id="categorybroken_macroanchorconditions" %)
--
  == Conditions ==
  The <conditions> node can contain one or multiple conditions, all of which must be met to activate the cue. If the node is missing, the cue will become active unconditionally. The conditions are checked in sequence, and if a check fails, the following conditions are ignored. There are two types of conditions: Events and non-event conditions.
@@ -210,18 +210,10 @@
  The attributes //onfail//, //checkinterval//, //checktime// are not allowed for cues with event conditions.
--\\
++{{info}}Reminder: When using an XSD-capable editor, it's a great help, but you cannot rely on that alone to verify correctness. Please also check the documentation and look for errors in the game debug output. Concretely, the schema cannot tell whether the above cue attributes are used correctly.{{/info}}
--{{note body="Reminder: When using an XSD-capable editor, it's a great help, but you cannot rely on that alone to verify correctness. Please also check the documentation and look for errors in the game debug output. Concretely, the schema cannot tell whether the above cue attributes are used correctly."/}}
--
--
--
--\\
--
--(% id="actions" %)
--
  == Actions ==
  The <actions> node contains the actions that are performed one after another, without any delay inbetween. You can enforce a delay after activation of the cue and actual action performance, using a <delay> node right before the <actions>:
@@ -254,7 +254,7 @@
--{{note body="Messages printed with &lt;debug_text&gt; are usually only visible when the ΓÇ£scriptsΓÇ¥ debug filter is enabled, see [[NULL|Script debug output]]."/}}
++{{info}}Messages printed with &lt;debug_text&gt; are usually only visible when the ΓÇ£scriptsΓÇ¥ debug filter is enabled, see [[NULL|Script debug output]].{{/info}}
@@ -266,17 +266,11 @@
  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.
--\\
--
--┬á
--
--(% id="libraries" %)
--
  = 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.
--{{note body="<span style=~"color: rgb(0,0,0);~">The syntax of libraries is considerably different from the syntax in the MD of X3TC."/}}
++{{info}}The syntax of libraries is considerably different from the syntax in the MD of X3TC.{{/info}}
@@ -330,11 +330,10 @@
  {{/code}}
++{{warning}}These examples are definitely <u>not</u> examples of good scripting style.{{/warning}}
--{{warning body="These examples are definitely <u>not</u> examples of good scripting style."/}}
--
  So when writing the library, you donΓÇÖt have to worry about name confusion, just use the names of cues in your library and it will work as expected when the library is used. Names of cues that do not belong to the library will not be available in expressions (see Foo in the example above), however, names of other libraries in the file are available when referencing them in the ref attribute.
  Notes:
@@ -341,10 +341,8 @@
  * 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" %)
--(% id="library-parameters" %)
--
  == Library Parameters ==
  A library can be parametrised, so that it can be adapted to the needs of a missions that uses it. You can define required and/or optional parameters for a library, and it will be validated at load time that the user of the library has provided all required parameters.
@@ -386,18 +386,11 @@
  If your library is supposed to provide a result to the library user, it is recommended to store a predefined variable in the library cue with a standardised name, e.g. $result. The user will be able to read it via CueName.$result. This variable does not have to be defined as a parameter but should be documented in the library.
--\\
--
--┬á
--
--(% id="instantiation" %)
--
  = 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.**
  \\An instantiating cue should only be used with conditions that are only going to be met once (or a fairly limited number of times), or with conditions that include an event condition. Instantiation should (% style="color: rgb(0,0,0);text-decoration: underline;" %)not 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.
--\\\\\\\\\\(% id="cleaning-up-instances-explicitly" %)
  == Cleaning up instances explicitly ==
@@ -405,15 +405,11 @@
  {{info body="&lt;cancel_cue&gt; and &lt;reset_cue&gt; only take effect after all remaining actions of the current cue are performed. So you can even safely cancel the cue that you are currently in (keyword ΓÇ£'''this'''ΓÇ¥) or any ancestor cue, and still perform more actions afterwards."/}}
--
--
--(% id="access-to-instances" %)
--
  == Access to instances ==
--{{note body="This sub-section requires basic knowledge of [[NULL|script expressions]]."/}}
++{{info}}This sub-section requires basic knowledge of [[NULL|script expressions]].{{/info}}
@@ -446,10 +446,6 @@
  You can store cue references in variables. But when storing an instance cue in a variable, and later accessing that variable, be aware that the instance may not exist any more. Use the property **exists** to check if an instance is still alive. (In contrast, non-instance cues always exist, but may be in the //disabled// or //cancelled// state.)
--\\
--
--(% id="pitfalls" %)
--
  == Pitfalls ==
  Some additional common pitfalls with respect to instantiation are listed here. There may be more.
@@ -463,16 +463,10 @@
  * **Resetting completed/cancelled instances:** As explained above, sub-instances are only created when needed (when going to the //waiting// state) and are destroyed when they are not needed any more (when they are completed or cancelled, including all sub-cues). There are cases in which you want to access cues that donΓÇÖt exist any more - it simply doesnΓÇÖt work. In some cases you are safe: You can be sure that all your ancestors exist, and instantiating cues wonΓÇÖt be removed until they are cancelled. In some other cases you simply donΓÇÖt know and have to check if the instance is already (or still) there.
  * **Lifetime of instances:** Do not make assumptions about when an instance is removed! Just looking at it in the Debug Manager keeps it alive for the time being. So, sometimes you could still have a completed instance that wouldnΓÇÖt exist under other circumstances.
--┬á
--
--(% id="categorybroken_macroanchorexpressions" %)
--
  = Expressions =
--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:**\\
++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}}0{{/code}} (integer number)
  * {{code}}0772{{/code}} (leading 0 means octal integer number)
  * {{code}}3.14159{{/code}} (floating point number)
@@ -481,7 +481,7 @@
--{{note body="Since octal numbers are hardly ever used (usually unknowingly), the parser is will produce a warning if an octal number is encountered."/}}
++{{info}}Since octal numbers are hardly ever used (usually unknowingly), the parser is will produce a warning if an octal number is encountered."{{info}}
@@ -493,14 +493,8 @@
--{{note body="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 '''&lt; &gt; &quot; &amp;''' in an expression string (or anywhere else in an XML attribute value), youΓÇÖll have to escape them as '''&amp;lt; &amp;gt; &amp;quot; &amp;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}}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 '''&lt; &gt; &quot; &amp;''' in an expression string (or anywhere else in an XML attribute value), youΓÇÖll have to escape them as '''&amp;lt; &amp;gt; &amp;quot; &amp;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}}
--
--
--\\
--
--(% id="numeric-data-types-and-suffixes" %)
--
  == 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:
@@ -516,14 +516,8 @@
  Here is the complete list of numeric data types and corresponding unit suffixes:
--\\
--
  (% style="margin-left: 0.0px;" %)
  (((
--\\
--
--
--
  |Data type|Suffix|Examples|Description
  |null|(none)|null|Converted to non-null data type of value 0 when needed.
  |integer|i|42|32-bit signed integer. Default for integer literals, so the suffix is not required for them.
@@ -557,26 +557,14 @@
  \\24h|Time in milliseconds, seconds, minutes, or hours, respectively. A time value is always stored in seconds.
  )))
--{{note body="All unit data types are floating point types, except for money, which is an integer data type."/}}
++{{info}}All unit data types are floating point types, except for money, which is an integer data type.{{/info}}
--\\
--
--
--
--(% id="categorybroken_macroanchoroperators" %)
--
  == Operators ==
--You can build expressions by combining sub-expressions with operators. For Boolean operations, expressions are considered ΓÇ£falseΓÇ¥ if they are equal to zero, ΓÇ£trueΓÇ¥ otherwise. The following operators, delimiters, and constants are supported:
++You can build expressions by combining sub-expressions with operators. For Boolean operations, expressions are considered ΓÇ£falseΓÇ¥ if they are equal to zero, ΓÇ£trueΓÇ¥ otherwise. The following operators, delimiters, and constants are supported
--\\
--
  (% style="margin-left: 0.0px;" %)
  (((
--\\
--
--
--
  |Operator / Delimiter / Constant|Type|Example|Result of example|Description
  |null|constant|{{code}}null + 1{{/code}}|{{code}}1{{/code}}|Null value, see above
  |false|constant|{{code}}1 == 0{{/code}}|{{code}}false{{/code}}|Integer value 0, useful in Boolean expressions
@@ -656,20 +656,13 @@
  {{code}}null{{/code}}
  \\{{code}}'T'{{/code}}|Conditional operator ("inline if")
++)))(% id="operator-precedence-rules" %)
++(%%)
--\\
--
--
--)))
--
--(% 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.\\
++You can group sub-expressions using parentheses, but if you donΓÇÖt, the following order of operations is applied, so that 5-1+2*3 == 10 as you would expect. The order is the same as in the table above, but there are operators with the same precedence - these are applied from left to right.
--
--
  * Unary operators: +, -, not, typeof, function-style operators (highest precedence)
  * Power operator: ^
  * Multiplicative: *, /, %
@@ -696,8 +696,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}}(1 + 1)f{{/code}} Γƒ╣ {{code}}2f{{/code}} Γƒ╣ {{code}}2.0{{/code}}
--* {{code}}(1h) m / (180deg) i{{/code}} Γƒ╣ {{code}}(3600s) m / (3.14rad) i{{/code}} Γƒ╣ {{code}}3600m / 3{{/code}} Γƒ╣ {{code}}1200m{{/code}}
++* {{code}}(1 + 1)f{{/code}} ⟹ {{code}}2f{{/code}} ⟹ {{code}}2.0{{/code}}
++* {{code}}(1h) m / (180deg) i{{/code}} ⟹ {{code}}(3600s) m / (3.14rad) i{{/code}} ⟹ {{code}}3600m / 3{{/code}} ⟹ {{code}}1200m{{/code}}
  When converting to a non-default unit type, this means you interpret the number as in the given units: ΓÇ£{{code}}(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.)
@@ -705,8 +705,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}}'One plus one is equal to ' + (1+1) + '.'{{/code}} Γƒ╣ {{code}}'One plus one is equal to 2.'{{/code}}
--* {{code}}'One plus one is not equal to ' + 1 + 1 + '.'{{/code}} Γƒ╣ {{code}}'One plus one is not equal to 11.'{{/code}}
++* {{code}}'One plus one is equal to ' + (1+1) + '.'{{/code}} ⟹ {{code}}'One plus one is equal to 2.'{{/code}}
++* {{code}}'One plus one is not equal to ' + 1 + 1 + '.'{{/code}} ⟹ {{code}}'One plus one is not equal to 11.'{{/code}}
  As you can see, operators of the same precedence (+ in this case) are always evaluated from left to right.
@@ -714,22 +714,20 @@
  === Boolean operators ===
--Some additional notes on Boolean operators (such as and, or, not, ==):\\
++Some additional notes on Boolean operators (such as and, or, not, ==):
--
--
  * Of course a Boolean operation always results in true or false (integer 1 or 0).
  * Values of any type can be used as Boolean operands, e.g. for ΓÇ£andΓÇ¥. They will be interpreted as ΓÇ£trueΓÇ¥ if they are **non-zero** or **non-numeric**.
  * != and == can be used with any data types, even non-numeric ones. When comparing two numeric values, they are converted using the rules above. Values of non-numeric types are never equal to null, or to any other numbers.
  * ΓÇ£andΓÇ¥ and ΓÇ£orΓÇ¥ use short-circuit semantics: The right side of the operation can be skipped if the left side already determines the outcome of the operation
--** Example:{{code}} false and $foo{{/code}} Γƒ╣ {{code}}false{{/code}} (the value of $foo is not checked at all)
++** Example:{{code}} false and $foo{{/code}} ⟹ {{code}}false{{/code}} (the value of $foo is not checked at all)
  * Unlike != and ==, the comparison operators <, <=, >, >= are only supported **for numeric values**, **difficulty levels**, and **attention levels**. Comparing other non-numeric values will result in an error and an undefined result.
  * <, <=, >, >= cannot be used in XML directly, so lt, le, gt, ge are provided as alternatives. In some cases you wonΓÇÖt have to use them, though - using [[range checks>>MediaWiki.NULL]] with additional XML attributes can be more readable.
--\\
--(% id="categorybroken_macroanchorstrings-and-formatting" %)== Strings and formatting
++(% id="categorybroken_macroanchorstrings-and-formatting" %)== Strings and formatting==
++(% id="categorybroken_macroanchorstrings-and-formatting" %)
  {{{==}}}
@@ -746,9 +746,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}}'%,s'.[12345678]{{/code}} Γƒ╣ {{code}}'12,345,678'{{/code}} (the "," modifier shows a number with thousands separators, correctly localised)
--* {{code}}'%.3s'.[123.4]{{/code}} Γƒ╣ {{code}}'123.400'{{/code}} (show 3 fractional digits, rounding half away from zero - decimal point correctly localised)
--* {{code}}'%,.1s'.[12345.67]'{{/code}} Γƒ╣ {{code}}'12,345.7'{{/code}} (combination of the above)
++* {{code}}'%,s'.[12345678]{{/code}} ⟹ {{code}}'12,345,678'{{/code}} (the "," modifier shows a number with thousands separators, correctly localised)
++* {{code}}'%.3s'.[123.4]{{/code}} ⟹ {{code}}'123.400'{{/code}} (show 3 fractional digits, rounding half away from zero - decimal point correctly localised)
++* {{code}}'%,.1s'.[12345.67]'{{/code}} ⟹ {{code}}'12,345.7'{{/code}} (combination of the above)
  Additional remarks:
@@ -772,17 +772,17 @@
  A list can contain values of arbitrary data types, even mixed in the same list - so a list can actually contain other lists. However, some of the things that you can do with lists require that all contained elements are of a certain type. The contents of a list can be accessed via properties, see the section about [[value properties>>MediaWiki.NULL]]. Lists can be empty, these are written as ΓÇ£[ ]ΓÇ¥.
--{{note body="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}}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.
--{{note body="When using &lt;remove_from_list/&gt;, be aware that all elements are checked and potentially removed during the action. Do not provide this action with a index lookup of that list as it may become out of bounds.
++{{info}}When using &lt;remove_from_list/&gt;, be aware that all elements are checked and potentially removed during the action. Do not provide this action with a index lookup of that list as it may become out of bounds.
  Bad usage attempting to remove the last element of the list: &lt;remove_from_list name=&quot;$List&quot; exact=&quot;$List.{$List.count}&quot;/&gt;
--If you know the index, simply use &lt;remove_value/&gt; e.g. &lt;remove_value name=&quot;$List.{$List.count}&quot;/&gt;"/}}
++If you know the index, simply use &lt;remove_value/&gt; e.g. &lt;remove_value name=&quot;$List.{$List.count}&quot;/&gt;"{{/info}}
@@ -804,15 +804,15 @@
  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
--* {{code}}table[{0} = null]{{/code}} Γƒ╣ creates a table that maps the number 0 to null\\
++* {{code}}table[]{{/code}} ⟹ creates an empty table
++* {{code}}table[{0} = null]{{/code}} ⟹ creates a table that maps the number 0 to null\\
--* {{code}}table[{'$foo'} = 'bar']{{/code}} Γƒ╣ a table that maps the string '$foo' to the string 'bar'
--* {{code}}table[$foo = 'bar']{{/code}} Γƒ╣ exactly the same, just a shorter notation for string keys
--* {{code}}table[foo = 'bar']{{/code}} Γƒ╣ error, 'foo' does not start with a '$'
--* {{code}}table[{1} = [], {2} = table[]] {{/code}} Γƒ╣ a table that maps 1 to an empty list and 2 to an empty table\\
++* {{code}}table[{'$foo'} = 'bar']{{/code}} ⟹ a table that maps the string '$foo' to the string 'bar'
++* {{code}}table[$foo = 'bar']{{/code}} ⟹ exactly the same, just a shorter notation for string keys
++* {{code}}table[foo = 'bar']{{/code}} ⟹ error, 'foo' does not start with a '$'
++* {{code}}table[{1} = [], {2} = table[]] {{/code}} ⟹ a table that maps 1 to an empty list and 2 to an empty table\\
@@ -830,19 +830,19 @@
  You can imagine properties as key/value pairs in an associative mapping: You pass the key, and you get the value as result. For example, the list [42, null, 'text'] has the following mapping:
--* 1 Γƒ╣ 42
--* 2 Γƒ╣ null
--* 3 Γƒ╣ 'text'
--* 'count' Γƒ╣ 3
++* 1 ⟹ 42
++* 2 ⟹ null
++* 3 ⟹ 'text'
++* 'count' ⟹ 3
  As you can see, a property key can be a number or a string. Actually there is no restriction regarding the data type of the key.
  You can look up a property by appending a dot and the key in curly braces:
--* {{code}}[100, 200, 300, 400].{1}{{/code}} Γƒ╣ 100 (reading the first element)
--* {{code}}[100, 200, ['Hello ', 'world']] .{3}.{2}{{/code}} Γƒ╣ 'world' (second element of the inner list, which is the third element of the outer list)
--* {{code}}[].{'count'}{{/code}} Γƒ╣ 0
--* {{code}}table[{21} = 42].{21}{{/code}} Γƒ╣ 42\\
++* {{code}}[100, 200, 300, 400].{1}{{/code}} ⟹ 100 (reading the first element)
++* {{code}}[100, 200, ['Hello ', 'world']] .{3}.{2}{{/code}} ⟹ 'world' (second element of the inner list, which is the third element of the outer list)
++* {{code}}[].{'count'}{{/code}} ⟹ 0
++* {{code}}table[{21} = 42].{21}{{/code}} ⟹ 42\\
@@ -850,7 +850,7 @@
  * {{code}}[42].{'count'}{{/code}}
  * {{code}}$ship.{'name'}{{/code}}
--* {{code}}$ship.{'class'}┬á{{/code}}
++* {{code}}$ship.{'class'}{{/code}}
  * {{code}}table[$foo='bar'].{'$foo'}{{/code}}\\
@@ -872,19 +872,19 @@
  **min'** and '**max'** return the minimum or maximum (all elements have to be numeric)
--* {{code}}[1, 6, 8].min{{/code}} Γƒ╣ 1
++* {{code}}[1, 6, 8].min{{/code}} ⟹ 1
  **average'** returns the average (but all element types have to be compatible)
--* {{code}}[1, 6, 8].average{{/code}} Γƒ╣ 5
++* {{code}}[1, 6, 8].average{{/code}} ⟹ 5
  **indexof'** is followed by another property, and the index of the first occurence of that key in the list is returned, or 0 if itΓÇÖs not in the list
--* {{code}}[1, 6, 8].indexof.{8}{{/code}} Γƒ╣ 3
++* {{code}}[1, 6, 8].indexof.{8}{{/code}} ⟹ 3
  **clone'** creates a shallow copy of the list (i.e. lists that are contained as elements in the list are not copied, only the reference to them)
--* {{code}}[1, 6, 8].clone{{/code}} Γƒ╣ {{code}}[1, 6, 8]{{/code}}
++* {{code}}[1, 6, 8].clone{{/code}} ⟹ {{code}}[1, 6, 8]{{/code}}
  A table has different properties:
@@ -904,7 +904,7 @@
--{{note body="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}}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}}
@@ -915,22 +915,22 @@
  If you look up a property that does not exist, there will be an error, and the result will be null. To test whether a property exists, you can append a question mark ΓÇ£?ΓÇ¥ to the lookup, which yields true or false:
--* {{code}}$list.{5}{{/code}} Γƒ╣ The fifth element of a list - however, if $list has less than 5 elements (and if it's also not a table with the key 5), there will be an error
--* {{code}}$list.{5}?{{/code}} Γƒ╣ true if $list exists and has the property 5, false otherwise
--* {{code}}$table.$key?{{/code}} Γƒ╣ Analogously, true if $table exists and has the string property '$key'\\
++* {{code}}$list.{5}{{/code}} ⟹ The fifth element of a list - however, if $list has less than 5 elements (and if it's also not a table with the key 5), there will be an error
++* {{code}}$list.{5}?{{/code}} ⟹ true if $list exists and has the property 5, false otherwise
++* {{code}}$table.$key?{{/code}} ⟹ Analogously, true if $table exists and has the string property '$key'\\
  The question mark can even be applied to variables:
--* {{code}}$list{{/code}} Γƒ╣ The value stored under the name $list, or an error if there is no such variable
--* {{code}}$list?{{/code}} Γƒ╣ true if the variable exists, false otherwise
++* {{code}}$list{{/code}} ⟹ The value stored under the name $list, or an error if there is no such variable
++* {{code}}$list?{{/code}} ⟹ true if the variable exists, false otherwise
  To look up the value of a property although it may not exist, you can use the at-sign ΓÇ£@ΓÇ¥ as prefix:
--* {{code}}@$list.{5}{{/code}} Γƒ╣ The result of the $list lookup if $list exists and has the property 5, otherwise null (without error message)
--* {{code}}@$list{{/code}} Γƒ╣ The list if this variable exists, null otherwise
--* {{code}}@$list.{5}.{1}{{/code}} Γƒ╣ The first element of the fifth element of $list, if it exists, null otherwise
++* {{code}}@$list.{5}{{/code}} ⟹ The result of the $list lookup if $list exists and has the property 5, otherwise null (without error message)
++* {{code}}@$list{{/code}} ⟹ The list if this variable exists, null otherwise
++* {{code}}@$list.{5}.{1}{{/code}} ⟹ The first element of the fifth element of $list, if it exists, null otherwise
  As you can see, an error is already prevented if any link in the property chain does not exist. But use the @ prefix with care, since error messages are really helpful for detecting problems in your scripts. The @ prefix only suppresses property-related error messages and does not change any in-game behaviour.
@@ -994,15 +994,15 @@
  \\faction.argongovernment|Factions
  )))
--{{note body="[[Category:Broken_macro/anchor]]With the ''typeof'' operator you can get the datatype of any expression and compare it with what you expect, for example:
++{{info}}With the ''typeof'' operator you can get the datatype of any expression and compare it with what you expect, for example:
  <code>typeof $value == datatype.faction</code>
  However, you should not compare the type to datatype.string because there are strings that have different data types. To check for a string you should use the datatype's property &quot;'''isstring'''&quot; instead. For example, to check if the variable $value is a string, use the following term:
--<code>(typeof $value).isstring</code>"/}}
++<code>(typeof $value).isstring</code>"{{/info}}
--{{info body="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}}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}}
  \\
@@ -1053,13 +1053,13 @@
  **[New as of X Rebirth 4.0]**
  \\Numbers don't have any properties, except for money and time: They have a "**formatted**" property, which allows you to get a custom string representation with more advanced options than the [[generic formatting method>>MediaWiki.NULL]] for numbers.
--* {{code}}$money.formatted.{'formatstring'}┬á{{/code}}
++* {{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')
++* {{code}}$time.formatted.default{{/code}} (using default format string '%T')
  In scripts, money is stored in cents, not Credits. The formatted representation always shows the value in Credits, including thousands separators.
@@ -1089,20 +1089,20 @@
--* {{code}}(1234Cr).formatted.{'%s'}{{/code}}Γƒ╣{{code}}'1,234'{{/code}}
--* {{code}}(1234Cr).formatted.default{{/code}}Γƒ╣{{code}}'1,234'{{/code}} (same as {'%s'})
--* {{code}}(1234Cr).formatted.{'%.s %Cr'}{{/code}}Γƒ╣{{code}}'1,234.00 Cr'{{/code}}
--* {{code}}(1234Cr).formatted.{'%1s'}{{/code}}Γƒ╣{{code}}'1 k'{{/code}} (rounding towards zero)
--* {{code}}(1234Cr).formatted.{'%cM'}{{/code}}Γƒ╣{{code}}'0 M'{{/code}}
++* {{code}}(1234Cr).formatted.{'%s'}{{/code}}⟹{{code}}'1,234'{{/code}}
++* {{code}}(1234Cr).formatted.default{{/code}}⟹{{code}}'1,234'{{/code}} (same as {'%s'})
++* {{code}}(1234Cr).formatted.{'%.s %Cr'}{{/code}}⟹{{code}}'1,234.00 Cr'{{/code}}
++* {{code}}(1234Cr).formatted.{'%1s'}{{/code}}⟹{{code}}'1 k'{{/code}} (rounding towards zero)
++* {{code}}(1234Cr).formatted.{'%cM'}{{/code}}⟹{{code}}'0 M'{{/code}}
  For documentation of time format strings, see the Lua function ConvertTimeString() in the [[MediaWiki.ARCHIVE.XRWIKIModding_supportUI_Modding_supportLua_function_overview]].
  Examples:
--* {{code}}(151s).formatted.{'%T'}{{/code}} Γƒ╣ {{code}}'00:02:31'{{/code}}
--* {{code}}(151s).formatted.default{{/code}} Γƒ╣ {{code}}'00:02:31'{{/code}} (same as {'%T'})
--* {{code}}(151s).formatted.{'%.3T'}{{/code}} Γƒ╣ {{code}}'00:02:31.000'{{/code}}
--* {{code}}(151s).formatted.{'%h:%M'}{{/code}} Γƒ╣ {{code}}'0:02'{{/code}}
++* {{code}}(151s).formatted.{'%T'}{{/code}} ⟹ {{code}}'00:02:31'{{/code}}
++* {{code}}(151s).formatted.default{{/code}} ⟹ {{code}}'00:02:31'{{/code}} (same as {'%T'})
++* {{code}}(151s).formatted.{'%.3T'}{{/code}} ⟹ {{code}}'00:02:31.000'{{/code}}
++* {{code}}(151s).formatted.{'%h:%M'}{{/code}} ⟹ {{code}}'0:02'{{/code}}
  (% id="complete-property-documentation" %)
@@ -1114,10 +1114,10 @@
--{{note body="scriptproperties.html has to load files from different folders, which modern browsers do not allow by default for security reasons. In order to open scriptproperties.html, the following is required:
++{{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 &quot;security.fileuri.strict_origin_policy&quot; has to be changed to &quot;false&quot;.
--* Chrome: The Chrome launcher has to be started with the command-line parameter --allow-file-access-from-files"/}}
++* Chrome: The Chrome launcher has to be started with the command-line parameter --allow-file-access-from-files{{/info}}
@@ -1133,7 +1133,7 @@
--{{note body="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}}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}}
@@ -1172,9 +1172,9 @@
--{{warning body="Be aware that completed instances can be auto-deleted, and so added sub-cues will not become active in such a case."/}}
++{{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 body="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}}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}}
@@ -1186,13 +1186,13 @@
  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}}&lt;cue┬á[...] version=&quot;42&quot;&gt;┬á &lt;conditions&gt; [...] &lt;/conditions&gt;┬á &lt;actions&gt; [...] &lt;/actions&gt;┬á &lt;patch┬ásinceversion=&quot;42&quot;&gt;┬á┬á┬á [patch actions]┬á &lt;/patch&gt;&lt;/cue&gt;{{/code}}
++{{code}}&lt;cue┬á[...] version=&quot;42&quot;&gt; &lt;conditions&gt; [...] &lt;/conditions&gt; &lt;actions&gt; [...] &lt;/actions&gt; &lt;patch┬ásinceversion=&quot;42&quot;&gt;┬á┬á┬á [patch actions] &lt;/patch&gt;&lt;/cue&gt;{{/code}}
  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.
--{{note body="The &lt;patch&gt; elements will be ignored when refreshing the MD at run-time. They only affect loaded savegames."/}}
++{{info}}The &lt;patch&gt; elements will be ignored when refreshing the MD at run-time. They only affect loaded savegames."{{/info}}
@@ -1218,7 +1218,7 @@
  {{code}}&lt;check_value┬ávalue=&quot;FooCue.state&quot;┬áexact=&quot;cuestate.complete&quot;/&gt;&lt;check_value┬ávalue=&quot;$foo.count&quot;┬ámin=&quot;5&quot;/&gt;&lt;check_value┬ávalue=&quot;$foo&quot;┬ámax=&quot;player.age + 1min&quot;/&gt;&lt;check_value┬ávalue=&quot;player.money&quot;┬ámin=&quot;300Cr&quot; max=&quot;600Cr&quot;/&gt;&lt;check_value┬ávalue=&quot;$method&quot;┬álist=&quot;[killmethod.hitbymissile, killmethod.collected]&quot;/&gt;&lt;check_value┬ávalue=&quot;$attention&quot;┬ámin=&quot;attention.visible&quot;/&gt;{{/code}}
--{{note body="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}}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}}
@@ -1246,7 +1246,7 @@
  {{code}}&lt;set_value┬áname=&quot;$foo&quot;┬ámin=&quot;-20&quot;┬ámax=&quot;20&quot; profile=&quot;profile.increasing&quot; scale=&quot;4&quot;/&gt;{{/code}}
--(% style="color: rgb(0,0,255);text-decoration: none;" %)┬á
++(% style="color: rgb(0,0,255);text-decoration: none;" %)
  \\(% id="variables-and-namespaces" %)
  = Variables and namespaces =
@@ -1260,7 +1260,7 @@
  {{{You can create variables with certain actions and conditions, such as the &lt;set_value&gt; action:}}}
--{{code}}┬á&lt;set_value┬áname=&quot;$foo&quot;┬áexact=&quot;$bar + 1&quot; /&gt;{{/code}}
++{{code}}&lt;set_value┬áname=&quot;$foo&quot;┬áexact=&quot;$bar + 1&quot; /&gt;{{/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>.)
@@ -1312,7 +1312,7 @@
  Consider this case:
--{{code}}&lt;cue┬áname=&quot;Root&quot;&gt;┬á &lt;actions&gt;┬á ┬á &lt;set_value┬áname=&quot;$foo&quot; /&gt;┬á &lt;/actions&gt;┬á &lt;cues&gt;┬á ┬á &lt;cue┬áname=&quot;SubCue&quot;&gt; [...]┬á ┬á &lt;/cue&gt;┬á &lt;/cues&gt;&lt;/cue&gt;{{/code}}
++{{code}}&lt;cue┬áname=&quot;Root&quot;&gt; &lt;actions&gt;  &lt;set_value┬áname=&quot;$foo&quot; /&gt; &lt;/actions&gt; &lt;cues&gt;  &lt;cue┬áname=&quot;SubCue&quot;&gt; [...]  &lt;/cue&gt; &lt;/cues&gt;&lt;/cue&gt;{{/code}}
  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.
@@ -1331,6 +1331,6 @@
  (% style="color: rgb(0,0,255);text-decoration: none;" %)
--{{warning body="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>&lt;cue┬áname=&quot;LibRef&quot;┬áref=&quot;Lib&quot;&gt;┬á &lt;param┬áname=&quot;Param1&quot;┬ávalue=&quot;$foo&quot; /&gt; &lt;!-- $foo from parent namespace --&gt;┬á &lt;param┬áname=&quot;Param2&quot;┬ávalue=&quot;namespace.$foo&quot; /&gt; &lt;!-- LibRef.$foo (error) --&gt;&lt;/cue&gt;</code>"/}}
++<code>&lt;cue┬áname=&quot;LibRef&quot;┬áref=&quot;Lib&quot;&gt; &lt;param┬áname=&quot;Param1&quot;┬ávalue=&quot;$foo&quot; /&gt; &lt;!-- $foo from parent namespace --&gt; &lt;param┬áname=&quot;Param2&quot;┬ávalue=&quot;namespace.$foo&quot; /&gt; &lt;!-- LibRef.$foo (error) --&gt;&lt;/cue&gt;</code>{{/warning}}

Changes for page Mission Director Guide

Summary

Details

Navigation

Applications