Changes for page Mission Director Guide
Last modified by Klaus Meyer on 2025/03/31 16:39
From version 32949.1
edited by Daniel Turner
on 2023/08/22 18:54
on 2023/08/22 18:54
Change comment:
There is no comment for this version
To version 32950.1
edited by Daniel Turner
on 2023/08/22 18:56
on 2023/08/22 18:56
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -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}}-logfile debuglog.txt{{/code}} 35 +{{code language="xml"}}-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}}-debug scripts{{/code}} 39 +{{code language="xml"}}-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 ... ... @@ -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}}0{{/code}} (integer number) 415 -* {{code}}0772{{/code}} (leading 0 means octal integer number) 416 -* {{code}}3.14159{{/code}} (floating point number) 417 -* {{code}}5e12{{/code}} (float in exponent notation, "times ten to the power of") 418 -* {{code}}0xCAFE{{/code}} (hexadecimal integer number) 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) 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}}'Hello world'{{/code}} 429 -* {{code}}''{{/code}} (empty string) 430 -* {{code}}'String with a line break\n'{{/code}} 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}} 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}}5000000000L{{/code}} (large integer) 441 -* {{code}}1f{{/code}} (floating point number, same as 1.0, just 1 would be an integer) 442 -* {{code}}1000Cr{{/code}} (Money in Credits, converted to 100000 cents automatically) 443 -* {{code}}500m{{/code}} (Length in metres) 444 -* {{code}}10s{{/code}} (Time in seconds) 445 -* {{code}}1h{{/code}} (Time in hours, which is converted to 3600s automatically) 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) 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}}null + 1{{/code}}|{{code}}1{{/code}}|Null value, see above 496 -|false|constant|{{code}}1 == 0{{/code}}|{{code}}false{{/code}}|Integer value 0, useful in Boolean expressions 497 -|true|constant|{{code}}null == 0{{/code}}|{{code}}true{{/code}}|Integer value 1, useful in Boolean expressions 498 -|pi|constant|{{code}}2 * pi{{/code}}|{{code}}6.2831853rad{{/code}}|╧Ç as an angle (same as 180deg) 499 -|()|delimiter|{{code}}(2 + 4) * (6 + 1){{/code}}|{{code}}42{{/code}}|Parentheses for arithmetic grouping 500 -|[]|delimiter|{{code}}[1, 2, 2+1, 'string']{{/code}}|{{code}}[1, 2, 3, 'string']{{/code}}|[[List>>MediaWiki.NULL]] of values 501 -|table[]|delimiter|{{code}}table[$foo='bar', {1+1}=40+2]{{/code}}|{{code}}table[$foo='bar', {2}=42]{{/code}}|[[Table>>MediaWiki.NULL]] of values 502 -|{}|delimiter|{{code}}{101, 3}{{/code}}|{{code}}'Some text'{{/code}}|Text lookup (page ID and text ID) from TextDB 495 +|null|constant|{{code language="xml"}}null + 1{{/code}}|{{code language="xml"}}1{{/code}}|Null value, see above 496 +|false|constant|{{code language="xml"}}1 == 0{{/code}}|{{code language="xml"}}false{{/code}}|Integer value 0, useful in Boolean expressions 497 +|true|constant|{{code language="xml"}}null == 0{{/code}}|{{code language="xml"}}true{{/code}}|Integer value 1, useful in Boolean expressions 498 +|pi|constant|{{code language="xml"}}2 * pi{{/code}}|{{code language="xml"}}6.2831853rad{{/code}}|╧Ç as an angle (same as 180deg) 499 +|()|delimiter|{{code language="xml"}}(2 + 4) * (6 + 1){{/code}}|{{code language="xml"}}42{{/code}}|Parentheses for arithmetic grouping 500 +|[]|delimiter|{{code language="xml"}}[1, 2, 2+1, 'string']{{/code}}|{{code language="xml"}}[1, 2, 3, 'string']{{/code}}|[[List>>MediaWiki.NULL]] of values 501 +|table[]|delimiter|{{code language="xml"}}table[$foo='bar', {1+1}=40+2]{{/code}}|{{code language="xml"}}table[$foo='bar', {2}=42]{{/code}}|[[Table>>MediaWiki.NULL]] of values 502 +|{}|delimiter|{{code language="xml"}}{101, 3}{{/code}}|{{code language="xml"}}'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}}+21 * (+2){{/code}}|{{code}}42{{/code}}|Denotes positive number (no effect) 505 -|-|unary|{{code}}-(21 * -2){{/code}}|{{code}}42{{/code}}|Negates the following number 506 -|not|unary|{{code}}not (21 == 42){{/code}}|{{code}}true{{/code}}|Yields true if the following expression is false (equal to zero), false otherwise 504 +|+|unary|{{code language="xml"}}+21 * (+2){{/code}}|{{code language="xml"}}42{{/code}}|Denotes positive number (no effect) 505 +|-|unary|{{code language="xml"}}-(21 * -2){{/code}}|{{code language="xml"}}42{{/code}}|Negates the following number 506 +|not|unary|{{code language="xml"}}not (21 == 42){{/code}}|{{code language="xml"}}true{{/code}}|Yields true if the following expression is false (equal to zero), false otherwise 507 507 |typeof|unary| 508 -{{code}}typeof null{{/code}} 509 -\\{{code}}typeof 0{{/code}} 510 -\\{{code}}typeof 'Hello world'{{/code}}| 511 -{{code}}datatype.null{{/code}} 512 -\\{{code}}datatype.integer{{/code}} 513 -\\{{code}}datatype.string{{/code}}|Yields the [[data type of the following sub-expression>>MediaWiki.NULL]] 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]] 514 514 |sin|unary| 515 -{{code}}sin(30deg){{/code}} 516 -\\{{code}}sin(pi){{/code}}| 517 -{{code}}0.5{{/code}} 518 -\\{{code}}1.0{{/code}}|Sine (function-style, parentheses required) 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) 519 519 |cos|unary| 520 -{{code}}cos(60deg){{/code}} 521 -\\{{code}}cos(pi){{/code}}| 522 -{{code}}0.5{{/code}} 523 -\\{{code}}0.0{{/code}}|Cosine (function-style, parentheses required) 524 -|sqrt|unary|{{code}}sqrt(2){{/code}}|{{code}}1.414213LF{{/code}}|Square root (function-style, parentheses required) 525 -|exp|unary|{{code}}exp(1){{/code}}|{{code}}2.71828LF{{/code}}|Exponential function (function-style, parentheses required) 526 -|log|unary|{{code}}log(8) / log(2){{/code}}|{{code}}3.0LF{{/code}}|Natural logarithm (function-style, parentheses required) 527 -|^|binary|{{code}}10 ^ 3{{/code}}|{{code}}1000.0LF{{/code}}|Power 528 -|*|binary|{{code}}21 * 2{{/code}}|{{code}}42{{/code}}|Multiplication 529 -|/|binary|{{code}}42 / 1042.0 / 10.0{{/code}}|{{code}}44.2{{/code}}|Division 530 -|%|binary|{{code}}42 % 10{{/code}}|{{code}}2{{/code}}|Modulus (remainder of integer division) 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}}|{{code language="xml"}}1.414213LF{{/code}}|Square root (function-style, parentheses required) 525 +|exp|unary|{{code language="xml"}}exp(1){{/code}}|{{code language="xml"}}2.71828LF{{/code}}|Exponential function (function-style, parentheses required) 526 +|log|unary|{{code language="xml"}}log(8) / log(2){{/code}}|{{code language="xml"}}3.0LF{{/code}}|Natural logarithm (function-style, parentheses required) 527 +|^|binary|{{code language="xml"}}10 ^ 3{{/code}}|{{code language="xml"}}1000.0LF{{/code}}|Power 528 +|*|binary|{{code language="xml"}}21 * 2{{/code}}|{{code language="xml"}}42{{/code}}|Multiplication 529 +|/|binary|{{code language="xml"}}42 / 1042.0 / 10.0{{/code}}|{{code language="xml"}}44.2{{/code}}|Division 530 +|%|binary|{{code language="xml"}}42 % 10{{/code}}|{{code language="xml"}}2{{/code}}|Modulus (remainder of integer division) 531 531 |+|binary| 532 -{{code}}1 + 1{{/code}} 533 -\\{{code}}'Hello' + ' world'{{/code}}| 534 -{{code}}2{{/code}} 535 -\\{{code}}'Hello world'{{/code}}| 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}}| 536 536 Addition 537 537 \\String concatenation 538 -|-|binary|{{code}}1 - 1{{/code}}|{{code}}0{{/code}}|Subtraction 538 +|-|binary|{{code language="xml"}}1 - 1{{/code}}|{{code language="xml"}}0{{/code}}|Subtraction 539 539 | 540 540 lt 541 541 \\< (<)|binary| 542 -{{code}}1 lt 3{{/code}} 543 -\\{{code}}1 < 3{{/code}}|{{code}}true{{/code}}|Less than 542 +{{code language="xml"}}1 lt 3{{/code}} 543 +\\{{code language="xml"}}1 < 3{{/code}}|{{code language="xml"}}true{{/code}}|Less than 544 544 | 545 545 le 546 546 \\<=|binary| 547 -{{code}}1 le 3{{/code}} 548 -\\{{code}}1 <= 3{{/code}}|{{code}}true{{/code}}|Less than or equal to 547 +{{code language="xml"}}1 le 3{{/code}} 548 +\\{{code language="xml"}}1 <= 3{{/code}}|{{code language="xml"}}true{{/code}}|Less than or equal to 549 549 | 550 550 gt 551 551 \\> (>)|binary| 552 -{{code}}1 gt 3{{/code}} 553 -\\{{code}}1 > 3{{/code}}|{{code}}false{{/code}}|Greater than 552 +{{code language="xml"}}1 gt 3{{/code}} 553 +\\{{code language="xml"}}1 > 3{{/code}}|{{code language="xml"}}false{{/code}}|Greater than 554 554 | 555 555 ge 556 556 \\>=|binary| 557 -{{code}}1 ge 3{{/code}} 558 -\\{{code}}1 >= 3{{/code}}|{{code}}false{{/code}}|Greater than or equal to 557 +{{code language="xml"}}1 ge 3{{/code}} 558 +\\{{code language="xml"}}1 >= 3{{/code}}|{{code language="xml"}}false{{/code}}|Greater than or equal to 559 559 |((( 560 560 = = 561 -)))|binary|{{code}}1 + 1 == 2.0{{/code}}|{{code}}true{{/code}}|Equal to 562 -|~!=|binary|{{code}}1 + 1 != 2.0{{/code}}|{{code}}false{{/code}}|Not equal to 563 -|and|binary|{{code}}true and false{{/code}}|{{code}}false{{/code}}|Logical AND (short-circuit semantics) 564 -|or|binary|{{code}}true or false{{/code}}|{{code}}true{{/code}}|Logical OR (short-circuit semantics) 561 +)))|binary|{{code language="xml"}}1 + 1 == 2.0{{/code}}|{{code language="xml"}}true{{/code}}|Equal to 562 +|~!=|binary|{{code language="xml"}}1 + 1 != 2.0{{/code}}|{{code language="xml"}}false{{/code}}|Not equal to 563 +|and|binary|{{code language="xml"}}true and false{{/code}}|{{code language="xml"}}false{{/code}}|Logical AND (short-circuit semantics) 564 +|or|binary|{{code language="xml"}}true or false{{/code}}|{{code language="xml"}}true{{/code}}|Logical OR (short-circuit semantics) 565 565 | 566 566 if ... then ... 567 567 \\if ... then ... else ...|ternary| 568 -{{code}}if 1 == 2 then 'F'{{/code}} 569 -\\{{code}}if 1 == 2 then 'F' else 'T'{{/code}}| 570 -{{code}}null{{/code}} 571 -\\{{code}}'T'{{/code}}|Conditional operator ("inline if") 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") 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}}(1 + 1)f{{/code}} ⟹ {{code}}2f{{/code}} ⟹ {{code}}2.0{{/code}} 607 -* {{code}}(1h) m / (180deg) i{{/code}} ⟹ {{code}}(3600s) m / (3.14rad) i{{/code}} ⟹ {{code}}3600m / 3{{/code}} ⟹ {{code}}1200m{{/code}} 606 +* {{code language="xml"}}(1 + 1)f{{/code}} ⟹ {{code language="xml"}}2f{{/code}} ⟹ {{code language="xml"}}2.0{{/code}} 607 +* {{code language="xml"}}(1h) m / (180deg) i{{/code}} ⟹ {{code language="xml"}}(3600s) m / (3.14rad) i{{/code}} ⟹ {{code language="xml"}}3600m / 3{{/code}} ⟹ {{code language="xml"}}1200m{{/code}} 608 608 609 -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.) 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.) 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}}'One plus one is equal to ' + (1+1) + '.'{{/code}} ⟹ {{code}}'One plus one is equal to 2.'{{/code}} 616 -* {{code}}'One plus one is not equal to ' + 1 + 1 + '.'{{/code}} ⟹ {{code}}'One plus one is not equal to 11.'{{/code}} 615 +* {{code language="xml"}}'One plus one is equal to ' + (1+1) + '.'{{/code}} ⟹ {{code language="xml"}}'One plus one is equal to 2.'{{/code}} 616 +* {{code language="xml"}}'One plus one is not equal to ' + 1 + 1 + '.'{{/code}} ⟹ {{code language="xml"}}'One plus one is not equal to 11.'{{/code}} 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}} false and $foo{{/code}} ⟹ {{code}}false{{/code}} (the value of $foo is not checked at all) 630 +** Example:{{code language="xml"}} false and $foo{{/code}} ⟹ {{code language="xml"}}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}}'The %1 %2 %3 jumps over the %5 %4'.['quick', 'brown', 'fox', 'dog', 'lazy']{{/code}} 644 -* {{code}}'%1 + %2 = %3'.[$a, $b, $a + $b]{{/code}} 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}} 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}}'%,s'.[12345678]{{/code}} ⟹ {{code}}'12,345,678'{{/code}} (the "," modifier shows a number with thousands separators, correctly localised) 655 -* {{code}}'%.3s'.[123.4]{{/code}} ⟹ {{code}}'123.400'{{/code}} (show 3 fractional digits, rounding half away from zero - decimal point correctly localised) 656 -* {{code}}'%,.1s'.[12345.67]'{{/code}} ⟹ {{code}}'12,345.7'{{/code}} (combination of the above) 654 +* {{code language="xml"}}'%,s'.[12345678]{{/code}} ⟹ {{code language="xml"}}'12,345,678'{{/code}} (the "," modifier shows a number with thousands separators, correctly localised) 655 +* {{code language="xml"}}'%.3s'.[123.4]{{/code}} ⟹ {{code language="xml"}}'123.400'{{/code}} (show 3 fractional digits, rounding half away from zero - decimal point correctly localised) 656 +* {{code language="xml"}}'%,.1s'.[12345.67]'{{/code}} ⟹ {{code language="xml"}}'12,345.7'{{/code}} (combination of the above) 657 657 658 658 Additional remarks: 659 659 ... ... @@ -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}}[100, 200, 300, 400].{1}{{/code}} ⟹ 100 (reading the first element) 748 -* {{code}}[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}}[].{'count'}{{/code}} ⟹ 0 750 -* {{code}}table[{21} = 42].{21}{{/code}} ⟹ 42\\ 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}} ⟹ 0 750 +* {{code language="xml"}}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}}[42].{'count'}{{/code}} 757 -* {{code}}$ship.{'name'}{{/code}} 758 -* {{code}}$ship.{'class'}{{/code}} 759 -* {{code}}table[$foo='bar'].{'$foo'}{{/code}}\\ 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}}\\ 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}}[0].count{{/code}} 766 -* {{code}}$ship.name{{/code}} 767 -* {{code}}$ship.class{{/code}} 768 -* {{code}}table[$foo='bar'].$foo{{/code}}\\ 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}}\\ 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}}[1, 6, 8].min{{/code}} ⟹ 1 780 +* {{code language="xml"}}[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}}[1, 6, 8].average{{/code}} ⟹ 5 784 +* {{code language="xml"}}[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}}[1, 6, 8].indexof.{8}{{/code}} ⟹ 3 788 +* {{code language="xml"}}[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}}[1, 6, 8].clone{{/code}} ⟹ {{code}}[1, 6, 8]{{/code}} 792 +* {{code language="xml"}}[1, 6, 8].clone{{/code}} ⟹ {{code language="xml"}}[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}}$table.keys.list{{/code}}: Yields a list of all keys in the table (reliably sorted by key if all keys are numeric)\\ 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)\\ 804 804 805 805 806 806 807 -* {{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) 808 -* {{code}}$table.keys.random{{/code}}: A randomly chosen key (which requires that the table is non-empty) 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) 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}}$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 824 -* {{code}}$list.{5}?{{/code}} ⟹ true if $list exists and has the property 5, false otherwise 825 -* {{code}}$table.$key?{{/code}} ⟹ Analogously, true if $table exists and has the string property '$key'\\ 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 error 824 +* {{code language="xml"}}$list.{5}?{{/code}} ⟹ true if $list exists and has the property 5, false otherwise 825 +* {{code language="xml"}}$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}}$list{{/code}} ⟹ The value stored under the name $list, or an error if there is no such variable 832 -* {{code}}$list?{{/code}} ⟹ true if the variable exists, false otherwise 831 +* {{code language="xml"}}$list{{/code}} ⟹ The value stored under the name $list, or an error if there is no such variable 832 +* {{code language="xml"}}$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}}@$list.{5}{{/code}} ⟹ The result of the $list lookup if $list exists and has the property 5, otherwise null (without error message) 837 -* {{code}}@$list{{/code}} ⟹ The list if this variable exists, null otherwise 838 -* {{code}}@$list.{5}.{1}{{/code}} ⟹ The first element of the fifth element of $list, if it exists, null otherwise 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 otherwise 838 +* {{code language="xml"}}@$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}}$money.formatted.{'formatstring'}{{/code}} 962 -* {{code}}$money.formatted.default{{/code}} (using default format string '%s')\\ 961 +* {{code language="xml"}}$money.formatted.{'formatstring'}{{/code}} 962 +* {{code language="xml"}}$money.formatted.default{{/code}} (using default format string '%s')\\ 963 963 964 964 965 965 966 -* {{code}}$time.formatted.{'formatstring'}{{/code}} 967 -* {{code}}$time.formatted.default{{/code}} (using default format string '%T') 966 +* {{code language="xml"}}$time.formatted.{'formatstring'}{{/code}} 967 +* {{code language="xml"}}$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}}(1234Cr).formatted.{'%s'}{{/code}}⟹{{code}}'1,234'{{/code}} 998 -* {{code}}(1234Cr).formatted.default{{/code}}⟹{{code}}'1,234'{{/code}} (same as {'%s'}) 999 -* {{code}}(1234Cr).formatted.{'%.s %Cr'}{{/code}}⟹{{code}}'1,234.00 Cr'{{/code}} 1000 -* {{code}}(1234Cr).formatted.{'%1s'}{{/code}}⟹{{code}}'1 k'{{/code}} (rounding towards zero) 1001 -* {{code}}(1234Cr).formatted.{'%cM'}{{/code}}⟹{{code}}'0 M'{{/code}} 997 +* {{code language="xml"}}(1234Cr).formatted.{'%s'}{{/code}}⟹{{code language="xml"}}'1,234'{{/code}} 998 +* {{code language="xml"}}(1234Cr).formatted.default{{/code}}⟹{{code language="xml"}}'1,234'{{/code}} (same as {'%s'}) 999 +* {{code language="xml"}}(1234Cr).formatted.{'%.s %Cr'}{{/code}}⟹{{code language="xml"}}'1,234.00 Cr'{{/code}} 1000 +* {{code language="xml"}}(1234Cr).formatted.{'%1s'}{{/code}}⟹{{code language="xml"}}'1 k'{{/code}} (rounding towards zero) 1001 +* {{code language="xml"}}(1234Cr).formatted.{'%cM'}{{/code}}⟹{{code language="xml"}}'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}}(151s).formatted.{'%T'}{{/code}} ⟹ {{code}}'00:02:31'{{/code}} 1008 -* {{code}}(151s).formatted.default{{/code}} ⟹ {{code}}'00:02:31'{{/code}} (same as {'%T'}) 1009 -* {{code}}(151s).formatted.{'%.3T'}{{/code}} ⟹ {{code}}'00:02:31.000'{{/code}} 1010 -* {{code}}(151s).formatted.{'%h:%M'}{{/code}} ⟹ {{code}}'0:02'{{/code}} 1007 +* {{code language="xml"}}(151s).formatted.{'%T'}{{/code}} ⟹ {{code language="xml"}}'00:02:31'{{/code}} 1008 +* {{code language="xml"}}(151s).formatted.default{{/code}} ⟹ {{code language="xml"}}'00:02:31'{{/code}} (same as {'%T'}) 1009 +* {{code language="xml"}}(151s).formatted.{'%.3T'}{{/code}} ⟹ {{code language="xml"}}'00:02:31.000'{{/code}} 1010 +* {{code language="xml"}}(151s).formatted.{'%h:%M'}{{/code}} ⟹ {{code language="xml"}}'0:02'{{/code}} 1011 1011 1012 1012 (% id="complete-property-documentation" %) 1013 1013