Defining Movement Orders In Scenarios: Difference between revisions

From SignalWiki
Jump to navigation Jump to search
No edit summary
(→‎Type 5 : Change Driver: PrepTime added)
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{DeveloperNav}}
You can define movement orders for each scenario-defined train, either a spawning train or stabled train
You can define movement orders for each scenario-defined train, either a spawning train or stabled train


The following types of Movement Orders are available:
The following types of Movement Orders are available:
<pre style="color:blue;font-size:16px">
   0: Renumber
   0: Renumber
   1: Turnaround
   1: Turnaround
Line 17: Line 22:
  17: RunAround
  17: RunAround
  18: ContentChanges
  18: ContentChanges
</pre>


==General==
==General==


<pre style="color:blue">
<pre style="color:blue;font-size:16px">
  <SpawningConsist id="loc&gt;9903" physics="7" maxTechAllowedSpeed="80" track="SPAWN_TC2_0" startTime="08:05:20" speed="80" type="EL" destination="Velp" commDestination="Vp" isEngineeringTrain="false" consistTemplate="28">
  <SpawningConsist id="loc&gt;9903" physics="7" maxTechAllowedSpeed="80" track="SPAWN_TC2_0" startTime="08:05:20" speed="80" type="EL" destination="Velp" commDestination="Vp" isEngineeringTrain="false" consistTemplate="28">
     <PlatformStops>
     <PlatformStops>
Line 34: Line 40:
== Type 0 : Renumber ==
== Type 0 : Renumber ==


<pre style="color:blue">
<pre style="color:blue;font-size:16px">
   <Order type="Renumber" newID="1234" track="" station="Arnhem-kap" updateTNV="true" />
   <Order type="Renumber" newID="1234" track="" station="Arnhem-kap" updateTNV="true" />
</pre>
</pre>
Line 45: Line 51:
==Type 1 : TurnAround ==
==Type 1 : TurnAround ==


<pre style="color:blue">
<pre style="color:blue;font-size:16px">
   <Order type="Turnaround" track="" station="Arnhem-kap" />
   <Order type="Turnaround" track="" station="Arnhem-kap" />
</pre>
</pre>
Line 54: Line 60:
==Type 2 : Couple ==
==Type 2 : Couple ==


<pre style="color:blue">
<pre style="color:blue;font-size:16px">
  <Order type="Couple" track="" station="Arnhem-kap" with="ABC" newID="123" calls="true" callsForDelay="false" newDir="R" />
  <Order type="Couple" track="" station="Arnhem-kap" with="ABC" newID="123" calls="true" callsForDelay="false" newDir="R" />
</pre>
</pre>
Line 68: Line 74:
==Type 3 : Uncouple ==
==Type 3 : Uncouple ==


<pre style="color:blue">
<pre style="color:blue;font-size:16px">
  <Order type="Uncouple" track="" station="Arnhem-kap" left="A" leftDir="R" right="B" rightDir="R" at="0" leftCalls="true" rightCalls="false"
  <Order type="Uncouple" track="" station="Arnhem-kap" left="A" leftDir="R" right="B" rightDir="R" at="0" leftCalls="true" rightCalls="false" />
</pre>
</pre>


Line 84: Line 90:
==Type 4 : Call ==
==Type 4 : Call ==


<pre style="color:blue">
<pre style="color:blue;font-size:16px">
  <Order type="Call" track="" station="Arnhem-kap" />
  <Order type="Call" track="" station="Arnhem-kap" />
</pre>
</pre>
Line 93: Line 99:
==Type 5 : Change Driver==
==Type 5 : Change Driver==


<pre style="color:blue">
<pre style="color:blue;font-size:16px">
  <Order type="ChangeDriver" track="" station="Gelsenkirchen Hbf" type="train"/>
  <Order type="ChangeDriver" track="" station="Gelsenkirchen Hbf" changeTo="train" PrepTime="06:00"/>
</pre>
</pre>


*station = string (mandatory) : The station where the order must be executed. Cannot be blank.
*station = string (mandatory) : The station where the order must be executed. Cannot be blank.
*track   = string (optional)  : The track where the order must be executed. Blank if the order can be at any track in a station.
*track   = string (optional)  : The track where the order must be executed. Blank if the order can be at any track in a station.
*type    = string (mandatory) : driver type, can be "train", "shunt", "engineer", "none"
*changeTo = string (mandatory) : Driver type, can be "train", "shunt", "engineer", "none"
*PrepTime = time  (optional)  : Time order is performed. Format HH:mm. If no attribute is defined, order executes as soon as possible (when all other conditions are satisfied).


==Type 7 : PullUp==
==Type 7 : PullUp==


<pre style="color:blue">
<pre style="color:blue;font-size:16px">
  <Order type="PullUp" track="" station="Gelsenkirchen Hbf" signal="P005"/>
  <Order type="PullUp" track="" station="Gelsenkirchen Hbf" signal="P005"/>
</pre>
</pre>
Line 113: Line 120:
==Type 8 : StopShort==
==Type 8 : StopShort==


<pre style="color:blue">
<pre style="color:blue;font-size:16px">
  <Order type="StopShort" track="" station="Gelsenkirchen Hbf" distance ="40" />
  <Order type="StopShort" track="" station="Gelsenkirchen Hbf" distance ="40" />
</pre>
</pre>
Line 123: Line 130:
==Type 9: StopAhead==
==Type 9: StopAhead==


<pre style="color:blue">
<pre style="color:blue;font-size:16px">
  <Order type="StopAhead" track="" station="Gelsenkirchen Hbf" />
  <Order type="StopAhead" track="" station="Gelsenkirchen Hbf" />
</pre>
</pre>
Line 132: Line 139:
==Type 10: SwitchLock==
==Type 10: SwitchLock==


<pre style="color:blue">
<pre style="color:blue;font-size:16px">
  <Order type="SwitchLock" track="" station="Gelsenkirchen Hbf" />
  <Order type="SwitchLock" track="" station="Gelsenkirchen Hbf" />
</pre>
</pre>
Line 143: Line 150:
==Type 13: StableCars==
==Type 13: StableCars==


<pre style="color:blue">
<pre style="color:blue;font-size:16px">
  <Order type="StableCars" track="" station="Braunschweig Hbf" region="1" sequence="1;2" />
  <Order type="StableCars" track="" station="Braunschweig Hbf" region="1" sequence="1;2" />
</pre>
</pre>
Line 154: Line 161:
==Type 14: SpotCars==
==Type 14: SpotCars==


<pre style="color:blue">
<pre style="color:blue;font-size:16px">
  <Order type="SpotCars" track="" station="Braunschweig Hbf" region="1" sequence="1;2" />
  <Order type="SpotCars" track="" station="Braunschweig Hbf" region="1" sequence="1;2" />
</pre>
</pre>
Line 168: Line 175:
==Type 16: MoveTo==
==Type 16: MoveTo==


<pre style="color:blue">
<pre style="color:blue;font-size:16px">
<Order type="MoveTo" track="" station="KKB" targets="005AT;KKB49AT"/>
<Order type="MoveTo" track="" station="KKB" targets="005AT;KKB49AT"/>
</pre>
</pre>
Line 175: Line 182:
*track          = string  (optional)  : The track where the order must be executed. Blank if the order can be at any track in a station.
*track          = string  (optional)  : The track where the order must be executed. Blank if the order can be at any track in a station.
*targets        = string  (mandatory) : Delimited list of tracks that should be visited in a particular order. These tracks must be within dark territory. Delimiter is a semicolon (;).
*targets        = string  (mandatory) : Delimited list of tracks that should be visited in a particular order. These tracks must be within dark territory. Delimiter is a semicolon (;).
In [[Command_Line_Options|Developer Mode]], the tracks in the Dark Territory Viewer show their real track names. These names must be used when constructing a MoveTo order.


==Type 17: RunAround==
==Type 17: RunAround==


<pre style="color:blue">
<pre style="color:blue;font-size:16px">
  <Order type="RunAround" track="" station="Braunschweig Hbf" .... />
  <Order type="RunAround" track="" station="Braunschweig Hbf" .... />
</pre>
</pre>
Line 193: Line 202:
==Type 18: ContentChanges==
==Type 18: ContentChanges==


<pre style="color:blue">
<pre style="color:blue;font-size:16px">
  <Order type="ContentChanges" track="" station="Gelsenkirchen Hbf" changes="...." />
  <Order type="ContentChanges" track="" station="Gelsenkirchen Hbf" changes="...." />
</pre>
</pre>
Line 201: Line 210:
*changes  = string  (mandatory) : As defined in [[Vehicle Contents (Movement Order)|Vehicle Contents]].
*changes  = string  (mandatory) : As defined in [[Vehicle Contents (Movement Order)|Vehicle Contents]].


{{ScenariosNav}}
 
{{DeveloperNavBottom}}

Latest revision as of 21:33, 6 March 2012

Contents | Developers pages | Command Line Options | Timetables | Scenario Creation | Developing Installers



You can define movement orders for each scenario-defined train, either a spawning train or stabled train


The following types of Movement Orders are available:

  0: Renumber
  1: Turnaround
  2: Couple
  3: Uncouple
  4: Call
  5: ChangeDriver
  7: PullUp
  8: StopShort
  9: StopAhead
 10: SwitchLock
 13: StableCars
 14: SpotCars
 16: MoveTo
 17: RunAround
 18: ContentChanges

General

 <SpawningConsist id="loc>9903" physics="7" maxTechAllowedSpeed="80" track="SPAWN_TC2_0" startTime="08:05:20" speed="80" type="EL" destination="Velp" commDestination="Vp" isEngineeringTrain="false" consistTemplate="28">
    <PlatformStops>
       Arnhem,7,--:--,08:30,Arnhem-Velperpoort,1,08:35,08:38
    </PlatformStops>
    <MovementOrders>
        <Order type="Turnaround" track="" station="Arnhem-kap" />
        <Order type="Couple" track="" station="Arnhem-berg" with="9903w" newID="9903" calls="true" callsForDelay="false" newDir="R" />
    </MovementOrders>
 </SpawningConsist>

Type 0 : Renumber

  <Order type="Renumber" newID="1234" track="" station="Arnhem-kap" updateTNV="true" />
  • newID = string (mandatory) : The train ID of the train after renumbering.
  • track = string (optional)  : The track where the order must be executed. Blank if the order can be at any track in a station.
  • station = string (mandatory) : The station where the order must be executed. Cannot be blank.
  • updateTNV = boolean (mandatory) : Update train number window with new train ID (TNV system)

Type 1 : TurnAround

  <Order type="Turnaround" track="" station="Arnhem-kap" />
  • track = string (optional)  : The track where the order must be executed. Blank if the order can be at any track in a station.
  • station = string (mandatory) : The station where the order must be executed. Cannot be blank.

Type 2 : Couple

 <Order type="Couple" track="" station="Arnhem-kap" with="ABC" newID="123" calls="true" callsForDelay="false" newDir="R" />
  • track = string (optional)  : The track where the order must be executed. Blank if the order can be at any track in a station.
  • station = string (mandatory) : The station where the order must be executed. Cannot be blank.
  • with = string (mandatory) : The train ID of the other train with which to couple.
  • newID = string (mandatory) : The train ID of the train after coupling.
  • calls = boolean (mandatory) : True when the coupled train calls in to the dispatcher after coupling is complete.
  • callsForDelay = boolean (mandatory) : Not Used.
  • newDir = string (mandatory) : The direction of the new, coupled train. L = left, R = right.

Type 3 : Uncouple

 <Order type="Uncouple" track="" station="Arnhem-kap" left="A" leftDir="R" right="B" rightDir="R" at="0" leftCalls="true" rightCalls="false" />
  • track = string (optional)  : The track where the order must be executed. Blank if the order can be at any track in a station.
  • station = string (mandatory) : The station where the order must be executed. Cannot be blank.
  • left = string (mandatory) : The train ID of the new, left train.
  • leftDir = string (mandatory) : The direction of the new, left train. L = left, R = right.
  • right = string (mandatory) : The train ID of the new, right train.
  • rightDir = string (mandatory) : The direction of the new, right train. L = left, R = right.
  • at = integer (mandatory) : The 0-based coupler index, measured from the front of the train, at time of uncoupling.
  • leftCalls = boolean (mandatory) : True when the left train calls dispatcher after uncoupling is complete.
  • rightCalls = boolean (mandatory) : True when the right train calls dispatcher after uncoupling is complete.

Type 4 : Call

 <Order type="Call" track="" station="Arnhem-kap" />
  • track = string (optional)  : The track where the order must be executed. Blank if the order can be at any track in a station.
  • station = string (mandatory) : The station where the order must be executed. Cannot be blank.

Type 5 : Change Driver

 <Order type="ChangeDriver" track="" station="Gelsenkirchen Hbf" changeTo="train" PrepTime="06:00"/>
  • station = string (mandatory) : The station where the order must be executed. Cannot be blank.
  • track = string (optional)  : The track where the order must be executed. Blank if the order can be at any track in a station.
  • changeTo = string (mandatory) : Driver type, can be "train", "shunt", "engineer", "none"
  • PrepTime = time (optional)  : Time order is performed. Format HH:mm. If no attribute is defined, order executes as soon as possible (when all other conditions are satisfied).

Type 7 : PullUp

 <Order type="PullUp" track="" station="Gelsenkirchen Hbf" signal="P005"/>
  • station = string (mandatory) : The station where the order must be executed. Cannot be blank.
  • track = string (optional)  : The track where the order must be executed. Blank if the order can be at any track in a station.
  • signal = string (mandatory) : Signal name to pull up to

Type 8 : StopShort

 <Order type="StopShort" track="" station="Gelsenkirchen Hbf" distance ="40" />
  • station = string (mandatory) : The station where the order must be executed. Cannot be blank.
  • track = string (optional)  : The track where the order must be executed. Blank if the order can be at any track in a station.
  • distance = integer (mandatory) : Distance, in meters, to the next signal to stop at

Type 9: StopAhead

 <Order type="StopAhead" track="" station="Gelsenkirchen Hbf" />
  • station = string (mandatory) : The station where the order must be executed. Cannot be blank.
  • track = string (optional)  : The track where the order must be executed. Blank if the order can be at any track in a station.

Type 10: SwitchLock

 <Order type="SwitchLock" track="" station="Gelsenkirchen Hbf" />
  • station = string (mandatory) : The station where the order must be executed. Cannot be blank.
  • track = string (optional)  : The track where the order must be executed. Blank if the order can be at any track in a station.
  • lock = integer (mandatory) : Switch lock index number
  • newID = string (mandatory) : The new train ID

Type 13: StableCars

 <Order type="StableCars" track="" station="Braunschweig Hbf" region="1" sequence="1;2" />
  • station = string (mandatory) : The station where the order must be executed. Cannot be blank.
  • track = string (optional)  : The track where the order must be executed. Blank if the order can be at any track in a station.
  • region = integer (mandatory) : free shunting region #
  • sequence = integer (mandatory) : sequence number to use (defines which lights blink, and in which order)

Type 14: SpotCars

 <Order type="SpotCars" track="" station="Braunschweig Hbf" region="1" sequence="1;2" />
  • station = string (mandatory) : The station where the order must be executed. Cannot be blank.
  • track = string (optional)  : The track where the order must be executed. Blank if the order can be at any track in a station.
  • region = integer (mandatory) : free shunting region #
  • newID = string (mandatory) : train ID after spotting cars
  • newTrack = string (mandatory) : track where the train ends up
  • sequence = integer (mandatory) : sequence number to use (defines which lights blink, and in which order)
  • direction = string (mandatory) : The direction of the new train. "R" or "L"

Type 16: MoveTo

<Order type="MoveTo" track="" station="KKB" targets="005AT;KKB49AT"/>
  • station = string (mandatory) : The station where the order must be executed. Cannot be blank.
  • track = string (optional)  : The track where the order must be executed. Blank if the order can be at any track in a station.
  • targets = string (mandatory) : Delimited list of tracks that should be visited in a particular order. These tracks must be within dark territory. Delimiter is a semicolon (;).

In Developer Mode, the tracks in the Dark Territory Viewer show their real track names. These names must be used when constructing a MoveTo order.

Type 17: RunAround

 <Order type="RunAround" track="" station="Braunschweig Hbf" .... />
  • station = string (mandatory) : The station where the order must be executed. Cannot be blank.
  • track = string (optional)  : The track where the order must be executed. Blank if the order can be at any track in a station.
  • UncoupleLeftID = string (mandatory) : the name of the resulting train on the left of the splitting point
  • UncoupleRightID = string (mandatory) : the name of the resulting train on the right of the splitting point
  • CoupleNewID = string (mandatory) : the name of the train after re-coupling
  • PickOffPoint = string (mandatory) : splitting index as measured from the FRONT of the train. Typically, this will be 0 if you're just pulling off the first vehicle
  • RunAroundTime = string (mandatory) : time, in seconds, it takes for a loco to run around. If you enter 0, I'll guess a value but it might not be realistic. This might change in the future, though.
  • CoupleCallInForDeparture = boolean (mandatory) : true if you want the driver to call after recoupling.

Type 18: ContentChanges

 <Order type="ContentChanges" track="" station="Gelsenkirchen Hbf" changes="...." />
  • station = string (mandatory) : The station where the order must be executed. Cannot be blank.
  • track = string (optional)  : The track where the order must be executed. Blank if the order can be at any track in a station.
  • changes = string (mandatory) : As defined in Vehicle Contents.



Contents | Developers pages | Command Line Options | Timetables | Scenario Creation | Developing Installers