Changes for page Mission Director Guide

Summary

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

Details

Page properties

Content

...	...	@@ -1008,7 +1008,29 @@
1008	1008	* MD scripts and cues are identified by their names. So a script can only be refreshed if it has the same script name as before (file name is irrelevant).
1009	1009	* If there are new script files or new cue nodes (i.e. scripts/cues with new names) they are created and added properly. If you remove script files or cue nodes, the corresponding scripts/cues are removed from the game, including instances.
1010	1010	** (!) Pitfall: Cue Removal
1011		-If you remove a cue and then later add another cue with the same name, old save files will not know that the cue has been removed inbetween. In the following example the first cue was created setting $val_1 and the game is saved.
	1011	+
	1012	+* As a consequence, you CANNOT rename scripts or cues if you want to refresh them. Doing so would remove the old script or cue and add a new one with the new name.
	1013	+* You CANNOT change a <cue> to a <library> or vice versa.
	1014	+* You CANNOT add, remove, or change the "ref" attribute of a cue. But it is possible to remove the whole cue. (If all references to a library are removed you can also remove the library itself.)
	1015	+* You CANNOT change the cue tree structure, i.e. if you move a cue out of its <cues> node, you also have to change its name (see above). Changing the order of cues within the same <cues> node is possible, however, the order of execution is not reliable anyway.
	1016	+* You CAN change a library and change/add/remove its sub-cues. This automatically updates all cues that use the library.
	1017	+* You CAN change library parameters (both in libraries and in referencing cues). However, this does not change the variables of a referencing cue if it is already enabled.
	1018	+* You CAN change conditions without restrictions. You can even change between event and non-event conditions. If a cue has enabled condition checks, they are aborted and restarted (even if there is no change).
	1019	+* Adding root cues enables their condition checks immediately (if the module attribute allows it).
	1020	+* Adding sub-cues to active or complete cues enables their condition checks immediately.
	1021	+* You CAN change/add/remove <actions>, <force>, <delay>, and all attributes without restrictions, except for the "ref" attribute (see above). You can even change the <delay> while the cue is already active and the timer is running.
	1022	+* Changing instantiate="false" to "true" turns the cue into "waiting" state if it was active or complete before.
	1023	+* Changing instantiate="true" to "false" removes all instantiated cues and their descendants.
	1024	+
	1025	+{{warning}}
	1026	+Be aware that completed instances can be auto-deleted, and so added sub-cues will not become active in such a case.
	1027	+{{/warning}}
	1028	+
	1029	+{{warning}}
	1030	+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.
	1031	+{{/warning}}
	1032	+
	1033	+(% id="cke_bm_117445S" style="display:none" %) (%%)If you remove a cue and then later add another cue with the same name, old save files will not know that the cue has been removed inbetween. In the following example the first cue was created setting $val_1 and the game is saved.
1012	1012	{{code language="xml"}}<cue name="Deprecated_Test1">
1013	1013	<actions>
1014	1014	<set_value name="$val_1" exact="'old value'"/>
...	...	@@ -1032,27 +1032,7 @@
1032	1032	\\To avoid this, do not delete any cues (once they are public for save game compatibility), but empty them out and mark them as deprecated. This will prevent new cues with the same name in the script.
1033	1033	{{code language="xml"}}<!-- Deprecated Cues, kept to not duplicate names in future cues -->
1034	1034	<cue name="Deprecated_Test1" comment="deprecated"></cue>{{/code}}
1035		-* As a consequence, you CANNOT rename scripts or cues if you want to refresh them. Doing so would remove the old script or cue and add a new one with the new name.
1036		-* You CANNOT change a <cue> to a <library> or vice versa.
1037		-* You CANNOT add, remove, or change the "ref" attribute of a cue. But it is possible to remove the whole cue. (If all references to a library are removed you can also remove the library itself.)
1038		-* You CANNOT change the cue tree structure, i.e. if you move a cue out of its <cues> node, you also have to change its name (see above). Changing the order of cues within the same <cues> node is possible, however, the order of execution is not reliable anyway.
1039		-* You CAN change a library and change/add/remove its sub-cues. This automatically updates all cues that use the library.
1040		-* You CAN change library parameters (both in libraries and in referencing cues). However, this does not change the variables of a referencing cue if it is already enabled.
1041		-* You CAN change conditions without restrictions. You can even change between event and non-event conditions. If a cue has enabled condition checks, they are aborted and restarted (even if there is no change).
1042		-* Adding root cues enables their condition checks immediately (if the module attribute allows it).
1043		-* Adding sub-cues to active or complete cues enables their condition checks immediately.
1044		-* You CAN change/add/remove <actions>, <force>, <delay>, and all attributes without restrictions, except for the "ref" attribute (see above). You can even change the <delay> while the cue is already active and the timer is running.
1045		-* Changing instantiate="false" to "true" turns the cue into "waiting" state if it was active or complete before.
1046		-* Changing instantiate="true" to "false" removes all instantiated cues and their descendants.
1047	1047
1048		-{{warning}}
1049		-Be aware that completed instances can be auto-deleted, and so added sub-cues will not become active in such a case.
1050		-{{/warning}}
1051		-
1052		-{{warning}}
1053		-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.
1054		-{{/warning}}
1055		-
1056	1056	== Patching ==
1057	1057
1058	1058	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.