Changes for page Mission Director Guide
Last modified by Klaus Meyer on 2025/03/31 16:39
From version 32955.1
edited by Daniel Turner
on 2023/08/22 19:04
on 2023/08/22 19:04
Change comment:
There is no comment for this version
To version 32945.1
edited by Daniel Turner
on 2023/08/22 17:32
on 2023/08/22 17:32
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -1,10 +1,10 @@ 1 1 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.\\ 2 2 3 -An introduction to the original MD can be found in the 3 +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. 4 4 5 5 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++). 6 6 7 -{{ info}}The general MD scripting system is the same in XR and X4, so this guide applies to both games. However, each game has its own set of supported script features (i.e. actions, conditions and properties), so in general scripts from different games are not compatible.{{/info}}7 +{{{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.}}} 8 8 9 9 (% id="md-scripts" %) 10 10 ... ... @@ -14,9 +14,9 @@ 14 14 15 15 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. 16 16 17 -MD files are XML files located in the game folder **md**. All XML files in that folder are loaded at game start. The file names are irrelevant, since the internally used script names are read from the XML root nodes. However, it's recommended to keep file name and internal script name identical to avoid having to look up the names.17 +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. 18 18 19 -To edit MD scripts, an XML editing tool is needed. Microsoft Visual Studio (if available) or [[Microsoft Visual Web Developer>>url:http://www.microsoft.com/express/vwd/]](%%) (for free) are highly recommended because they have pretty good support for XML schemas (XSD). The provided Mission Director schema files help you create the XML file by displaying all available tags and attributes as you edit the XML. 19 +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. 20 20 21 21 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. 22 22 ... ... @@ -32,11 +32,11 @@ 32 32 33 33 To collect all messages in a file, start the game with the following parameters on the command line: 34 34 35 -{{code language="xml"}}-logfile debuglog.txt{{/code}}35 +{{code}}-logfile debuglog.txt{{/code}} 36 36 37 37 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: 38 38 39 -{{code language="xml"}}-debug scripts{{/code}}39 +{{code}}-debug scripts{{/code}} 40 40 41 41 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.\\ 42 42 ... ... @@ -182,9 +182,7 @@ 182 182 183 183 184 184 185 -{{info}} 186 -**Reminder** 187 -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}} 185 +{{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}} 188 188 189 189 == Actions == 190 190 ... ... @@ -351,7 +351,7 @@ 351 351 352 352 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. 353 353 354 -{{info }}<cancel_cue> and <reset_cue> only take effect after all remaining actions of the current cue are performed. So you can even safely cancel the cue that you are currently in (keyword "'''this'''") or any ancestor cue, and still perform more actions afterwards.{{/info}}352 +{{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."/}} 355 355 356 356 == Access to instances == 357 357 ... ... @@ -396,13 +396,9 @@ 396 396 397 397 * **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:\\ 398 398 399 -{{code language="xml"}} 400 - <debug_text text="static.$foo"/> 401 -{{/code}} 402 -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: 403 -{{code language="xml"}} 404 -<set_value name="$foo" exact="static.$foo"/> 405 -{{/code}} 397 +{{code}}<debug_text text="static.$foo"/>{{/code}} 398 +\\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: 399 +\\{{code}}<set_value name="$foo" exact="static.$foo"/>{{/code}} 406 406 407 407 * **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. 408 408 * **Lifetime of instances:** Do not make assumptions about when an instance is removed! Just looking at it in the Debug Manager keeps it alive for the time being. So, sometimes you could still have a completed instance that wouldn't exist under other circumstances. ... ... @@ -411,11 +411,11 @@ 411 411 412 412 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:** 413 413 414 -* {{code language="xml"}}0{{/code}} (integer number)415 -* {{code language="xml"}}0772{{/code}} (leading 0 means octal integer number)416 -* {{code language="xml"}}3.14159{{/code}} (floating point number)417 -* {{code language="xml"}}5e12{{/code}} (float in exponent notation, "times ten to the power of")418 -* {{code language="xml"}}0xCAFE{{/code}} (hexadecimal integer number)408 +* {{code}}0{{/code}} (integer number) 409 +* {{code}}0772{{/code}} (leading 0 means octal integer number) 410 +* {{code}}3.14159{{/code}} (floating point number) 411 +* {{code}}5e12{{/code}} (float in exponent notation, "times ten to the power of") 412 +* {{code}}0xCAFE{{/code}} (hexadecimal integer number) 419 419 420 420 421 421 ... ... @@ -425,9 +425,9 @@ 425 425 426 426 You can write string literals by putting the string in single quotes: 427 427 428 -* {{code language="xml"}}'Hello world'{{/code}}429 -* {{code language="xml"}}''{{/code}} (empty string)430 -* {{code language="xml"}}'String with a line break\n'{{/code}}422 +* {{code}}'Hello world'{{/code}} 423 +* {{code}}''{{/code}} (empty string) 424 +* {{code}}'String with a line break\n'{{/code}} 431 431 432 432 433 433 ... ... @@ -437,12 +437,12 @@ 437 437 438 438 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: 439 439 440 -* {{code language="xml"}}5000000000L{{/code}} (large integer)441 -* {{code language="xml"}}1f{{/code}} (floating point number, same as 1.0, just 1 would be an integer)442 -* {{code language="xml"}}1000Cr{{/code}} (Money in Credits, converted to 100000 cents automatically)443 -* {{code language="xml"}}500m{{/code}} (Length in metres)444 -* {{code language="xml"}}10s{{/code}} (Time in seconds)445 -* {{code language="xml"}}1h{{/code}} (Time in hours, which is converted to 3600s automatically)434 +* {{code}}5000000000L{{/code}} (large integer) 435 +* {{code}}1f{{/code}} (floating point number, same as 1.0, just 1 would be an integer) 436 +* {{code}}1000Cr{{/code}} (Money in Credits, converted to 100000 cents automatically) 437 +* {{code}}500m{{/code}} (Length in metres) 438 +* {{code}}10s{{/code}} (Time in seconds) 439 +* {{code}}1h{{/code}} (Time in hours, which is converted to 3600s automatically) 446 446 447 447 A space between number and suffix is allowed. 448 448 ... ... @@ -492,83 +492,83 @@ 492 492 (% style="margin-left: 0.0px;" %) 493 493 ((( 494 494 |Operator / Delimiter / Constant|Type|Example|Result of example|Description 495 -|null|constant|{{code language="xml"}}null + 1{{/code}}|{{codelanguage="xml"}}1{{/code}}|Null value, see above496 -|false|constant|{{code language="xml"}}1 == 0{{/code}}|{{codelanguage="xml"}}false{{/code}}|Integer value 0, useful in Boolean expressions497 -|true|constant|{{code language="xml"}}null == 0{{/code}}|{{codelanguage="xml"}}true{{/code}}|Integer value 1, useful in Boolean expressions498 -|pi|constant|{{code language="xml"}}2 * pi{{/code}}|{{codelanguage="xml"}}6.2831853rad{{/code}}|╧Ç as an angle (same as 180deg)499 -|()|delimiter|{{code language="xml"}}(2 + 4) * (6 + 1){{/code}}|{{codelanguage="xml"}}42{{/code}}|Parentheses for arithmetic grouping500 -|[]|delimiter|{{code language="xml"}}[1, 2, 2+1, 'string']{{/code}}|{{codelanguage="xml"}}[1, 2, 3, 'string']{{/code}}|[[List>>MediaWiki.NULL]] of values501 -|table[]|delimiter|{{code language="xml"}}table[$foo='bar', {1+1}=40+2]{{/code}}|{{codelanguage="xml"}}table[$foo='bar', {2}=42]{{/code}}|[[Table>>MediaWiki.NULL]] of values502 -|{}|delimiter|{{code language="xml"}}{101, 3}{{/code}}|{{codelanguage="xml"}}'Some text'{{/code}}|Text lookup (page ID and text ID) from TextDB489 +|null|constant|{{code}}null + 1{{/code}}|{{code}}1{{/code}}|Null value, see above 490 +|false|constant|{{code}}1 == 0{{/code}}|{{code}}false{{/code}}|Integer value 0, useful in Boolean expressions 491 +|true|constant|{{code}}null == 0{{/code}}|{{code}}true{{/code}}|Integer value 1, useful in Boolean expressions 492 +|pi|constant|{{code}}2 * pi{{/code}}|{{code}}6.2831853rad{{/code}}|╧Ç as an angle (same as 180deg) 493 +|()|delimiter|{{code}}(2 + 4) * (6 + 1){{/code}}|{{code}}42{{/code}}|Parentheses for arithmetic grouping 494 +|[]|delimiter|{{code}}[1, 2, 2+1, 'string']{{/code}}|{{code}}[1, 2, 3, 'string']{{/code}}|[[List>>MediaWiki.NULL]] of values 495 +|table[]|delimiter|{{code}}table[$foo='bar', {1+1}=40+2]{{/code}}|{{code}}table[$foo='bar', {2}=42]{{/code}}|[[Table>>MediaWiki.NULL]] of values 496 +|{}|delimiter|{{code}}{101, 3}{{/code}}|{{code}}'Some text'{{/code}}|Text lookup (page ID and text ID) from TextDB 503 503 \\(Note: Braces are also used for [[property lookups>>MediaWiki.NULL]]) 504 -|+|unary|{{code language="xml"}}+21 * (+2){{/code}}|{{codelanguage="xml"}}42{{/code}}|Denotes positive number (no effect)505 -|-|unary|{{code language="xml"}}-(21 * -2){{/code}}|{{codelanguage="xml"}}42{{/code}}|Negates the following number506 -|not|unary|{{code language="xml"}}not (21 == 42){{/code}}|{{codelanguage="xml"}}true{{/code}}|Yields true if the following expression is false (equal to zero), false otherwise498 +|+|unary|{{code}}+21 * (+2){{/code}}|{{code}}42{{/code}}|Denotes positive number (no effect) 499 +|-|unary|{{code}}-(21 * -2){{/code}}|{{code}}42{{/code}}|Negates the following number 500 +|not|unary|{{code}}not (21 == 42){{/code}}|{{code}}true{{/code}}|Yields true if the following expression is false (equal to zero), false otherwise 507 507 |typeof|unary| 508 -{{code language="xml"}}typeof null{{/code}}509 -\\{{code language="xml"}}typeof 0{{/code}}510 -\\{{code language="xml"}}typeof 'Hello world'{{/code}}|511 -{{code language="xml"}}datatype.null{{/code}}512 -\\{{code language="xml"}}datatype.integer{{/code}}513 -\\{{code language="xml"}}datatype.string{{/code}}|Yields the [[data type of the following sub-expression>>MediaWiki.NULL]]502 +{{code}}typeof null{{/code}} 503 +\\{{code}}typeof 0{{/code}} 504 +\\{{code}}typeof 'Hello world'{{/code}}| 505 +{{code}}datatype.null{{/code}} 506 +\\{{code}}datatype.integer{{/code}} 507 +\\{{code}}datatype.string{{/code}}|Yields the [[data type of the following sub-expression>>MediaWiki.NULL]] 514 514 |sin|unary| 515 -{{code language="xml"}}sin(30deg){{/code}}516 -\\{{code language="xml"}}sin(pi){{/code}}|517 -{{code language="xml"}}0.5{{/code}}518 -\\{{code language="xml"}}1.0{{/code}}|Sine (function-style, parentheses required)509 +{{code}}sin(30deg){{/code}} 510 +\\{{code}}sin(pi){{/code}}| 511 +{{code}}0.5{{/code}} 512 +\\{{code}}1.0{{/code}}|Sine (function-style, parentheses required) 519 519 |cos|unary| 520 -{{code language="xml"}}cos(60deg){{/code}}521 -\\{{code language="xml"}}cos(pi){{/code}}|522 -{{code language="xml"}}0.5{{/code}}523 -\\{{code language="xml"}}0.0{{/code}}|Cosine (function-style, parentheses required)524 -|sqrt|unary|{{code language="xml"}}sqrt(2){{/code}}|{{codelanguage="xml"}}1.414213LF{{/code}}|Square root (function-style, parentheses required)525 -|exp|unary|{{code language="xml"}}exp(1){{/code}}|{{codelanguage="xml"}}2.71828LF{{/code}}|Exponential function (function-style, parentheses required)526 -|log|unary|{{code language="xml"}}log(8) / log(2){{/code}}|{{codelanguage="xml"}}3.0LF{{/code}}|Natural logarithm (function-style, parentheses required)527 -|^|binary|{{code language="xml"}}10 ^ 3{{/code}}|{{codelanguage="xml"}}1000.0LF{{/code}}|Power528 -|*|binary|{{code language="xml"}}21 * 2{{/code}}|{{codelanguage="xml"}}42{{/code}}|Multiplication529 -|/|binary|{{code language="xml"}}42 / 1042.0 / 10.0{{/code}}|{{codelanguage="xml"}}44.2{{/code}}|Division530 -|%|binary|{{code language="xml"}}42 % 10{{/code}}|{{codelanguage="xml"}}2{{/code}}|Modulus (remainder of integer division)514 +{{code}}cos(60deg){{/code}} 515 +\\{{code}}cos(pi){{/code}}| 516 +{{code}}0.5{{/code}} 517 +\\{{code}}0.0{{/code}}|Cosine (function-style, parentheses required) 518 +|sqrt|unary|{{code}}sqrt(2){{/code}}|{{code}}1.414213LF{{/code}}|Square root (function-style, parentheses required) 519 +|exp|unary|{{code}}exp(1){{/code}}|{{code}}2.71828LF{{/code}}|Exponential function (function-style, parentheses required) 520 +|log|unary|{{code}}log(8) / log(2){{/code}}|{{code}}3.0LF{{/code}}|Natural logarithm (function-style, parentheses required) 521 +|^|binary|{{code}}10 ^ 3{{/code}}|{{code}}1000.0LF{{/code}}|Power 522 +|*|binary|{{code}}21 * 2{{/code}}|{{code}}42{{/code}}|Multiplication 523 +|/|binary|{{code}}42 / 1042.0 / 10.0{{/code}}|{{code}}44.2{{/code}}|Division 524 +|%|binary|{{code}}42 % 10{{/code}}|{{code}}2{{/code}}|Modulus (remainder of integer division) 531 531 |+|binary| 532 -{{code language="xml"}}1 + 1{{/code}}533 -\\{{code language="xml"}}'Hello' + ' world'{{/code}}|534 -{{code language="xml"}}2{{/code}}535 -\\{{code language="xml"}}'Hello world'{{/code}}|526 +{{code}}1 + 1{{/code}} 527 +\\{{code}}'Hello' + ' world'{{/code}}| 528 +{{code}}2{{/code}} 529 +\\{{code}}'Hello world'{{/code}}| 536 536 Addition 537 537 \\String concatenation 538 -|-|binary|{{code language="xml"}}1 - 1{{/code}}|{{codelanguage="xml"}}0{{/code}}|Subtraction532 +|-|binary|{{code}}1 - 1{{/code}}|{{code}}0{{/code}}|Subtraction 539 539 | 540 540 lt 541 541 \\< (<)|binary| 542 -{{code language="xml"}}1 lt 3{{/code}}543 -\\{{code language="xml"}}1 < 3{{/code}}|{{codelanguage="xml"}}true{{/code}}|Less than536 +{{code}}1 lt 3{{/code}} 537 +\\{{code}}1 < 3{{/code}}|{{code}}true{{/code}}|Less than 544 544 | 545 545 le 546 546 \\<=|binary| 547 -{{code language="xml"}}1 le 3{{/code}}548 -\\{{code language="xml"}}1 <= 3{{/code}}|{{codelanguage="xml"}}true{{/code}}|Less than or equal to541 +{{code}}1 le 3{{/code}} 542 +\\{{code}}1 <= 3{{/code}}|{{code}}true{{/code}}|Less than or equal to 549 549 | 550 550 gt 551 551 \\> (>)|binary| 552 -{{code language="xml"}}1 gt 3{{/code}}553 -\\{{code language="xml"}}1 > 3{{/code}}|{{codelanguage="xml"}}false{{/code}}|Greater than546 +{{code}}1 gt 3{{/code}} 547 +\\{{code}}1 > 3{{/code}}|{{code}}false{{/code}}|Greater than 554 554 | 555 555 ge 556 556 \\>=|binary| 557 -{{code language="xml"}}1 ge 3{{/code}}558 -\\{{code language="xml"}}1 >= 3{{/code}}|{{codelanguage="xml"}}false{{/code}}|Greater than or equal to551 +{{code}}1 ge 3{{/code}} 552 +\\{{code}}1 >= 3{{/code}}|{{code}}false{{/code}}|Greater than or equal to 559 559 |((( 560 560 = = 561 -)))|binary|{{code language="xml"}}1 + 1 == 2.0{{/code}}|{{codelanguage="xml"}}true{{/code}}|Equal to562 -|~!=|binary|{{code language="xml"}}1 + 1 != 2.0{{/code}}|{{codelanguage="xml"}}false{{/code}}|Not equal to563 -|and|binary|{{code language="xml"}}true and false{{/code}}|{{codelanguage="xml"}}false{{/code}}|Logical AND (short-circuit semantics)564 -|or|binary|{{code language="xml"}}true or false{{/code}}|{{codelanguage="xml"}}true{{/code}}|Logical OR (short-circuit semantics)555 +)))|binary|{{code}}1 + 1 == 2.0{{/code}}|{{code}}true{{/code}}|Equal to 556 +|~!=|binary|{{code}}1 + 1 != 2.0{{/code}}|{{code}}false{{/code}}|Not equal to 557 +|and|binary|{{code}}true and false{{/code}}|{{code}}false{{/code}}|Logical AND (short-circuit semantics) 558 +|or|binary|{{code}}true or false{{/code}}|{{code}}true{{/code}}|Logical OR (short-circuit semantics) 565 565 | 566 566 if ... then ... 567 567 \\if ... then ... else ...|ternary| 568 -{{code language="xml"}}if 1 == 2 then 'F'{{/code}}569 -\\{{code language="xml"}}if 1 == 2 then 'F' else 'T'{{/code}}|570 -{{code language="xml"}}null{{/code}}571 -\\{{code language="xml"}}'T'{{/code}}|Conditional operator ("inline if")562 +{{code}}if 1 == 2 then 'F'{{/code}} 563 +\\{{code}}if 1 == 2 then 'F' else 'T'{{/code}}| 564 +{{code}}null{{/code}} 565 +\\{{code}}'T'{{/code}}|Conditional operator ("inline if") 572 572 573 573 )))(% id="operator-precedence-rules" %) 574 574 (%%) ... ... @@ -603,17 +603,17 @@ 603 603 604 604 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: 605 605 606 -* {{code language="xml"}}(1 + 1)f{{/code}} ⟹ {{codelanguage="xml"}}2f{{/code}} ⟹ {{codelanguage="xml"}}2.0{{/code}}607 -* {{code language="xml"}}(1h) m / (180deg) i{{/code}} ⟹ {{codelanguage="xml"}}(3600s) m / (3.14rad) i{{/code}} ⟹ {{codelanguage="xml"}}3600m / 3{{/code}} ⟹ {{codelanguage="xml"}}1200m{{/code}}600 +* {{code}}(1 + 1)f{{/code}} ⟹ {{code}}2f{{/code}} ⟹ {{code}}2.0{{/code}} 601 +* {{code}}(1h) m / (180deg) i{{/code}} ⟹ {{code}}(3600s) m / (3.14rad) i{{/code}} ⟹ {{code}}3600m / 3{{/code}} ⟹ {{code}}1200m{{/code}} 608 608 609 -When converting to a non-default unit type, this means you interpret the number as in the given units: "{{code language="xml"}}(1km + 500m)h{{/code}}" means that you interpret 1500m as 1500 hours, so the resulting value will be 1500x3600 seconds. (As stated above, the default unit for a length is metres.)603 +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.) 610 610 611 611 The division operation will be an integer division (rounding towards zero) if both operands are integers (see the example in the table above). So if you want to get a floating point result, you have to make sure that at least one of the operands is a floating point type. 612 612 613 613 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: 614 614 615 -* {{code language="xml"}}'One plus one is equal to ' + (1+1) + '.'{{/code}} ⟹ {{codelanguage="xml"}}'One plus one is equal to 2.'{{/code}}616 -* {{code language="xml"}}'One plus one is not equal to ' + 1 + 1 + '.'{{/code}} ⟹ {{codelanguage="xml"}}'One plus one is not equal to 11.'{{/code}}609 +* {{code}}'One plus one is equal to ' + (1+1) + '.'{{/code}} ⟹ {{code}}'One plus one is equal to 2.'{{/code}} 610 +* {{code}}'One plus one is not equal to ' + 1 + 1 + '.'{{/code}} ⟹ {{code}}'One plus one is not equal to 11.'{{/code}} 617 617 618 618 As you can see, operators of the same precedence (+ in this case) are always evaluated from left to right. 619 619 ... ... @@ -627,7 +627,7 @@ 627 627 * 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**. 628 628 * != 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. 629 629 * "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 630 -** Example:{{code language="xml"}} false and $foo{{/code}} ⟹ {{codelanguage="xml"}}false{{/code}} (the value of $foo is not checked at all)624 +** Example:{{code}} false and $foo{{/code}} ⟹ {{code}}false{{/code}} (the value of $foo is not checked at all) 631 631 * 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. 632 632 * <, <=, >, >= 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. 633 633 ... ... @@ -640,8 +640,8 @@ 640 640 641 641 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: 642 642 643 -* {{code language="xml"}}'The %1 %2 %3 jumps over the %5 %4'.['quick', 'brown', 'fox', 'dog', 'lazy']{{/code}}644 -* {{code language="xml"}}'%1 + %2 = %3'.[$a, $b, $a + $b]{{/code}}637 +* {{code}}'The %1 %2 %3 jumps over the %5 %4'.['quick', 'brown', 'fox', 'dog', 'lazy']{{/code}} 638 +* {{code}}'%1 + %2 = %3'.[$a, $b, $a + $b]{{/code}} 645 645 646 646 See also the section about [[value properties>>MediaWiki.NULL]]. 647 647 ... ... @@ -651,9 +651,9 @@ 651 651 \\**[New as of X Rebirth 4.0]** 652 652 \\ 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): 653 653 654 -* {{code language="xml"}}'%,s'.[12345678]{{/code}} ⟹ {{codelanguage="xml"}}'12,345,678'{{/code}} (the "," modifier shows a number with thousands separators, correctly localised)655 -* {{code language="xml"}}'%.3s'.[123.4]{{/code}} ⟹ {{codelanguage="xml"}}'123.400'{{/code}} (show 3 fractional digits, rounding half away from zero - decimal point correctly localised)656 -* {{code language="xml"}}'%,.1s'.[12345.67]'{{/code}} ⟹ {{codelanguage="xml"}}'12,345.7'{{/code}} (combination of the above)648 +* {{code}}'%,s'.[12345678]{{/code}} ⟹ {{code}}'12,345,678'{{/code}} (the "," modifier shows a number with thousands separators, correctly localised) 649 +* {{code}}'%.3s'.[123.4]{{/code}} ⟹ {{code}}'123.400'{{/code}} (show 3 fractional digits, rounding half away from zero - decimal point correctly localised) 650 +* {{code}}'%,.1s'.[12345.67]'{{/code}} ⟹ {{code}}'12,345.7'{{/code}} (combination of the above) 657 657 658 658 Additional remarks: 659 659 ... ... @@ -663,7 +663,7 @@ 663 663 664 664 665 665 666 -{{info }}There are also special methods to [[NULL|format money values and time values]] using the "formatted" property.{{/info}}660 +{{info body="There are also special methods to [[NULL|format money values and time values]] using the "formatted" property."/}} 667 667 668 668 669 669 ... ... @@ -709,15 +709,15 @@ 709 709 710 710 These restrictions only apply to the keys, there are no restrictions for values that you assign to them. For example: 711 711 712 -* {{code language="xml"}}table[]{{/code}} ⟹ creates an empty table713 -* {{code language="xml"}}table[{0} = null]{{/code}} ⟹ creates a table that maps the number 0 to null\\706 +* {{code}}table[]{{/code}} ⟹ creates an empty table 707 +* {{code}}table[{0} = null]{{/code}} ⟹ creates a table that maps the number 0 to null\\ 714 714 715 715 716 716 717 -* {{code language="xml"}}table[{'$foo'} = 'bar']{{/code}} ⟹ a table that maps the string '$foo' to the string 'bar'718 -* {{code language="xml"}}table[$foo = 'bar']{{/code}} ⟹ exactly the same, just a shorter notation for string keys719 -* {{code language="xml"}}table[foo = 'bar']{{/code}} ⟹ error, 'foo' does not start with a '$'720 -* {{code language="xml"}}table[{1} = [], {2} = table[]] {{/code}} ⟹ a table that maps 1 to an empty list and 2 to an empty table\\711 +* {{code}}table[{'$foo'} = 'bar']{{/code}} ⟹ a table that maps the string '$foo' to the string 'bar' 712 +* {{code}}table[$foo = 'bar']{{/code}} ⟹ exactly the same, just a shorter notation for string keys 713 +* {{code}}table[foo = 'bar']{{/code}} ⟹ error, 'foo' does not start with a '$' 714 +* {{code}}table[{1} = [], {2} = table[]] {{/code}} ⟹ a table that maps 1 to an empty list and 2 to an empty table\\ 721 721 722 722 723 723 ... ... @@ -744,28 +744,28 @@ 744 744 745 745 You can look up a property by appending a dot and the key in curly braces: 746 746 747 -* {{code language="xml"}}[100, 200, 300, 400].{1}{{/code}} ⟹ 100 (reading the first element)748 -* {{code language="xml"}}[100, 200, ['Hello ', 'world']] .{3}.{2}{{/code}} ⟹ 'world' (second element of the inner list, which is the third element of the outer list)749 -* {{code language="xml"}}[].{'count'}{{/code}} ⟹ 0750 -* {{code language="xml"}}table[{21} = 42].{21}{{/code}} ⟹ 42\\741 +* {{code}}[100, 200, 300, 400].{1}{{/code}} ⟹ 100 (reading the first element) 742 +* {{code}}[100, 200, ['Hello ', 'world']] .{3}.{2}{{/code}} ⟹ 'world' (second element of the inner list, which is the third element of the outer list) 743 +* {{code}}[].{'count'}{{/code}} ⟹ 0 744 +* {{code}}table[{21} = 42].{21}{{/code}} ⟹ 42\\ 751 751 752 752 753 753 754 754 In most cases the property key is a fixed string, like "name" or "class". You can write this like above: 755 755 756 -* {{code language="xml"}}[42].{'count'}{{/code}}757 -* {{code language="xml"}}$ship.{'name'}{{/code}}758 -* {{code language="xml"}}$ship.{'class'}{{/code}}759 -* {{code language="xml"}}table[$foo='bar'].{'$foo'}{{/code}}\\750 +* {{code}}[42].{'count'}{{/code}} 751 +* {{code}}$ship.{'name'}{{/code}} 752 +* {{code}}$ship.{'class'}{{/code}} 753 +* {{code}}table[$foo='bar'].{'$foo'}{{/code}}\\ 760 760 761 761 762 762 763 763 But it is easier just to write the property key without braces, which is equivalent: 764 764 765 -* {{code language="xml"}}[0].count{{/code}}766 -* {{code language="xml"}}$ship.name{{/code}}767 -* {{code language="xml"}}$ship.class{{/code}}768 -* {{code language="xml"}}table[$foo='bar'].$foo{{/code}}\\759 +* {{code}}[0].count{{/code}} 760 +* {{code}}$ship.name{{/code}} 761 +* {{code}}$ship.class{{/code}} 762 +* {{code}}table[$foo='bar'].$foo{{/code}}\\ 769 769 770 770 771 771 ... ... @@ -777,19 +777,19 @@ 777 777 778 778 **min'** and '**max'** return the minimum or maximum (all elements have to be numeric) 779 779 780 -* {{code language="xml"}}[1, 6, 8].min{{/code}} ⟹ 1774 +* {{code}}[1, 6, 8].min{{/code}} ⟹ 1 781 781 782 782 **average'** returns the average (but all element types have to be compatible) 783 783 784 -* {{code language="xml"}}[1, 6, 8].average{{/code}} ⟹ 5778 +* {{code}}[1, 6, 8].average{{/code}} ⟹ 5 785 785 786 786 **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 787 787 788 -* {{code language="xml"}}[1, 6, 8].indexof.{8}{{/code}} ⟹ 3782 +* {{code}}[1, 6, 8].indexof.{8}{{/code}} ⟹ 3 789 789 790 790 **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) 791 791 792 -* {{code language="xml"}}[1, 6, 8].clone{{/code}} ⟹ {{codelanguage="xml"}}[1, 6, 8]{{/code}}786 +* {{code}}[1, 6, 8].clone{{/code}} ⟹ {{code}}[1, 6, 8]{{/code}} 793 793 794 794 A table has different properties: 795 795 ... ... @@ -800,12 +800,12 @@ 800 800 801 801 802 802 803 -* {{code language="xml"}}$table.keys.list{{/code}}: Yields a list of all keys in the table (reliably sorted by key if all keys are numeric)\\797 +* {{code}}$table.keys.list{{/code}}: Yields a list of all keys in the table (reliably sorted by key if all keys are numeric)\\ 804 804 805 805 806 806 807 -* {{code language="xml"}}$table.keys.sorted{{/code}}: Yields a list of all keys in the table, sorted by their associated values (which requires that all values are numeric)808 -* {{code language="xml"}}$table.keys.random{{/code}}: A randomly chosen key (which requires that the table is non-empty)801 +* {{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) 802 +* {{code}}$table.keys.random{{/code}}: A randomly chosen key (which requires that the table is non-empty) 809 809 810 810 811 811 ... ... @@ -820,22 +820,22 @@ 820 820 821 821 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: 822 822 823 -* {{code language="xml"}}$list.{5}{{/code}} ⟹ The fifth element of a list - however, if $list has less than 5 elements (and if it's also not a table with the key 5), there will be an error824 -* {{code language="xml"}}$list.{5}?{{/code}} ⟹ true if $list exists and has the property 5, false otherwise825 -* {{code language="xml"}}$table.$key?{{/code}} ⟹ Analogously, true if $table exists and has the string property '$key'\\817 +* {{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 818 +* {{code}}$list.{5}?{{/code}} ⟹ true if $list exists and has the property 5, false otherwise 819 +* {{code}}$table.$key?{{/code}} ⟹ Analogously, true if $table exists and has the string property '$key'\\ 826 826 827 827 828 828 829 829 The question mark can even be applied to variables: 830 830 831 -* {{code language="xml"}}$list{{/code}} ⟹ The value stored under the name $list, or an error if there is no such variable832 -* {{code language="xml"}}$list?{{/code}} ⟹ true if the variable exists, false otherwise825 +* {{code}}$list{{/code}} ⟹ The value stored under the name $list, or an error if there is no such variable 826 +* {{code}}$list?{{/code}} ⟹ true if the variable exists, false otherwise 833 833 834 834 To look up the value of a property although it may not exist, you can use the at-sign "@" as prefix: 835 835 836 -* {{code language="xml"}}@$list.{5}{{/code}} ⟹ The result of the $list lookup if $list exists and has the property 5, otherwise null (without error message)837 -* {{code language="xml"}}@$list{{/code}} ⟹ The list if this variable exists, null otherwise838 -* {{code language="xml"}}@$list.{5}.{1}{{/code}} ⟹ The first element of the fifth element of $list, if it exists, null otherwise830 +* {{code}}@$list.{5}{{/code}} ⟹ The result of the $list lookup if $list exists and has the property 5, otherwise null (without error message) 831 +* {{code}}@$list{{/code}} ⟹ The list if this variable exists, null otherwise 832 +* {{code}}@$list.{5}.{1}{{/code}} ⟹ The first element of the fifth element of $list, if it exists, null otherwise 839 839 840 840 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. 841 841 ... ... @@ -958,13 +958,13 @@ 958 958 **[New as of X Rebirth 4.0]** 959 959 \\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. 960 960 961 -* {{code language="xml"}}$money.formatted.{'formatstring'}{{/code}}962 -* {{code language="xml"}}$money.formatted.default{{/code}} (using default format string '%s')\\955 +* {{code}}$money.formatted.{'formatstring'}{{/code}} 956 +* {{code}}$money.formatted.default{{/code}} (using default format string '%s')\\ 963 963 964 964 965 965 966 -* {{code language="xml"}}$time.formatted.{'formatstring'}{{/code}}967 -* {{code language="xml"}}$time.formatted.default{{/code}} (using default format string '%T')960 +* {{code}}$time.formatted.{'formatstring'}{{/code}} 961 +* {{code}}$time.formatted.default{{/code}} (using default format string '%T') 968 968 969 969 In scripts, money is stored in cents, not Credits. The formatted representation always shows the value in Credits, including thousands separators. 970 970 ... ... @@ -994,20 +994,20 @@ 994 994 995 995 996 996 997 -* {{code language="xml"}}(1234Cr).formatted.{'%s'}{{/code}}⟹{{codelanguage="xml"}}'1,234'{{/code}}998 -* {{code language="xml"}}(1234Cr).formatted.default{{/code}}⟹{{codelanguage="xml"}}'1,234'{{/code}} (same as {'%s'})999 -* {{code language="xml"}}(1234Cr).formatted.{'%.s %Cr'}{{/code}}⟹{{codelanguage="xml"}}'1,234.00 Cr'{{/code}}1000 -* {{code language="xml"}}(1234Cr).formatted.{'%1s'}{{/code}}⟹{{codelanguage="xml"}}'1 k'{{/code}} (rounding towards zero)1001 -* {{code language="xml"}}(1234Cr).formatted.{'%cM'}{{/code}}⟹{{codelanguage="xml"}}'0 M'{{/code}}991 +* {{code}}(1234Cr).formatted.{'%s'}{{/code}}⟹{{code}}'1,234'{{/code}} 992 +* {{code}}(1234Cr).formatted.default{{/code}}⟹{{code}}'1,234'{{/code}} (same as {'%s'}) 993 +* {{code}}(1234Cr).formatted.{'%.s %Cr'}{{/code}}⟹{{code}}'1,234.00 Cr'{{/code}} 994 +* {{code}}(1234Cr).formatted.{'%1s'}{{/code}}⟹{{code}}'1 k'{{/code}} (rounding towards zero) 995 +* {{code}}(1234Cr).formatted.{'%cM'}{{/code}}⟹{{code}}'0 M'{{/code}} 1002 1002 1003 1003 For documentation of time format strings, see the Lua function ConvertTimeString() in the [[MediaWiki.ARCHIVE.XRWIKIModding_supportUI_Modding_supportLua_function_overview]]. 1004 1004 1005 1005 Examples: 1006 1006 1007 -* {{code language="xml"}}(151s).formatted.{'%T'}{{/code}} ⟹ {{codelanguage="xml"}}'00:02:31'{{/code}}1008 -* {{code language="xml"}}(151s).formatted.default{{/code}} ⟹ {{codelanguage="xml"}}'00:02:31'{{/code}} (same as {'%T'})1009 -* {{code language="xml"}}(151s).formatted.{'%.3T'}{{/code}} ⟹ {{codelanguage="xml"}}'00:02:31.000'{{/code}}1010 -* {{code language="xml"}}(151s).formatted.{'%h:%M'}{{/code}} ⟹ {{codelanguage="xml"}}'0:02'{{/code}}1001 +* {{code}}(151s).formatted.{'%T'}{{/code}} ⟹ {{code}}'00:02:31'{{/code}} 1002 +* {{code}}(151s).formatted.default{{/code}} ⟹ {{code}}'00:02:31'{{/code}} (same as {'%T'}) 1003 +* {{code}}(151s).formatted.{'%.3T'}{{/code}} ⟹ {{code}}'00:02:31.000'{{/code}} 1004 +* {{code}}(151s).formatted.{'%h:%M'}{{/code}} ⟹ {{code}}'0:02'{{/code}} 1011 1011 1012 1012 (% id="complete-property-documentation" %) 1013 1013 ... ... @@ -1091,15 +1091,7 @@ 1091 1091 1092 1092 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. 1093 1093 1094 -{{code language="xml"}} 1095 - <cue [...] version="42"> 1096 - <conditions> [...] </conditions> 1097 - <actions> [...] </actions> 1098 - <patch sinceversion="42"> 1099 - [patch actions] 1100 - </patch> 1101 - </cue> 1102 -{{/code}} 1088 +{{code}}<cue [...] version="42"> <conditions> [...] </conditions> <actions> [...] </actions> <patch sinceversion="42"> [patch actions] </patch></cue>{{/code}} 1103 1103 1104 1104 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. 1105 1105 ... ... @@ -1125,20 +1125,11 @@ 1125 1125 1126 1126 There are many conditions and conditional actions that require a value comparison, for example the condition <check_value>: 1127 1127 1128 -{{code language="xml"}} 1129 - <check_value value="$ware == ware.silicon and $amount != 0"/> 1130 -{{/code}} 1114 +{{code}}<check_value value="$ware == ware.silicon and $amount != 0"/>{{/code}} 1131 1131 1132 1132 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: 1133 1133 1134 -{{code language="xml"}} 1135 - <check_value value="FooCue.state" exact="cuestate.complete"/> 1136 - <check_value value="$foo.count" min="5"/> 1137 - <check_value value="$foo" max="player.age + 1min"/> 1138 - <check_value value="player.money" min="300Cr" max="600Cr"/> 1139 - <check_value value="$method" list="[killmethod.hitbymissile, killmethod.collected]"/> 1140 - <check_value value="$attention" min="attention.visible"/> 1141 -{{/code}} 1118 +{{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}} 1142 1142 1143 1143 {{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}} 1144 1144 ... ... @@ -1150,30 +1150,21 @@ 1150 1150 1151 1151 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: 1152 1152 1153 -{{code language="xml"}} 1154 - <set_value name="$race" exact="race.teladi"/> 1155 -{{/code}} 1130 +{{code}}<set_value name="$race" exact="race.teladi"/>{{/code}} 1156 1156 1157 1157 To select a random element from a list, this syntax can be used: 1158 1158 1159 -{{code language="xml"}} 1160 - <set_value name="$prime" list="[2, 3, 5, 7, 11]"/> 1161 -{{/code}} 1134 +{{code}}<set_value name="$prime" list="[2, 3, 5, 7, 11]"/>{{/code}} 1162 1162 1163 1163 To get a random number within a given range, you can use min/max: 1164 1164 1165 -{{code language="xml"}} 1166 - <set_value name="$foo" min="-20" max="20"/> 1167 - <set_value name="$timeout" max="20s"/> 1168 -{{/code}} 1138 +{{code}}<set_value name="$foo" min="-20" max="20"/><set_value name="$timeout" max="20s"/>{{/code}} 1169 1169 1170 1170 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). 1171 1171 1172 1172 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). 1173 1173 1174 -{{code language="xml"}} 1175 - <set_value name="$foo" min="-20" max="20" profile="profile.increasing" scale="4"/> 1176 -{{/code}} 1144 +{{code}}<set_value name="$foo" min="-20" max="20" profile="profile.increasing" scale="4"/>{{/code}} 1177 1177 1178 1178 \\(% id="variables-and-namespaces" %) 1179 1179 ... ... @@ -1186,73 +1186,49 @@ 1186 1186 1187 1187 == Creating and removing variables == 1188 1188 1189 -You can create variables with certain actions and conditions, such as the <set_value> action: 1157 +{{{You can create variables with certain actions and conditions, such as the <set_value> action:}}} 1190 1190 1191 -{{code language="xml"}} 1192 - <set_value name="$foo" exact="$bar + 1" /> 1193 -{{/code}} 1159 +{{code}}<set_value name="$foo" exact="$bar + 1" />{{/code}} 1194 1194 1195 1195 <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>.) 1196 1196 1197 1197 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. 1198 1198 1199 -{{code language="xml"}} 1200 - <set_value name="$foo" operation="add" /> 1201 -{{/code}} 1165 +{{code}}<set_value name="$foo" operation="add" />{{/code}} 1202 1202 1203 1203 The trick is that <set_value> not only works on variables, but also on list elements and table keys: 1204 1204 1205 -{{code language="xml"}} 1206 - <set_value name="$list.{1}" exact="42" /> 1207 - <set_value name="$table.$foo" exact="42" /> 1208 -{{/code}} 1169 +{{code}}<set_value name="$list.{1}" exact="42" /><set_value name="$table.$foo" exact="42" />{{/code}}\\ 1209 1209 1210 1210 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): 1211 1211 1212 -{{code language="xml"}} 1213 - <set_value name="$list.{1}" exact="42" operation="insert" /> 1214 -{{/code}} 1173 +{{code}}<set_value name="$list.{1}" exact="42" operation="insert" />{{/code}} 1215 1215 1216 1216 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. 1217 1217 1218 1218 Appending is easier than that. The following actions are equivalent: 1219 1219 1220 -{{code language="xml"}} 1221 - <set_value name="$list.{$list.count + 1}" exact="42" operation="insert" /> 1222 - <append_to_list name="$list" exact="42" /> 1223 -{{/code}} 1179 +{{code}}<set_value name="$list.{$list.count + 1}" exact="42" operation="insert" /><append_to_list name="$list" exact="42" />{{/code}} 1224 1224 1225 1225 Inserting at a position below 1 or above $list.count + 1 is not possible. 1226 1226 1227 1227 To remove variables or list/table entries, use <remove_value>: 1228 1228 1229 -{{code language="xml"}} 1230 - <remove_value name="$foo" /> 1231 - <remove_value name="$list.{1}" /> 1232 - <remove_value name="$table.$foo" /> 1233 -{{/code}} 1185 +{{code}}<remove_value name="$foo" /><remove_value name="$list.{1}" /><remove_value name="$table.$foo" />{{/code}}\\ 1234 1234 1235 1235 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. 1236 1236 1237 -(% id="accessing-remote-variables" %) 1189 +\\\\\\(% id="accessing-remote-variables" %) 1238 1238 1239 1239 == Accessing remote variables == 1240 1240 1241 1241 You can also read and write variables in other cues by using the variable name as property key: 1242 1242 1243 -{{code language="xml"}} 1244 - <set_value name="OtherCue.$foo" min="0.0" max="1.0" /> 1245 - <set_value name="md.OtherScript.YetAnotherCue.$bar" exact="OtherCue.$foo" /> 1246 -{{/code}} 1195 +{{code}}<set_value name="OtherCue.$foo" min="0.0" max="1.0" /><set_value name="md.OtherScript.YetAnotherCue.$bar" exact="OtherCue.$foo" />{{/code}} 1247 1247 1248 1248 Instead of referencing a cue by name, you could also reference it via a keyword or another variable: 1249 1249 1250 -{{code language="xml"}} 1251 - <set_value name="static.$counter" operation="add" /> 1252 - <set_value name="parent.$foo" exact="42" /> 1253 - <set_value name="this.$bar" exact="parent" /> 1254 - <set_value name="$baz" exact="this.$bar.$foo" /> 1255 -{{/code}} 1199 +{{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}} 1256 1256 1257 1257 \\\\\\(% id="namespaces" %) 1258 1258 ... ... @@ -1262,17 +1262,7 @@ 1262 1262 1263 1263 Consider this case: 1264 1264 1265 -{{code language="xml"}} 1266 -<cue name="Root"> 1267 - <actions> 1268 - <set_value name="$foo" /> 1269 - </actions> 1270 - <cues> 1271 - <cue name="SubCue"> [...] 1272 - </cue> 1273 - </cues> 1274 -</cue> 1275 -{{/code}} 1209 +{{code}}<cue name="Root"> <actions> <set_value name="$foo" /> </actions> <cues> <cue name="SubCue"> [...] </cue> </cues></cue>{{/code}} 1276 1276 1277 1277 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. 1278 1278 ... ... @@ -1291,10 +1291,4 @@ 1291 1291 1292 1292 {{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: 1293 1293 1294 -{{code language="xml"}} 1295 -<cue name="LibRef" ref="Lib"> 1296 - <param name="Param1" value="$foo" /> <!-- $foo from parent namespace --> 1297 - <param name="Param2" value="namespace.$foo" /> <!-- LibRef.$foo (error) --> 1298 -</cue> 1299 -{{/code }} 1300 -{{/warning}} 1228 +<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}}