Changes for page Mission Director Guide

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

From 31068.1 to 31067.1 From 31076.1 to 31075.1

From version 31075.1

edited by Daniel Turner
on 2023/04/14 17:13

Change comment: There is no comment for this version

To version 31068.1

edited by Daniel Turner
on 2023/04/14 16:47

Change comment: Created page with "{{Info |body = Please note that this is officially-maintained documentation. To ensure that you can rely on the information having been checked by Egosoft, you will not be able to edit this page. }} <span style="color: rgb(0,0,0);text-decoration: none;"><br /> </span> <span style="color: rgb(0,0,0);text-decoration: none;">The Mission Director (MD) is a subsystem of the game and interprets mission scripts, which are written in an XML-based language. The Mission D..."

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -80,26 +80,13 @@
  (% style="color: rgb(0,0,0);text-decoration: none;" %)The XML root node of an MD file is called ΓÇ£mdscriptΓÇ¥ and looks like this:
--{{code language="xml"}}
--<?xml version="1.0" encoding="utf-8"?>
--<mdscript name="ScriptName" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="md.xsd">
--{{/code}}
++{{code}}&lt;?xml┬áversion=&quot;1.0&quot;┬áencoding=&quot;utf-8&quot;?&gt;&lt;mdscript┬áname=&quot;ScriptName&quot;┬áxmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot;┬áxsi:noNamespaceSchemaLocation=&quot;md.xsd&quot;&gt;{{/code}}
  (% style="color: rgb(0,0,0);text-decoration: none;" %)ΓÇ£ScriptNameΓÇ¥ is the name used for this script regardless of the file name. It (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)has to start with an upper case letter and must be unique(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %) among all MD script names. It also should not contain spaces, so other MD scripts can use it as an identifier to access this scriptΓÇÖs contents easily.
  (% style="color: rgb(0,0,0);text-decoration: none;" %)The only allowed sub-node of <mdscript> is <cues>, which can only contain <cue> sub-nodes:
--{{code language="xml"}}
--<?xml version="1.0" encoding="utf-8"?>
--<mdscript name="ScriptName" ...>
--  <cues>
--    <cue name="RootCue1"> [...]
--    </cue>
--    <cue name="RootCue2"> [...]
--    </cue>
--  </cues>
--</mdscript>
--{{/code}}
++{{code}}&lt;?xml┬áversion=&quot;1.0&quot;┬áencoding=&quot;utf-8&quot;?&gt;&lt;mdscript┬áname=&quot;ScriptName&quot; ...&gt;┬á &lt;cues&gt;┬á┬á┬á &lt;cue┬áname=&quot;RootCue1&quot;&gt; [...]┬á┬á┬á &lt;/cue&gt;┬á┬á┬á &lt;cue┬áname=&quot;RootCue2&quot;&gt; [...]┬á┬á┬á &lt;/cue&gt;┬á &lt;/cues&gt;&lt;/mdscript&gt;{{/code}}
  (% style="color: rgb(0,0,0);text-decoration: none;" %)┬á
@@ -131,17 +131,7 @@
  (% style="color: rgb(0,0,0);text-decoration: none;" %)This is how a cue node looks like:
--{{code language="xml"}}
--<cue name="CueName">
--  <conditions> [...]
--  </conditions>
--  <delay exact="5s" />
--  <actions> [...]
--  </actions>
--  <cues> [...]
--  </cues>
--</cue>
--{{/code}}
++{{code}}&lt;cue┬áname=&quot;CueName&quot;&gt;┬á &lt;conditions&gt; [...]┬á &lt;/conditions&gt;┬á &lt;delay┬áexact=&quot;5s&quot; /&gt;┬á &lt;actions&gt; [...]┬á &lt;/actions&gt;┬á &lt;cues&gt; [...]┬á &lt;/cues&gt;&lt;/cue&gt;{{/code}}
  (% style="color: rgb(0,0,0);text-decoration: none;" %)The rules for naming cues is the same for MD script names: The name **starts with an upper case letter**, and has to be (%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %)unique within this file(%%)**(% style="color: rgb(0,0,0);text-decoration: none;" %). So it is actually possible to use the same cue name in different scripts, which is different from the MD in X3.
@@ -160,35 +160,15 @@
  (% style="color: rgb(0,0,0);text-decoration: none;" %)Example for an event condition:
--{{code language="xml"}}
--<conditions>
--  <event_object_destroyed object="$target"/>
--</conditions>
--{{/code}}
++{{code}}&lt;conditions&gt;┬á &lt;event_object_destroyed┬áobject=&quot;$target&quot;/&gt;&lt;/conditions&gt;{{/code}}
  (% style="color: rgb(0,0,0);text-decoration: none;" %)Example for an event condition with an additional (non-event) check:
--{{code language="xml"}}
--<conditions>
--  <event_player_killed_object/>
--  <check_value value="event.param.isclass.turret"/>
--</conditions>
--{{/code}}
++{{code}}&lt;conditions&gt;┬á &lt;event_player_killed_object/&gt;┬á &lt;check_value┬ávalue=&quot;event.param.isclass.turret&quot;/&gt;&lt;/conditions&gt;{{/code}}
  (% style="color: rgb(0,0,0);text-decoration: none;" %)Example for an event condition with two alternative events and a common additional check:
--{{code language="xml"}}
--<conditions>
--  <check_any>
--    <event_cue_completed cue="Cue1"/>
--    <check_all>
--      <event_player_killed_object/>
--      <check_value value="event.param.isclass.turret"/>
--    </check_all>
--  </check_any>
--  <check_age min="$starttime"/>
--</conditions>
--{{/code}}
++{{code}}&lt;conditions&gt;┬á &lt;check_any&gt;┬á ┬á &lt;event_cue_completed┬ácue=&quot;Cue1&quot;/&gt;┬á ┬á &lt;check_all&gt;┬á┬á ┬á┬á &lt;event_player_killed_object/&gt;┬á┬á ┬á┬á &lt;check_value┬ávalue=&quot;event.param.isclass.turret&quot;/&gt;┬á ┬á &lt;/check_all&gt;┬á &lt;/check_any&gt;┬á &lt;check_age┬ámin=&quot;$starttime&quot;/&gt;&lt;/conditions&gt;{{/code}}
  (% style="color: rgb(0,0,0);text-decoration: none;" %)For more information about expressions and event parameters, see below.
@@ -206,21 +206,11 @@
  (% style="color: rgb(0,0,0);text-decoration: none;" %)Check conditions every 5 seconds, but start checking only 1 hour after game start.
--{{code language="xml"}}
--<cue name="Foo" checktime="1h" checkinterval="5s">
--  <conditions>
--  [...]
--</cue>
--{{/code}}
++{{code}}&lt;cue┬áname=&quot;Foo&quot;┬áchecktime=&quot;1h&quot;┬ácheckinterval=&quot;5s&quot;&gt;┬á &lt;conditions&gt;┬á [...]&lt;/cue&gt;{{/code}}
  (% style="color: rgb(0,0,0);text-decoration: none;" %)Check conditions 3 seconds after the cue is enabled, and cancel the cue in case of failure.
--{{code language="xml"}}
--<cue name="Foo" checktime="player.age + 3s" onfail="cancel">
--  <conditions>
--  [...]
--</cue>
--{{/code}}
++{{code}}&lt;cue┬áname=&quot;Foo&quot;┬áchecktime=&quot;player.age + 3s&quot;┬áonfail=&quot;cancel&quot;&gt;┬á &lt;conditions&gt;┬á [...]&lt;/cue&gt;{{/code}}
  (% style="color: rgb(0,0,0);text-decoration: none;" %)(% style="color: rgb(0,0,0);text-decoration: none;" %)(% style="color: rgb(0,0,0);text-decoration: none;" %)The attributes //onfail//, //checkinterval//, //checktime// are not allowed for cues with event conditions.
@@ -240,15 +240,11 @@
  (% style="color: rgb(0,0,0);text-decoration: none;" %)The <actions> node contains the actions that are performed one after another, without any delay inbetween. You can enforce a delay after activation of the cue and actual action performance, using a <delay> node right before the <actions>:
--{{code language="xml"}}
--<delay min="10s" max="30s"/>
--{{/code}}
++{{code}}&lt;delay┬ámin=&quot;10s&quot;┬ámax=&quot;30s&quot;/&gt;{{/code}}
  (% style="color: rgb(0,0,0);text-decoration: none;" %)Note that during the delay the cue is already in the active state, and the sub-cues have been enabled! If you want to make sure that a sub-cue only becomes active after this cue is complete, there is a useful event condition for that:
--{{code language="xml"}}
--<event_cue_completed cue="parent"/>
--{{/code}}
++{{code}}&lt;event_cue_completed┬ácue=&quot;parent&quot;/&gt;{{/code}}
  (% style="color: rgb(0,0,0);text-decoration: none;" %)<actions> is optional. Leaving it out may be useful if you only want to enable sub-cues after the cueΓÇÖs condition check. The state transition from active to complete will still take the <delay> node into account.
@@ -256,18 +256,8 @@
  (% style="color: rgb(0,0,0);text-decoration: none;" %)Example, which selects one of the three texts randomly:
--{{code language="xml"}}
--<actions>
-- <do_any>
--   <debug_text text="'Hello world'"/>
--   <debug_text text="'Welcome to the MD'"/>
--   <debug_text text="'And now for something completely different'"/>
-- </do_any>
--<actions>
--{{/code}}
++{{code}}&lt;actions&gt;┬á&lt;do_any&gt;┬á┬á &lt;debug_text┬átext=&quot;'Hello world'&quot;/&gt;┬á┬á &lt;debug_text┬átext=&quot;'Welcome to the MD'&quot;/&gt;┬á┬á &lt;debug_text┬átext=&quot;'And now for something completely different'&quot;/&gt;┬á&lt;/do_any&gt;&lt;actions&gt;{{/code}}
--
--
  {{note body="<span style=~"color: rgb(0,0,0);text-decoration: none;~">Messages printed with &lt;debug_text&gt; are usually only visible when the ΓÇ£scriptsΓÇ¥ debug filter is enabled, see [[NULL|Script debug output]].</span>"/}}

Changes for page Mission Director Guide

Summary

Details

Navigation

Applications