Changes for page Mission Director Guide

Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -22,7 +22,7 @@
22	22	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.
23	23
24	24	{{info}}
25		-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 [[Conditions>>doc:||anchor="HConditions" style="outline-width: 0px !important; user-select: auto !important;"]]).
	25	+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]]).
26	26
27	27	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."
28	28	{{/info}}
...	...	@@ -217,11 +217,11 @@
217	217	{{/code}}
218	218
219	219	{{info}}
220		-Messages printed with <debug_text> are usually only visible when the "scripts" debug filter is enabled, see [[Script debug output>>doc:||anchor="HScriptdebugoutput"]]
	220	+Messages printed with <debug_text> are usually only visible when the "scripts" debug filter is enabled, see Script debug output
221	221	{{/info}}
222	222
223		-Script debug output
224	224
	224	+
225	225	Each child action in a <do_any> node can have a //**weight**// attribute, which can be used to control the random selection of an action node. The default weight of a child node is 1.
226	226
227	227	Also available is **<do_if>**, which completes the enclosed action(s) only if one provided value is non-null or matches another. Directly after a <do_if> node, you can add one or more **<do_elseif>** nodes to perform additional checks only in case the previous conditions were not met. The node **<do_else>** can be used directly after a <do_if> or a <do_elseif>. It is executed only if none of the conditions are met.
...	...	@@ -239,6 +239,7 @@
239	239	{{/info}}
240	240
241	241
	242	+
242	242	Library cues are written like normal cues, they are also defined in a <cues> node, just with the difference that the XML tag is called library instead of cue:
243	243
244	244	{{code language="xml"}}
...	...	@@ -289,9 +289,11 @@
289	289	{{/code}}
290	290
291	291	{{warning}}
292		-These examples are definitely **__not__ **examples of good scripting style.
	293	+These examples are definitely <u>not</u> examples of good scripting style.
293	293	{{/warning}}
294	294
	296	+
	297	+
295	295	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.
296	296
297	297	Notes:
...	...	@@ -361,6 +361,8 @@
361	361	This sub-section requires basic knowledge of script expressions.
362	362	{{/info}}
363	363
	367	+
	368	+
364	364	In case of instances with sub-instances, you will often want to access a related instance from the current one. Like in the non-instance case, you can simply write the cue name in an expression to reference that cue. However, you should be aware of the pitfalls that are accompanied by this.
365	365
366	366	When you use a cue name from the same script in an expression, it will always be resolved to some cue - usually a static cue, even if it is still in the disabled state, but it can also be an instance, if it is "related" to the current one.
...	...	@@ -396,7 +396,7 @@
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"}}<debug_text text="static.$foo"/>{{/code}}
	404	+{{code language="xml"}} <debug_text text="static.$foo"/>{{/code}}
400	400	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:
401	401	{{code language="xml"}}<set_value name="$foo" exact="static.$foo"/>{{/code}}
402	402
...	...	@@ -417,6 +417,8 @@
417	417	Since octal numbers are hardly ever used (usually unknowingly), the parser is will produce a warning if an octal number is encountered."
418	418	{{/info}}
419	419
	425	+
	426	+
420	420	You can write string literals by putting the string in single quotes:
421	421
422	422	* {{code language="xml"}}'Hello world'{{/code}}
...	...	@@ -494,10 +494,10 @@
494	494	|true|constant|{{code language="xml"}}null == 0{{/code}}|{{code language="xml"}}true{{/code}}|Integer value 1, useful in Boolean expressions
495	495	|pi|constant|{{code language="xml"}}2 * pi{{/code}}|{{code language="xml"}}6.2831853rad{{/code}}|π as an angle (same as 180deg)
496	496	|()|delimiter|{{code language="xml"}}(2 + 4) * (6 + 1){{/code}}|{{code language="xml"}}42{{/code}}|Parentheses for arithmetic grouping
497		-|[]|delimiter|{{code language="xml"}}[1, 2, 2+1, 'string']{{/code}}|{{code language="xml"}}[1, 2, 3, 'string']{{/code}}|[[List>>doc:||anchor="HLists" style="outline-width: 0px !important; user-select: auto !important;"]] of values
498		-|table[]|delimiter|{{code language="xml"}}table[$foo='bar', {1+1}=40+2]{{/code}}|{{code language="xml"}}table[$foo='bar', {2}=42]{{/code}}|[[Table>>doc:||anchor="HTables" style="outline-width: 0px !important; user-select: auto !important;"]] of values
	504	+|[]|delimiter|{{code language="xml"}}[1, 2, 2+1, 'string']{{/code}}|{{code language="xml"}}[1, 2, 3, 'string']{{/code}}|[[List>>MediaWiki.NULL]] of values
	505	+|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
499	499	|{}|delimiter|{{code language="xml"}}{101, 3}{{/code}}|{{code language="xml"}}'Some text'{{/code}}|Text lookup (page ID and text ID) from TextDB
500		-\\(Note: Braces are also used for [[property lookups>>doc:||anchor="HValueproperties" style="outline-width: 0px !important; user-select: auto !important;"]])
	507	+\\(Note: Braces are also used for [[property lookups>>MediaWiki.NULL]])
501	501	|+|unary|{{code language="xml"}}+21 * (+2){{/code}}|{{code language="xml"}}42{{/code}}|Denotes positive number (no effect)
502	502	|-|unary|{{code language="xml"}}-(21 * -2){{/code}}|{{code language="xml"}}42{{/code}}|Negates the following number
503	503	|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,7 +507,7 @@
507	507	\\{{code language="xml"}}typeof 'Hello world'{{/code}}|
508	508	{{code language="xml"}}datatype.null{{/code}}
509	509	\\{{code language="xml"}}datatype.integer{{/code}}
510		-\\{{code language="xml"}}datatype.string{{/code}}|Yields the [[data type of the following sub-expression>>||anchor="typeof" style="outline-width: 0px !important; user-select: auto !important;"]]
	517	+\\{{code language="xml"}}datatype.string{{/code}}|Yields the [[data type of the following sub-expression>>MediaWiki.NULL]]
511	511	|sin|unary|
512	512	{{code language="xml"}}sin(30deg){{/code}}
513	513	\\{{code language="xml"}}sin(pi){{/code}}|
...	...	@@ -552,9 +552,9 @@
552	552	ge
553	553	\\>=|binary|
554	554	{{code language="xml"}}1 ge 3{{/code}}
555		-\\{{code language="xml"}}1 >= 3{{/code}}|{{code language="xml"}}false{{/code}}|Greater than or equal to
	562	+\\{{code language="xml"}}1 <= 3{{/code}}|{{code language="xml"}}false{{/code}}|Greater than or equal to
556	556	|(((
557		-
	564	+= =
558	558	)))|binary|{{code language="xml"}}1 + 1 == 2.0{{/code}}|{{code language="xml"}}true{{/code}}|Equal to
559	559	|~!=|binary|{{code language="xml"}}1 + 1 != 2.0{{/code}}|{{code language="xml"}}false{{/code}}|Not equal to
560	560	|and|binary|{{code language="xml"}}true and false{{/code}}|{{code language="xml"}}false{{/code}}|Logical AND (short-circuit semantics)
...	...	@@ -623,8 +623,11 @@
623	623	* 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.
624	624	* <, <=, >, >= 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.
625	625
626		-== (% id="categorybroken_macroanchorstrings-and-formatting" %)Strings and formatting(%%) ==
	633	+(% id="categorybroken_macroanchorstrings-and-formatting" %)== Strings and formatting==
627	627
	635	+
	636	+{{{==}}}
	637	+
628	628	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:
629	629
630	630	* {{code language="xml"}}'The %1 %2 %3 jumps over the %5 %4'.['quick', 'brown', 'fox', 'dog', 'lazy']{{/code}}
...	...	@@ -844,8 +844,6 @@
844	844	\\faction.argongovernment|Factions
845	845	)))
846	846
847		-{{id name="typeof"/}}
848		-
849	849	{{info}}
850	850	With the ''typeof'' operator you can get the datatype of any expression and compare it with what you expect, for example:
851	851