Driver Commands List

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
m (added Trainz Plus where needed, replaced references to multiple Trainz versions with "Trainz")
(Major correction - wrong file added to wiki)
Line 1: Line 1:
The information in this Wiki Page applies to '''TANE''', '''TRS19''' and '''Trainz Plus'''. List of '''Trainz Session Rules''' in ''Classification or Category Order'' with Properties.
+
The information in this Wiki Page applies to '''TANE''', '''TRS19''' and '''Trainz Plus'''.
  
<table bgcolor=#ffff00>
+
<table bgcolor="green">
 
<tr>
 
<tr>
 
<td>
 
<td>
<span style="color: black; font-weight: 700;">This page is always under construction. As new rules appear and are tested they will be added to this list. Current Command Count: 128</span></td>
+
<span style="color: white; font-weight: 700;">This page is always under construction. As new driver commands appear and are tested they will be added to this list. Current Command Count: 57</span></td>
 
</tr>
 
</tr>
 
</table>
 
</table>
'''Only rules supplied with Trainz or on the DLS are covered in this document.'''<br>
+
'''Only driver commands supplied with Trainz or on the DLS are covered in this document.'''<br>
 
+
<table width="100%" bgcolor=#a8ff8a>
<table width="100%" bgcolor=#ffffaa>
+
 
<tr>
 
<tr>
 
<td>
 
<td>
The rules listed in this page are all accessible in the [[file:WikiLink.PNG|link=]] '''[[How to Use Session Editor|Surveyor Session Editor]]'''. Those rules that are identified as '''DLS Rule''' must be downloaded and installed from the '''Trainz DLS''' first.</td>
+
The driver commands listed in this page are all found in Trainz '''Surveyor''' from the '''Edit Session''' option in the '''Main Menu''' and are accessed by the [[file:WikiLink.PNG|link=]]&nbsp;'''[[Session_Rule_List_with_Parameters#Driver_Command_Rule|Driver Command Rule]]''' and the [[file:WikiLink.PNG|link=]]&nbsp;'''[[Session_Rule_List_with_Parameters#Driver_Setup_Rule|Driver Setup Rule]]'''.<br>
 +
 
 +
See the Trainz Wiki Page [[file:WikiLink.PNG|link=]]&nbsp;'''[[How_to_Use_Driver_Setup_Rule|How to Use the Driver Setup Rule]]''' for more information on both rules.
 +
 
 +
Those commands that are identified as a '''DLS Command''' must be downloaded and installed from the Trainz DLS first.</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
Also available [[file:WikiLink.PNG|link=]] '''[[Session Rule List with Parameters|Session Rule List (Alphabetical) with Parameters]]'''
 
  
 
----
 
----
 +
 
'''Description Key:'''
 
'''Description Key:'''
*'''<kuid number>''' is for the rule version at the time of writing. This number will change if the rule is updated.
+
*'''<kuid number>''' is for the command version at the time of writing. This number will change if the command is updated.
*'''DLS Rule''' must be downloaded and installed from the '''DLS'''.
+
*'''DLS Command''' must be downloaded and installed from the '''DLS'''.
*'''Base Rule''' and '''Built-in Rule''' is installed with '''Trainz'''.
+
*'''Base Command''' and '''Built-in Command''' are installed with '''Trainz'''.
*'''Parent Rule''' will execute child rules if it returns a ''true'' result.
+
*'''Obsolete Command''' is no longer required (explanation given).
*'''Obsolete Rule''' is no longer required (explanation given).
+
*'''Legacy Command''' has been replaced by another command (new command will be identified).
*'''Legacy Rule''' has been replaced by another rule (new rule will be identified).
+
*'''SP2 and later''' means '''TANE SP2''' and later versions including '''TRS19''' and '''Trainz Plus'''.
*Rules that are named '''TANE SP2''' or '''TANE SP3''' will work in '''TRS19''' and '''Trainz Plus'''.
+
 
----
 
----
 
__TOC__
 
__TOC__
<table width="100%" bgcolor=#ffff88>
+
<table width="100%" bgcolor=#a8ff8a>
 
<tr>
 
<tr>
 
<td>
 
<td>
='''Achievement Rules'''=
+
='''Interlocking Tower and Mission Code Commands'''=
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Achievement Check Rule'''==
+
=='''AddMissionCode (SP2 and Later) '''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules when achievement conditions have been met
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_AddMissionCode.PNG|50px|link=]]</td>
 
+
<td>Adds a mission code (a sequence of IT or EIT paths) to any mission codes already loaded for the train. The mission code must be set by the '''Mission Code Manager Rule (SP2 and Later)'''</td>
*'''<kuid:401543:1190>'''
+
 
+
*'''Built-in Rule'''
+
 
+
*'''Parent Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''''<Not configured, click here to select an achievement asset>''''' - click to select an '''Achievement Asset''' from those installed
+
      When an '''Achievement Asset''' has been selected, the following will appear:-
+
      '''Achievement KUID: ''<selected asset name>''''' - click to change the selected '''Achievement Asset'''
+
      '''Achievement name: ''<not set>''''' - click to select the achievement name from the selected asset
+
      '''Trigger if achievement: ''<select>''''' - choose one of:-
+
          '''has been gained''' - the rule will be triggered when this achievement has been gained
+
          '''has not been gained''' - the rule will be triggered when this achievement has '''NOT''' been gained
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[How to Use Parent and Child Rules]]'''
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Consist Check Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules when a matching consist is found. The order of the vehicles in the consists is not important.  
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:61392:8203:56> AddMissionCode (SP2 and later)'''
  
*'''<kuid:-25:1068>'''
+
*'''DLS Command''' by '''pguy'''
  
*'''Built-in Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
*'''Parent Rule'''
+
  '''''<mission codes>''''' - select a mission code from the Session list
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 +
:The mission code must be created by the '''Mission Code Manager Rule (SP2 and Later)''' using paths created with '''Interlocking Towers'''
  
    '''[x] Enforce strict exclusive testing''' - check to only accept an exact match with no unspecified vehicles in the consist.
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
      - leave unchecked to accept any consist that contains the specified vehicles.
+
*'''[[#RemoveMissionCode (SP2 and Later)|RemoveMissionCode (SP2 and Later)]]''' - sets a mission code for the train
    Select one of two option buttons:-
+
*'''[[#SetMissionCode (SP2 and Later)|SetMissionCode (SP2 and Later)]]''' - removes a mission code from those already set for the train
    '''( ) Rule disabled''' - select to disable the operation of this rule
+
    '''( ) Complete whenever a train matching the description exists''' - When selected, enter the consist description:-
+
      '''Specific vehicle''' - identify the specific vehicle(s) that will trigger the rule
+
          '''''+''''' - click to add a ''specific'' vehicle from the session list
+
          '''''x''''' - click to remove the ''specific'' vehicle from the rule
+
      '''Vehicle types''''' - identify the ''type'' of vehicle(s) that will trigger the rule
+
          '''''+''''' - click to add a ''type'' of vehicle from the session list
+
          '''''x''''' - click to remove the ''type'' of vehicle from the rule
+
      '''Drivers''''' - identify the ''driver(s)'' that will trigger the rule
+
          '''''+''''' - click to add a ''driver'' from the session list
+
          '''''x''''' - click to remove a ''driver'' from the rule
+
  
[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
+
[[file:PageLink3.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Required Session Rules:</span><br>
:When used as a top level parent rule it does not terminate after triggering but will continue to check all consists for a match and will trigger every time another match is found.
+
:'''Rules that MUST be added to the Session for this Driver Command to operate'''
 
+
*'''[[Session_Rule_List_with_Parameters#MissionCode_Manager_Rule_.28SP2_and_later.29|Mission Code Manager Rule (SP2 and later)]]'''
[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+
*'''[[How to Use Variables in Sessions (Examples)#Example 3: Counting Consist Checks|How to Use Variables in Sessions (Examples): Counting Consist Checks]]'''
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[How to Use Parent and Child Rules]]'''
+
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Consist_Check_Rule</span>'''
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Multiple Resource Check Rule'''==
+
 
 +
=='''IT CancelEnhancedPath'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules if industries or vehicles reach set commodity levels. This rule replaces the older '''Resource Check Rule'''
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_ITCancelEnhancedPath.png|50px|link=]]</td>
 +
<td>Cancels an active Enhanced Interlocking Tower (EIT) path for the train that had been set by the '''IT SetPath Command'''</td>
 +
</tr>
 +
</table>
  
*'''<kuid:-25:656>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
*'''Built-in Rule'''
+
*'''<kuid2:61392:8114:54> IT CancelEnhancedPath'''
  
*'''Parent Rule'''
+
*'''DLS Command''' by '''pguy'''
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
    '''<Product Level>''' - click to select a product test from two choices:-
+
  '''<Select EIT>''' - select from list of session EITs
      '''''Reach/Exceed''''' - sets an upper limit for the resources being monitored.
+
      '''<Select Path>''' - select the active path from that EIT
          For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon reaches or exceeds a specified level.
+
          The initial level in the object must be below the set upper limit.
+
      '''''Fall below''''' - sets a lower limit for the resources being monitored.
+
          For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon falls below a specified level.
+
          The initial level in the object must be above the set lower limit.
+
          To test when a resource level reaches zero (i.e. is empty) set the lower limit to a very low value but not zero as the level can never fall below zero.
+
    '''''<value>''''' - enter required quantity value
+
    '''''<select>''''' - select a product from session list of products
+
    '''''<Add object>''''' - click to select a source or target object. Multiple objects and their queues can be added to the rule.
+
      ALL the entered products must reach/exceed or fall below the specified value for the rule to be triggered.
+
      For each object:-
+
          '''''<Object>''''' - click to select session active industry or product enabled rail vehicle
+
          '''''<Queue>''''' - select product queue (there may be only one available)
+
          '''''<Remove>''''' - removes the object and its product queue from the rule
+
  
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
:This rule only checks for ''changing'' commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is ''full'' or ''empty''.
+
#The active path must be created using '''Enhanced Interlocking Towers'''
 +
#Cancelling a path makes it available for other consists and allows conflicting paths to be made active
 +
#An active path is automatically cancelled after it has been completed by a train
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
*'''[[#Resource Check Rule|Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
+
*'''[[#IT SetPath|IT SetPath]]''' - sets an active path
*'''[[#Resource Verify Rule (fixed)|Resource Verify Rule (fixed)]]''' - executes child rules when a set resource (commodity) level is reached
+
 
+
[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+
*'''[[How to Use Navigation Point Rules (Applications)#Application 3: Wait for Loading to be Completed|How to Use Navigation Point Rules (Applications): Wait for Loading to be Completed]]'''
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[How to Use Parent and Child Rules]]'''
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Objective Add Rule'''==
+
 
 +
=='''IT SetPath'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Sets up a game Objective with ID and display Name
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_ITSetPath.png|50px|link=]]</td>
 
+
<td>Selects and sets a path for the train from those available from Interlocking Towers (ITs) and Enhanced Interlocking Towers (EITs). If this path was created by an EIT it can be cancelled prior to its use by the '''IT CancelEnhancedPath Command'''</td>
*'''<kuid:401543:2001>'''
+
 
+
*'''Base Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''Priority ''<Select>''''' - select one of:-
+
      '''''Above Normal'''''
+
      '''''Below Normal'''''
+
      '''''Normal'''''
+
      '''''Optional'''''
+
      '''''Urgent'''''
+
    '''Completion Target Number ''<value>''''' - to set Completion Target Number
+
    '''Icon ''<select>''''' - to select Icon from list
+
    '''Display Name ''<enter>''''' - to insert Name
+
    '''Unique Objective ID ''<enter>''''' - enter a unique objective ID
+
    '''Custom Message ''<Text Box>''''' - insert typed message in text area
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Objective Check Rule|Objective Check Rule]]''' - executes child rules if an objective is completed
+
*'''[[#Objective Update Rule|Objective Update Rule]]''' - changes the progress of a game objective
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Objective Check Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules if an objective created with the '''Objective Add Rule''' is complete.
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:61392:8111:54> IT SetPath'''
  
*'''<kuid:401543:2003>'''
+
*'''DLS Command''' by '''pguy'''
  
*'''Base Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
*'''Parent Rule'''
+
  '''<Select IT or EIT>''' - select from list of session ITs and/or EITs
 +
      '''<Select Path>''' - select from available paths for that IT/EIT
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 +
#The paths must be created using '''Interlocking Towers'''
 +
#An active path is automatically cancelled after it has been completed by a train
  
    '''Unique Objective ID ''<value>''''' - enter the unique ID created with the '''Objective Add Rule'''
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
    '''Mode ''<select>''''' - select one of three:-
+
*'''[[#IT CancelEnhancedPath|IT CancelEnhancedPath]]''' - cancels an active EIT path
      '''''Wait for completion'''''
+
*'''[[#IT SetPathAndWaitActive|IT SetPathAndWaitActive]]''' - sets an active IT or EIT path and waits until it is active
      '''''Wait for failure'''''
+
*'''[[#IT SetPathAndWaitNotRed|IT SetPathAndWaitNotRed]]''' - sets an active IT or EIT path and waits until the signal ahead is not red
      '''''Wait for progress'''''
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Objective Add Rule|Objective Add Rule]]''' - sets up a game objective
+
*'''[[#Objective Update Rule|Objective Update Rule]]''' - changes the progress of a game objective
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[How to Use Parent and Child Rules]]'''
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Objective Update Rule'''==
+
 
 +
=='''IT SetPathAndWaitActive'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Changes progress of an objective outcome created with the '''Objective Add Rule''' according to Property choices
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_ITSetPath.png|50px|link=]]</td>
 
+
<td>Selects and sets a path for the train from those available from Interlocking Towers (ITs) and Enhanced Interlocking Towers (EITs) and waits until the path becomes active. If this path was created by an EIT it can be cancelled prior to its use by the '''IT CancelEnhancedPath Command'''</td>
*'''<kuid:401543:2002>'''
+
 
+
*'''Base Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''Unique Objective ID ''<value>''''' - enter the unique ID created with the '''Objective Add Rule'''
+
    '''Mode ''<select>''''' - select one from the following options
+
      '''''Decrement progress'''''
+
      '''''Increment progress'''''
+
      '''''Reset Objective'''''
+
      '''''Set objects as complete'''''
+
      '''''Set objects as failed'''''
+
      '''''Set progress'''''
+
      '''''Set progress only if greater'''''
+
    '''Amount ''<value>''''' - click to enter a value
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Objective Add Rule|Objective Add Rule]]''' - sets up a game objective
+
*'''[[#Objective Check Rule|Objective Check Rule]]''' - executes child rules if an objective is completed
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Ranked Session Begin Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Begins a ranked Session
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:61392:8113:54> IT SetPathAndWaitActive'''
  
*'''<kuid:401543:2031>'''
+
*'''DLS Command''' by '''pguy'''
  
*'''Base Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
  '''<Select IT or EIT>''' - select from list of session ITs and/or EITs
 
+
      '''<Select Path>''' - select from available paths for that IT/EIT
    '''Countdown Starting Value ''<value>'''''
+
      '''''hrs:'''''
+
      '''''min:'''''
+
      '''''sec:'''''
+
    '''1 through 5 stars, points for each star ''<value>''''' - enter number of points for each star rating
+
    '''Session timer mode:''' - select one of three option buttons:-
+
      '''( ) Timer'''
+
      '''( ) Countdown Starting value ''<value>''''' - enter time ''hh:mm:ss''
+
      '''( ) None'''
+
  
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
:Times are Trainz clock time, not real time
+
#The paths must be created using '''Interlocking Towers'''
 +
#An active path is automatically cancelled after it has been completed by a train
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
*'''[[#Ranked Session Complete Rule|Ranked Session Complete Rule]]''' - completes the active ranked Session
+
*'''[[#IT CancelEnhancedPath|IT CancelEnhancedPath]]''' - cancels an active EIT path
 +
*'''[[#IT SetPath|IT SetPath]]''' - sets an active IT or EIT path
 +
*'''[[#IT SetPathAndWaitNotRed|IT SetPathAndWaitNotRed]]''' - sets an active IT or EIT path and waits until the signal ahead is not red
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Ranked Session Complete Rule'''==
+
 
 +
=='''IT SetPathAndWaitNotRed'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Completes the active ranked Session
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_ITSetPath.png|50px|link=]]</td>
 
+
<td>Selects and sets a path for the train from those available from Interlocking Towers (ITs) and Enhanced Interlocking Towers (EITs) and waits until the next signal is not showing red. If this path was created by an EIT it can be cancelled prior to its use by the '''IT CancelEnhancedPath Command'''</td>
*'''<kuid:401543:2032>'''
+
 
+
*'''Base Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''Set the active ranked session as:''' - select one of two option buttons:-
+
      '''( ) Complete'''
+
      '''( ) Failed'''
+
    '''[x] Customize the completion message ''<text>''''' - enter a text message
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Ranked Session Begin Rule|Ranked Session Begin Rule]]''' - begins a ranked Session
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Resource Check Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules if a selected industry or vehicle reaches a set commodity level. This rule has been superseded by the '''Multiple Resource Check Rule'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:61392:8112:54> IT SetPathAndWaitNotRed'''
  
*'''<kuid:-25:1067>'''
+
*'''DLS Command''' by '''pguy'''
  
*'''Legacy Rule''' (replaced by '''Multiple Resource Check Rule''')
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
*'''Built-in Rule'''
+
  '''<Select IT or EIT>''' - select from list of session ITs and/or EITs
 
+
      '''<Select Path>''' - select from available paths for that IT/EIT
*'''Parent Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    Select one of two option buttons:-
+
      '''( ) Watch industry queue'''
+
          '''Target Object ''<select>''''' - select an industry from the session list
+
          '''Queue ''<select>''''' - select a product queue from the selected industry
+
          '''Product ''<select>''''' - select a product from the selected queue
+
          '''Amount ''<value>''''' - enter a quantity
+
          Select one of two option buttons:-
+
            '''( ) Complete when designated queue equals or exceeds required amount'''
+
            '''( ) Complete when designated queue falls below required amount'''
+
      '''( ) Watch vehicle'''
+
          '''Target Object ''<select>''''' - select a rolling stock asset from the session list
+
          '''Queue ''<select>''''' - select a product queue from the selected rolling stock
+
          '''Product ''<select>''''' - select a product from the selected queue
+
          '''Amount ''<value>''''' - enter a quantity
+
          Select one of two option buttons:-
+
            '''( ) Complete when designated queue equals or exceeds required amount'''
+
            '''( ) Complete when designated queue falls below required amount'''
+
  
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
:This rule only checks for ''changing'' commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is ''full'' or ''empty''.
+
#The paths must be created using '''Interlocking Towers'''
 +
#An active path is automatically cancelled after it has been completed by a train
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
*'''[[#Multiple Resource Check Rule|Multiple Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
+
*'''[[#IT CancelEnhancedPath|IT CancelEnhancedPath]]''' - cancels an active EIT path
*'''[[#Resource Verify Rule (fixed)|Resource Verify Rule (fixed)]]''' - executes child rules when a set resource (commodity) level is reached
+
*'''[[#IT SetPath|IT SetPath]]''' - sets an active IT or EIT path
 
+
*'''[[#IT SetPathAndWaitActive|IT SetPathAndWaitActive]]''' - sets an active IT or EIT path and waits until it is active
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[How to Use Parent and Child Rules]]'''
+
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Resource_Check_Rule</span>'''
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Resource Verify Rule (fixed)'''==
+
 
 +
=='''RemoveMissionCode (SP2 and Later) '''==
 
</td>
 
</td>
 +
</tr>
 +
</table>
 +
<table>
 +
<tr valign="top">
 +
<td>[[file:CMD_RemoveMissionCode.PNG|50px|link=]]</td>
 +
<td>Removes a mission code (a sequence of IT or EIT paths) from any mission codes already loaded for the train. The mission code must be set by the '''Mission Code Manager Rule (SP2 and Later)''' and given to the driver by the '''SetMissionCode (SP2 and later)''' or '''AddMissionCode (SP2 and Later)''' driver commands or by the '''Mission Code Manager Rule (SP2 and Later)''' itself</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules if a selected industry or vehicle reaches a set commodity level. The rule resets when all child rules have completed.
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:61392:8204:56> RemoveMissionCode (SP2 and later)'''
  
*'''<kuid:160293:10060>'''
+
*'''DLS Command''' by '''pguy'''
  
*'''DLS Rule''' by '''trev999
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
*'''Parent Rule'''
+
  '''''<mission codes>''''' - select a mission code from the Session list
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    Select one of two option buttons:-
+
    '''( ) Watch industry queue'''
+
      '''Target object ''<click to select>''''' - click to select an industry from the session list.
+
      '''Product ''<click to select>''''' - click to select an industry product.
+
      '''Amount ''<value>''''' - enter a quantity for the selected product.
+
      Select one of two option buttons:-
+
      '''( ) Complete when designated queue equals or exceeds designated amount'''
+
      '''( ) Complete when designated queue falls below designated amount'''
+
    '''( ) Watch vehicle queue'''
+
      '''Target object ''<click to select>''''' - click to select a rolling stock vehicle from the session list.
+
      '''Product ''<click to select>''''' - click to select a commodity product.
+
      '''Amount ''<value>''''' - enter a quantity for the selected product.
+
      Select one of two option buttons:-
+
      '''( ) Complete when designated queue equals or exceeds designated amount'''
+
      '''( ) Complete when designated queue falls below designated amount'''
+
  
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
#This rule will only monitor a single commodity in a single industry or vehicle.
+
:The mission code must be created by the '''Mission Code Manager Rule (SP2 and Later)''' using paths created with '''Interlocking Towers'''
#This rule only checks for ''changing'' commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is ''full'' or ''empty''.
+
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
*'''[[#Multiple Resource Check Rule|Multiple Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
+
*'''[[#AddMissionCode (SP2 and Later)|AddMissionCode (SP2 and Later)]]''' - adds another mission code to the train
*'''[[#Resource Check Rule|Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
+
*'''[[#SetMissionCode (SP2 and Later)|SetMissionCode (SP2 and Later)]]''' - removes a mission code from those already set for the train
  
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
[[file:PageLink3.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Required Session Rules:</span><br>
*'''[[How to Use Parent and Child Rules]]'''
+
:'''Rules that MUST be added to the Session for this Driver Command to operate'''
 +
*'''[[Session_Rule_List_with_Parameters#MissionCode_Manager_Rule_.28SP2_and_later.29|Mission Code Manager Rule (SP2 and later)]]'''
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Station Visited Check Rule'''==
+
 
 +
=='''SetMissionCode (SP2 and Later) '''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules if specific trains call at set stations or industries
+
<table>
 +
<tr valign="top">
 +
<td>[[file:CMD_SetMissionCode.PNG|50px|link=]]</td>
 +
<td>Sets a mission code (a sequence of IT or EIT paths) for the train. The mission code must be set by the '''Mission Code Manager Rule (SP2 and Later)'''. Mission codes can also be given to trains in Surveyor or Driver mode through the '''Mission Code Manager Rule (SP2 and Later)'''</td>
 +
</tr>
 +
</table>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
*'''<kuid2:60850:89005:3>'''
+
*'''<kuid2:61392:8201:56> SetMissionCode (SP2 and later)'''
  
*'''Built-in Rule'''
+
*'''DLS Command''' by '''pguy'''
  
*'''Parent Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
  '''''<*Reset mission code>''''' - resets the currently loaded mission code, or
 +
  '''''<mission codes>''''' - select a mission code from the Session list
  
    '''Trigger: ''<select>''''' - click to select one of the following
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
      '''''Never''''' - stopping at the selected industries will never trigger the rule.
+
:The mission code must be created by the '''Mission Code Manager Rule (SP2 and Later)''' using paths created with '''Interlocking Towers'''
      '''''Once only''''' - the rule is triggered on the first visit only to any one of the selected industries
+
 
      '''''Once per industry''''' - the rule is triggered on the first visit to each industry with each individual product
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
      '''''Once per visit''''' - the rule is triggered on the first visit to each industry regardless of the product
+
*'''[[#AddMissionCode (SP2 and Later)|AddMissionCode (SP2 and Later)]]''' - adds another mission code to the train
      '''''Once per vehicle''''' - each vehicle can only trigger the rule once.  
+
*'''[[#RemoveMissionCode (SP2 and Later)|RemoveMissionCode (SP2 and Later)]]''' - sets a mission code for the train
    '''''<select industry>''''' - select industry or industries from session list
+
 
    Select one of two option buttons:-
+
[[file:PageLink3.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Required Session Rules:</span><br>
      '''( ) click to accept all trains'''
+
:'''Rules that MUST be added to the Session for this Driver Command to operate'''
      '''( ) click to accept trains matching specific criteria'''
+
*'''[[Session_Rule_List_with_Parameters#MissionCode_Manager_Rule_.28SP2_and_later.29|Mission Code Manager Rule (SP2 and later)]]'''
          Selecting the second option will produce the following selection controls:-        
+
          '''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
+
            '''''+''''' - click to add a ''specific'' vehicle from the session list
+
            '''''x''''' - click to remove the ''specific'' vehicle from the rule
+
          '''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule
+
            '''''+''''' - click to add a ''type'' of vehicle from the session list
+
            '''''x''''' - click to remove the ''type'' of vehicle from the rule
+
          '''Drivers''''' - identify the ''drivers'' that will trigger the rule
+
            '''''+''''' - click to add a ''driver'' from the session list
+
            '''''x''''' - click to remove a ''driver'' from the rule
+
  
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
 
*'''[[How to Use Parent and Child Rules]]'''
 
 
<br>
 
<br>
<table width="100%" bgcolor=#ffff88>
+
<table bgcolor=#a8ff8a>
 
<tr>
 
<tr>
 
<td>
 
<td>
Line 483: Line 306:
 
</table>
 
</table>
  
<table width="100%" bgcolor=#ffff88>
+
<table width="100%" bgcolor=#a8ff8a>
 
<tr>
 
<tr>
 
<td>
 
<td>
='''Camera Rules'''=
+
 
 +
='''Junction and Signal Commands'''=
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Cinematic Camera Rule'''==
+
=='''ControlJunction'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Provides several different cinematic style cameras with animations. Best used at the start of a session.  
+
<table>
Use the '''Trackside Camera''' (tracking view) found in the '''Set Camera Rule''' during session play.
+
<tr valign="top">
 +
<td>[[file:CMD_ControlJunction.png|50px|link=]]</td>
 +
<td>Sets the direction for a single specified junction switch.</td>
 +
</tr>
 +
</table>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
*'''<kuid2:401543:1166:3>'''
+
*'''<kuid:131986:1011> ControlJunction'''
  
*'''Built-in Rule'''
+
*'''DLS Command''' by '''atilabarut'''
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
 
+
    '''[x] Lock camera controls for the duration''' - if checked user cannot alter camera view
+
    '''[x] Prevent train control for duration - if checked user cannot control train
+
    '''Camera target: ''<click to select>''''' - click to select the object from the session list that will be the camera target
+
    '''Camera mode:''' - select one of three option buttons:-
+
      '''( ) Stationary'''
+
      '''( ) Circle targeted object'''
+
      '''( ) Move from one point to another (zoom, pan, etc)'''
+
    '''Initial camera values:'''
+
      '''[x] Pitch: ''<value>''''' - check to select then click ''value'' to enter a pitch value
+
      '''[x] Yaw:  ''<value>''''' - check to select then click ''value'' to enter a yaw value
+
      '''[x] Zoom:  ''<value>''''' - check to select then click ''value'' to enter a zoom value
+
    '''Total time to animate:  ''<value>''''' - enter an animation time in seconds
+
 
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+
:Times are Trainz clock times, not real times
+
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
  '''Select switch direction''', one of '''''<LEFT/RIGHT/FORWARD>'''''
*'''[[#Focus Camera Rule|Focus Camera Rule]]''' - sets the initial camera view and starting vehicle for a session
+
      '''Select ''<switch name>''''' from the session list
*'''[[#Set Camera Rule|Set Camera Rule]]''' - sets the target object and properties of the camera
+
*'''[[#Wait for Camera View Mode Rule|Wait for Camera View Mode Rule]]''' - executes child rules when the camera view is changed
+
  
 +
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
 +
*'''[[#SetOneJunction|SetOneJunction]]''' - sets the direction for a single specified junction switch
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Focus Camera Rule'''==
+
=='''SetOneJunction'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Sets the initial camera view and starting vehicle for a session.
+
<table>
 +
<tr valign="top">
 +
<td>[[file:CMD_SetOneJunction.png|50px|link=]]</td>
 +
<td>Sets the direction for a single specified junction switch.</td>
 +
</tr>
 +
</table>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
*'''<kuid2:122381:10014:1>'''
+
*'''<kuid:121843:100445> SetOneJunction'''
  
*'''DLS Rule''' by '''mizi'''
+
*'''DLS Command''' by '''pitkin'''
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
    '''Focus camera to:''' - select one of two option buttons
+
  '''Select ''<switch name>''''' from the session list
      '''( ) Map object'''
+
      '''Select switch direction''', one of ''<LEFT/RIGHT/FORWARD/BACKWARD>'''''
      '''( ) Vehicle'''
+
    '''Named ''<?????>''''' - enter name of object or vehicle from session list
+
    '''Additionally:'''
+
      '''[x] set view mode to''' - check to select one of four option buttons
+
          '''( ) Internal view'''
+
          '''( ) External view'''
+
          '''( ) Tracking view'''
+
          '''( ) Roaming view'''
+
      '''[x] restrict user to manipulate the camera''' - check to set user limits on camera controls
+
          '''[x] allow internal view'''
+
          '''[x] allow external view'''
+
          '''[x] allow tracking view'''
+
          '''[x] allow roaming view'''
+
          '''[x] allow change of view mode'''
+
          '''[x] allow change vehicle in train'''
+
          '''[x] allow change trains'''
+
          '''[x] allow adjust camera viewpoint'''
+
      '''[x] set camera angles''' - check to set the initial camera view point
+
          '''Yaw (90 = look at front of train): ''<value>'' degrees''' - enter yaw angle
+
          '''Pitch (-90 = down, 90 = up): ''<value>'' degrees''' - enter pitch angle
+
          '''Distance from the focused object: ''<value>'' metres''' - enter distance from camera to object
+
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
*'''[[#Cinematic Camera Rule|Cinematic Camera Rule]]''' - provides several different cinematic style cameras with animations
+
*'''[[#ControlJunction|ControlJunction]]''' - sets the direction for a single specified junction switch
*'''[[#Set Camera Rule|Set Camera Rule]]''' - sets the target object and properties of the camera
+
*'''[[#Wait for Camera View Mode Rule|Wait for Camera View Mode Rule]]''' - executes child rules when the camera view is changed
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Set Camera Rule'''==
+
=='''Set Signal Ahead'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Sets the target object and properties of the camera.
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_SignalAhead.png|50px|link=]]</td>
 
+
<td>Sets the state of the next signal ahead.</td>
*'''<kuid:-25:179>'''
+
 
+
*'''Built-in Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''[x] Set the target object of the camera to:''' - if checked, select one of three option buttons:-
+
      '''( ) Vehicle ''<click to select>''''' - select a vehicle from the Session list
+
      '''( ) Junction ''<click to select>''''' - select a junction from the Session list
+
      '''( ) Map Object ''<click to select>''''' - select a named map object from the Session list
+
    '''[x] Change the camera view mode to ''<click to select>''''' - if checked, select one camera view mode from
+
      '''Cab View'''
+
      '''External View'''
+
      '''Tracking View'''
+
      '''Free Roaming'''
+
    '''[x] Set the camera flags to enable/disable user access to''' - if checked, select as many of the following check boxes as needed
+
      '''[x] Internal view mode''' - check to enable, uncheck to disable
+
      '''[x] External view mode''' - check to enable, uncheck to disable
+
      '''[x] Tracking view mode''' - check to enable, uncheck to disable
+
      '''[x] Roaming view mode''' - check to enable, uncheck to disable
+
      '''[x] View switching''' - check to enable, uncheck to disable
+
      '''[x] Vehicle view switching''' - check to enable, uncheck to disable
+
      '''[x] Train view switching''' - check to enable, uncheck to disable
+
      '''[x] Camera adjustments (pan, zoom, etc)''' - check to enable, uncheck to disable
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Cinematic Camera Rule|Cinematic Camera Rule]]''' - provides several different cinematic style cameras with animations
+
*'''[[#Focus Camera Rule|Focus Camera Rule]]''' - sets the initial camera view and starting vehicle for a session
+
*'''[[#Wait for Camera View Mode Rule|Wait for Camera View Mode Rule]]''' - executes child rules when the camera view is changed
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Wait for Camera View Mode Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules when the camera view is changed to a selected view
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:368725:60003:6> Set Signal Ahead'''
  
*'''<kuid:-25:192>'''
+
*'''DLS Command''' by '''elstoko'''
  
*'''Built-in Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
*'''Parent Rule'''
+
  '''''<Set next signal to>''''' - select one from
 +
      '''''<Stop>'''''
 +
      '''''<Caution Straight>'''''
 +
      '''''<Caution Left>'''''
 +
      '''''<Caution Right>'''''
 +
      '''''<Proceed Straight>'''''
 +
      '''''<Proceed Left>'''''
 +
      '''''<Proceed Right>'''''
 +
      '''''<Advance Caution>'''''
 +
      '''''<Call on 1 (State 9)>'''''
 +
      '''''<Call on 2 (State 10)>'''''
 +
      '''''<Automatic>'''''
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
+
#This command only works on signals that will respond to the function "SetSignalStateEx", not all signals will respond
    '''[x] Trigger rule once''' - check to set
+
#The signal must support the selected state otherwise there will be no change
    '''Wait for the camera to change to the ''<click to select>''''' - select one camera view mode from:-
+
#The signal will be reset after the train has cleared the signal
      '''Cab View'''
+
      '''External View'''
+
      '''Tracking View'''
+
      '''Free Roaming'''
+
    '''[x] Wait for the camera to target vehicle ''<click to select>''''' - if checked, select a vehicle from the Session list
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Cinematic Camera Rule|Cinematic Camera Rule]]''' - provides several different cinematic style cameras with animations
+
*'''[[#Focus Camera Rule|Focus Camera Rule]]''' - sets the initial camera view and starting vehicle for a session
+
*'''[[#Set Camera Rule|Set Camera Rule]]''' - sets the target object and properties of the camera
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[How to Use Parent and Child Rules]]'''
+
 
<br>
 
<br>
<table width="100%" bgcolor=#ffff88>
+
<table bgcolor=#a8ff8a>
 
<tr>
 
<tr>
 
<td>
 
<td>
Line 668: Line 423:
 
</table>
 
</table>
  
<table width="100%" bgcolor=#ffff88>
+
<table width="100%" bgcolor=#a8ff8a>
 
<tr>
 
<tr>
 
<td>
 
<td>
='''Danger, Derailment and Safety Rules'''=
+
='''Load and Unload Commands'''=
 
</td>
 
</td>
 
</tr>
 
</tr>
Line 677: Line 432:
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''ATP Speed Limiter Rule'''==
+
=='''Instant Load'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Limits allowable speed over set limit
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_InstantLoad.png|50px|link=]]</td>
 
+
<td>Instantly loads all rolling stock (except locos and tenders) in the train with the item(s) in their commodity queues.</td>
*'''<kuid2:321959:1000:1>'''
+
 
+
*'''Built-in Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''Limits the speed to ''<value>'' mph over the set limit''' - enter speed value in mph
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#AWS Configuration Rule|AWS Configuration Rule]]''' - configures the Trainz implementation of the Automatic Warning System when approaching signals
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''AWS Configuration Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
This rule configures the Trainz implementation of the Automatic Warning System when approaching signals
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:45324:555017:7> Instant Load Command'''
  
*'''<kuid2:60850:89002:3>'''
+
*'''DLS Command''' by '''norfolksouthern37'''
  
*'''Built-in Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
'''None'''
 
+
    Select one of three option buttons:-
+
      '''( ) Active'''
+
      '''( ) Passive'''
+
      '''( ) Passive with HUD hidden'''
+
    '''[x] Simulate AWS for unfitted cabs?'''
+
    '''[x] Use modern sound set for unfitted cabs?'''
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Clean Up Derailed Trains Rule'''==
+
=='''InstantLoadLocos'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Cleans up derailed train cars after a set time delay
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_InstantLoadLocos.png|50px|link=]]</td>
 
+
<td>Instantly loads all locos and tenders in the train with the item(s) in their commodity queues (coal, water, diesel fuel).</td>
*'''<kuid2:60850:89003:1>'''
+
 
+
*'''Base Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''Set delay to clean up derailed traincars to'''
+
      '''''<h>'':''' - click to enter the number of hours (0-23) to wait
+
      '''''<mm>'':''' - click to enter the number of minutes (0-59) to wait
+
      '''''<ss>'':''' - click to enter the number of seconds (0-59) to wait
+
 
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+
:Time is Trainz clock time, not real time.
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Replace Missing Vehicles Rule|Replace Missing Vehicles Rule]]''' - creates a replacement train after a derailment
+
*'''[[#Wait for Derailment Rule|Wait for Derailment Rule]]''' - executes child rules when a derailment occurs
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Clean_up_Derailed_Trains_Rule</span>'''
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Coupler Breakage Check Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules if there is a coupler breakage
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:117290:1022:1> InstantLoadLocos'''
  
*'''<kuid2:447264:1017:1>'''
+
*'''Built-in Command''' by '''nzhorse'''
  
*'''Built-in Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
*'''Parent Rule'''
+
'''None'''
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''None'''
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Coupler Breakage HUD Rule|Coupler Breakage HUD Rule]]''' - adds a coupler stress and breakage warning to the HUD
+
*'''[[#Set Coupler Masks Rule|Set Coupler Masks Rule]]''' - sets the coupling/decoupling masks on selected vehicles
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[How to Use Parent and Child Rules]]'''
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Coupler Breakage HUD Rule'''==
+
=='''InstantUnLoad'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
HUD displays warning about coupler stress and breakage
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_InstantUnLoad.png|50px|link=]]</td>
 
+
<td>Instantly unloads the commodities in all rolling stock (except locos and tenders) in the train.</td>
*'''<kuid:-25:423>'''
+
 
+
*'''Built-in Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    Select one of two option buttons:-
+
      '''( ) Show the Coupler Breakage Display'''
+
      '''( ) Hide the Coupler Breakage Display'''
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Coupler Breakage Check Rule|Coupler Breakage Check Rule]]''' - executes child rules if a coupler breaks
+
*'''[[#Set Coupler Masks Rule|Set Coupler Masks Rule]]''' - sets the coupling/decoupling masks on selected vehicles
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Junction Derailment Prevention Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Sets opposing (trailing) junctions ahead of a train to prevent derailments.  Works with both AI and manually driven trains.
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:67585:1021:2> InstantUnload'''
  
*'''<kuid2:121843:100282:1>'''
+
*'''DLS Command''' by '''robin_hoods'''
  
*'''DLS Rule''' by '''pitkin'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
'''None'''
 
+
    '''None'''
+
 
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+
:This rule will not overrule a junction already locked by another AI train or locked against AI control using the '''Set Junctions Rule'''.
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Control Path Rule|Control Path Rule]]''' - sets the path for selected trains
+
*'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
+
*'''[[#Set Cleared Junctions Rule|Set Cleared Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.
+
*'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Replace Missing Vehicles Rule'''==
+
=='''Load'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Produces new trains to replace missing vehicles that have been removed from the session by the '''Clean Up Derailed Trains Rule'''
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_Load.png|50px|link=]]</td>
 
+
<td>Instructs the AI driver to load the commodity or commodities waiting at an industry enabled asset into the rolling stock assets that have been configured to receive them. This may involve the AI driver moving the train forward a few wagons at a time until the entire length of the train has passed through the loading area. The '''Load''' command is also used for loading (and unloading) passengers at passenger enabled stations.</td>
*'''<kuid:447264:1214>'''
+
 
+
*'''Built-in Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''[x] Respawn trains if they are abandoned for 10 minutes'''
+
    If checked:-
+
      Select one of two option buttons:-
+
          '''( ) Respawn trains at their original locations'''
+
          '''( ) Respawn trains from portals'''
+
            '''''<+ Add a new portal>''''' - click to enter the name of a portal, there can be more than one portal.
+
            Entered portal names that appear in red have not been found in the session
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Clean Up Derailed Trains Rule|Clean Up Derailed Trains Rule]]''' - cleans up derailed train cars after a set time delay
+
*'''[[#Wait for Derailment Rule|Wait for Derailment Rule]]''' - executes child rules when a derailment occurs
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Safety System Engaged Check Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules if safety systems are applied.
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid:-3:10076> Load'''
  
*'''<kuid:447264:1216>'''
+
*'''Base Command'''
  
*'''Built-in Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
*'''Parent Rule'''
+
'''None'''
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
+
#If the industry where the loading is taking place uses up all the available commodities before all the wagons are fully loaded, then any following wagons will not be loaded until the commodity is available again but the AI driver will not stop to wait.
    '''[x] Trigger only once'''
+
#With passenger enabled stations the '''Load''' command will first execute an '''Unload''' command to unload some of the passengers.
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Safety System Isolated Check Rule|Safety System Isolated Check Rule]]''' - executes child rules if safety systems have been isolated
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[How to Use Parent and Child Rules]]'''
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Safety System Isolated Check Rule'''==
+
=='''Load At'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules if safety systems are isolated (disengaged).
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_IndustryIcon.png|50px|link=]]</td>
 
+
<td>Combines the '''Drive To''' and '''Load''' commands. Instructs the AI driver to drive to an industry (or passenger enabled station) and load the commodity or commodities waiting there into the rolling stock assets that have been configured to receive them. This may involve the AI driver moving the train forward a few wagons at a time until the entire length of the train has passed through the loading area. The '''Load At''' command is also used for loading (and unloading) passengers at passenger enabled stations. All signals and speed signs are obeyed during the "Drive To" operation.</td>
*'''<kuid:447264:1217>'''
+
 
+
*'''Built-in Rule'''
+
 
+
*'''Parent Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''[x] Trigger only once'''
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Safety System Engaged Check Rule|Safety System Engaged Check Rule]]''' - executes child rules if safety systems have been engaged
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[How to Use Parent and Child Rules]]'''
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Set Coupler Masks Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Set the coupling/decoupling  masks on the selected vehicles
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:75377:84:1> Load At'''
  
*'''<kuid:-25:980>'''
+
*'''DLS Command''' by '''stagecoach'''
  
*'''Built-in Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
Select '''<name of industry>''' or industry enabled passenger station from the session list
 +
  if applicable '''<name/number of track or platform>''' for industries and stations that have identified active platforms, tracks or loading bays
  
    '''''<Add vehicle>''''' - click to select a vehicle from the session list
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
    '''''<Add All>''''' - click to add all vehicles in the session list
+
#The AI driver will select the shortest available path to the destination.
    '''''<Delete All>''''' - click to remove all added vehicles from this rule
+
#If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will not attempt to find an alternative path to the destination. This can lead to the train stopping and waiting indefinately until the blockage is removed.
      For each selected vehicle:-
+
#If the industry where the loading is taking place uses up all the available commodities before all the wagons are fully loaded, then any following wagons will not be loaded until the commodity is available again but the AI driver will not stop to wait.
      '''Coupling Mask'''
+
#With passenger enabled stations the '''Load''' command will first execute an '''Unload''' command to unload some of the passengers.
          '''Front''' and '''Back''' - choose for each
+
            '''''Locked'''''
+
            '''''Unlocked'''''
+
      '''Decoupling Mask'''
+
          '''Front''' and '''Back''' - choose for each
+
            '''''Locked'''''
+
            '''''Unlocked'''''
+
      '''''<Remove>''''' - click to remove this vehicle from the rule
+
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
*'''[[#Coupler Breakage Check Rule|Coupler Breakage Check Rule]]''' - executes child rules when a coupler breaks
+
*'''[[#Drive To|Drive To]]''' - drives to an industry but does not seek alternative paths if blocked
*'''[[#Coupler Breakage HUD Rule|Coupler Breakage HUD Rule]]''' - adds a coupler stress and breakage warning to the HUD
+
*'''[[#Load|Load]]''' - loads commodities at an industry (including a station)
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Signal Passed At Danger Check Rule'''==
+
=='''Terminate Passenger Train'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules if a signal or stop mark is ''Passed at Danger (STOP)''.
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_TerminateTrain.png|50px|link=]]</td>
 
+
<td>An '''Unload''' command for passenger trains arriving at a terminal station. The train will be emptied of passengers.</td>
*'''<kuid2:60850:89007:2>'''
+
 
+
*'''Built-in Rule'''
+
 
+
*'''Parent Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''[x] Trigger only once'''
+
 
+
[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+
*'''[[How to Use Variables in Sessions (Examples)#Example 2: Event Counter and Message Selection|How to Use Variables in Sessions (Examples): Event Counter and Message Selection]]
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[How to Use Parent and Child Rules]]'''
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Speeding Check Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules if player controlled trains are over the local speed limit or over a set (custom) speed
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:116387:16:2> Terminate Passenger Train'''
  
*'''<kuid2:60850:89004:3>'''
+
*'''Built-in Command''' by '''maggs'''
  
*'''Built-in Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
*'''Parent Rule'''
+
'''None'''
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
+
#Issue a '''Drive To''' command (or similar) to the station before using this command. The station must be industry active.
    Select one of two options to set a speed limit to be observed
+
      '''( ) Watch for trains travelling above the posted speed limit'''
+
          '''''<speed value>''''' - click to enter a new overspeed tolerance value
+
          '''''<speed units>''''' - click to select one from the list:-
+
            '''''Km/h''''' - Kilometres per hour
+
            '''''MPH''''' - Miles per hour
+
            '''''mps''''' - metres per second
+
      '''( ) Watch for trains travelling above a custom speed'''
+
          '''''<speed value>''''' - click to enter a new custom speed value
+
          '''''<speed units>''''' - click to select one from the list:-
+
            '''''Km/h''''' - Kilometres per hour
+
            '''''MPH''''' - Miles per hour
+
            '''''mps''''' - metres per second
+
            '''Warning: This option is very performance intensive and should only be used in sessions with few trains'''
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[How to Use Parent and Child Rules]]'''
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Vehicle Physics Rule'''==
+
=='''Unload'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Overrides the default vehicle physics properties for all vehicles or for those matching set criteria
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_Unload.png|50px|link=]]</td>
 
+
<td>Instructs the AI driver to unload the commodity or commodities loaded in rolling stock assets to the industry enabled asset if it has been configured and is able to receive them. This may involve the AI driver moving the train forward a few wagons at a time until the entire length of the train has passed through the loading area. The '''Unload''' command is also used for unloading passengers at passenger enabled stations.</td>
*'''<kuid:-25:1052>'''
+
 
+
*'''Built-in Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    Select one of two option buttons:-
+
      '''( ) click to accept all trains'''
+
      '''( ) click to accept trains matching specific criteria'''
+
          Selecting the second option will produce the following selection controls:-
+
          '''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
+
            '''''+''''' - click to add a ''specific'' vehicle from the session list
+
            '''''x''''' - click to remove the ''specific'' vehicle from the rule
+
          '''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule
+
            '''''+''''' - click to add a ''type'' of vehicle from the session list
+
            '''''x''''' - click to remove the ''type'' of vehicle from the rule
+
          '''Drivers''''' - identify the ''drivers'' that will trigger the rule
+
            '''''+''''' - click to add a ''driver'' from the session list
+
            '''''x''''' - click to remove a ''driver'' from the rule
+
    '''Coupler Parameters:'''
+
      '''Couplers break at ''<value>'' kN expansion force''' - enter force value
+
      '''Couplers break at when coupling above ''<value>'' kph''' - enter speed value
+
      '''[x] Show coupler breakage in HUD''' - check to display breakage in on-screen HUD
+
    '''Wheelslip Parameters:'''
+
      '''Maximum tractive effort adjusted by ''<value>'' %''' - enter adjustment as a %
+
      '''Traction is reduced to ''<value>'' % while wheelslipping''' - enter value as a %
+
      '''Traction boost is ''<value>'' % while sanding''' - enter value as a %
+
    '''Sway Parameters:'''
+
      '''Cab sway level is set to ''<value>'' %''' - enter value as a %
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Wait for Derailment Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules when a derailment occurs
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid:-3:10077> Unload'''
  
*'''<kuid:-25:1053>'''
+
*'''Base Command'''
  
*'''Built-in Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
*'''Parent Rule'''
+
'''None'''
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
+
#If the industry where the unloading is taking place reaches its maximum capacity before all the wagons are fully unloaded, then any following wagons will not be unloaded until capacity is available again but the AI driver will not stop to wait.
    '''[x] Trigger derailment watch once''' - check to execute the rule once only
+
#With passenger enabled stations the '''Unload''' command will unload a set number of passengers, specifically:-
 
+
::*Terminal stations = 100% of loaded passengers
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
::*Large stations = 50%
*'''[[#Clean Up Derailed Trains Rule|Clean Up Derailed Trains Rule]]''' - cleans up derailed train cars after a set time delay
+
::*Standard stations = 25%
*'''[[#Replace Missing Vehicles Rule|Replace Missing Vehicles Rule]]''' - creates a replacement train after a derailment
+
::*Small stations = 10%
 
+
:::The station size is set in the station properties
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[How to Use Parent and Child Rules]]'''
+
 
<br>
 
<br>
<table width="100%" bgcolor=#ffff88>
+
<table bgcolor=#a8ff8a>
 
<tr>
 
<tr>
 
<td>
 
<td>
Line 1,122: Line 648:
 
</table>
 
</table>
  
<table width="100%" bgcolor=#ffff88>
+
<table width="100%" bgcolor=#a8ff8a>
 
<tr>
 
<tr>
 
<td>
 
<td>
='''Driver Rules'''=
+
='''Movement Commands'''=
 
</td>
 
</td>
 
</tr>
 
</tr>
Line 1,131: Line 657:
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''AI Start Rule'''==
+
=='''AI Wait Until Green Signal'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Restarts all halted AI controlled trains. Drivers will continue with the commands in their driver command list.
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_WaitUntilGreen.png|50px|link=]]</td>
 +
<td>Instructs the AI driver to wait for a green signal ahead before executing the next driver command. The interface for this driver command is in Russian.</td>
 +
</tr>
 +
</table>
  
*'''<kuid2:400048:100981:1>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
*'''DLS Rule''' by '''callavsg'''
+
*'''<kuid2:151055:100101:3> AI Wait until green signal'''
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
*'''DLS Command''' by '''erendir'''
  
    '''None'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+
  '''Ждать, пока не будет зелёный >''' - Translation: "Wait until it is green >"
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
      '''На любом светофоре''' - Translation: "At any traffic light" - select for the next signal up to 3000m ahead
*'''[[#AI Stop Rule|AI Stop Rule]]''' - halts all AI drivers
+
      '''Только на станционном зале " Z7 " /Су''' - Translation: "Only at the station hall " Z7 " / su" - unknown meaning
*'''[[#Disallow AI Rule|Disallow AI Rule]]''' - cancels all AI driver commands
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''AI Stop Rule'''==
+
=='''Change Train Direction'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Halts all AI controlled trains but does not delete their driver commands. AI trains can be restarted with the '''AI Start Rule''' or by issuing individual '''Continue Schedule''' commands.
+
<table>
 +
<tr valign="top">
 +
<td>[[file:CMD_ChangeDirection.png|50px|link=]]</td>
 +
<td>Reverses the driving direction of the train.</td>
 +
</tr>
 +
</table>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
*'''<kuid2:400048:100980:1>'''
+
*'''<kuid2:70791:9001:1> Change Train Direction'''
  
*'''DLS Rule''' by '''callavsg'''
+
*'''Built-in Command''' by '''mgalling'''
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
    '''None'''
+
'''None'''
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#AI Start Rule|AI Start Rule]]''' -  restarts all halted AI drivers
+
*'''[[#Disallow AI Rule|Disallow AI Rule]]''' -  cancels all AI driver commands
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Control Check Rule'''==
+
=='''Halt Train'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules if the train control method has been altered or a specific method has been selected.
+
<table>
 +
<tr valign="top">
 +
<td>[[file:CMD_HaltTrain.png|50px|link=]]</td>
 +
<td>Brings the train to an immediate stop.</td>
 +
</tr>
 +
</table>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
*'''<kuid:401543:1191>'''
+
*'''<kuid:401543:1090> Halt Train'''
  
*'''Built-in Rule'''
+
*'''Base Command'''
  
*'''Parent Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
'''None'''
 
+
  '''Execute child rules when:''' - select one of two option buttons:-
+
    '''( ) DCC mode is Selected'''
+
    '''( ) Cab mode is Selected'''
+
  '''Execute child rules:''' - select one of two option buttons:-
+
    '''( ) Every time control method is set'''
+
    '''( ) Once only'''
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Control Type Rule|Control Type Rule]]''' - sets the control method
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[How to Use Parent and Child Rules]]'''
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Control Type Rule'''==
+
=='''Set Max Speed To'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Sets the control method
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_MaxSpeed.png|50px|link=]]</td>
 
+
<td>Instructs the AI driver to drive up to the set maximum speed (mph). This speed limit has no effect on other AI trains. Lower speed limit signs are obeyed.</td>
*'''<kuid:-16:2030>'''
+
 
+
*'''Base Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
  '''Current control method is: ''<select>''''' - click to select one of
+
    '''''Easy Mode''''' - DCC (standard keyboard and mouse) control
+
    '''''Ask User''''' - let the user decide
+
    '''''Realistic Mode''''' - Cab controls (on screen levers, throttles, buttons, etc)
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Control Check Rule|Control Check Rule]]''' - executes child rules if the train control method changes
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Disallow AI Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Cancels (deletes) all current and waiting AI commands for all drivers
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:450022:90001:2> Set Max Speed To'''
  
*'''<kuid:400048:100603>'''
+
*'''DLS Command''' by '''nikkia'''
  
*'''DLS Rule''' by '''callavsg'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
Select '''<No maximum speed>''' or '''<value>''' in mph
  
  '''None'''
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 +
:The maximum speed, once set, will remain in place throughout the session unless cancelled or reset by another '''Set Max Speed To''' command.
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
*'''[[#AI Start Rule|AI Start Rule]]''' - restarts all halted AI drivers
+
*'''[[#Set Max Speed To (km/h)|Set Max Speed To (km/h)]]''' - set the maximum speed in km/h
*'''[[#AI Stop Rule|AI Stop Rule]]''' -  halts all AI drivers
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Driver Command Check Rule'''==
+
=='''Set Max Speed To (km/h)'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules if the driver commands match a set list.
+
<table>
 +
<tr valign="top">
 +
<td>[[file:CMD_MaxSpeed.png|50px|link=]]</td>
 +
<td>Instructs the AI driver to drive up to the set maximum speed (km/h). This speed limit has no effect on other AI trains. Lower speed limit signs are obeyed.</td>
 +
</tr>
 +
</table>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
*'''<kuid:-25:447>'''
+
*'''<kuid:450022:90002> Set Max Speed To (km/h)'''
  
*'''Built-in Rule'''
+
*'''DLS Command''' by '''nikkia'''
  
*'''Parent Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
Select '''<No maximum speed>''' or '''<value>''' in km/h
  
  '''[x] Trigger rule once''' - check to allow the rule to execute only once
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
  '''Driver character to watch the command list of ''<select>''' - select a driver name from the Session List''
+
:The maximum speed, once set, will remain in place throughout the session unless cancelled or reset by another '''Set Max Speed To''' command.
  '''Wait for driver character to have a command list that matches this:'''
+
    '''''<add driver command>''''' - add a driver command from the session list. More commands can be added. Commands can be deleted.
+
    '''''<add all>''''' - adds ALL driver commands in the session list. Individual commands can be removed.
+
    '''''<delete all>''''' - deletes all entered driver commands from the session rule
+
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
*'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
+
*'''[[#Set Max Speed To|Set Max Speed To]]''' - set the maximum speed in mph
*'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
+
*'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
+
*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
+
*'''[[#ScheduleAtTrackside Rule|ScheduleAtTrackside Rule]]''' - issues set of driver commands at a trackmark or trigger
+
*'''[[#Schedule Library Rule|Schedule Library Rule]]''' - creates a library of driver schedules (commands)
+
*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[How to Use Parent and Child Rules]]'''
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Driver Command Rule'''==
+
=='''WaitFor'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Specifies which commands will be available for the drivers
+
<table>
 +
<tr valign="top">
 +
<td>[[file:CMD_WaitFor.png|50px|link=]]</td>
 +
<td>Instructs the AI driver to wait for a set time period before executing the next instruction in the command list.</td>
 +
</tr>
 +
</table>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
*'''<kuid:-3:10057>'''
+
*'''<kuid:-3:10090> WaitFor'''
  
*'''Base Rule'''
+
*'''Base Command'''
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
    For each installed Driver Command:-
+
Select '''<time delay>''' from list
    '''[x] ''Name of Driver Command'' and ''Description (if available)''''' - check to make that command available to the drivers
+
  
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
:Some Driver Commands that have been checked will not appear in the Command Lists for drivers if there is no target for their action. For example:
+
:There are a limited range of available times from 5 seconds to 1 hour. A time delay that is not in this list (e.g. 3 minutes) can be achieved by using two (or more) '''WaitFor''' commands with the combined total of their times equaling the required time delay.
:*The ''Wait For Trigger'' command will not be available to any drivers if there are no triggers set.
+
:*The ''Call At'' command will not be available to any drivers if there are no industry active assets or passenger enabled stations.
+
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
 
*'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
 
*'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
 
*'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
 
*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
 
*'''[[#ScheduleAtTrackside Rule|ScheduleAtTrackside Rule]]''' - issues set of driver commands at a trackmark or trigger
 
*'''[[#Schedule Library Rule|Schedule Library Rule]]''' - creates a library of driver schedules (commands)
 
*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
 
  
[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
*'''[[How to Use Driver Setup Rule#Driver Command Rule|How to Use Driver Command Rule]]'''
+
*'''[[#Wait Until II|Wait Until II]]''' - sets the wait to a set clock time
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[Driver_Commands_List|Driver Commands List]]'''
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Driver Main Menu Options Rule'''==
 
</td>
 
</tr>
 
</table>
 
  
Show/Hide the Driver Main Menu Bar
+
=='''WaitForTrigger'''==
 
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
 
+
*'''<kuid:-25:448>'''
+
 
+
*'''Built-in Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''''<Show/Hide>'' the Driver Main Menu Bar''' - click '''Show''' or '''Hide''' to select
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Driver Schedule Rule'''==
+
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Sets up a list of basic scheduled commands
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_WaitForTrigger.png|50px|link=]]</td>
 
+
<td>Instructs the AI driver to wait for a trigger event before executing the next instruction in the command list. The train triggering the event can be any train in the session.</td>
*'''<kuid2:82445:90001:9>'''
+
 
+
*'''Built-in Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
+
    '''Driver Schedule Assigned to ''name of driver <icon>''''' - click '''icon''' to select a driver from those assigned in the '''Driver Setup Rule'''
+
    '''Next commands, will be executed''' 
+
      '''''>>''''' - click to enter driver commands from those specified in the '''Driver Command Rule'''
+
    '''Style:''' - select one of four option buttons:-
+
      '''( ) Classic style: If there is a schedule do not emit a new schedule''' - any currently assigned set of driver commands will not be replaced
+
      '''( ) Killer style: If there is a schedule clean it and emit a new one''' - replace any currently assigned driver commands with the new commands
+
      '''( ) Cooperative style: If there is a schedule append the new one''' - add the new driver commands to the end of any existing commands
+
      '''( ) Active style: Emit a new schedule, only if already a schedule running''' - only add the new commands if commands are currently running
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
+
*'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
+
*'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
+
*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
+
*'''[[#ScheduleAtTrackside Rule|ScheduleAtTrackside Rule]]''' - issues set of driver commands at a trackmark or trigger
+
*'''[[#Schedule Library Rule|Schedule Library Rule]]''' - creates a library of driver schedules (commands)
+
*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
+
 
+
[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+
*'''[[How to Use Variables in Sessions (Examples)#Example 2: Event Counter and Message Selection|How to Use Variables in Sessions (Examples): Event Counter and Message Selection]]
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Driver Setup Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Creates the list of drivers for this session and assigns them their orders
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:57344:80001:5> WaitFor'''
  
*'''<kuid:-16:2025>'''
+
*'''Built-in Command''' by '''marinus'''
  
*'''Base Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
Select '''<trigger name>''' from the session list
 
+
     Select '''<any train>''' or locomotive from '''<list of locomotive names>'''
    '''''<driver icon>''''' - click to select a new driver from the list of installed and built in drivers
+
     '''''<loco>''''' - click to select a new locomotive from the session list and assign it to this driver. Locos displayed in red have not been found in the session list
+
    '''''<driver name>''''' - click to enter a new name for the selected driver
+
    '''''<driver mode>''''' - click to select one of:-
+
      '''''Autodetect''''' - the program will detect the driver mode to be used. For example, if driver commands have been entered for this driver
+
          then the '''AI driver''' mode will be selected
+
      '''''First Human Player''''' - the driver will be assigned to the user or multiplayer who accesses her/him first
+
      '''''AI driver''''' - the AI will be given control even if no commands are present
+
      '''''Multiplayer Driver''''' - the driver will be assigned to a multiplayer user
+
    '''''<remove>''''' - this driver will be removed from the rule
+
    '''''>>''''' - click to enter driver commands from those specified in the '''Driver Command Rule'''
+
    --> Scroll down to the bottom of the list of entered drivers for more options
+
  '''''<Add another driver>''''' - click to add another driver
+
  '''[x] Remove all existing Drivers first''' - see '''Known Issues''' below
+
  '''[x] Generate new Drivers for empty Trains''' - when checked all newly added locos will automatically be given drivers
+
  
 
[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
 
[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
#The '''Remove all existing Drivers first''' option does not appear to work in '''TANE''' (but works in '''TRS19''' and later)
+
*The presence of a large number of locos in a session can cause this command to fail due to a timeout error
#Adding a large number of drivers to a session can cause ''Timeout'' errors. One known workaround is to split the drivers between two copies of the '''Driver Setup Rule''' and make the second copy a child of a '''Wait Rule'''. For more details see the Wiki '''[[How to Use Driver Setup Rule]]'''. This issue has been reported as '''FIXED''' in the latest '''beta''' versions of '''TRS19 SP1''' and '''Trainz Plus'''
+
  
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
:The driver at the top of the list will have the camera focus when the Session starts. There is no way to move a driver up the list order except by removing the higher drivers
+
*Command will not appear in a drivers command list if there are no triggers set
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
+
*'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
+
*'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
+
*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
+
*'''[[#ScheduleAtTrackside Rule|ScheduleAtTrackside Rule]]''' - issues set of driver commands at a trackmark or trigger
+
*'''[[#Schedule Library Rule|Schedule Library Rule]]''' - creates a library of driver schedules (commands)
+
*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
+
 
+
[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+
*'''[[How to Use Driver Setup Rule]]'''
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[Driver_Commands_List|Driver Commands List]]'''
+
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Driver_Setup_Rule</span>'''
+
 
+
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width="100%" bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Enable/Disable Driver Commands Rule'''==
+
=='''Wait Until II'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Enable/Disable specific driver commands on certain drivers. Multiple copies of the rule can be used to give different drivers or consists different command lists
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_WaitUntilII.png|50px|link=]]</td>
 
+
<td>Instructs the AI driver to wait until the specified time</td>
*'''<kuid:-25:480>'''
+
 
+
*'''Built-in Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''<Enable/Disable>'' the following driver commands ...''' - click to select '''Enable''' or '''Disable'''
+
    For each driver command:-
+
    '''[x] ''command name''''' - check to enable or disable
+
    '''[x] ''command name''''' - check to enable or disable
+
    '''[x] ''command name''''' - check to enable or disable
+
    etc
+
    Select one of two option buttons:-
+
      '''( ) click to accept all trains'''
+
      '''( ) click to accept trains matching specific criteria'''
+
          Selecting the second option will produce the following selection controls:-
+
          '''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
+
            '''''+''''' - click to add a ''specific'' vehicle from the session list
+
            '''''x''''' - click to remove the ''specific'' vehicle from the rule
+
          '''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule
+
            '''''+''''' - click to add a ''type'' of vehicle from the session list
+
            '''''x''''' - click to remove the ''type'' of vehicle from the rule
+
          '''Drivers''''' - identify the ''drivers'' that will trigger the rule
+
            '''''+''''' - click to add a ''driver'' from the session list
+
            '''''x''''' - click to remove a ''driver'' from the rule
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
+
*'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
+
*'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
+
*'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
+
*'''[[#ScheduleAtTrackside Rule|ScheduleAtTrackside Rule]]''' - issues set of driver commands at a trackmark or trigger
+
*'''[[#Schedule Library Rule|Schedule Library Rule]]''' - creates a library of driver schedules (commands)
+
*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Enable/Disable_Driver_Commands_Rule</span>'''
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''JTG Correct Vehicle Lights'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Corrects the brightness of vehicle headlights. Now obsolete.
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid:32711:100025> Wait Until II'''
  
*'''<kuid2:478657:999103:1>'''
+
*'''Built-in Command''' by '''dap'''
  
*'''DLS Rule''' by '''jtg-trainz'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
*''' Obsolete Rule''' (function is now built into '''Trainz''' Driver Additional Tools Menu)
+
Select '''<hours>''' 1 to 24
 +
    Select '''<minutesx10>''' minutes 0 to 50 in increments of 10
 +
      Select '''<minutesx1>''' minutes 0 to 9
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
+
* If the driver is running up to 4 hours late this command will terminate immediately
    '''None'''
+
* If the wait until time is more than 4 hours behind the game time, the command will wait until tomorrow
 +
* The game time rate must be set to x1 (normal speed) for the command to work correctly
 +
* Run-time editing is not available for this command. To edit in Driver the command must be removed first
  
 +
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
 +
*'''[[#WaitFor|WaitFor]]''' - sets the wait period for up to 1 hour
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table bgcolor=#a8ff8a>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''QuickDrive Rule'''==
+
'''[[#top|Back to Top]]'''
 +
 
 +
='''Navigation Commands'''=
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
Changes the Session settings.
 
 
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
 
 
*'''<kuid:401543:1184>'''
 
 
*'''Base Rule'''
 
 
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
 
 
  '''Open QuickDrive window when session is started          [x]''' - check to set
 
  '''Set time to ''<hours:minutes>'' with a rate of ''<speed x>''''' - set start time and rate at which time advances
 
  '''Enable gameplay Session Mode                            [x]''' - check to set. Gameplay mode restricts the players options
 
  '''Enable in game help by default                          [x]''' - check to allow help options to be displayed
 
  '''Set the default Control method to:''' - select one of two option buttons:-
 
      '''( ) Easy Mode'''
 
      '''( ) Realistic Mode'''
 
      '''[x] Prevent player from changing this setting''' - check to set
 
  '''Realistic mode requires achievement: ''<text>'' in asset ''<asset name>''''' - enter achievement name and select an asset from Aurans Achievements
 
  '''Set the default derailment realism to:''' - select one of three option buttons:-
 
      '''( ) None'''
 
      '''( ) Arcade'''
 
      '''( ) Realistic'''
 
      '''[x] Prevent player from changing this setting''' - check to set
 
  '''Set the default units to:''' - select one of three option buttons:-
 
      '''( ) Imperial'''
 
      '''( ) Metric'''
 
      '''( ) Default'''
 
 
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
 
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/QuickDrive_Rule</span>'''
 
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''ScheduleAtTrackside Rule'''==
+
=='''AutoDrivePastSignal'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Allows a set of driver commands to be given to a train when it reaches a trackmark or trigger.
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_AutoDrivePastSignal.png|50px|link=]]</td>
 
+
<td>Instructs the AI driver to drive under '''Autopilot''' until the entire train clears the specified signal but the AI will not set any junction switches so the train will follow whatever path is set ahead of it. All signals and speed signs are obeyed. The train will slow to a halt after passing the signal.</td>
*'''<kuid2:61392:2001:6>'''
+
 
+
*'''DLS Rule''' by '''pguy'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''''<Select trackmark>'' - ''<Select trigger>''''' - click one to select a trackmark from the Session list or a trigger from the Session list
+
    '''Schedule will be fired ''<in both directions/in trackside forward direction/in trackside backward direction>''''' - click to select one. Only available if '''trackmark''' has been selected
+
    '''This rule will be applied ''<all along the session>''''' - click to enter the number of times to trigger the rule. 0 = everytime (all along the session)
+
    '''Enter driver commands to schedule when train is at trackside'''
+
      '''''>>''''' - click to enter driver commands from those specified in the '''Driver Command Rule'''
+
    Select one of two option buttons:-
+
      '''( ) new schedule will replace current driver command''' - select to delete any current command list and replace it with the command list above
+
      '''( ) new schedule will be appended to current driver commands''' - select to add the command list above above to the current driver command list
+
    '''''<add a new trackside entry>''''' - click to add a new '''ScheduleAtTrackside''' entry below
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
+
*'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
+
*'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
+
*'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
+
*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
+
*'''[[#Schedule Library Rule|Schedule Library Rule]]''' - creates a library of driver schedules (commands)
+
*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Schedule Library Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Creates a library of driver schedules (driver command lists) that can be given to drivers during the creation or running of a session
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:61392:7101:1> AutoDrivePastSignal Command'''
  
*'''<kuid2:192081:12:5>'''
+
*'''DLS Command''' by '''pguy'''
  
*'''Built-in Rule''' by '''brummfondel'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
   Select '''''<signal name>''''' from Session list
 
+
   '''''<add schedule>''''' | '''''<add group>'''''
+
      To add <u>individual schedules</u> click ''<add schedule>'' then
+
        '''''<library Entry Name>''''' - enter a unique name for the schedule
+
          '''''<library Entry Name>''''' - click to edit name
+
          '''''<remove>''''' - click to delete this schedule from the list
+
          '''''<copy>''''' - click to add a copy this schedule to the current group
+
          '''''<move to group>''''' - click to move this schedule to a schedule group
+
          In the driver command bar:-
+
              '''''>>''''' - click to enter driver commands from those specified in the '''Driver Command Rule'''
+
      To add <u>groups of schedules</u> click ''<add group>'' then
+
        '''''<Group Name>''''' - enter a unique name for the group
+
            '''-''' - click to close the group list
+
            '''+''' - click to open the group list
+
            '''''<Group Name>''''' - click to edit name
+
            '''''<remove>''''' - click to delete this group from the schedule list
+
  
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
#Create the library schedules in this rule first.
+
*It is the users responsibility to set all junction switches ahead of the train. The AI will not set the switches
#In '''Surveyor''' (using the '''Driver Setup Rule''') or '''Driver''' (directly in a driver command bar) add the Driver Command '''Copy Commands From''' and select the command schedule to be added or appended. The driver command '''Copy Commands From''' must be enabled in the '''Driver Command Rule'''.
+
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
*'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
+
*'''[[#AutoPilot|AutoPilot]]''' - drives continuously or until a specified trackmark has been passed
*'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
+
*'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
+
*'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
+
*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
+
*'''[[#ScheduleAtTrackside Rule|ScheduleAtTrackside Rule]]''' - issues set of driver commands at a trackmark or trigger
+
*'''[[#Schedule Rule|Schedule Rule]]''' - applies a schedule of timed events to a train
+
  
[[file:PageLink4.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Dependent Driver Commands:</span>
 
:'''The rule must be added to the Session for the following Driver Command to work'''
 
*'''[[Driver Commands List#Copy Commands From|Copy Commands From]]'''
 
 
 
<br>
 
<br>
<table width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Schedule Rule'''==
+
 
 +
=='''Autopilot'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Allows a schedule of timed events to be applied to a train
+
<table>
 +
<tr valign="top">
 +
<td>[[file:CMD_AutoPilot.png|50px|link=]]</td>
 +
<td>Instructs the AI driver to drive but the AI will not set any junction switches so the train will follow whatever path is set ahead of it. All signals and speed signs are obeyed.</td>
 +
</tr>
 +
</table>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
*'''<kuid:-3:10185>'''
+
*'''<kuid2:71155:60001:5> Autopilot Command'''
  
*'''Base Rule'''
+
*'''DLS Command''' by '''_mutton_'''
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
     '''Insert track mark ''<select>''''' - select a track mark from the Session List
+
Select one of
    '''Arrival and Departure Time ''<Select>''''' - set time
+
     '''<activate>''' - starts the Autopilot Command. This will only terminate when the '''Autopilot Command''' is removed from the driver command line
      '''''hh:mm:ss''''' - in hours/minutes/seconds
+
     '''<stop at track mark>''' - select a trackmark from the session list. Starts the Autopilot Command and drives until the train reaches the selected trackmark (see '''Notes''' below)
     '''Current Train ''<select>''''' - select from session list
+
    '''Insert destination ''<select>''''' - select from session list
+
 
+
[[file:BugMini.PNG|link=]] <span style="text-decoration: underline; font-weight: 700; color: red;">Known Bugs:</span>
+
:There are reports that this rule does not work correctly particularly if a train arrives late or early.
+
  
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
:Times are Trainz clock times, not real time
+
#It is the users responsibility to set all junction switches ahead of the train. The AI will not set the switches
 
+
#If the '''Stop at track mark''' option is used then:-
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
:*the train will not set a path to the track mark, that is the users responsibility
*'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
+
:*the train will run at the full posted line speed upto the track mark and then it will slow to a stop
*'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
+
:*if the track mark is never reached because the correct path has not been set, the train will continue as it would for the '''activate''' option
*'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
+
*'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
+
*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
+
*'''[[#ScheduleAtTrackside Rule|ScheduleAtTrackside Rule]]''' - issues set of driver commands at a trackmark or trigger
+
*'''[[#Schedule Library Rule|Schedule Library Rule]]''' - creates a library of driver schedules (commands)
+
  
[[file:WWWLinks.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Other Links:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
*'''<span class="plainlinks">http://www.auran.com/games/gamefiles/trainz/tutorial1.html</span>'''
+
*'''[[#AutoDrivePastSignal|AutoDrivePastSignal]]''' - drives until a specified signal has been passed
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Wait for Driver On/Off Train Rule'''==
+
=='''Drive To'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules when a driver gets on or off a train
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_IndustryIcon.png|50px|link=]]</td>
 
+
<td>Instructs the AI driver to Drive, via the shortest available path, to the designated Industry (including Passenger Stations). Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will '''NOT''' attempt to find a way around blockages when calculating the shortest path to the industry. All signals and speed signs are obeyed.</td>
*'''<kuid:-25:953>'''
+
 
+
*'''Built-in Rule'''
+
 
+
*'''Parent Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
  '''[x] Trigger Rule Once''' - click to set''
+
  '''Wait for a driver character to get ''<On/Off>''''' a train that matches the following criteria''' - select '''On''' or '''Off'''
+
  Select one of two option buttons:-
+
    '''( ) click to accept all trains'''
+
    '''( ) click to accept trains matching specific criteria'''
+
        Selecting the second option will produce the following selection controls:-
+
        '''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
+
          '''''+''''' - click to add a ''specific'' vehicle from the session list
+
          '''''x''''' - click to remove the ''specific'' vehicle from the rule
+
        '''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule
+
          '''''+''''' - click to add a ''type'' of vehicle from the session list
+
          '''''x''''' - click to remove the ''type'' of vehicle from the rule
+
        '''Drivers''''' - identify the ''drivers'' that will trigger the rule
+
          '''''+''''' - click to add a ''driver'' from the session list
+
          '''''x''''' - click to remove a ''driver'' from the rule
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Wait for Driver/Train to be Locally Owned Rule|Wait for Driver/Train to be Locally Owned Rule]]''' -  executes child rules when a vehicle or driver changes ownership
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[How to Use Parent and Child Rules]]'''
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Wait for Driver/Train to be Locally Owned Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules when a specific driver or vehicle is locally owned. If the driver/vehicle becomes unowned again the child rules are paused
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid:-3:11058> Drive To'''
  
*'''<kuid2:401543:1173:1>'''
+
*'''Base Command'''
  
*'''Built-in Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
*'''Parent Rule'''
+
Select '''<name of industry>''' or industry enabled passenger station from the session list
 +
  if applicable '''<name/number of track or platform>''' for industries and stations that have identified active platforms, tracks or loading bays
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 +
:If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will not attempt to find an alternative path to the destination. This can lead to the train stopping and waiting indefinately until the blockage is removed.
  
  '''Assets Ownership:''' - select one of two option buttons:-
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
    '''( ) Wait for ownership of a specific Driver'''
+
*'''[[#Navigate To|Navigate To]]''' - will seek alternative paths if blocked
    '''( ) Wait for ownership of Driver'''
+
  '''Driver or Vehicle ''<select>''''' - choose from session list
+
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
 
*'''[[#Wait for Driver On/Off Train Rule|Wait for Driver On/Off Train Rule]]''' -  executes child rules when a driver gets on or off a train
 
 
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
 
*'''[[How to Use Parent and Child Rules]]'''
 
 
<br>
 
<br>
<table width="100%" bgcolor=#ffff88>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
'''[[#top|Back to Top]]'''
+
=='''Drive To Trackmark'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
<table width="100%" bgcolor=#ffff88>
+
<table>
<tr>
+
<tr valign="top">
<td>
+
<td>[[file:CMD_NavigateTo.png|50px|link=]]</td>
 
+
<td>Instructs the AI driver to Drive, via the shortest available path, to the designated Trackmark. Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will '''NOT''' attempt to find a way around blockages when calculating the shortest path to the trackmark. All signals and speed signs are obeyed.</td>
='''HUD (Heads Up Display) Rules'''=
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
<br>
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Cab Controls HUD Rule'''==
+
</td>
+
</tr>
+
</table>
+
  
Was used to provide the HUD controls for the cabin view. Now obsolete.
+
*'''<kuid:-3:11149> Drive To Trackmark'''
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''Base Command'''
  
*'''<kuid:-16:287428>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
*'''Base Rule'''
+
Select '''<name of trackmark>''' from the session list
  
*'''Obsolete Rule''' (function is now built into '''Trainz''')
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 +
:If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will not attempt to find an alternative path to the destination. This can lead to the train stopping and waiting indefinately until the blockage is removed.
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
 +
*'''[[#Drive Via Trackmark|Drive Via Trackmark]]''' - drives through trackmark, will NOT seek alternative paths if blocked
 +
*'''[[#Navigate To Trackmark|Navigate To Trackmark]]''' - stops at trackmark, will seek alternative paths if blocked
 +
*'''[[#Navigate Via Trackmark|Navigate Via Trackmark]]''' - drives through trackmark, will seek alternative paths if blocked
  
    '''None'''
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
 +
*'''[[How to Use Track Markers]]'''
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Coupler Breakage HUD Rule'''==
+
 
 +
=='''Drive Via Trackmark'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
HUD displays warning about coupler stress and breakage
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_NavigateTo.png|50px|link=]]</td>
 
+
<td>Instructs the AI driver to Drive, via the shortest available path, to and through the designated Trackmark. If there are no further commands then the AI will halt after passing the trackmark. Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will '''NOT''' attempt to find a way around blockages when calculating the shortest path to the trackmark. All signals and speed signs are obeyed.</td>
*'''<kuid:-25:423>'''
+
 
+
*'''Built-in Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    Select one of two option buttons:-
+
      '''( ) Show the Coupler Breakage Display'''
+
      '''( ) Hide the Coupler Breakage Display'''
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Coupler Breakage Check Rule|Coupler Breakage Check Rule]]''' - executes child rules if a coupler breaks
+
*'''[[#Set Coupler Masks Rule|Set Coupler Masks Rule]]''' - sets the coupling/decoupling masks on selected vehicles
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Display Custom HUD Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Show or hide the Custom Heads Up Display.
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid:-3:11209> Drive Via Trackmark'''
  
*'''<kuid:-3:10206>'''
+
*'''Base Command'''
  
*'''Base Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
Select '''<name of trackmark>''' from the session list
  
    '''Show or Hide the Custom Heads up Display''' - select one of two option buttons:-
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
      '''( ) Show the Custom Heads up Display'''
+
#This command is used to direct the AI along a set route to a final destination which is not normally the trackmark identified in this command.
      '''( ) Hide the Custom Heads up Display'''
+
#If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will not attempt to find an alternative path to the designated trackmark. This can lead to the train stopping and waiting indefinately until the blockage is removed.
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
*'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
+
*'''[[#Drive To Trackmark|Drive To Trackmark]]''' - stops at trackmark, will NOT seek alternative paths if blocked
*'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
+
*'''[[#Navigate To Trackmark|Navigate To Trackmark]]''' - stops at trackmark, will seek alternative paths if blocked
*'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers
+
*'''[[#Navigate Via Trackmark|Navigate Via Trackmark]]''' - drives through trackmark, will seek alternative paths if blocked
*'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
+
*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
+
*'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked
+
  
 
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
 
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Display_Custom_HUD_Rule</span>'''
+
*'''[[How to Use Track Markers]]'''
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Flash HUD Icon Rule'''==
+
 
 +
=='''Navigate To'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_IndustryIcon.png|50px|link=]]</td>
 
+
<td>Instructs the AI driver to Navigate, via the shortest available path, to the designated Industry (including Passenger Station). Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will attempt to find a way around blockages when calculating the shortest path to the industry. All signals and speed signs are obeyed.</td>
*'''<kuid:-25:968>'''
+
 
+
*'''Built-in Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    Select one of two option buttons:-
+
    '''( ) Flash the ''<click to select>'' icon on the ''<click to select>'' HUD panel for a period of ''<value>'' seconds'''
+
      TIP: Select the HUD panel first (the second ''<click to select>'' link).
+
      Available HUD panels are (select one):-
+
          '''Bottom Right Menu'''
+
          '''Camera Controls'''
+
          '''DCC Controls'''
+
          '''Driver Main Menu'''
+
      Available icons will depend on the HUD panel selected.
+
    '''( ) ''<Start/Stop>'' flashing the ''<click to select>'' icon on the ''<click to select>'' HUD panel'''
+
      TIP: Select the HUD panel first (the second ''<click to select>'' link).
+
      Available HUD panels are (select one):-
+
          '''Bottom Right Menu'''
+
          '''Camera Controls'''
+
          '''DCC Controls'''
+
          '''Driver Main Menu'''
+
      Available icons will depend on the HUD panel selected.
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
+
*'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
+
*'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers
+
*'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
+
*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
+
*'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''mc Display Custom HUD V2 Rule (SP2 and later)'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Shows or hides a graphical HUD which includes junction direction for the junction ahead. This rule has been superseded by the '''Quick CustomHUD Manager Rule (SP2 and later)'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid:-3:10058> Navigate To'''
  
*'''<kuid2:61392:1072:10>'''
+
*'''Base Command'''
  
*'''Legacy Rule''' (replaced by '''Quick CustomHUD Manager Rule (SP2 and later)''')
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
*'''DLS Rule''' by '''pguy'''
+
Select '''<name of industry>''' or industry enabled passenger station from the session list
 +
  if applicable '''<name/number of track or platform>''' for industries and stations that have identified active platforms, tracks or loading bays
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 +
:If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will attempt to find an alternative path to the destination. This can lead to the train traveling backwards and down the wrong track.
  
    '''Show or Hide the Custom Heads up Display''' - select one of two option buttons:-
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
    '''( ) Show the Custom Heads up Display'''
+
*'''[[#Drive To|Drive To]]''' - does not seek alternative paths if blocked
    '''( ) Hide the Custom Heads up Display'''
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
+
*'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
+
*'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers
+
*'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
+
*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
+
*'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Quick CustomHud Manager Rule (SP2 and later)'''==
+
=='''Navigate To Trackmark'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Allows the creation of new graphical heads up displays which are assigned to the drivers in Driver Mode. Replaces the '''mc Display Custom HUD V2 Rule (SP2 and later)'''
+
<table>
 +
<tr valign="top">
 +
<td>[[file:CMD_NavigateTo.png|50px|link=]]</td>
 +
<td>Instructs the AI driver to Navigate, via the shortest available path, to the designated Trackmark. Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will attempt to find a way around blockages when calculating the shortest path to the trackmark. All signals and speed signs are obeyed.</td>
 +
</tr>
 +
</table>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
*'''<kuid2:61392:5020:47>'''
+
*'''<kuid:-3:10149> Navigate To Trackmark'''
  
*'''DLS Rule''' by '''pguy'''
+
*'''Base Command'''
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
    '''''<Copy rule to data Clipboard>''''' - click to copy the data from the selected HUD to a special clipboard area used by the rules created by '''pguy'''.
+
Select '''<name of trackmark>''' from the session list
      This is NOT the standard OS clipboard.
+
    '''''<Paste rule data from Clipboard>''''' - if data is held in the special clipboard area, then click to paste that data into the selected HUD.
+
      This is NOT the standard OS clipboard.
+
    '''Current HUD Parameters'''
+
      '''HUD to select: ''<HUD name>''''' - click to select a HUD from those available. One or two default HUDs will be supplied.
+
      '''''new HUD''''' - click to create a new HUD display with default properties. You will be required to enter a name for the new HUD
+
      '''''clone HUD''''' - click to create a new HUD using the properties of the currently selected HUD. You will be required to enter a name for the new HUD
+
      '''''copy HUD''''' - copies (overwrites) the currently selected HUD with the properties of another HUD. You will be required to enter the name of the HUD to be copied
+
    For new, cloned or copied HUDs, additional commands will be shown:
+
      '''''rename HUD''''' - rename the selected HUD. You will be required to enter a new name for the HUD
+
      '''''delete HUD''''' - delete the currently displayed HUD
+
    In '''Driver Mode''' an additional command will be shown:
+
      '''''Assign hud to current train''''' - click to assign the currently selected HUD to the currently selected driver
+
    '''[x] hud is displayed (on)''' - check to display HUD in '''Driver Mode'''
+
    '''hud items nb entries max: ''<value>''''' - enter the maximum number of items to be displayed in the HUD. Maximum is 30.
+
    '''hud view limit: ''<value>''''' - enter the maximum look-ahead distance in metres for the HUD. Minimum value is 1000, maximum value is 10000.
+
    '''[x] display data in a centred window above orderbar''' - check to display the HUD centred on the screen just above the driver command bar in '''Driver Mode'''
+
    For each individual HUD property:
+
      '''[x] ''HUD property''''' - check to add this property to the HUD
+
  
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
:HUDs are assigned to drivers in '''Driver Mode''' by either adding a '''SetCustomHud (SP2 and later)''' command to individual drivers command lists or manually by clicking a green '''RM''' tool button displayed on the top menu and selecting '''Quick CustomHUD Manager''' from the menu.
+
:If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will attempt to find an alternative path to the destination. This can lead to the train traveling backwards and down the wrong track.
  
[[file:PageLink4.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Dependent Driver Commands:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
:'''The rule must be added to the Session for the following Driver Commands to work'''
+
*'''[[#Drive To Trackmark|Drive To Trackmark]]''' - stops at trackmark, will NOT seek alternative paths if blocked
*'''[[Driver Commands List#Set Custom HUD (SP2 and later)|Set Custom HUD (SP2 and later)]]'''
+
*'''[[#Drive Via Trackmark|Drive Via Trackmark]]''' - drives through trackmark, will NOT seek alternative paths if blocked
 +
*'''[[#Navigate Via Trackmark|Navigate Via Trackmark]]''' - drives through trackmark, will seek alternative paths if blocked
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
*'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
+
*'''[[How to Use Track Markers]]'''
*'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
+
*'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
+
*'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
+
*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
+
*'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Show/Hide HUD Panel Rule'''==
 
</td>
 
</tr>
 
</table>
 
  
Shows or hides a HUD panel.
+
=='''Navigate Via Trackmark'''==
 
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
 
+
*'''<kuid:-25:1047>'''
+
 
+
*'''Built-in Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''''<Show/Hide>'' the ''<click to select>'' HUD panel''' - select '''''Show''''' or '''''Hide''''' and then select the HUD panel
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
+
*'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
+
*'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
+
*'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers
+
*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
+
*'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Variable Show Rule'''==
+
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Adds or removes a specified variable and a descriptive label to the custom HUD. This rule does not make the custom HUD appear on the screen.
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_NavigateTo.png|50px|link=]]</td>
 
+
<td>Instructs the AI driver to Drive, via the shortest available path, to and through the designated Trackmark. If there are no further commands then the AI will halt after passing the trackmark. Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will attempt to find a way around blockages when calculating the shortest path to the trackmark. All signals and speed signs are obeyed.</td>
*'''<kuid:-25:971>'''
+
 
+
*'''Built-in Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
  '''[x] Add'''
+
      '''''<variable-name>''''' - enter variable-name to add to HUD. Variable-name is case sensitive.
+
      '''''<label>''''' - (optional) enter a short label to be displayed on the HUD in front of the variable value.
+
  '''[x] Remove'''
+
      '''''<variable-name>''''' - enter variable-name to remove from HUD. Variable-name is case sensitive.
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
+
*'''[[#Quick Session Variables Rule|Quick Session Variables Rule]]''' - allows the editing of session variables.
+
*'''[[#Variable Check Rule|Variable Check Rule]]''' - executes child rules according to the value of a specified variable.
+
*'''[[#Variable Modify Rule|Variable Modify Rule]]''' - changes the value of a specified variable.
+
*'''[[#Variable Modify Continuous Rule|Variable Modify Continuous Rule]]''' - continuously changes the value of a specified variable.
+
*'''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.
+
 
+
[[file:Ex.PNG|link=]] '''<u>Examples of Use:</u>'''
+
*'''[[How to Use Variables in Sessions (Examples)]]
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Wait for Click on HUD Icon Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules when the user clicks on a selected HUD icon
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid:-3:10209> Navigate Via Trackmark'''
  
*'''<kuid:-25:951> <kuid:-25:970>''' - two versions built-in with different kuids, both have the same properties
+
*'''Base Command'''
  
*'''Built-in Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
*'''Parent Rule'''
+
Select '''<name of trackmark>''' from the session list
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 +
#This command is used to direct the AI along a set route to a final destination which is not normally the trackmark identified in this command.
 +
#If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will attempt to find an alternative path to the designated trackmark. This can lead to the train traveling backwards and down the wrong track.
  
    '''[x] Trigger Once'''
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
    '''HUD Panel ''<Click>''''' - click choose from list:-
+
*'''[[#Drive To Trackmark|Drive To Trackmark]]''' - stops at trackmark, will NOT seek alternative paths if blocked
      '''Bottom Right Menu'''
+
*'''[[#Drive Via Trackmark|Drive Via Trackmark]]''' - drives through trackmark, will NOT seek alternative paths if blocked
      '''Camera Controls'''
+
*'''[[#Navigate To Trackmark|Navigate To Trackmark]]''' - stops at trackmark, will seek alternative paths if blocked
      '''DCC Controls'''
+
    '''Icon ''<Click>''''' - click to choose from list. Selections depends on HUD Panel chosen
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
+
*'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
+
*'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
+
*'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers
+
*'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
+
*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
+
  
 
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
 
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
*'''[[How to Use Parent and Child Rules]]'''
+
*'''[[How to Use Track Markers]]'''
 +
 
 
<br>
 
<br>
<table width="100%" bgcolor=#ffff88>
+
<table bgcolor=#a8ff8a>
 
<tr>
 
<tr>
 
<td>
 
<td>
Line 2,136: Line 1,211:
 
</table>
 
</table>
  
<table width="100%" bgcolor=#ffff88>
+
<table width="100%" bgcolor=#a8ff8a>
 
<tr>
 
<tr>
 
<td>
 
<td>
='''Industry Rules'''=
+
 
 +
='''Session Management Commands'''=
 
</td>
 
</td>
 
</tr>
 
</tr>
Line 2,145: Line 1,221:
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Advanced Industry Load Configuration Rule'''==
+
=='''Copy Commands From'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Locks train controls when loading/unloading at an industry, overrides time settings for begin load and begin unload operations
+
<table>
 +
<tr valign="top">
 +
<td>[[file:CMD_CopyCommandsFrom.png|50px|link=]]</td>
 +
<td>Copies a driver schedule from a schedule library or another driver.</td>
 +
</tr>
 +
</table>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
*'''<kuid:30501:100007>'''
+
*'''<kuid2:192081:1:7> Copy Commands From'''
  
*'''Base Rule'''
+
*'''Built-in Command''' by '''brummfondel'''
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
    '''Target object ''<select>''''' - select industry object from session list
+
'''Append''' - '''From Library''' - select a saved schedule from Schedule Library and add it to the end of the current schedule (if any)
    '''[x] Lock the train's controls during a stopped load/unload operation''' - check to disable driver controls while train is stopped and loading/unloading
+
'''Append''' - '''From Vehicle''' - select a vehicle, copy its driver commands and add them to the end of the current schedule (if any)
    '''[x] Override 'begin load' and 'begin unload' durations to ''<value>'' seconds''' - if checked enter number of seconds to override
+
'''Insert''' - '''From Library''' - select a saved schedule from Schedule Library and insert it into the current schedule (if any)
 +
'''Insert''' - '''From Vehicle''' - select a vehicle, copy its driver commands and insert them into the current schedule (if any)
  
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+
[[file:PageLink3.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Required Session Rules:</span><br>
:Times are Trainz clock time, not real time
+
:'''Rules that MUST be added to the Session for this Driver Command to operate'''
 +
*'''[[Session_Rule_List_with_Parameters#Schedule Library Rule|Schedule Library Rule]]'''
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Disable/Enable Industry Rule'''==
+
=='''Delete Train'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Enables/Disables vehicle load/unload for industry
+
<table>
 +
<tr valign="top">
 +
<td>[[file:CMD_DeleteTrain.png|50px|link=]]</td>
 +
<td>Deletes the train from the session.</td>
 +
</tr>
 +
</table>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
*'''<kuid2:401543:1171:1>'''
+
*'''<kuid2:116387:15:3> Delete Train'''
  
*'''Built-in Rule'''
+
*'''Built-in Command''' by '''maggs'''
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
  '''Load/unload ''<Disable/Enable>''''' - click to set to '''Disable''' or '''Enable'''
+
'''None'''
  '''Which Industry? ''<select>''''' - click to set Industry from Session List
+
  '''Which Vehicles:''' - select one of two option buttons:-
+
      '''( ) Apply to every vehicle in the session'''
+
      '''( ) Apply only to a specific vehicles from Session List'''
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''ExTrainz Manager Rule - TANE SP2'''==
+
=='''Insert Buff Label'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Provides information on consists, industries and products in both Surveyor and Driver modes. Once activated, the rule creates an additional short menu bar below the main menu bar.
+
<table>
 +
<tr valign="top">
 +
<td>[[file:CMD_InsertBuffLabel.png|50px|link=]]</td>
 +
<td>Inserts a driver command as a label for a block of driver commands.</td>
 +
</tr>
 +
</table>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
*'''<kuid:160293:10029>'''
+
*'''<kuid:160293:101002> Insert buff label'''
  
*'''DLS Rule''' by '''trev999'''
+
*'''DLS Command''' by '''trev999'''
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
    '''Diagnostic mode is ''<On/Off>''''' - click to select ''On'' or ''Off''. When set ''On'' diagnostic messages will be added to the Trainz Log file.
+
'''Select ''<label number>''''' - select the label number (1 to 10)
    '''Turn on message overlay ''<Yes/No>''''' - click to select ''Yes'' or ''No''. When set to ''Yes'' the message overlay (lower left of screen) will be active.
+
    '''Show rolling stock in Driver mode ''<Yes/No>''''' - click to select ''Yes'' or ''No''. When set to ''Yes'' rolling stock can be searched in Driver.
+
    '''Search only rolling stock already in session ''<Yes/No>''''' - click to select ''Yes'' or ''No''. When set to ''Yes'' only those rolling stock assets
+
      installed in the session can be searched.
+
    '''Graphic colours: ''<When Red, the industry does not require service/When Green, the industry does not require service>''''' - click to switch
+
      between the two colour options.
+
    '''Industry page size: ''<value>''''' - enter the number of industries to be displayed in the Industry List window (maximum 250).
+
    '''The following industries are excluded: ''<Add an industry to be excluded>''''' - name can be complete (e.g. "Coal Mine 2")  
+
      which will exclude that specific industry from the management list, or partial (e.g. "Coal") which will exclude all
+
      industries with the word "Coal" in their names. Entries are not case sensitive.
+
      Once industries have been excluded, additional commands will appear for each excluded industry:-
+
      '''''<delete> <industry name begins with/class name begins with> <name>''''' - click ''delete'' to remove this entry.
+
          - click ''industry name begins with/class name begins with'' to select between the two (see ''notes'' below).
+
          - click ''name'' to edit the name.
+
  
[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
:This rule is NOT compatible with all industries.
+
:Up to 10 labels can be inserted into each drivers command list
  
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
#Rolling stock installed in the current session only (see settings above) can be searched to find a match for any selected product from any industry. In Surveyor (and Driver if that setting is enabled) click on the '''View Products''' sub menu link and click on a product name in the '''Product Window''' to display a list of all compatible rolling stock for that product.
+
*'''[[#Jump to Label|Jump to Label]]''' - unconditionally jumps to a named command label
#Alternatively, click on the '''View Industries''' sub menu link and then click on a ''Product Icon'' to open a '''Product Window''', then click    on the '''''View Rolling Stock''''' link at the top of the window.
+
*'''[[#Skip if Session-Variable|Skip if Session Variable]]''' - conditionally jumps to the named command label if a selected session variable meets a set condition
#Industry class names are defined in the config.txt file of industry assets and are not normally accessible by users. However, you can exclude an entire group of related "industry asset classes" such as ''station'', ''coalingtower'', ''watertank'', etc regardless of their actual names provided those assets have been given that "class name" by their creators.
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Multiple Resource Check Rule'''==
+
=='''Jump to Label'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules if industries or vehicles reach set commodity levels. This rule replaces the older '''Resource Check Rule'''
+
<table>
 +
<tr valign="top">
 +
<td>[[file:CMD_JumpToLabel.png|50px|link=]]</td>
 +
<td>Unconditionally jumps to a named command label.</td>
 +
</tr>
 +
</table>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
*'''<kuid:-25:656>'''
+
*'''<kuid2:160293:101003:2> Jump to label'''
  
*'''Built-in Rule'''
+
*'''DLS Command''' by '''trev999'''
  
*'''Parent Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
'''Select ''<label number>''''' - select the label number (1 to 20)
 
+
    '''<Product Level>''' - click to select a product test from two choices:-
+
      '''''Reach/Exceed''''' - sets an upper limit for the resources being monitored.
+
          For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon reaches or exceeds a specified level.
+
          The initial level in the object must be below the set upper limit.
+
      '''''Fall below''''' - sets a lower limit for the resources being monitored.
+
          For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon falls below a specified level.
+
          The initial level in the object must be above the set lower limit.
+
          To test when a resource level reaches zero (i.e. is empty) set the lower limit to a very low value but not zero as the level can never fall below zero.
+
    '''''<value>''''' - enter required quantity value
+
    '''''<select>''''' - select a product from session list of products
+
    '''''<Add object>''''' - click to select a source or target object. Multiple objects and their queues can be added to the rule.
+
      ALL the entered products must reach/exceed or fall below the specified value for the rule to be triggered.
+
      For each object:-
+
          '''''<Object>''''' - click to select session active industry or product enabled rail vehicle
+
          '''''<Queue>''''' - select product queue (there may be only one available)
+
          '''''<Remove>''''' - removes the object and its product queue from the rule
+
  
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
:This rule only checks for ''changing'' commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is ''full'' or ''empty''.
+
:A '''label''' ('''Insert Buff label''' driver command) with the matching label number must be added to the driver commands
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
*'''[[#Resource Check Rule|Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
+
*'''[[#Insert Buff Label|Insert Buff Label]]''' - inserts a driver command as a label for a block of driver commands
*'''[[#Resource Verify Rule (fixed)|Resource Verify Rule (fixed)]]''' - executes child rules when a set resource (commodity) level is reached
+
*'''[[#Skip if Session-Variable|Skip if Session Variable]]''' - conditionally jumps to the named command label if a selected session variable meets a set condition
 
+
[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+
*'''[[How to Use Navigation Point Rules (Applications)#Application 3: Wait for Loading to be Completed|How to Use Navigation Point Rules (Applications): Wait for Loading to be Completed]]'''
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[How to Use Parent and Child Rules]]'''
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Power Station Rule'''==
+
=='''Layer Control'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Sets up a Power Station and its electricity consumers
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_LayerControl.png|50px|link=]]</td>
 
+
<td>Shows or hides a selected layer.</td>
*'''<kuid:-25:746>'''
+
 
+
*'''Base Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''Power station ''<select>''''' - select a Power Station from the session list.
+
    '''Consumers:'''
+
      '''''<add object>''''' - add power consumers from the session list
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Resource Check Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules if a selected industry or vehicle reaches a set commodity level. This rule has been superseded by the '''Multiple Resource Check Rule'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid:160293:101080> Layer Control'''
  
*'''<kuid:-25:1067>'''
+
*'''DLS Command''' by '''trev999'''
  
*'''Legacy Rule''' (replaced by '''Multiple Resource Check Rule''')
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
*'''Built-in Rule'''
+
'''Show ''<list of layers in route and session>''''' - select a layer to make visible
 +
'''Hide ''<list of layers in route and session>''''' - select a layer to make invisible
  
*'''Parent Rule'''
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Session Rules:</span>
 +
*'''[[Session_Rule_List_with_Parameters#Show.2FHide_Layer_Rule|Show/Hide Layer Rule]]'''
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
 
+
*'''[[How_to_Use_Layers#Layers_in_Driver_Mode|Layers in Driver Mode]]'''
    Select one of two option buttons:-
+
      '''( ) Watch industry queue'''
+
          '''Target Object ''<select>''''' - select an industry from the session list
+
          '''Queue ''<select>''''' - select a product queue from the selected industry
+
          '''Product ''<select>''''' - select a product from the selected queue
+
          '''Amount ''<value>''''' - enter a quantity
+
          Select one of two option buttons:-
+
            '''( ) Complete when designated queue equals or exceeds required amount'''
+
            '''( ) Complete when designated queue falls below required amount'''
+
      '''( ) Watch vehicle'''
+
          '''Target Object ''<select>''''' - select a rolling stock asset from the session list
+
          '''Queue ''<select>''''' - select a product queue from the selected rolling stock
+
          '''Product ''<select>''''' - select a product from the selected queue
+
          '''Amount ''<value>''''' - enter a quantity
+
          Select one of two option buttons:-
+
            '''( ) Complete when designated queue equals or exceeds required amount'''
+
            '''( ) Complete when designated queue falls below required amount'''
+
 
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+
:This rule only checks for ''changing'' commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is ''full'' or ''empty''.
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Multiple Resource Check Rule|Multiple Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
+
*'''[[#Resource Verify Rule (fixed)|Resource Verify Rule (fixed)]]''' - executes child rules when a set resource (commodity) level is reached
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[How to Use Parent and Child Rules]]'''
+
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Resource_Check_Rule</span>'''
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Resource Verify Rule (fixed)'''==
+
=='''Move to Train'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules if a selected industry or vehicle reaches a set commodity level. The rule resets when all child rules have completed.
+
<table>
 +
<tr valign="top">
 +
<td>[[file:CMD_MoveToTrain.png|50px|link=]]</td>
 +
<td>Moves the driver with all their remaining driver commands to another train.</td>
 +
</tr>
 +
</table>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
*'''<kuid:160293:10060>'''
+
*'''<kuid2:71155:60004:2> Move to train'''
  
*'''DLS Rule''' by '''trev999
+
*'''DLS Command''' by '''_mutton_'''
  
*'''Parent Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
'''All trains ''<list of locomotives>''''' - select a locomotive from the Session list
 
+
    Select one of two option buttons:-
+
    '''( ) Watch industry queue'''
+
      '''Target object ''<click to select>''''' - click to select an industry from the session list.
+
      '''Product ''<click to select>''''' - click to select an industry product.
+
      '''Amount ''<value>''''' - enter a quantity for the selected product.
+
      Select one of two option buttons:-
+
      '''( ) Complete when designated queue equals or exceeds designated amount'''
+
      '''( ) Complete when designated queue falls below designated amount'''
+
    '''( ) Watch vehicle queue'''
+
      '''Target object ''<click to select>''''' - click to select a rolling stock vehicle from the session list.
+
      '''Product ''<click to select>''''' - click to select a commodity product.
+
      '''Amount ''<value>''''' - enter a quantity for the selected product.
+
      Select one of two option buttons:-
+
      '''( ) Complete when designated queue equals or exceeds designated amount'''
+
      '''( ) Complete when designated queue falls below designated amount'''
+
  
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
#This rule will only monitor a single commodity in a single industry or vehicle.
+
#The new train must not already have a driver - make sure that the '''Generate New Drivers for Empty Trains''' option in the '''Driver Setup Rule''' is not ticked.
#This rule only checks for ''changing'' commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is ''full'' or ''empty''.
+
#If the new train does already have a driver then the command and any following commands will not be executed.
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Multiple Resource Check Rule|Multiple Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
+
*'''[[#Resource Check Rule|Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
+
  
 
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
 
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
*'''[[How to Use Parent and Child Rules]]'''
+
*'''[[How_to_Use_Driver_Setup_Rule|How to Use the Driver Setup Rule]]'''
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Station Visited Check Rule'''==
+
=='''Set Custom HUD (SP2 and later)'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules if specific trains call at set stations or industries
+
<table>
 +
<tr valign="top">
 +
<td>[[file:CMD_SetCustomHUD.png|50px|link=]]</td>
 +
<td>Sets a predefined HUD on the screen.</td>
 +
</tr>
 +
</table>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
*'''<kuid2:60850:89005:3>'''
+
*'''<kuid2:61392:7006:37> SetCustomHud (SP2 and later)'''
  
*'''Built-in Rule'''
+
*'''DLS Command''' by '''pguy'''
  
*'''Parent Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
'''''<defHud>''''' - select the default HUD
 +
'''''<altHud>''''' - select the alternate HUD
 +
'''''<named Hud>''''' - select from a number of user defined HUDs
  
    '''Trigger: ''<select>''''' - click to select one of the following
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
      '''''Never''''' - stopping at the selected industries will never trigger the rule.
+
#the '''Quick CustomHud Manager Rule (SP2 and later)''' must be added to a session for a HUD to be selected by this command
      '''''Once only''''' - the rule is triggered on the first visit only to any one of the selected industries
+
#the default and alternate HUDs are preset but can be edited using the above rule
      '''''Once per industry''''' - the rule is triggered on the first visit to each industry with each individual product
+
#additional user defined and named HUDs can be created with the '''Quick CustomHud Manager Rule (SP2 and later)'''
      '''''Once per visit''''' - the rule is triggered on the first visit to each industry regardless of the product
+
 
      '''''Once per vehicle''''' - each vehicle can only trigger the rule once.
+
[[file:PageLink3.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Required Session Rules:</span><br>
    '''''<select industry>''''' - select industry or industries from session list
+
:'''Rules that MUST be added to the Session for this Driver Command to operate'''
    Select one of two option buttons:-
+
*'''[[Session_Rule_List_with_Parameters#Quick_CustomHud_Manager_Rule_(SP2_and_later)|Quick CustomHud Manager Rule (SP2 and later)]]'''
      '''( ) click to accept all trains'''
+
      '''( ) click to accept trains matching specific criteria'''
+
          Selecting the second option will produce the following selection controls:-        
+
          '''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
+
            '''''+''''' - click to add a ''specific'' vehicle from the session list
+
            '''''x''''' - click to remove the ''specific'' vehicle from the rule
+
          '''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule
+
            '''''+''''' - click to add a ''type'' of vehicle from the session list
+
            '''''x''''' - click to remove the ''type'' of vehicle from the rule
+
          '''Drivers''''' - identify the ''drivers'' that will trigger the rule
+
            '''''+''''' - click to add a ''driver'' from the session list
+
            '''''x''''' - click to remove a ''driver'' from the rule
+
  
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
 
*'''[[How to Use Parent and Child Rules]]'''
 
 
<br>
 
<br>
<table width="100%" bgcolor=#ffff88>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
'''[[#top|Back to Top]]'''
 
</td>
 
</tr>
 
</table>
 
  
<table width="100%" bgcolor=#ffff88>
+
=='''Skip if Session-Variable'''==
<tr>
+
<td>
+
='''Interlocking Tower, Junction and Signal Rules'''=
+
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
<br>
+
<table>
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr valign="top">
<tr>
+
<td>[[file:CMD_SkipIfSVar.png|50px|link=]]</td>
<td>
+
<td>Jumps to the named command label if a selected session variable meets a set condition.</td>
=='''Control Path Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Sets the path for selected trains
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:160293:101014:3> Skip if session-variable'''
  
*'''<kuid:131986:158781>'''
+
*'''DLS Command''' by '''trev999'''
  
*'''DLS Rule''' by '''atilabarut'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
*'''Legacy Rule''' (replaced by '''Interlocking Tower Rules''')
+
'''Select ''<label number if>''''' - select the label number (1 to 20)
 +
    '''''<Variable Name>''''' - from the '''InputTable Rule'''
 +
      '''''<condition>''''' - from the '''InputTable Rule'''
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 +
#The '''InputTable Rule''' must be installed in the session before this command can be used. This rule must be configured to identify the session variable(s), test condition(s) and value(s).
 +
#A '''label''' ('''Insert Buff Label''' driver command) with the matching label number must be added to the driver commands
  
  '''<add junction>''''' - click to add a junction from the Session list
+
[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
    For each junction:-
+
*'''TANE''' Sessions containing driver commands that use variables ''may not'' work correctly when imported into '''TRS19''' and '''Trainz Plus'''. The solution is to delete and then reinsert these commands in the imported Sessions
      '''Set switch to ''<RIGHT/LEFT/FORWARD>''''' - click to select one junction state
+
      '''Exiting from ''<FORWARD/BACKWARD/LEFT/RIGHT>''''' - click to select the direction the train exits from the junction
+
      '''Permit type ''<EXCLUSIVE/DIRECTIONAL>''''' - click to select permission type.
+
          ''DIRECTIONAL'' permits all trains heading in the same direction to use the set path.
+
          ''EXCLUSIVE'' only allows one train to use the path at a time
+
      '''''<up>''''' - move the junction UP one level in the list
+
      '''''<dn>''''' - move the junction DOWN one level in the list
+
      '''''<rm>''''' - remove the junction from the list
+
  '''Name of the signal before entering the path ''<signal name>''''' - click to select the signal before the first junction from the Session signal list
+
  '''Signal state in case the path is not cleared ''<GREEN/RED/YELLOW>''''' - click to select a signal state
+
  '''Train for which path is controlled ''<train>''''' - click to select a consist from the Session list
+
  '''Rule activates on train entering trigger ''<trigger name>''''' - click to select a start trigger from the Session list
+
  '''Rule exits on train entering trigger ''<trigger name>''''' - click to select an end trigger from the Session list
+
  
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
#This rule may not be compatible with Interlocking Towers.
+
*'''[[#Insert Buff Label|Insert Buff Label]]''' - inserts a driver command as a label for a block of driver commands
#Triggers have to be placed before the first junction and controlling signal and after the final junction.
+
*'''[[#Jump to Label|Jump to Label]]''' - unconditionally jumps to a named command label
#Multiple paths can be set up by placing multiple copies of this rule under an '''Ordered List''' or '''Simultaneous List'''
+
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:PageLink3.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Required Session Rules:</span><br>
*'''[[#Junction Derailment Prevention Rule|Junction Derailment Prevention Rule]]''' - sets opposing junctions ahead of a train to prevent derailments
+
:'''Rules that MUST be added to the Session for this Driver Command to operate'''
*'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
+
*'''[[Session Rule List with Parameters#InputTable Rule|InputTable Rule]]'''
*'''[[#Multiple Junction Alignment Check Rule|Multiple Junction Alignment Check Rule]]''' - executes child rules when junctions are aligned
+
*'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Interlocking Tower Configure Path Rule'''==
+
 
 +
=='''Wait Until S-Variable V3'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Alters settings on an interlocking tower path
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_WaitSVariable.png|50px|link=]]</td>
 
+
<td>The AI driver will wait until the identified variable matches the condition specified before the next command will be executed</td>
*'''<kuid:401543:3205>'''
+
 
+
*'''Base Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
  '''Interlocking Tower ''<select>''''' - to set Name and Objects
+
 
+
[[file:BugMini.PNG|link=]] <span style="color: red; text-decoration: underline; font-weight: 700;">Known Bugs</span><span style="color: red; font-weight: 700;">:</span>
+
:The '''Interlocking Tower''' and '''Enhanced Interlocking Tower''' assets have a bug that saves their initial paths and properties in the Route and then saves any edits you make in the Session. The workaround is to always use Session Surveyor when using ITs and EITs.
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Interlocking Tower Path Selection UI Rule|Interlocking Tower Path Selection UI Rule]]''' - automatically reacts to messages from Interlocking Towers and displays a path selection dialog to the player.
+
*'''[[#Interlocking Tower Set Path Rule|Interlocking Tower Set Path Rule]]''' - sets the state of an interlocking tower path for a train
+
*'''[[#Interlocking Tower Enhanced Manager Rule (SP2 and later)|Interlocking Tower Enhanced Manager Rule (SP2 and later)]]''' - more management and control options for interlocking towers.
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Interlocking Tower Path Selection UI Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Will automatically react to messages from Interlocking Towers and display a path selection dialog to the player. Disable by removing rule from session
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:160293:101006:3> Wait Until S-variable V3'''
  
*'''<kuid:401543:3203>'''
+
*'''DLS Command''' by '''trev999'''
  
*'''Base Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
'''Select ''<Variable Name>''''' - select the variable name from those entered in the '''InputTable Rule'''
 +
    '''Select <Condition><Value>''''' - select from those entered in the '''InputTable Rule'''
  
  '''[Checkbox] Show path activation message in Driver'''
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 +
*The '''InputTable Rule''' must be installed in the session before this command can be used. This rule must be configured to identify the session variable(s), test condition(s) and value(s).
  
[[file:BugMini.PNG|link=]] <span style="color: red; text-decoration: underline; font-weight: 700;">Known Bugs</span><span style="color: red; font-weight: 700;">:</span>
+
[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
:The '''Interlocking Tower''' and '''Enhanced Interlocking Tower''' assets have a bug that saves their initial paths and properties in the Route and then saves any edits you make in the Session. The workaround is to always use Session Surveyor when using ITs and EITs.
+
*'''TANE''' Sessions containing driver commands that use variables ''may not'' work correctly when imported into '''TRS19''' and '''Trainz Plus'''. The solution is to delete and then reinsert these commands in the imported Sessions
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:PageLink3.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Required Session Rules:</span><br>
*'''[[#Interlocking Tower Configure Path Rule|Interlocking Tower Configure Path Rule]]''' - alters the settings on an interlocking tower path
+
:'''Rules that MUST be added to the Session for this Driver Command to operate'''
*'''[[#Interlocking Tower Set Path Rule|Interlocking Tower Set Path Rule]]''' - sets the state of an interlocking tower path for a train
+
*'''[[Session Rule List with Parameters#InputTable Rule|InputTable Rule]]'''
*'''[[#Interlocking Tower Enhanced Manager Rule (SP2 and later)|Interlocking Tower Enhanced Manager Rule (SP2 and later)]]''' - more management and control options for interlocking towers.
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Interlocking Tower Set Path Rule'''==
+
 
 +
=='''WaitUntilSVariable'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Will set the state of an interlocking tower path for a train
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_WaitSVar.png|50px|link=]]</td>
 
+
<td>The AI driver will wait until the identified variable matches the condition specified before the next command will be executed</td>
*'''<kuid:401543:3204>'''
+
 
+
*'''Base Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
  '''Interlocking Tower ''<select>''''' - to set Name and Objects
+
 
+
[[file:BugMini.PNG|link=]] <span style="color: red; text-decoration: underline; font-weight: 700;">Known Bugs</span><span style="color: red; font-weight: 700;">:</span>
+
:The '''Interlocking Tower''' and '''Enhanced Interlocking Tower''' assets have a bug that saves their initial paths and properties in the Route and then saves any edits you make in the Session. The workaround is to always use Session Surveyor when using ITs and EITs.
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Interlocking Tower Configure Path Rule|Interlocking Tower Configure Path Rule]]''' - alters the settings on an interlocking tower path
+
*'''[[#Interlocking Tower Path Selection UI Rule|Interlocking Tower Path Selection UI Rule]]''' - automatically reacts to messages from Interlocking Towers and displays a path selection dialog to the player.
+
*'''[[#Interlocking Tower Enhanced Manager Rule (SP2 and later)|Interlocking Tower Enhanced Manager Rule (SP2 and later)]]''' - more management and control options for interlocking towers.
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Interlocking Tower Enhanced Manager Rule (SP2 and later)'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Provides more management and control options for interlocking towers.
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:131986:1006:1> WaitUntilSVariable'''
  
*'''<kuid2:61392:8130:41>'''
+
*'''DLS Command''' by '''atilabarut'''
  
*'''DLS Rule''' by '''pguy'''
+
*'''Legacy Command''' has been replaced by '''Wait Until S-Variable'''
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
    '''''<towers>''''' - click to select interlocking towers from the session list
+
'''Select ''<Variable Name><Condition><Value>''''' - from the '''InputTable Rule'''
      '''''<do full check again>''''' - click to run an error check on all interlocking towers
+
      '''List of all available interlocking towers''' - for each tower:-
+
          '''''<view details>''''' - click to view and edit the tower properties
+
          '''''<copy from>''''' - click to copy properties from another tower selected from the session list
+
    '''''<debug log>''''' - click to set the debug log properties
+
  
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
*It is recommended that you refer to the detailed instructions in the Trainz Wiki shown below.
+
*The '''InputTable Rule''' must be installed in the session before this command can be used. This rule must be configured to identify the session variable(s), test condition(s) and value(s).
  
[[file:BugMini.PNG|link=]] <span style="color: red; text-decoration: underline; font-weight: 700;">Known Bugs</span><span style="color: red; font-weight: 700;">:</span>
+
[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
:The '''Interlocking Tower''' and '''Enhanced Interlocking Tower''' assets have a bug that saves their initial paths and properties in the Route and then saves any edits you make in the Session. The workaround is to always use Session Surveyor when using ITs and EITs.
+
*'''TANE''' Sessions containing driver commands that use variables ''may not'' work correctly when imported into '''TRS19''' and '''Trainz Plus'''. The solution is to delete and then reinsert these commands in the imported Sessions
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
*'''[[#Interlocking Tower Configure Path Rule|Interlocking Tower Configure Path Rule]]''' - alters the settings on an interlocking tower path
+
*'''[[#Wait Until S-Variable V3|Wait Until S-Variable V3]]''' - AI driver waits for specified variable condition
*'''[[#Interlocking Tower Path Selection UI Rule|Interlocking Tower Path Selection UI Rule]]''' - automatically reacts to messages from Interlocking Towers and displays a path selection dialog to the player.
+
*'''[[#Interlocking Tower Set Path Rule|Interlocking Tower Set Path Rule]]''' - sets the state of an interlocking tower path for a train
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Enhanced_Interlocking_Tower_Manager_Rule</span>'''
+
  
 +
[[file:PageLink3.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Required Session Rules:</span><br>
 +
:'''Rules that MUST be added to the Session for this Driver Command to operate'''
 +
*'''[[Session Rule List with Parameters#InputTable Rule|InputTable Rule]]'''
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table bgcolor=#a8ff8a>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Junction Derailment Prevention Rule'''==
+
'''[[#top|Back to Top]]'''
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Sets opposing (trailing) junctions ahead of a train to prevent derailments.  Works with both AI and manually driven trains.
+
<table width="100%" bgcolor=#a8ff8a>
 
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
 
+
*'''<kuid2:121843:100282:1>'''
+
 
+
*'''DLS Rule''' by '''pitkin'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''None'''
+
 
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+
:This rule will not overrule a junction already locked by another AI train or locked against AI control using the '''Set Junctions Rule'''.
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
+
*'''[[#Set Cleared Junctions Rule|Set Cleared Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.
+
*'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Lock All Junctions Rule'''==
+
 
 +
='''Train Operation Commands'''=
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
Locks all junctions against user actions. AI operations are not affected. Once the AI releases a junction, it will be returned to its previous locked state.
 
 
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
 
 
*'''<kuid:400048:100971>'''
 
 
*'''DLS Rule''' by '''callavsg'''
 
 
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
 
 
    '''None'''
 
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
:Individual junctions can still be set, locked and unlocked by using the '''Set Junction Rule'''
 
 
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
 
*'''[[#Set Cleared Junctions Rule|Set Cleared Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.
 
*'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).
 
  
 
<br>
 
<br>
<table width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''MissionCode Manager Rule (SP2 and later)'''==
+
=='''Bellz'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Enables the addition, editing and management of Mission Codes used to auto select paths in '''Interlocking Towers'''.
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_Bellz.png|50px|link=]]</td>
 
+
<td>Rings the train bell.</td>
*'''<kuid2:61392:8200:50>'''
+
 
+
*'''DLS Rule''' by '''pguy'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
  Refer to the detailed instructions in the '''Trainz Wiki Links''' shown below.
+
 
+
[[file:PageLink4.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Dependent Driver Commands:</span>
+
:'''The rule must be added to the Session for the following Driver Commands to work'''
+
*'''[[Driver Commands List#AddMissionCode (SP2 and Later)|AddMissionCode (SP2 and Later)]]'''
+
*'''[[Driver Commands List#RemoveMissionCode (SP2 and Later)|RemoveMissionCode (SP2 and Later)]]'''
+
*'''[[Driver Commands List#SetMissionCode (SP2 and Later)|SetMissionCode (SP2 and Later)]]'''
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#MissionCode Stops and Timetable Manager Rule (SP2 and later)|MissionCode Stops and Timetable Manager Rule (SP2 and later)]]''' - creates and edits stop zones and timetables for trains with mission codes
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/MissionCodes_Manager</span>'''
+
 
+
<br>
+
<table width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''MissionCode Stops and Timetable Manager Rule (SP2 and later)'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Enables the creation, editing and management of stop zones and timetables for trains following a path defined using mission codes.
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:66277:80002:1> bellz'''
  
*'''<kuid2:61392:8300:50>'''
+
*'''Built-in Command''' by '''smileyman'''
  
*'''DLS Rule''' by '''pguy'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
'''None'''
  Refer to the detailed instructions in the '''Trainz Wiki Links''' shown below.
+
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
*'''[[#MissionCode Manager Rule (SP2 and later)|MissionCode Manager Rule (SP2 and later)]]''' - creates and edits mission codes for trains
+
:the locomotive must be equipped with a working bell.
  
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Mission_Code_Stops_and_TimeTables_Manager</span>'''
+
*'''[[#Hornz|Hornz]]''' - gives a blast of the horn (or whistle)
 +
*'''[[#HornzExtended|HornzExtended]]''' - gives a specified number of horn blasts
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Multiple Junction Alignment Check Rule'''==
+
=='''Couple'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules if specific junctions are set.
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_Couple.png|50px|link=]]</td>
 
+
<td>The AI driver moves the train (or just the locomotive if it is by itself) to couple with the specified wagon.</td>
*'''<kuid:-25:168>'''
+
 
+
*'''Built-in Rule'''
+
 
+
*'''Parent Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''Wait until ''<selection>''''' - select from:-
+
      '''any one''' - any of the junctions in the rule list (below) is set correctly
+
      '''all''' - ALL of the junctions in the rule list are set correctly
+
    '''''<Add junction>''''' - click to select a junction from the session list
+
    '''''<Add all>''''' - click to select ALL junctions in the session list
+
    '''''<Delete all>''''' - click to delete ALL selected junctions from the rule list
+
      For each selected junction:-
+
      '''''<setting>''''' - click to select one switch direction from:-
+
          '''Left'''
+
          '''Right'''
+
          '''Center'''
+
          '''Any'''
+
      '''''<remove>''''' - to delete this junction from the rule list
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Control Path Rule|Control Path Rule]]''' - sets the path for selected trains
+
*'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
+
*'''[[#Set Cleared Junctions Rule|Set Cleared Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.
+
*'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).
+
 
+
[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+
*'''[[How to Control Junctions in Sessions]]'''
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[How to Use Parent and Child Rules]]'''
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Set Cleared Junctions Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied. If a junction is occupied it waits until the junction is cleared. '''''Warning:'' not compatible with Interlocking Tower Assets'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid:-3:10081> Couple'''
  
*'''<kuid2:131986:157661:1>'''
+
*'''Base Command'''
  
*'''DLS Rule''' by '''atilabarut'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
  '''''<list of available wagons>''''' - select a wagon to couple to
 
+
 
    '''''Add Junction''''' - click to select a junction from the session junction list
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
    '''''Add All''''' - click to add ALL junctions in the session junction list
+
#The target wagon must be at the end of a consist or by itself. If the target is coupled in between other wagons then no coupling will take place.
    '''''Delete All''''' - click to remove ALL entered junctions from the rule
+
#There must be a clear path to the target wagon.
      '''Junction Options:''' - for each selected junction:-
+
          '''''<direction>''''' - click to select the junction direction
+
            '''Left'''
+
            '''Center'''
+
            '''Right'''
+
            '''Don't change'''
+
          '''''<user control>''''' - click to select a user control option
+
            '''Locked''' - the junction setting cannot be changed by the user
+
            '''Unlocked''' - the junction setting can be changed by the user
+
          '''''<AI control>''''' - click to select AI control
+
            '''Allows AI control''' - an AI train can switch the junction
+
            '''Blocks AI control''' - an AI train cannot switch the junction
+
          '''''Remove''''' - click to remove this junction from the rule list
+
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
*'''[[#Control Path Rule|Control Path Rule]]''' - sets the path for selected trains
+
*'''[[#Couple At Trackmark|Couple At Trackmark]]''' - couples to the wagon closest to a specified trackmark
*'''[[#Junction Derailment Prevention Rule|Junction Derailment Prevention Rule]]''' - sets opposing junctions ahead of a train to prevent derailments
+
*'''[[#Decouple|Decouple]]''' - decouples a consist at a specific place (does not work in the '''Driver Setup Rule''')
*'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
+
*'''[[#Decouple DLX|Decouple DLX]]''' - decouples a consist at a specific, or a random, place. Upto 99 wagons
*'''[[#Multiple Junction Alignment Check Rule|Multiple Junction Alignment Check Rule]]''' - executes child rules when junctions are aligned
+
*'''[[#Decouple Head N|Decouple Head N]]''' - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
*'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).
+
*'''[[#Decouple Number #|Decouple Number #]]''' - decouples a consist at a specific place. Upto 40 wagons
 +
*'''[[#Uncouplez|Uncouplez]]''' - decouples the locomotive (or locomotive + tender) from a consist
 +
*'''[[#UncouplezFrom|UncouplezFrom]]''' - decouples a consist at a specific place. Upto 20 wagons
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Set Junctions Rule'''==
+
=='''Couple At Trackmark'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control). '''''Warning:'' not compatible with Interlocking Tower Assets'''
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_Couple_At_Trackmark.png|50px|link=]]</td>
 
+
<td>The AI driver moves the train (or just the locomotive if it is by itself) to couple with the wagon that is closest to a specified trackmark.</td>
*'''<kuid:-25:1065>'''
+
 
+
*'''Built-in Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''''Add Junction''''' - click to select a junction from the session junction list
+
    '''''Add All''''' - click to add ALL junctions in the session junction list
+
    '''''Delete All''''' - click to remove ALL entered junctions from the rule
+
      '''Junction Options:''' - for each selected junction:-
+
          '''''<direction>''''' - click to select the junction direction
+
            '''Left'''
+
            '''Center'''
+
            '''Right'''
+
            '''Don't change'''
+
          '''''<user control>''''' - click to select a user control option
+
            '''Locked''' - the junction setting cannot be changed by the user
+
            '''Unlocked''' - the junction setting can be changed by the user
+
          '''''<AI control>''''' - click to select AI control
+
            '''Allows AI control''' - an AI train can switch the junction
+
            '''Blocks AI control''' - an AI train cannot switch the junction
+
          '''''Remove''''' - click to remove this junction from the rule list
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Control Path Rule|Control Path Rule]]''' - sets the path for selected trains
+
*'''[[#Junction Derailment Prevention Rule|Junction Derailment Prevention Rule]]''' - sets opposing junctions ahead of a train to prevent derailments
+
*'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
+
*'''[[#Multiple Junction Alignment Check Rule|Multiple Junction Alignment Check Rule]]''' - executes child rules when junctions are aligned
+
*'''[[#Set Cleared Junctions Rule|Set Cleared Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.
+
 
+
[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+
*'''[[How to Control Junctions in Sessions]]'''
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Set Signal Extended Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid:2:57145:81100:1> Couple At Trackmark'''
  
*'''<kuid2:47662:20002:4>'''
+
*'''DLS Command''' by '''marzipan'''
  
*'''Built-in Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''''<Select signal>'' to ''<signal state>''''' - click to select a signal from the session list and click to select a state from the list -
+
      '''Automatic'''
+
      '''Stop'''
+
      '''Stop then Continue'''
+
      '''Caution Left'''
+
      '''Caution Right'''
+
      '''Caution'''
+
      '''Advance Caution Left'''
+
      '''Advance Caution Right'''
+
      '''Advance Caution'''
+
      '''Proceed Left'''
+
      '''Proceed Right'''
+
      '''Proceed'''
+
      '''Slow'''
+
      '''Medium'''
+
  
 +
  '''''<list of available trackmarks>''''' - select a trackmark
 +
 
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
:The signal must support the state selected otherwise there will be no change in the signal
+
#The end wagon of a consist must be within the effect radius of the trackmark. If there is no wagon with the radius then no coupling will take place.
 +
#The train will couple to the wagon closest to the trackmark and that may mean navigating to the other end of the consist.
 +
#There must be a clear path to the target wagon.
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
*'''[[#Trigger Multiple Signals Rule|Trigger Multiple Signals Rule]]''' - sets selected signals to DANGER (STOP) when selected triggers are activated
+
*'''[[#Couple|Couple]]''' - couples wagons in a consist
 +
*'''[[#Decouple|Decouple]]''' - decouples a consist at a specific place (does not work in the '''Driver Setup Rule''')
 +
*'''[[#Decouple DLX|Decouple DLX]]''' - decouples a consist at a specific, or a random, place. Upto 99 wagons
 +
*'''[[#Decouple Head N|Decouple Head N]]''' - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
 +
*'''[[#Decouple Number #|Decouple Number #]]''' - decouples a consist at a specific place. Upto 40 wagons
 +
*'''[[#Uncouplez|Uncouplez]]''' - decouples the locomotive (or locomotive + tender) from a consist
 +
*'''[[#UncouplezFrom|UncouplezFrom]]''' - decouples a consist at a specific place. Upto 20 wagons
  
<br>
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
<table width=100% width=100% bgcolor=#ffffcc>
+
*'''[[How to Use Track Markers]]'''
<tr>
+
<td>
+
=='''Trigger Multiple Signals Rule'''==
+
</td>
+
</tr>
+
</table>
+
 
+
Sets selected signals to DANGER (STOP) when selected triggers are activated. Signals will be at AUTOMATIC when the triggers are not activated.
+
 
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
 
+
*'''<kuid2:116387:26:1>'''
+
 
+
*'''DLS Rule''' by '''maggs'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''<add signal>''' - select a signal from the Session List. More than one signal can be added.
+
      '''<delete>''' - remove a signal from the rule.
+
    '''<add trigger>''' - select a trigger from the Session List. More than one trigger can be added.
+
      '''<delete>''' - remove a trigger from the rule.
+
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
 
*'''[[#Set Signal Extended Rule|Set Signal Extended Rule]]''' -  sets a selected signal to a specific signal state
 
 
<br>
 
<br>
<table width="100%" bgcolor=#ffff88>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
'''[[#top|Back to Top]]'''
 
</td>
 
</tr>
 
</table>
 
  
<table width="100%" bgcolor=#ffff88>
+
=='''Decouple'''==
<tr>
+
<td>
+
='''Message Rules'''=
+
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
<br>
+
<table>
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr valign="top">
<tr>
+
<td>[[file:CMD_Decouple.png|50px|link=]]</td>
<td>
+
<td>The train is decoupled at the specified wagon (does not work in '''Driver Setup Rule''').</td>
=='''Close Message Popup Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Closes open message popups
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid:-3:10082> Decouple'''
  
*'''<kuid:447264:1526>'''
+
*'''Base Command'''
  
*'''Built-in Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
   '''''<list of available wagons>''''' - select a wagon to decouple from
 
+
   '''None'''
+
  
 
[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
 
[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
:This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule
+
*This command does not work when added to a driver's command list in the '''Driver Setup Rule''' in Surveyor but it does work when manually added to the driver's command list in Driver
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
*'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
+
#If programming a driver via the '''Driver Setup Rule''', use the alternative commands '''Decouple DLX''', '''Decouple Number #''', '''Uncouplez''' or '''UncouplezFrom'''
 +
#The main problem with using decoupling commands in the '''Driver Setup Rule''' is that the number and identity of the wagons in a consist may not be known when the command is added to a driver's command list.
  
[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
*'''[[How to Use Message Popup Rule (Applications)]]'''
+
*'''[[#Couple|Couple]]''' - couples wagons in a consist
 +
*'''[[#Couple At Trackmark|Couple At Trackmark]]''' - couples to the wagon closest to a specified trackmark
 +
*'''[[#Decouple DLX|Decouple DLX]]''' - decouples a consist at a specific, or a random, place. Upto 99 wagons
 +
*'''[[#Decouple Head N|Decouple Head N]]''' - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
 +
*'''[[#Decouple Number #|Decouple Number #]]''' - decouples a consist at a specific place. Upto 40 wagons
 +
*'''[[#Uncouplez|Uncouplez]]''' - decouples the locomotive (or locomotive + tender) from a consist
 +
*'''[[#UncouplezFrom|UncouplezFrom]]''' - decouples a consist at a specific place. Upto 20 wagons
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''DestSign Table Rule'''==
+
=='''Decouple DLX'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Creates a list of destination names for a destination sign
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_DecoupleDLX.png|50px|link=]]</td>
 
+
<td>The train is decoupled at the specified wagon identified by name or number (upto 99 wagons), or at a random location.</td>
*'''<kuid2:206816:99004:2>'''
+
 
+
*'''Built-in Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
  '''''<add destination>''''' - enter a destination name to be added to the destination sign roll
+
  '''''<import destinations from texture-group>''''' - select a list of destination names from session
+
  '''[x] Enable industries/stations as destination''' - check to set
+
  '''[x] Enable Track Marks as destinations''' - check to set
+
  '''[x] Enable table of destinations''' - check to set
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Display HTML Pages Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Creates a browser to display the listed HTML files in order as a navigable sequence of pages. This rule has been superseded by the '''Message Popup Rule'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:160293:100120:2> Decouple DLX'''
  
*'''<kuid:-25:442>'''
+
*'''DLS Command''' by '''trev999'''
  
*'''Legacy Rule''' (replaced by '''Message Popup Rule''')
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
*'''Base Rule'''
+
  '''When Used in Surveyor using the Driver Setup Rule'''
 +
      '''''<1-33>''''' - select a wagon numbered 1 to 33 where 1 is the wagon (or tender) immediately following the locomotive
 +
      '''''<34-66>''''' - select a wagon from 34 to 66
 +
      '''''<67-99>''''' - select a wagon from 67 to 99
 +
      '''''<at position determined by>'''''
 +
        '''''<consist_count>''''' - requires the use of the '''special_instruction''' driver command
 +
        '''''<a random number>''''' - a random number which may be beyond the last wagon in the consist
 +
  '''When used in Driver Mode'''
 +
      '''''<1-33>''''' - each wagon is numbered and named. Select a wagon numbered 1 to 33 (or to the last wagon in that range)
 +
        where 1 is the wagon (or tender) immediately following the locomotive
 +
      '''If there are more than 33 wagons, then'''
 +
        '''''<34-66>''''' - each wagon is numbered and named. Select a wagon from 34 to 66 (or to the last wagon in that range)
 +
      '''if there are more than 66 wagons, then'''
 +
        '''''<67-99>''''' - each wagon is numbered and named. Select a wagon from 67 to 99 (or to the last wagon in that range)
 +
      '''''<at position determined by>'''''
 +
        '''''<consist_count>''''' - requires the use of the '''special_instruction''' driver command
 +
        '''''<a random number>''''' - a random number upto and including the last wagon in the consist
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
+
:The main problem with using decoupling commands in the '''Driver Setup Rule''' is that the number and identity of the wagons in a consist may not be known when the command is added to a driver's command list.
    '''''<Add Page>''''' - adds the HTML page ''index.html'' from the selected HTML asset
+
      '''''<index.html>''''' - click to change the page name. The extension ''.html'' is optional
+
    '''''<Add All>''''' - adds all HTML pages from the session list '''(this appears to be disabled in TANE)'''
+
    '''''<Delete All>''''' - delete all HTML pages from this property list
+
    '''[x] Prevent user from exiting browser until all pages viewed'''
+
    '''[x] Disable closing of browser window by user'''
+
    '''[x] Disable browser window scrolling'''
+
    '''[x] Make browser window invisible'''
+
    '''[x] Set position-Under Construction!!!''' - not implemented
+
    '''[x] Set size-Under Construction!!!''' - not implemented
+
    '''Use the page ''<index.html>'' from asset ''<select>'' as the hidden button''' - the link buttons at the bottom of the page will be taken from the selected page in the selected HTML asset
+
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
*'''[[#Close Message Popup Rule|Close Message Popup Rule]]''' - closes a displayed pop-up browser window.
+
*'''[[#Couple|Couple]]''' - couples wagons in a consist
*'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
+
*'''[[#Couple At Trackmark|Couple At Trackmark]]''' - couples to the wagon closest to a specified trackmark
*'''[[#Set HTML Page Rule|Set HTML Page Rule]]''' - sets parameters for the '''Display HTML Pages Rule'''
+
*'''[[#Decouple|Decouple]]''' - decouples a consist at a specific place (does not work in the '''Driver Setup Rule''')
*'''[[#Timed Limited Display HTML Rule (SP2 and later)|Timed Limited Display HTML Rule (SP2 and later)]]''' - displays a HTML page in a browser window for a set time.
+
*'''[[#Decouple Head N|Decouple Head N]]''' - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
 +
*'''[[#Decouple Number #|Decouple Number #]]''' - decouples a consist at a specific place. Upto 40 wagons
 +
*'''[[#Uncouplez|Uncouplez]]''' - decouples the locomotive (or locomotive + tender) from a consist
 +
*'''[[#UncouplezFrom|UncouplezFrom]]''' - decouples a consist at a specific place. Upto 20 wagons
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Display Video Rule'''==
+
=='''Decouple Head N'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Displays a page containing a video clip from a HTML asset in a browser window.
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_Decouple.png|50px|link=]]</td>
 
+
<td>The train is decoupled to leave the selected number ('''N''') of wagons left in the consist.</td>
*'''<kuid:-25:138>'''
+
 
+
*'''Built-in Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''Display page ''<index.html>'' of html asset ''<click to select>'' in a new browser window
+
      '''''index.html''''' - enter the filename of a HTML page in the selected HTML asset. The ''.html'' is optional in the filename.
+
      '''''<click to select>''''' - select the HTML asset from those installed.
+
 
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+
:Video must be in a valid web format.
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Play Sound Rule|Play Sound Rule]]''' - plays a wav sound file
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''ExTrainz Manager Rule - TANE SP2'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Provides information on consists, industries and products in both Surveyor and Driver modes. Once activated, the rule creates an additional short menu bar below the main menu bar.
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:46162:70002:12> Decouple Head N'''
  
*'''<kuid:160293:10029>'''
+
*'''DLS Command''' by '''josefpav'''
  
*'''DLS Rule''' by '''trev999'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
  '''<select wagon number>''' - select the number of wagons (sorted by ASCII code not numerical value) to be left in the consist after the decoupling.  
 
+
        1 = the lead loco only (without its tender), 2 = loco + first wagon (which could be the tender), upto 75.
    '''Diagnostic mode is ''<On/Off>''''' - click to select ''On'' or ''Off''. When set ''On'' diagnostic messages will be added to the Trainz Log file.
+
    '''Turn on message overlay ''<Yes/No>''''' - click to select ''Yes'' or ''No''. When set to ''Yes'' the message overlay (lower left of screen) will be active.
+
    '''Show rolling stock in Driver mode ''<Yes/No>''''' - click to select ''Yes'' or ''No''. When set to ''Yes'' rolling stock can be searched in Driver.
+
    '''Search only rolling stock already in session ''<Yes/No>''''' - click to select ''Yes'' or ''No''. When set to ''Yes'' only those rolling stock assets
+
      installed in the session can be searched.
+
    '''Graphic colours: ''<When Red, the industry does not require service/When Green, the industry does not require service>''''' - click to switch
+
      between the two colour options.
+
    '''Industry page size: ''<value>''''' - enter the number of industries to be displayed in the Industry List window (maximum 250).
+
    '''The following industries are excluded: ''<Add an industry to be excluded>''''' - name can be complete (e.g. "Coal Mine 2")
+
      which will exclude that specific industry from the management list, or partial (e.g. "Coal") which will exclude all
+
      industries with the word "Coal" in their names. Entries are not case sensitive.
+
      Once industries have been excluded, additional commands will appear for each excluded industry:-
+
      '''''<delete> <industry name begins with/class name begins with> <name>''''' - click ''delete'' to remove this entry.
+
          - click ''industry name begins with/class name begins with'' to select between the two (see ''notes'' below).
+
          - click ''name'' to edit the name.
+
 
+
[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
+
:This rule is NOT compatible with all industries.
+
  
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
#Rolling stock installed in the current session only (see settings above) can be searched to find a match for any selected product from any industry. In Surveyor (and Driver if that setting is enabled) click on the '''View Products''' sub menu link and click on a product name in the '''Product Window''' to display a list of all compatible rolling stock for that product.
+
:The main problem with using decoupling commands in the '''Driver Setup Rule''' is that the number and identity of the wagons in a consist may not be known when the command is added to a driver's command list.
#Alternatively, click on the '''View Industries''' sub menu link and then click on a ''Product Icon'' to open a '''Product Window''', then click    on the '''''View Rolling Stock''''' link at the top of the window.
+
#Industry class names are defined in the config.txt file of industry assets and are not normally accessible by users. However, you can exclude an entire group of related "industry asset classes" such as ''station'', ''coalingtower'', ''watertank'', etc regardless of their actual names provided those assets have been given that "class name" by their creators.
+
  
<br>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
<table width=100% width=100% bgcolor=#ffffcc>
+
*'''[[#Couple|Couple]]''' - couples wagons in a consist
<tr>
+
*'''[[#Couple At Trackmark|Couple At Trackmark]]''' - couples to the wagon closest to a specified trackmark
<td>
+
*'''[[#Decouple|Decouple]]''' - decouples a consist at a specific place (does not work in the '''Driver Setup Rule''')
=='''Fade In/Out Rule'''==
+
*'''[[#Decouple DLX|Decouple DLX]]''' - decouples a consist at a specific, or a random, place. Upto 99 wagons
</td>
+
*'''[[#Decouple Number #|Decouple Number #]]''' - decouples a consist at a specific place. Upto 40 wagons
</tr>
+
*'''[[#Uncouplez|Uncouplez]]''' - decouples the locomotive (or locomotive + tender) from a consist
</table>
+
*'''[[#UncouplezFrom|UncouplezFrom]]''' - decouples a consist at a specific place. Upto 20 wagons
 
+
Fade in or out within seconds, using specified color and opacity values.
+
 
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
 
+
*'''<kuid2:190611:200000:2>'''
+
 
+
*'''Built-in Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''Red percentage:            ''<value>''''' - enter the final % of red (0 = none, 100 = maximum)
+
    '''Green percentage:          ''<value>''''' - enter the final % of green
+
    '''Blue percentage:            ''<value>''''' - enter the final % of blue
+
    '''Alpha percentage (opacity): ''<value>''''' - enter the final % of opacity (0 = invisible, 100 = solid)
+
    '''Fading duration:            ''<value>''''' - enter the number of seconds required for the fade
+
    '''''<help>''''' - click to bring up help instructions
+
 
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+
:Seconds are Trainz clock time, not real time.
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Hide Product Overlays Rule'''==
+
=='''Decouple Number #'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Hides the commodity or product bar graphs that appear on active industries
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_DecoupleNumber.png|50px|link=]]</td>
 
+
<td>The specified wagon number (#) and any following wagons will be uncoupled from the locomotive and consist.</td>
*'''<kuid:400048:100970>'''
+
 
+
*'''DLS Rule''' by '''callavsg'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
  '''None'''
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''InputTable Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Creates a list of message names to be used for various purposes including passing data to '''Driver Commands'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:147570:80008:1> Decouple number #'''
  
*'''<kuid2:131986:1012:1>'''
+
*'''Built-in Command''' by '''erniesouchak'''
  
*'''Built-in Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
  '''''<number>''''' - select a wagon number (1-40) to decouple from.
  
    '''''<add>''''' - click to add a new entry to the table
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
    Each new entry will require an input message
+
#The first locomotive is #1, the second locomotive (if any) or the tender (on a steam locomotive) is #2, etc.
      '''''<short message>''''' - enter a message. The message must be in a format that is specific for each purpose
+
#The main problem with using decoupling commands in the '''Driver Setup Rule''' is that the number and identity of the wagons in a consist may not be known when the command is added to a driver's command list.
      For the '''MoveTurntable''' driver command the message must be formatted as:-
+
          '''turntable,name_of_turntable,number_of_connecting_roads''' - the first entry must be the word ''turntable'' in lower case.
+
            ''name_of_turntable'' is the name of the turntable,  
+
            ''number_of_connecting_roads'' is the number of tracks connecting to the turntable
+
      For the '''WaitUntilTime''' driver command the message must be formatted as:-
+
          '''time,hour,minute''' - the first entry must be the word ''time'' in lower case,
+
            ''hour'' must be from 0 to 23,
+
            ''minute'' must be from 0 to 59.
+
      For the '''Skip If Session-Variable''' and '''Wait Until S-Variable''' driver commands the message must be formatted as:-
+
          '''svar,svar_name,svar_condition,value''' - the first entry must be the word ''svar'' in lower case,
+
            ''svar_name'' is the name of the session variable,
+
            ''svar_condition'' is an equality (eg eq for equal, gt for greater than, etc)
+
            ''value'' is an integer value to be compared to the session variable.
+
    Each entry in the table will be followed by the commands:-
+
      '''''cp''''' - click to copy this entry to a new entry
+
      '''''up''''' - click to move this entry up one level
+
      '''''dn''''' - click to move this entry down one level
+
      '''''rm''''' - click to remove this entry from the table
+
  
[[file:PageLink4.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Dependent Driver Commands:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
:'''The rule must be added to the Session for the following Driver Commands to work'''
+
*'''[[#Couple|Couple]]''' - couples wagons in a consist
*'''[[Driver Commands List#MoveTurntable|MoveTurntable]]'''
+
*'''[[#Couple At Trackmark|Couple At Trackmark]]''' - couples to the wagon closest to a specified trackmark
*'''[[Driver Commands List#Skip if Session-Variable|Skip If Session-Variable]]'''
+
*'''[[#Decouple|Decouple]]''' - decouples a consist at a specific place (does not work in the '''Driver Setup Rule''')
*'''[[Driver Commands List#Wait Until S-Variable|Wait Until S-Variable]]'''
+
*'''[[#Decouple DLX|Decouple DLX]]''' - decouples a consist at a specific, or a random, place. Upto 99 wagons
 +
*'''[[#Decouple Head N|Decouple Head N]]''' - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
 +
*'''[[#Uncouplez|Uncouplez]]''' - decouples the locomotive (or locomotive + tender) from a consist
 +
*'''[[#UncouplezFrom|UncouplezFrom]]''' - decouples a consist at a specific place. Upto 20 wagons
  
 
<br>
 
<br>
<table width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Message Popup Rule'''==
+
=='''Hornz'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Displays a pop-up browser window and waits for it to be closed. Closure can be manual (by the user) or by another rule.
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_Hornz.png|50px|link=]]</td>
 
+
<td>Gives one blast of the train horn or whistle.</td>
*'''<kuid:-25:1003>'''
+
 
+
*'''Built-in Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''[x] Pause game while message is displayed''' - stops the game until this message is closed
+
    '''[x] Close previous popup windows''' - closes any Message Popups currently displayed before this message is shown
+
    '''Message location ''<Top Left/Top Right/Bottom Left/Bottom Right>''''' - select one to position the browser window on the screen
+
    '''Message Source:''' - select one of three option buttons:-
+
      '''( ) Custom text''' - the simplest and easiest option
+
          '''Icon ''<Click here to set>''''' - (optional) shows a list of message icons. Select one to be displayed with the message
+
          '''Icon ''<Clear icon>''''' - clears any currently displayed message icon
+
          '''Custom text box''' Enter text to be displayed. You will be limited to about 6 lines of text.
+
              For longer messages or to include graphics, use the '''A predefined HTML page''' option.
+
          '''''<HTML Wave>''''' - (optional) select the name of the HTML asset from the list shown that contains the wave file to be played.
+
          '''''<Wave Name>''''' - (optional) enter the name of a wave (.wav) sound file to be played.
+
              The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension ".wav" is optional
+
          '''[x] Autoplay Wave:''' - plays the .wav sound file as soon as message is displayed.
+
              If unchecked the sound will not be played.
+
      '''( ) A predefined HTML page''' - requires a working knowledge of HTML
+
          '''''<HTML Asset>''''' - select the name of the HTML asset that contains the required HTML page from the list shown.
+
          '''''<HTML Page>''''' - enter the filename of the HTML page to be displayed. The page must be in the HTML asset identified above.
+
              Filename is not case sensitive. Extension ".html" is optional.
+
          '''''<HTML Wave>''''' - (optional) select the name of the HTML file containing the wave file to be played.
+
              The page must be in the HTML asset identified above. Filename is not case sensitive. Extension ".html" is optional.
+
          '''''<Wave Name>''''' - (optional) enter the name of a wave (.wav) sound file to be played.
+
              The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension ".wav" is optional
+
          '''[x] Autoplay Wave:''' - plays the .wav sound file as soon as message is displayed.
+
            If unchecked sound will not be played.
+
      '''( ) A predefined string-table entry from a HTML asset'''
+
          '''''<HTML Asset>''''' - select the name of the HTML asset from those installed that contains the required string-table.
+
          '''''<String Table Token>''''' - enter the "tag name" of the text in the string-table of the HTML assets '''config.txt''' file.
+
          '''''<HTML Wave>''''' - (optional) select the name of the HTML file containing the wave file to be played.
+
              The page must be in the HTML asset identified above. Filename is not case sensitive. Extension ".html" is optional.
+
          '''''<Wave Name>''''' - (optional) enter the name of a wave (.wav) sound file to be played.
+
              The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension ".wav" is optional
+
          '''[x] Autoplay Wave:''' - plays the .wav sound file as soon as message is displayed.
+
              If unchecked sound will not be played.
+
 
+
[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
+
:Because this rule will wait until it is closed (terminated) then it is not recommended for use in an '''Ordered List''' because you cannot guarantee that any following child rules will be executed.  If it MUST be used in an '''Ordered List''' then place it last.
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Close Message Popup Rule|Close Message Popup Rule]]''' - closes a displayed pop-up browser window.
+
*'''[[#Display HTML Pages Rule|Display HTML Pages Rule]]''' - display listed HTML files in order as a navigable sequence of pages.
+
*'''[[#Timed Limited Display HTML Rule (SP2 and later)|Timed Limited Display HTML Rule (SP2 and later)]]''' - displays a HTML page in a browser window for a set time.
+
 
+
[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+
*'''[[How to Use Message Popup Rule]]'''
+
*'''[[How to Use Message Popup Rule (Applications)]]'''
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[How to Create a HTML Asset|How to Create a HTML Asset (Session Introduction Page and In Game Messages)]]'''
+
*'''[[How to Create a Message Popup Icon]]'''
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Minimap Options Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Sets the display options for the minimap.
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:66277:80001:2> Hornz'''
  
*'''<kuid:-25:636>'''
+
*'''Built-in Command''' by '''smileyman'''
  
*'''Built-in Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
  '''None'''
  ''Default values - all checked''
+
    '''[x] Map Textures'''
+
    '''[x] Gradients'''
+
    '''[x] Junctions'''
+
    '''[x] Signals'''
+
    '''[x] Triggers'''
+
    '''[x] Markers'''
+
    '''[x] Trackside Labels'''
+
    '''[x] Terrain Objects'''
+
    '''[x] Industrial Names'''
+
    '''[x] Named Objects'''
+
    '''[x] Consists'''
+
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
*'''[[#Show/Hide Minimap Rule|Show/Hide Minimap Rule]]''' - shows the minimap window in Driver.
+
*'''[[#Bellz|Bellz]]''' - rings the locomotive bell (if it has one)
 +
*'''[[#HornzExtended|HornzExtended]]''' - gives a specified number of horn blasts
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Play Sound Rule'''==
+
=='''HornzExtended'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Plays a wav sound file.
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_HornzExtended.png|50px|link=]]</td>
 
+
<td>Gives a specified number of blasts of the train horn or whistle.</td>
*'''<kuid:-25:1045>'''
+
 
+
*'''Built-in Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''Default HTML ''<Click>''''' - click to to enter Sound File Name
+
    '''HTML Assets ''<Click>''''' - click to select HTML asset
+
    '''Rule Completes ''<Click>''''' -  to select one of:-
+
      '''sound has just started'''
+
      '''sound has finished playing'''
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Display Video Rule|Display Video Rule]]''' - displays a page containing a video clip from a HTML asset in a browser window
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Session Metadata Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Sets session metadata in the config file. Info can be read by other systems and displayed to the player.
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid:478639:100034> HornzExtended'''
  
*'''<kuid:401543:2036>'''
+
*'''Built-in Command''' by '''ffccnn'''
  
*'''Base Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
Select one of '''''<Play once>'''''
 +
              '''''<Play twice>'''''
 +
              ... up to ...
 +
              '''''<Play 10 times>'''''
  
    '''Type ''<Click>''''' - click to select one of:-
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
      '''Simulation'''
+
:When the command is executed, the AI will immediately move onto the next command in the sequence and will blast the horn during the execution of the following driver commands until the set count has been reached
      '''Challenge'''
+
    '''Length ''<value>''''' - to enter number of minutes, default is 30 minutes
+
    '''Difficulty ''<Click>''''' - click to select one of:-
+
      '''Normal''' - default
+
      '''Tutorial'''
+
      '''Easy'''
+
      '''Hard'''
+
      '''Expert'''
+
  
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>  
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
:Time is Trainz clock time, not real time
+
*'''[[#Bellz|Bellz]]''' - rings the locomotive bell (if it has one)
 +
*'''[[#Hornz|Hornz]]''' - gives one blast of the horn or whistle
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Set Helper Icon Size Rule'''==
+
=='''MoveTurntable'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Sets the size of helper icons such as the junction lever arrows.
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_MoveTurntable.png|50px|link=]]</td>
 
+
<td>Moves the specified turntable to the specified track position.</td>
*'''<kuid:-25:791>'''
+
 
+
*'''Built-in Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
  '''Junction Arrows Size ''<Click>''''' - to set scale ratio smaller than default, default is 100%
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Set HTML Pages Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Instructs the Display HTML Pages rule to perform specific operations. This rule has been superseded by the '''Message Popup Rule'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:609850:100018:1> MoveTurntable'''
  
*'''<kuid:-25:792>'''
+
*'''Built-in Command''' by '''vandragonax'''
  
*'''Legacy Rule''' (replaced by '''Message Popup Rule''')
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
*'''Built-in Rule'''
+
  '''''<name of turntable>''''' - select the named turntable (see '''Notes''' below).
 +
  '''''<track #>'' or ''<relative track movement>''''' - select the track number (0 = 1st track) or a relative movement (prev, next)
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 +
:The '''InputTable Rule''' must be installed in the session before this command can be used. This rule must be configured to identify all the turntables and the number of tracks they have.
  
    '''Operations to preform on the display HTML pages sequence browser'''
+
[[file:PageLink3.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Required Session Rules:</span><br>
    Select one of six option buttons:-
+
:'''Rules that MUST be added to the Session for this Driver Command to operate'''
      '''( ) to instruct the sequence browser to ''<select>''''' - to choose page operations
+
*'''[[Session Rule List with Parameters#InputTable Rule|InputTable Rule]]'''
      '''( ) to instruct the sequence browser to open the page ''<select>''''' - enter the HTML page name
+
      '''( ) to set browser parameters ''<select>''''' - choose one of:-
+
          '''to Enable/Disable closing of the browser window by the user'''
+
          '''to Enable/Disable scrolling on the sequence browser window'''
+
          '''to Show/Hide the sequence browser window'''
+
      '''( ) Set the following flag for the page named ''<select>''''' - enter the HTML page name
+
          '''[x] Hide/Close window on 'done' action'''
+
          '''[x] Window has no 'done' button'''
+
          '''[x] Disable scrolling(not implemented yet)'''
+
          '''[x] Spare setting 1'''
+
          '''[x] Spare setting 2'''
+
          '''[x] Spare setting 3'''
+
          '''[x] Spare setting 4'''
+
          '''[x] Spare setting 5'''
+
      '''( ) Use the page ''<select>''''' (enter HTML page name) '''from the HTML asset ''<select>''''' (select HTML asset)
+
      '''( ) Use the string table entry ''<select>''''' (enter Index) '''from the HTML asset ''<select>''''' (select HTML asset)
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Display HTML Pages Rule|Display HTML Pages Rule]]''' - displays HTML pages in a browser window.
+
*'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
+
*'''[[#Timed Limited Display HTML Rule (SP2 and later)|Timed Limited Display HTML Rule (SP2 and later)]]''' - displays a HTML page in a browser window for a set time.
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Show/Hide Layer Rule'''==
+
=='''Priorityz'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Shows or hides a layer from Driver.
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_Priorityz.png|50px|link=]]</td>
 
+
<td>Sets the train priority value.</td>
*'''<kuid2:401543:1170:1>'''
+
 
+
*'''Built-in Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
  '''''<visibility>''''' - select one of two options
+
      '''Show''' - select to make the layer visible
+
      '''Hide''' - select to make the layer invisible
+
  '''''<click here to set>''''' - enter name of layer. Name is case sensitive.
+
 
+
[[file:BugMini.PNG|link=]] <span style="color: red; text-decoration: underline; font-weight: 700;">Known Bugs</span><span style="color: red; font-weight: 700;">:</span>
+
:Layers set to '''Hide''' when a game is saved will be '''Shown''' when the saved game is reloaded
+
 
+
[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
+
:Rule will NOT check to see if the named layer exists or not
+
 
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Driver Commands:</span>
+
*'''[[Driver Commands List#Layer Control|Layer Control]]'''
+
 
+
[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+
*'''[[How to Use Layers#Layers in Driver Mode|How to Use Layers: Layers in Driver Mode]]
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Show/Hide Minimap Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Shows the minimap window in Driver.
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:66277:80003:1> priorityz'''
  
*'''<kuid:-25:794>'''
+
*'''Built-in Command''' by '''smileyman'''
  
*'''Built-in Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
'''''<value>''''' - select train priority value 1, 2 or 3
  
    '''''<Show/Hide>'' the driver Minimap Window''' - click to switch between '''Show''' and '''Hide'''.
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 +
:The Priority value identifies the importance of the train for the '''Priority Trackmarkers'''. Usually (a guide only):-
 +
:*Priority 1 = Express trains
 +
:*Priority 2 = Local Expresses or Fast Freights
 +
:*Priority 3 = Slow Local Freights or All Stops Services
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
*'''[[#Minimap Options Rule|Minimap Options Rule]]''' - sets the display options for the minimap.
+
*'''[[How_to_Use_Track_Priority_Markers|How to Use Track Priority Markers]]'''
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Show/Hide On-screen Help Rule'''==
+
=='''Run Around'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Shows or hides On-screen help in Driver.
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_RunAround.png|50px|link=]]</td>
 
+
<td>Uncouples the locomotive (plus tender if present) from the train, navigates to the other end of the train and couples to the last wagon.</td>
*'''<kuid:401543:2020>'''
+
 
+
*'''Built-in Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''On screen help (junction overlays, etc)''' - select one of three option buttons:-
+
      '''( ) Show
+
      '''( ) Hide
+
      '''( ) Leave Unchanged
+
    '''On Screen Vehicle Names:''' -  - select one of three option buttons:-
+
      '''( ) Show
+
      '''( ) Hide
+
      '''( ) Leave Unchanged
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Timed Limited Display HTML Rule (SP2 and later)'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Displays an HTML browser window for a limited time.
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid:-3:10083> Run Around'''
  
*'''<kuid2:61392:2005:32>'''
+
*'''Base Command'''
  
*'''DLS Rule''' by '''pguy'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
'''None'''
 
+
  '''HTML Asset Name : ''<[Click to select HTML asset]>''''' - click to select an HTML asset from those installed
+
  '''Page filename : ''<value>''''' - click to enter the filename of the HTML page in the selected HTML asset. The ''.html'' filename extension is optional.
+
  '''Play duration (SessVar or duration in seconds) : ''<value>''''' - enter a SessVar name or the number of seconds.
+
  '''Browser left position (SessVar or position) : ''<value>''''' - enter a SessVar name or the number of pixels from the left screen edge.
+
  '''Browser top position (SessVar or position) : ''<value>''''' - enter a SessVar name or the number of pixels from the top screen edge.
+
  '''Browser width (SessVar or position) : ''<value>''''' - enter a SessVar name or the width in pixels.
+
  '''Browser height (SessVar or position) : ''<value>''''' - enter a SessVar name or the browser height.
+
  '''[x] ''<Alert is not reshowable on request/Alert is showable on request>''''' - check or click to allow or prevent the user viewing the page again.
+
  
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
:Seconds are Trainz clock time, not real time.
+
#There must be a path for the locomotive to follow from one end of the train to the other.
 +
#The locomotive must have sufficient clear space, free of track switches and signals, at both ends of the train to perform this movement.
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
*'''[[#Close Message Popup Rule|Close Message Popup Rule]]''' - closes open message popups
+
*'''[[#Run Around Ex|Run Around Ex]]''' - performs the run around only if there is no loco already in position at the other end
*'''[[#Display HTML Pages Rule|Display HTML Pages Rule]]''' - displays HTML pages in a browser window.
+
*'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
+
*'''[[#Set HTML Page Rule|Set HTML Page Rule]]''' - sets parameters for the '''Display HTML Pages Rule'''
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[How to Create a HTML Asset]]'''
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Wait on Waybill Screen/Main Screen Rule'''==
+
=='''Run Around Ex'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules when the Waybill window is opened or closed
+
<table>
 +
<tr valign="top">
 +
<td>[[file:CMD_RunAroundEx.png|50px|link=]]</td>
 +
<td>Uncouples the locomotive(s) (plus tender if present) from the train, navigates to the other end of the train and couples to the last wagon but ONLY if the other end of the train does not already have a locomotive in place.</td>
 +
</tr>
 +
</table>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
*'''<kuid:-25:957>'''
+
*'''<kuid2:117667:83:3> Run Around Ex'''
  
*'''Built-in Rule'''
+
*'''DLS Command''' by '''nicroman'''
  
*'''Parent Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
'''None'''
  
    '''[x] Trigger rule once''' - check to trigger the rule once only
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
    '''Wait for the Waybill window to be ''<opened/closed>''''' - select either '''opened''' or '''closed'''.
+
#There must be a path for the locomotive to follow from one end of the train to the other.
 
+
#The locomotive must have sufficient clear space, free of track switches and signals, at both ends of the train to perform this movement.
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
#There must be no locomotive already coupled to the destination end of the train.
*'''[[How to Use Parent and Child Rules]]'''
+
<br>
+
<table width="100%" bgcolor=#ffff88>
+
<tr>
+
<td>
+
'''[[#top|Back to Top]]'''
+
</td>
+
</tr>
+
</table>
+
 
+
<table width="100%" bgcolor=#ffff88>
+
<tr>
+
<td>
+
='''Miscellaneous Rules'''=
+
</td>
+
</tr>
+
</table>
+
  
Some of these rules have no user accessible functions but may be used by other rules. Others do not fit in any other category.
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
 +
*'''[[#Run Around|Run Around]]''' - unconditionally performs the run around
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''ConsistDataHandler Rule'''==
+
=='''Uncouplez'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Was used by the '''QuickDrive Rule''' to place consists onto a route. Now obsolete.
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_Uncouplez.png|50px|link=]]</td>
 
+
<td>Uncouples the locomotive (plus tender if present) from the train.</td>
*'''<kuid:401543:1180>'''
+
 
+
*'''Obsolete Rule''' (function is now built into '''Trainz''')
+
 
+
*'''Base Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''None'''
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Custom Script Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
No description
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:66277:80000:1> UnCouplez'''
  
*'''<kuid:447264:1526>'''
+
*'''Built-in Command''' by '''smileyman'''
  
*'''Built-in Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
'''None'''
  
  '''None'''
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
 +
*'''[[#Couple|Couple]]''' - couples wagons in a consist
 +
*'''[[#Couple At Trackmark|Couple At Trackmark]]''' - couples to the wagon closest to a specified trackmark
 +
*'''[[#Decouple|Decouple]]''' - decouples a consist at a specific place (does not work in the '''Driver Setup Rule''')
 +
*'''[[#Decouple DLX|Decouple DLX]]''' - decouples a consist at a specific, or a random, place. Upto 99 wagons
 +
*'''[[#Decouple Head N|Decouple Head N]]''' - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
 +
*'''[[#Decouple Number #|Decouple Number #]]''' - decouples a consist at a specific place. Upto 40 wagons
 +
*'''[[#UncouplezFrom|UncouplezFrom]]''' - decouples a consist at a specific place. Upto 20 wagons
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Generic TreeNode Debug Window Rule'''==
+
=='''UncouplezFrom'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
No description.
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_Uncouplez.png|50px|link=]]</td>
 
+
<td>Uncouples the train at the wagon specified.</td>
*'''<kuid:30501:1042>'''
+
 
+
*'''Base Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''None'''
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Session Debug Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes the first child if ''Debug'' mode is selected. Otherwise executes the second child rule.
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:66277:80005:2> UnCouplezFrom'''
  
*'''<kuid:30501:100180>'''
+
*'''Built-in Command''' by '''smileyman'''
  
*'''Built-in Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
*'''Parent Rule'''  
+
  '''''<number>''''' - select a wagon number (0-20) to decouple from.
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 +
#The first wagon '''after''' the locomotive (or the locomotive and tender) is #0, the second wagon is #1, etc.
 +
#The main problem with using decoupling commands in the '''Driver Setup Rule''' is that the number and identity of the wagons in a consist may not be known when the command is added to a driver's command list.
  
    '''None'''
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
 
+
*'''[[#Couple|Couple]]''' - couples wagons in a consist
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>  
+
*'''[[#Couple At Trackmark|Couple At Trackmark]]''' - couples to the wagon closest to a specified trackmark
:When a session starts with this rule enabled, the player will be given the choice of running the session in '''''Debug''''' or '''''Normal''''' mode. Selecting ''Debug'' will execute the first child rule. Selecting ''Normal'' will execute the second child rule.
+
*'''[[#Decouple|Decouple]]''' - decouples a consist at a specific place (does not work in the '''Driver Setup Rule''')
 
+
*'''[[#Decouple DLX|Decouple DLX]]''' - decouples a consist at a specific, or a random, place. Upto 99 wagons
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[#Decouple Head N|Decouple Head N]]''' - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
*'''[[How to Use Parent and Child Rules]]'''
+
*'''[[#Decouple Number #|Decouple Number #]]''' - decouples a consist at a specific place. Upto 40 wagons
 +
*'''[[#Uncouplez|Uncouplez]]''' - decouples the locomotive (or locomotive + tender) from a consist
 
<br>
 
<br>
<table width="100%" bgcolor=#ffff88>
+
<table bgcolor=#a8ff8a>
 
<tr>
 
<tr>
 
<td>
 
<td>
Line 3,752: Line 2,163:
 
</table>
 
</table>
  
<table width="100%" bgcolor=#ffff88>
+
<table width="100%" bgcolor=#a8ff8a>
 
<tr>
 
<tr>
 
<td>
 
<td>
='''Navigation Rules'''=
+
 
 +
='''Navigation Commands'''=
 
</td>
 
</td>
 
</tr>
 
</tr>
Line 3,761: Line 2,173:
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Directional Trigger Check Rule'''==
+
=='''AutoDrivePastSignal'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules when a set train enters a set trigger in a set direction. Adds direction to the '''Trigger Check Rule'''.
+
<table>
 +
<tr valign="top">
 +
<td>[[file:CMD_AutoDrivePastSignal.png|50px|link=]]</td>
 +
<td>Instructs the AI driver to drive under '''Autopilot''' until the entire train clears the specified signal but the AI will not set any junction switches so the train will follow whatever path is set ahead of it. All signals and speed signs are obeyed. The train will slow to a halt after passing the signal.</td>
 +
</tr>
 +
</table>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
*'''<kuid2:532391:100003:1>'''
+
*'''<kuid2:61392:7101:1> AutoDrivePastSignal Command'''
  
*'''DLS Rule''' by '''bobhahn'''
+
*'''DLS Command''' by '''pguy'''
  
*'''Parent Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
  Select '''''<signal name>''''' from Session list
 
+
    '''[x] Trigger only once '''
+
    '''[x] Wait for child rules to complete even if no trains are present in rule trigger'''
+
    '''[x] Only activate when the entering vehicle of the train is heading ''<select direction>'' into the trigger''' - select one of two directions:-
+
      '''''forward'''''
+
      '''''backward'''''
+
    '''Triggers List'''
+
      '''''<add trigger>''''' - select a trigger from the session list
+
      '''''<delete trigger>''''' - delete a selected trigger from the rule
+
    Select one of two option buttons:-
+
      '''( ) click to accept all trains'''
+
      '''( ) click to accept trains matching specific criteria'''
+
          Selecting the second option will produce the following selection controls:-
+
          '''Specific vehicle''' - identify the specific vehicle(s) that will trigger the rule
+
            '''''+''''' - click to add a ''specific'' vehicle from the session list
+
            '''''x''''' - click to remove the ''specific'' vehicle from the rule
+
          '''Vehicle types''''' - identify the ''type'' of vehicle(s) that will trigger the rule
+
            '''''+''''' - click to add a ''type'' of vehicle from the session list
+
            '''''x''''' - click to remove the ''type'' of vehicle from the rule
+
          '''Drivers''''' - identify the ''driver(s)'' that will trigger the rule
+
            '''''+''''' - click to add a ''driver'' from the session list
+
            '''''x''''' - click to remove a ''driver'' from the rule
+
  
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
#This rule works best when used with the '''Directional Trigger''' track object available on the DLS.  
+
*It is the users responsibility to set all junction switches ahead of the train. The AI will not set the switches
#The Directional Trigger, when installed, will appear as a ''Signal'' not as a ''Trackmark''.
+
#Normal (non directional) triggers can be used with this rule but the rule will have no direction sensitivity apart from the ''forward'' and ''backward'' in the rule properties.
+
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
*'''[[#Trackside Check Rule|Trackside Check Rule]]''' - executes child rules when activated by a train. Provides different options to the '''Trigger Check Rule'''
+
*'''[[#AutoPilot|AutoPilot]]''' - drives continuously or until a specified trackmark has been passed
*'''[[#Trigger Check Rule|Trigger Check Rule]]''' - executes child rules when a set train enters a set trigger (non-directional)
+
 
+
[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+
*'''[[How to Control Signals in Sessions#Application 2: Halt Before Clear|How to Control Signals in Sessions: Halt Before Clear]]'''
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[How to Use Parent and Child Rules]]'''
+
*'''[[How to Use Track Triggers]]'''
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Navigation Display Rule'''==
+
 
 +
=='''Autopilot'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Creates a set of navigation points. Multiple sets can be created by adding additional copies of this rule. This rule creates the navigation set, it does not display it.
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_AutoPilot.png|50px|link=]]</td>
 
+
<td>Instructs the AI driver to drive but the AI will not set any junction switches so the train will follow whatever path is set ahead of it. All signals and speed signs are obeyed.</td>
*'''<kuid2:401543:1161:1>'''
+
 
+
*'''Base Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''Unique set ID: ''<click here to set>''''' - enter a unique name for the navigation set. Name must be in lowercase and have no spaces.
+
    '''Train (optional): ''<click here to set>''''' - select a rolling stock asset from the session list shown.
+
    Select one of three option buttons:-
+
    '''( ) All points must be completed in sequence:'''
+
      - the first uncompleted navigation point will be shown and must be completed next.
+
      - the next point (if any) will also be shown partly transparent.
+
    '''( ) Points will be completed in sequence, but can be skipped:'''
+
      - navigation points can be skipped but must be completed in order.
+
      - you cannot go back to complete a missed point.
+
    '''( ) All points must be completed, but in any order:'''
+
      - all uncompleted navigation points will be shown.
+
      - you may complete them in any order.
+
  For each navigation point:
+
      '''''<Click here to set>''''' - select an item (trigger, trackmark, track object, rolling stock) from the session list to become the navigation point.
+
      '''''<Display text>''''' - enter a text message to display with the navigation point. You are limited to 25 characters.
+
      '''Icon ''<icon list>''''' - select an icon for the navigation point.
+
      '''''<Style>''''' - click to select one from three choices
+
        '''''Automatic''''' - the navigation point will be completed as soon as the consist reaches the point.
+
        '''''Manual''''' - the navigation point must be set as complete by using the '''Navigation point complete rule''' or the '''Navigation set clear rule'''.
+
            The '''Manual''' style option allows you to execute other rules (e.g. consist check, wait, etc) before completing the navigation point.
+
        '''''Require Stop''''' - the navigation point will be completed when the consist comes to a complete stop on the point.
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Navigation Set Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.
+
*'''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set has completed or is incomplete.
+
*'''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
+
*'''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.
+
*'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed
+
 
+
[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+
*'''[[How to Use Navigation Point Rules]]'''
+
*'''[[How to Use Navigation Point Rules (Applications)]]'''
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Navigation Point Complete Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Manually completes a navigation point in a set
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:71155:60001:5> Autopilot Command'''
  
*'''<kuid:401543:1167>'''
+
*'''DLS Command''' by '''_mutton_'''
  
*'''Base Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
Select one of
 
+
     '''<activate>''' - starts the Autopilot Command. This will only terminate when the '''Autopilot Command''' is removed from the driver command line
     '''Mark navigation point ''<click here to set>''''' - enter the navigation point number to be completed
+
     '''<stop at track mark>''' - select a trackmark from the session list. Starts the Autopilot Command and drives until the train reaches the selected trackmark (see '''Notes''' below)
     '''complete in set ''<click here to set>''''' - enter the unique name for the navigation set created using the '''Navigation Display Rule'''.
+
        Name must be in lowercase and have no spaces.
+
 
+
[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
+
:The rule will '''NOT''' check to see if the named navigation set and point exists or not.
+
  
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
:The navigation set and point must first be created by the '''Navigation Display Rule'''
+
#It is the users responsibility to set all junction switches ahead of the train. The AI will not set the switches
 +
#If the '''Stop at track mark''' option is used then:-
 +
:*the train will not set a path to the track mark, that is the users responsibility
 +
:*the train will run at the full posted line speed upto the track mark and then it will slow to a stop
 +
:*if the track mark is never reached because the correct path has not been set, the train will continue as it would for the '''activate''' option
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
*'''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
+
*'''[[#AutoDrivePastSignal|AutoDrivePastSignal]]''' - drives until a specified signal has been passed
*'''[[#Navigation Set Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.
+
*'''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set has completed or is incomplete.
+
*'''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
+
*'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed
+
 
+
[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+
*'''[[How to Use Navigation Point Rules]]'''
+
*'''[[How to Use Navigation Point Rules (Applications)]]'''
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Navigation Set Check Rule'''==
+
=='''Drive To'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules if a navigation set created with the '''Navigation Display Rule''' is complete (or incomplete).
+
<table>
 +
<tr valign="top">
 +
<td>[[file:CMD_IndustryIcon.png|50px|link=]]</td>
 +
<td>Instructs the AI driver to Drive, via the shortest available path, to the designated Industry (including Passenger Stations). Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will '''NOT''' attempt to find a way around blockages when calculating the shortest path to the industry. All signals and speed signs are obeyed.</td>
 +
</tr>
 +
</table>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
*'''<kuid:401543:1165>'''
+
*'''<kuid:-3:11058> Drive To'''
  
*'''Base Rule'''
+
*'''Base Command'''
  
*'''Parent Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
Select '''<name of industry>''' or industry enabled passenger station from the session list
 
+
  if applicable '''<name/number of track or platform>''' for industries and stations that have identified active platforms, tracks or loading bays
    '''Checks if navigation point set ''<name>'':''' - enter the unique name for the navigation set created using the '''Navigation Display Rule'''.
+
        Name must be in lowercase and have no spaces.
+
    '''is ''<Complete/Incomplete>''''' - click to select one
+
 
+
[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
+
:The rule will '''NOT''' check to see if the named navigation set exists or not.
+
  
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
:The navigation set must first be created by the '''Navigation Display Rule'''
+
:If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will not attempt to find an alternative path to the destination. This can lead to the train stopping and waiting indefinately until the blockage is removed.
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
*'''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
+
*'''[[#Navigate To|Navigate To]]''' - will seek alternative paths if blocked
*'''[[#Navigation Set Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.
+
*'''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
+
*'''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.
+
*'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[How to Use Navigation Point Rules]]'''
+
*'''[[How to Use Navigation Point Rules (Applications)]]'''
+
*'''[[How to Use Parent and Child Rules]]'''
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Navigation Set Clear Rule'''==
+
=='''Drive To Trackmark'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Clears a navigation set removing any uncompleted navigation points
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_NavigateTo.png|50px|link=]]</td>
 
+
<td>Instructs the AI driver to Drive, via the shortest available path, to the designated Trackmark. Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will '''NOT''' attempt to find a way around blockages when calculating the shortest path to the trackmark. All signals and speed signs are obeyed.</td>
*'''<kuid:401543:1164>'''
+
 
+
*'''Base Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''''<Click here to set>''''' - enter the unique name for the navigation set created using the '''Navigation Display Rule'''.
+
        Name must be in lowercase and have no spaces.
+
 
+
[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
+
:The rule will '''NOT''' check to see if the named navigation set exists or not.
+
 
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+
:The navigation set must first be created by the '''Navigation Display Rule'''
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
+
*'''[[#Navigation Set Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.
+
*'''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set has completed or is incomplete.
+
*'''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.
+
*'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed
+
 
+
[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+
*'''[[How to Use Navigation Point Rules]]'''
+
*'''[[How to Use Navigation Point Rules (Applications)]]'''
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Navigation Set Hide/Show Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Shows and hides navigation sets. You can have multiple sets visible and hidden at the same time.
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid:-3:11149> Drive To Trackmark'''
  
*'''<kuid:401543:1163>'''
+
*'''Base Command'''
  
*'''Base rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
Select '''<name of trackmark>''' from the session list
 
+
    '''''<visibility>''''' - click to select one
+
      '''Hide''' - select to make the navigation set invisible
+
      '''Show''' - select to make the navigation set visible
+
    '''''<click here to set>''''' - enter the unique name for the navigation set created using the '''Navigation Display Rule'''.
+
        Name must be in lowercase and have no spaces.
+
 
+
[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
+
:The rule will '''NOT''' check to see if the named navigation set exists or not.
+
  
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
:The navigation set must first be created by the '''Navigation Display Rule'''
+
:If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will not attempt to find an alternative path to the destination. This can lead to the train stopping and waiting indefinately until the blockage is removed.
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
*'''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
+
*'''[[#Drive Via Trackmark|Drive Via Trackmark]]''' - drives through trackmark, will NOT seek alternative paths if blocked
*'''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set has completed or is incomplete.
+
*'''[[#Navigate To Trackmark|Navigate To Trackmark]]''' - stops at trackmark, will seek alternative paths if blocked
*'''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
+
*'''[[#Navigate Via Trackmark|Navigate Via Trackmark]]''' - drives through trackmark, will seek alternative paths if blocked
*'''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.
+
*'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed
+
  
[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
*'''[[How to Use Navigation Point Rules]]'''
+
*'''[[How to Use Track Markers]]'''
*'''[[How to Use Navigation Point Rules (Applications)]]'''
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Schedule Rule'''==
+
 
 +
=='''Drive Via Trackmark'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Allows a schedule of timed events to be applied to a train
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_NavigateTo.png|50px|link=]]</td>
 
+
<td>Instructs the AI driver to Drive, via the shortest available path, to and through the designated Trackmark. If there are no further commands then the AI will halt after passing the trackmark. Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will '''NOT''' attempt to find a way around blockages when calculating the shortest path to the trackmark. All signals and speed signs are obeyed.</td>
*'''<kuid:-3:10185>'''
+
 
+
*'''Base Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''Insert track mark ''<select>''''' - select a track mark from the Session List
+
    '''Arrival and Departure Time ''<Select>''''' - set time
+
      '''''hh:mm:ss''''' - in hours/minutes/seconds
+
    '''Current Train ''<select>''''' - select from session list
+
    '''Insert destination ''<select>''''' - select from session list
+
 
+
[[file:BugMini.PNG|link=]] <span style="text-decoration: underline; font-weight: 700; color: red;">Known Bugs:</span>
+
:There are reports that this rule does not work correctly particularly if a train arrives late or early.
+
 
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+
:Times are Trainz clock times, not real time
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
+
*'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
+
*'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
+
*'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
+
*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
+
*'''[[#ScheduleAtTrackside Rule|ScheduleAtTrackside Rule]]''' - issues set of driver commands at a trackmark or trigger
+
 
+
[[file:WWWLinks.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Other Links:</span>
+
*'''<span class="plainlinks">http://www.auran.com/games/gamefiles/trainz/tutorial1.html</span>'''
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Trackside Check Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules when a set train enters a set trigger. Similar to the '''Trigger Check Rule''' but provides different options.
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid:-3:11209> Drive Via Trackmark'''
  
*'''<kuid2:46162:100207:1>'''
+
*'''Base Command'''
  
*'''DLS Rule''' by '''Josefpav'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
*'''Parent Rule'''
+
Select '''<name of trackmark>''' from the session list
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 +
#This command is used to direct the AI along a set route to a final destination which is not normally the trackmark identified in this command.
 +
#If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will not attempt to find an alternative path to the designated trackmark. This can lead to the train stopping and waiting indefinately until the blockage is removed.
  
    '''Applies to:''' - select one of three option buttons:-
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
      '''( ) Junction'''
+
*'''[[#Drive To Trackmark|Drive To Trackmark]]''' - stops at trackmark, will NOT seek alternative paths if blocked
      '''( ) Trigger'''
+
*'''[[#Navigate To Trackmark|Navigate To Trackmark]]''' - stops at trackmark, will seek alternative paths if blocked
      '''( ) Trackmark'''
+
*'''[[#Navigate Via Trackmark|Navigate Via Trackmark]]''' - drives through trackmark, will seek alternative paths if blocked
    '''Trackside object name: ''<specify>''''' - select object name from session list
+
    '''Wait for train to:''' - select one of three option buttons:-
+
      '''( ) Enter'''
+
      '''( ) Stop at'''
+
      '''( ) Leave'''
+
    '''[x] Auto reset this rule''' - check to execute the rule continuously
+
    '''Applies to train containing:'''
+
    '''''<Add vehicle>''''' - click to select a rail vehicle from the session list
+
    '''''del''''' - click to remove a selected vehicle from the rule
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Directional Trigger Check Rule|Directional Trigger Check Rule]]''' - executes child rules when activated by a train moving in a set direction.
+
*'''[[#Trigger Check Rule|Trigger Check Rule]]''' - executes child rules when activated by a train
+
  
 
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
 
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
*'''[[How to Use Parent and Child Rules]]'''
+
*'''[[How to Use Track Markers]]'''
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Trigger Check Rule'''==
+
 
 +
=='''Navigate To'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules when a set train enters a set trigger. This rule replaces the older and less versatile '''Trigger Rule'''.
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_IndustryIcon.png|50px|link=]]</td>
 
+
<td>Instructs the AI driver to Navigate, via the shortest available path, to the designated Industry (including Passenger Station). Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will attempt to find a way around blockages when calculating the shortest path to the industry. All signals and speed signs are obeyed.</td>
*'''<kuid:-25:1071>'''
+
 
+
*'''Built-in Rule'''
+
 
+
*'''Parent Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''[x] Trigger only once '''
+
    '''[x] Wait for child rules to complete even if no trains are present in rule trigger'''
+
    '''[x] Only activate when the entering vehicle of the train is heading ''<select direction>'' into the trigger''' - select one of two directions:-
+
      '''''forward'''''
+
      '''''backward'''''
+
    '''Triggers List'''
+
      '''''<add trigger>''''' - select a trigger from the session list
+
      '''''<delete trigger>''''' - delete a selected trigger from the rule
+
    Select one of two option buttons:-
+
      '''( ) click to accept all trains'''
+
      '''( ) click to accept trains matching specific criteria'''
+
          Selecting the second option will produce the following selection controls:-
+
          '''Specific vehicle''' - identify the specific vehicle(s) that will trigger the rule
+
            '''''+''''' - click to add a ''specific'' vehicle from the session list
+
            '''''x''''' - click to remove the ''specific'' vehicle from the rule
+
          '''Vehicle types''''' - identify the ''type'' of vehicle(s) that will trigger the rule
+
            '''''+''''' - click to add a ''type'' of vehicle from the session list
+
            '''''x''''' - click to remove the ''type'' of vehicle from the rule
+
          '''Drivers''''' - identify the ''driver(s)'' that will trigger the rule
+
            '''''+''''' - click to add a ''driver'' from the session list
+
            '''''x''''' - click to remove a ''driver'' from the rule
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Directional Trigger Check Rule|Directional Trigger Check Rule]]''' -  executes child rules when activated by a train moving in a set direction.
+
*'''[[#Trackside Check Rule|Trackside Check Rule]]''' - executes child rules when activated by a train. Provides different options to the '''Trigger Check Rule'''
+
 
+
[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+
*'''[[How to Use Message Popup Rule (Applications)]]
+
*'''[[How to Use Navigation Point Rules (Applications)#Application 3: Wait for Loading to be Completed|How to Use Navigation Point Rules (Applications): Wait for Loading to be Completed]]
+
*'''[[How to Use Track Triggers]]'''
+
*'''[[How to Use Variables in Sessions (Examples)]]
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[How to Use Parent and Child Rules]]'''
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Wait on Navigation Point Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules when a specific navigation point is completed
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid:-3:10058> Navigate To'''
  
*'''<kuid:401543:1168>'''
+
*'''Base Command'''
  
*'''Base Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
*'''Parent Rule'''
+
Select '''<name of industry>''' or industry enabled passenger station from the session list
 
+
  if applicable '''<name/number of track or platform>''' for industries and stations that have identified active platforms, tracks or loading bays
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''navigation point ''<click here to set>''''' - enter the number of the navigation point to be completed
+
    '''in set ''<click here to set>''''' - enter the unique name for the navigation set created using the '''Navigation Display Rule'''.
+
      Name must be in lowercase and have no spaces.
+
 
+
[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
+
:The rule will '''NOT''' check to see if the named navigation set and point exists or not.
+
  
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
:The navigation set and point must first be created by the '''Navigation Display Rule'''
+
:If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will attempt to find an alternative path to the destination. This can lead to the train traveling backwards and down the wrong track.
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
*'''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
+
*'''[[#Drive To|Drive To]]''' - does not seek alternative paths if blocked
*'''[[#Navigation Set Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.
+
*'''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set is complete or incomplete.
+
*'''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
+
*'''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.
+
 
+
[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+
*'''[[How to Use Message Popup Rule (Applications)#Application 2: Navigation Point and Train Stopped Event Message|How to Use Message Popup Rule (Applications): Navigation Point and Train Stopped Event Message]]
+
*'''[[How to Use Navigation Point Rules (Applications)]]'''
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[How to Use Navigation Point Rules]]'''
+
*'''[[How to Use Parent and Child Rules]]'''
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Wait on Train Stop/Start Rule'''==
+
=='''Navigate To Trackmark'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules when a train stops or starts moving
+
<table>
 +
<tr valign="top">
 +
<td>[[file:CMD_NavigateTo.png|50px|link=]]</td>
 +
<td>Instructs the AI driver to Navigate, via the shortest available path, to the designated Trackmark. Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will attempt to find a way around blockages when calculating the shortest path to the trackmark. All signals and speed signs are obeyed.</td>
 +
</tr>
 +
</table>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
*'''<kuid:-25:1069>'''
+
*'''<kuid:-3:10149> Navigate To Trackmark'''
  
*'''Built-in Rule'''
+
*'''Base Command'''
  
*'''Parent Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
Select '''<name of trackmark>''' from the session list
  
    '''[x] Trigger rule once'''
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
    '''Wait for a train that matches the following criteria to ''<select>''''' - select one of:-
+
:If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will attempt to find an alternative path to the destination. This can lead to the train traveling backwards and down the wrong track.
      '''''start moving'''''
+
      '''''stop moving'''''
+
    Select one of two option buttons:-
+
      '''( ) click to accept all trains'''
+
      '''( ) click to accept trains matching specific criteria'''
+
          Selecting the second option will produce the following selection controls:-
+
          '''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
+
            '''''+''''' - click to add a ''specific'' vehicle from the session list
+
            '''''x''''' - click to remove the ''specific'' vehicle from the rule
+
          '''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule
+
            '''''+''''' - click to add a ''type'' of vehicle from the session list
+
            '''''x''''' - click to remove the ''type'' of vehicle from the rule
+
          '''Drivers''''' - identify the ''drivers'' that will trigger the rule
+
            '''''+''''' - click to add a ''driver'' from the session list
+
            '''''x''''' - click to remove a ''driver'' from the rule
+
  
[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
*'''[[How to Use Message Popup Rule (Applications)#Application 2: Navigation Point and Train Stopped Event Message|How to Use Message Popup Rule (Applications): Navigation Point and Train Stopped Event Message]]'''
+
*'''[[#Drive To Trackmark|Drive To Trackmark]]''' - stops at trackmark, will NOT seek alternative paths if blocked
 +
*'''[[#Drive Via Trackmark|Drive Via Trackmark]]''' - drives through trackmark, will NOT seek alternative paths if blocked
 +
*'''[[#Navigate Via Trackmark|Navigate Via Trackmark]]''' - drives through trackmark, will seek alternative paths if blocked
  
 
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
 
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
*'''[[How to Use Parent and Child Rules]]'''
+
*'''[[How to Use Track Markers]]'''
 +
 
 
<br>
 
<br>
<table width="100%" bgcolor=#ffff88>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
'''[[#top|Back to Top]]'''
 
</td>
 
</tr>
 
</table>
 
  
<table width="100%" bgcolor=#ffff88>
+
=='''Navigate Via Trackmark'''==
<tr>
+
<td>
+
='''Portal Rules'''=
+
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
<br>
+
<table>
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr valign="top">
<tr>
+
<td>[[file:CMD_NavigateTo.png|50px|link=]]</td>
<td>
+
<td>Instructs the AI driver to Drive, via the shortest available path, to and through the designated Trackmark. If there are no further commands then the AI will halt after passing the trackmark. Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will attempt to find a way around blockages when calculating the shortest path to the trackmark. All signals and speed signs are obeyed.</td>
=='''Quick Portal Manager Standard Edition Rule (SP2 and later)'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Manages portals and adds flexible timetables.  
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid:-3:10209> Navigate Via Trackmark'''
  
*'''<kuid2:61392:5011:45>'''
+
*'''Base Command'''
  
*'''DLS Rule''' by '''pguy'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
Select '''<name of trackmark>''' from the session list
  
    '''Target date is ''day-of-week'' ''&<nowiki />lt;dd/mm/yyyy&<nowiki />gt;''''' - ''day-of-week'' and ''date'' shown are for today's date. Click '''''dd/mm/yyyy''''' to change date.
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
    '''''<Copy rule data to Clipboard>''''' - click to copy the currently entered data to a special clipboard area used by the rules created by '''pguy'''.
+
#This command is used to direct the AI along a set route to a final destination which is not normally the trackmark identified in this command.
      This is NOT the standard OS clipboard.
+
#If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will attempt to find an alternative path to the designated trackmark. This can lead to the train traveling backwards and down the wrong track.
    '''''<Paste rule data from Clipboard>''''' - if data is held in the special clipboard area, then click to paste that data into the rule.
+
      This is NOT the standard OS clipboard.
+
    '''[x] This rule is enabled''' - check to activate (enable) the rule.
+
    '''[x] Avoid duplicated driver if possible''' - check to prevent the same driver being used again. If a driver name is reused, the rule will select a different driver name.
+
    '''[x] Disable locomotives/vehicles enhanced mode''' - check to save vehicle properties when a train is removed by a portal.
+
      These properties will be restored if the same train is emitted by a portal. If checked then a new command will appear:
+
      '''''<for all vehicles/for only locomotives/for only tagged vehicles>''''' - click to select one.
+
    '''Portal selected: ''<portal name> [...]''''' - select a portal to manage by clicking '''''<portal name>''''' or '''''[...]''''' and selecting a portal from the Session list.
+
    '''Portal output link: ''<[no link]> [...]''''' - leave blank.
+
    '''Portal input link: ''<[no link]> [...]''''' - leave blank unless you want to connect to a Global Input Queue. Click to select an input queue from the Session list.
+
    '''Default schedule for input trains is named: ''<schedule>''''' - click to enter a schedule name.
+
    '''Today's schedule: ''<Insert new schedule>''''' - click to enter a new schedule
+
    For each schedule:-
+
      '''''<hh:mm>''''' - click to set the time when a train will be emitted from the portal. Times use the 24hr clock.
+
      '''''<train name>''''' - click to enter the train name
+
      '''''<mission code>''''' - click to enter the '''Mission Code''' created by the '''MissionCode Manager Rule (SP2 and later)'''.
+
      '''''<schedule>''''' - click to enter the re-occurrence schedule in ''hh:mm'' (24hr clock) where, for example:
+
          ''02:30'' means every 2 hrs 30 minutes,
+
          ''00:00'' means once only,
+
          ''24:00'' means once each day.
+
      '''''<driver>''''' - click to select a driver name or select '''''auto-driver''''' to let the rule select a driver.
+
          '''Current driver order bar is named ''<schedule>''''' - click to enter a name for the order (Driver Command) bar used in this schedule.
+
      '''''<hud>''''' - click to select a HUD for this train. HUDs must be created using the '''Quick CustomHud Manager Rule (SP2 and later)'''.
+
      '''Driver Command Bar''' - enter driver commands for this train.
+
      Choose one of two consist sets:
+
      '''''<mono consist>'' consist for every day''' - if selected the same consist will be used each day.
+
          '''''<no consist selected>''''' - click to select a consist from those saved in your install.
+
      '''''<multi consists>''''' - if selected a different consist will be used each day.
+
          For each day of the week:
+
            '''Day-of-week ''<no consist selected>''''' - click to select a consist from those saved in your install.
+
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
*'''[[#MissionCode Manager Rule (SP2 and later)|MissionCode Manager Rule (SP2 and later)]]''' - creates and manages '''Mission Codes''' for '''Interlocking Tower''' paths
+
*'''[[#Drive To Trackmark|Drive To Trackmark]]''' - stops at trackmark, will NOT seek alternative paths if blocked
*'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - create driver HUDs
+
*'''[[#Drive Via Trackmark|Drive Via Trackmark]]''' - drives through trackmark, will NOT seek alternative paths if blocked
*'''[[#Un-Portal Rule|Un-Portal Rule]]''' - configures trackmarks as portals
+
*'''[[#Navigate To Trackmark|Navigate To Trackmark]]''' - stops at trackmark, will seek alternative paths if blocked
  
 
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
 
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Quick_Portal_Manager</span>'''
+
*'''[[How to Use Track Markers]]'''
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table bgcolor=#a8ff8a>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Un-Portal Rule'''==
+
'''[[#top|Back to Top]]'''
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Provides portals to routes that have no portals by configuring track marks as portals.
+
<table width="100%" bgcolor=#a8ff8a>
 
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
 
+
*'''<kuid2:117746:1024:10>'''
+
 
+
*'''DLS Rule''' by '''sforget'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
    '''Maximum Trains on Route ''<value>''''' - enter number
+
    '''Remove Excess Trains ''<YES/NO>''''' - select either. Warning: Selecting YES may result in undesirable effects
+
    '''Remove Which Trains ''<Last created/Oldest>''''' - select either
+
    '''''<u>New Un-Portal</u>''''' - click to select a new Un-portal from the session list of available track marks
+
    For each Un-portal:-
+
      '''''<u>Track Mark Name</u>''''' - click on track mark name to configure the Un-Portal
+
      Configuration Settings:-
+
          '''Currently Editing Portal ''<u>Track Mark Name</u> <u>Remove</u>''''' - click on name to edit a different Un-Portal, click on '''Remove''' to delete this Un-Portal
+
          '''Time between trains ''<value>'' minutes''' - enter number of minutes
+
          '''Timer Fluctuation ''<value>'' minutes''' - enter how much randomness to add to the "Time between trains"
+
          '''Direction Relative to TrackMark ''<Forwards/Backwards>''''' - select one to indicate the direction of travel compared to the direction of the Track Mark
+
          '''Consume Trains ''<YES/NO>''''' - select one
+
          '''Emit Immediately ''<YES/NO>''''' - select one
+
          '''Order to Emit Trains ''<Random/Sequential>''''' - select one to control train order from entered list of consists
+
          '''Wait for Triggered Event ''<YES/NO>''''' - select one
+
          '''''<u>Add New Consist</u>''''' - click to add a consist to be emitted.
+
            '''''+''''' - click to add a ''specific'' vehicle from the session list
+
            '''''x''''' - click to remove the ''specific'' vehicle from the rule
+
            '''''<u>Add driver to consist</u>''''' - click to select a driver from the session list
+
            '''''<u>Add an existing saved consist</u>''''' - click to select a previously saved consist
+
 
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+
#Minutes are Trainz clock time, not real time
+
#If '''Consume Trains''' is set to '''YES''' then ALL trains that pass over that trackmark will be consumed so don't create the Un-Portal on a mainline
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Quick Portal Manager Standard Edition Rule (SP2 and later)|Quick Portal Manager Standard Edition Rule (SP2 and later)]]''' - provides additional features for portals
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[How to Use Portals]]'''
+
<br>
+
<table width="100%" bgcolor=#ffff88>
+
 
<tr>
 
<tr>
 
<td>
 
<td>
'''[[#top|Back to Top]]'''
+
 
 +
='''Session Management Commands'''=
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
<table width="100%" bgcolor=#ffff88>
+
<br>
 +
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
='''Resources Rules'''=
+
=='''Copy Commands From'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
<br>
+
<table>
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr valign="top">
<tr>
+
<td>[[file:CMD_CopyCommandsFrom.png|50px|link=]]</td>
<td>
+
<td>Copies a driver schedule from a schedule library or another driver.</td>
=='''ExTrainz Manager Rule - TANE SP2'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Provides information on consists, industries and products in both Surveyor and Driver modes. Once activated, the rule creates an additional short menu bar below the main menu bar.
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:192081:1:7> Copy Commands From'''
  
*'''<kuid:160293:10029>'''
+
*'''Built-in Command''' by '''brummfondel'''
  
*'''DLS Rule''' by '''trev999'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
'''Append''' - '''From Library''' - select a saved schedule from Schedule Library and add it to the end of the current schedule (if any)
 +
'''Append''' - '''From Vehicle''' - select a vehicle, copy its driver commands and add them to the end of the current schedule (if any)
 +
'''Insert''' - '''From Library''' - select a saved schedule from Schedule Library and insert it into the current schedule (if any)
 +
'''Insert''' - '''From Vehicle''' - select a vehicle, copy its driver commands and insert them into the current schedule (if any)
  
    '''Diagnostic mode is ''<On/Off>''''' - click to select ''On'' or ''Off''. When set ''On'' diagnostic messages will be added to the Trainz Log file.
+
[[file:PageLink3.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Required Session Rules:</span><br>
    '''Turn on message overlay ''<Yes/No>''''' - click to select ''Yes'' or ''No''. When set to ''Yes'' the message overlay (lower left of screen) will be active.
+
:'''Rules that MUST be added to the Session for this Driver Command to operate'''
    '''Show rolling stock in Driver mode ''<Yes/No>''''' - click to select ''Yes'' or ''No''. When set to ''Yes'' rolling stock can be searched in Driver.
+
*'''[[Session_Rule_List_with_Parameters#Schedule Library Rule|Schedule Library Rule]]'''
    '''Search only rolling stock already in session ''<Yes/No>''''' - click to select ''Yes'' or ''No''. When set to ''Yes'' only those rolling stock assets
+
      installed in the session can be searched.
+
    '''Graphic colours: ''<When Red, the industry does not require service/When Green, the industry does not require service>''''' - click to switch
+
      between the two colour options.
+
    '''Industry page size: ''<value>''''' - enter the number of industries to be displayed in the Industry List window (maximum 250).
+
    '''The following industries are excluded: ''<Add an industry to be excluded>''''' - name can be complete (e.g. "Coal Mine 2")
+
      which will exclude that specific industry from the management list, or partial (e.g. "Coal") which will exclude all
+
      industries with the word "Coal" in their names. Entries are not case sensitive.
+
      Once industries have been excluded, additional commands will appear for each excluded industry:-
+
      '''''<delete> <industry name begins with/class name begins with> <name>''''' - click ''delete'' to remove this entry.
+
          - click ''industry name begins with/class name begins with'' to select between the two (see ''notes'' below).
+
          - click ''name'' to edit the name.
+
 
+
[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
+
:This rule is NOT compatible with all industries.
+
 
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+
#Rolling stock installed in the current session only (see settings above) can be searched to find a match for any selected product from any industry. In Surveyor (and Driver if that setting is enabled) click on the '''View Products''' sub menu link and click on a product name in the '''Product Window''' to display a list of all compatible rolling stock for that product.
+
#Alternatively, click on the '''View Industries''' sub menu link and then click on a ''Product Icon'' to open a '''Product Window''', then click    on the '''''View Rolling Stock''''' link at the top of the window.
+
#Industry class names are defined in the config.txt file of industry assets and are not normally accessible by users. However, you can exclude an entire group of related "industry asset classes" such as ''station'', ''coalingtower'', ''watertank'', etc regardless of their actual names provided those assets have been given that "class name" by their creators.
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Hide Product Overlays Rule'''==
+
=='''Delete Train'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Hides the commodity or product bar graphs that appear on active industries
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_DeleteTrain.png|50px|link=]]</td>
 
+
<td>Deletes the train from the session.</td>
*'''<kuid:400048:100970>'''
+
 
+
*'''DLS Rule''' by '''callavsg'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
  '''None'''
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Multiple Resource Check Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules if industries or vehicles reach set commodity levels. This rule replaces the older '''Resource Check Rule'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:116387:15:3> Delete Train'''
  
*'''<kuid:-25:656>'''
+
*'''Built-in Command''' by '''maggs'''
  
*'''Built-in Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
*'''Parent Rule'''
+
'''None'''
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''<Product Level>''' - click to select a product test from two choices:-
+
      '''''Reach/Exceed''''' - sets an upper limit for the resources being monitored.
+
          For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon reaches or exceeds a specified level.
+
          The initial level in the object must be below the set upper limit.
+
      '''''Fall below''''' - sets a lower limit for the resources being monitored.
+
          For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon falls below a specified level.
+
          The initial level in the object must be above the set lower limit.
+
          To test when a resource level reaches zero (i.e. is empty) set the lower limit to a very low value but not zero as the level can never fall below zero.
+
    '''''<value>''''' - enter required quantity value
+
    '''''<select>''''' - select a product from session list of products
+
    '''''<Add object>''''' - click to select a source or target object. Multiple objects and their queues can be added to the rule.
+
      ALL the entered products must reach/exceed or fall below the specified value for the rule to be triggered.
+
      For each object:-
+
          '''''<Object>''''' - click to select session active industry or product enabled rail vehicle
+
          '''''<Queue>''''' - select product queue (there may be only one available)
+
          '''''<Remove>''''' - removes the object and its product queue from the rule
+
 
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+
:This rule only checks for ''changing'' commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is ''full'' or ''empty''.
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Resource Check Rule|Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
+
*'''[[#Resource Verify Rule (fixed)|Resource Verify Rule (fixed)]]''' - executes child rules when a set resource (commodity) level is reached
+
 
+
[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+
*'''[[How to Use Navigation Point Rules (Applications)#Application 3: Wait for Loading to be Completed|How to Use Navigation Point Rules (Applications): Wait for Loading to be Completed]]'''
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[How to Use Parent and Child Rules]]'''
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Resource Check Rule'''==
+
=='''Insert Buff Label'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules if a selected industry or vehicle reaches a set commodity level. This rule has been superseded by the '''Multiple Resource Check Rule'''
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_InsertBuffLabel.png|50px|link=]]</td>
 
+
<td>Inserts a driver command as a label for a block of driver commands.</td>
*'''<kuid:-25:1067>'''
+
 
+
*'''Legacy Rule''' (replaced by '''Multiple Resource Check Rule''')
+
 
+
*'''Built-in Rule'''
+
 
+
*'''Parent Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    Select one of two option buttons:-
+
      '''( ) Watch industry queue'''
+
          '''Target Object ''<select>''''' - select an industry from the session list
+
          '''Queue ''<select>''''' - select a product queue from the selected industry
+
          '''Product ''<select>''''' - select a product from the selected queue
+
          '''Amount ''<value>''''' - enter a quantity
+
          Select one of two option buttons:-
+
            '''( ) Complete when designated queue equals or exceeds required amount'''
+
            '''( ) Complete when designated queue falls below required amount'''
+
      '''( ) Watch vehicle'''
+
          '''Target Object ''<select>''''' - select a rolling stock asset from the session list
+
          '''Queue ''<select>''''' - select a product queue from the selected rolling stock
+
          '''Product ''<select>''''' - select a product from the selected queue
+
          '''Amount ''<value>''''' - enter a quantity
+
          Select one of two option buttons:-
+
            '''( ) Complete when designated queue equals or exceeds required amount'''
+
            '''( ) Complete when designated queue falls below required amount'''
+
 
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+
:This rule only checks for ''changing'' commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is ''full'' or ''empty''.
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Multiple Resource Check Rule|Multiple Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
+
*'''[[#Resource Verify Rule (fixed)|Resource Verify Rule (fixed)]]''' - executes child rules when a set resource (commodity) level is reached
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[How to Use Parent and Child Rules]]'''
+
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Resource_Check_Rule</span>'''
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Resource Verify Rule (fixed)'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules if a selected industry or vehicle reaches a set commodity level. The rule resets when all child rules have completed.
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid:160293:101002> Insert buff label'''
  
*'''<kuid:160293:10060>'''
+
*'''DLS Command''' by '''trev999'''
  
*'''DLS Rule''' by '''trev999
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
*'''Parent Rule'''
+
'''Select ''<label number>''''' - select the label number (1 to 10)
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    Select one of two option buttons:-
+
    '''( ) Watch industry queue'''
+
      '''Target object ''<click to select>''''' - click to select an industry from the session list.
+
      '''Product ''<click to select>''''' - click to select an industry product.
+
      '''Amount ''<value>''''' - enter a quantity for the selected product.
+
      Select one of two option buttons:-
+
      '''( ) Complete when designated queue equals or exceeds designated amount'''
+
      '''( ) Complete when designated queue falls below designated amount'''
+
    '''( ) Watch vehicle queue'''
+
      '''Target object ''<click to select>''''' - click to select a rolling stock vehicle from the session list.
+
      '''Product ''<click to select>''''' - click to select a commodity product.
+
      '''Amount ''<value>''''' - enter a quantity for the selected product.
+
      Select one of two option buttons:-
+
      '''( ) Complete when designated queue equals or exceeds designated amount'''
+
      '''( ) Complete when designated queue falls below designated amount'''
+
  
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
#This rule will only monitor a single commodity in a single industry or vehicle.
+
:Up to 10 labels can be inserted into each drivers command list
#This rule only checks for ''changing'' commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is ''full'' or ''empty''.
+
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
*'''[[#Multiple Resource Check Rule|Multiple Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
+
*'''[[#Jump to Label|Jump to Label]]''' - unconditionally jumps to a named command label
*'''[[#Resource Check Rule|Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
+
*'''[[#Skip if Session-Variable|Skip if Session Variable]]''' - conditionally jumps to the named command label if a selected session variable meets a set condition
  
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
 
*'''[[How to Use Parent and Child Rules]]'''
 
 
<br>
 
<br>
<table width="100%" bgcolor=#ffff88>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
'''[[#top|Back to Top]]'''
+
=='''Jump to Label'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
<table width="100%" bgcolor=#ffff88>
+
<table>
<tr>
+
<tr valign="top">
<td>
+
<td>[[file:CMD_JumpToLabel.png|50px|link=]]</td>
='''Schedule Rules'''=
+
<td>Unconditionally jumps to a named command label.</td>
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
<br>
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Driver Command Check Rule'''==
+
</td>
+
</tr>
+
</table>
+
  
Executes child rules if the driver commands match a set list.
+
*'''<kuid2:160293:101003:2> Jump to label'''
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''DLS Command''' by '''trev999'''
  
*'''<kuid:-25:447>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
*'''Built-in Rule'''
+
'''Select ''<label number>''''' - select the label number (1 to 20)
  
*'''Parent Rule'''
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 +
:A '''label''' ('''Insert Buff label''' driver command) with the matching label number must be added to the driver commands
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
 
+
*'''[[#Insert Buff Label|Insert Buff Label]]''' - inserts a driver command as a label for a block of driver commands
  '''[x] Trigger rule once''' - check to allow the rule to execute only once
+
*'''[[#Skip if Session-Variable|Skip if Session Variable]]''' - conditionally jumps to the named command label if a selected session variable meets a set condition
  '''Driver character to watch the command list of ''<select>''' - select a driver name from the Session List''
+
  '''Wait for driver character to have a command list that matches this:'''
+
    '''''<add driver command>''''' - add a driver command from the session list. More commands can be added. Commands can be deleted.
+
    '''''<add all>''''' - adds ALL driver commands in the session list. Individual commands can be removed.
+
    '''''<delete all>''''' - deletes all entered driver commands from the session rule
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
+
*'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
+
*'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
+
*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
+
*'''[[#ScheduleAtTrackside Rule|ScheduleAtTrackside Rule]]''' - issues set of driver commands at a trackmark or trigger
+
*'''[[#Schedule Library Rule|Schedule Library Rule]]''' - creates a library of driver schedules (commands)
+
*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[How to Use Parent and Child Rules]]'''
+
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Driver_Command_Rule</span>'''
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Driver Command Rule'''==
+
=='''Layer Control'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Specifies which commands will be available for the drivers
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_LayerControl.png|50px|link=]]</td>
 
+
<td>Shows or hides a selected layer.</td>
*'''<kuid:-3:10057>'''
+
 
+
*'''Base Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
:
+
    For each installed Driver Command:-
+
    '''[x] ''Name of Driver Command'' and ''Description (if available)''''' - check to make that command available to the drivers
+
 
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+
:Some Driver Commands that have been checked will not appear in the Command Lists for drivers if there is no target for their action. For example:
+
:*The ''Wait For Trigger'' command will not be available to any drivers if there are no triggers set.
+
:*The ''Call At'' command will not be available to any drivers if there are no industry active assets or passenger enabled stations.
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
+
*'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
+
*'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
+
*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
+
*'''[[#ScheduleAtTrackside Rule|ScheduleAtTrackside Rule]]''' - issues set of driver commands at a trackmark or trigger
+
*'''[[#Schedule Library Rule|Schedule Library Rule]]''' - creates a library of driver schedules (commands)
+
*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
+
 
+
[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+
*'''[[How to Use Driver Setup Rule#Driver Command Rule|How to Use Driver Command Rule]]'''
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[Driver_Commands_List|Driver Commands List]]'''
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Driver Schedule Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Sets up a list of basic scheduled commands
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid:160293:101080> Layer Control'''
  
*'''<kuid2:82445:90001:9>'''
+
*'''DLS Command''' by '''trev999'''
  
*'''Built-in Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
  '''Show ''<list of layers in route and session>''''' - select a layer to make visible
   
+
  '''Hide ''<list of layers in route and session>''''' - select a layer to make invisible
    '''Driver Schedule Assigned to ''name of driver <icon>''''' - click '''icon''' to select a driver from those assigned in the '''Driver Setup Rule'''
+
    '''Next commands, will be executed'''  
+
      '''''>>''''' - click to enter driver commands from those specified in the '''Driver Command Rule'''
+
    '''Style:''' - select one of four option buttons:-
+
      '''( ) Classic style: If there is a schedule do not emit a new schedule''' - any currently assigned set of driver commands will not be replaced
+
      '''( ) Killer style: If there is a schedule clean it and emit a new one''' - replace any currently assigned driver commands with the new commands
+
      '''( ) Cooperative style: If there is a schedule append the new one''' - add the new driver commands to the end of any existing commands
+
      '''( ) Active style: Emit a new schedule, only if already a schedule running''' - only add the new commands if commands are currently running
+
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Session Rules:</span>
*'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
+
*'''[[Session_Rule_List_with_Parameters#Show.2FHide_Layer_Rule|Show/Hide Layer Rule]]'''
*'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
+
*'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
+
*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
+
*'''[[#ScheduleAtTrackside Rule|ScheduleAtTrackside Rule]]''' - issues set of driver commands at a trackmark or trigger
+
*'''[[#Schedule Library Rule|Schedule Library Rule]]''' - creates a library of driver schedules (commands)
+
*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
+
  
 
[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
 
[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
*'''[[How to Use Variables in Sessions (Examples)#Example 2: Event Counter and Message Selection|How to Use Variables in Sessions (Examples): Event Counter and Message Selection]]
+
*'''[[How_to_Use_Layers#Layers_in_Driver_Mode|Layers in Driver Mode]]'''
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Driver Setup Rule'''==
+
=='''Move to Train'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Creates the list of drivers for this session and assigns them their orders
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_MoveToTrain.png|50px|link=]]</td>
 
+
<td>Moves the driver with all their remaining driver commands to another train.</td>
*'''<kuid:-16:2025>'''
+
 
+
*'''Base Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''''<driver icon>''''' - click to select a new driver from the list of installed and built in drivers
+
    '''''<loco>''''' - click to select a new locomotive from the session list and assign it to this driver. Locos displayed in red have not been found in the session list
+
    '''''<driver name>''''' - click to enter a new name for the selected driver
+
    '''''<driver mode>''''' - click to select one of:-
+
      '''''Autodetect''''' - the program will detect the driver mode to be used. For example, if driver commands have been entered for this driver
+
          then the '''AI driver''' mode will be selected
+
      '''''First Human Player''''' - the driver will be assigned to the user or multiplayer who accesses her/him first
+
      '''''AI driver''''' - the AI will be given control even if no commands are present
+
      '''''Multiplayer Driver''''' - the driver will be assigned to a multiplayer user
+
    '''''<remove>''''' - this driver will be removed from the rule
+
    '''''>>''''' - click to enter driver commands from those specified in the '''Driver Command Rule'''
+
    --> Scroll down to the bottom of the list of entered drivers for more options
+
  '''''<Add another driver>''''' - click to add another driver
+
  '''[x] Remove all existing Drivers first''' - see '''Known Issues''' below
+
  '''[x] Generate new Drivers for empty Trains''' - when checked all newly added locos will automatically be given drivers
+
 
+
[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
+
#The '''Remove all existing Drivers first''' option does not appear to work in '''TANE''' (but works in '''TRS19''' and later)
+
#Adding a large number of drivers to a session can cause ''Timeout'' errors. One known workaround is to split the drivers between two copies of the '''Driver Setup Rule''' and make the second copy a child of a '''Wait Rule'''. For more details see the Wiki '''[[How to Use Driver Setup Rule]]'''. This issue has been reported as '''FIXED''' in the latest '''beta''' versions of '''TRS19 SP1''' and '''Trainz Plus'''
+
 
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+
:The driver at the top of the list will have the camera focus when the Session starts. There is no way to move a driver up the list order except by removing the higher drivers
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
+
*'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
+
*'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
+
*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
+
*'''[[#ScheduleAtTrackside Rule|ScheduleAtTrackside Rule]]''' - issues set of driver commands at a trackmark or trigger
+
*'''[[#Schedule Library Rule|Schedule Library Rule]]''' - creates a library of driver schedules (commands)
+
*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
+
 
+
[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+
*'''[[How to Use Driver Setup Rule]]'''
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[Driver_Commands_List|Driver Commands List]]'''
+
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Driver_Setup_Rule</span>'''
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Enable/Disable Driver Commands Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Enable/Disable specific driver commands on certain drivers. Multiple copies of the rule can be used to give different drivers or consists different command lists
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:71155:60004:2> Move to train'''
  
*'''<kuid:-25:480>'''
+
*'''DLS Command''' by '''_mutton_'''
  
*'''Built-in Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
'''All trains ''<list of locomotives>''''' - select a locomotive from the Session list
  
    '''<Enable/Disable>'' the following driver commands ...''' - click to select '''Enable''' or '''Disable'''
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
    For each driver command:-
+
#The new train must not already have a driver - make sure that the '''Generate New Drivers for Empty Trains''' option in the '''Driver Setup Rule''' is not ticked.
    '''[x] ''command name''''' - check to enable or disable
+
#If the new train does already have a driver then the command and any following commands will not be executed.
    '''[x] ''command name''''' - check to enable or disable
+
    '''[x] ''command name''''' - check to enable or disable
+
    etc
+
    Select one of two option buttons:-
+
      '''( ) click to accept all trains'''
+
      '''( ) click to accept trains matching specific criteria'''
+
          Selecting the second option will produce the following selection controls:-
+
          '''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
+
            '''''+''''' - click to add a ''specific'' vehicle from the session list
+
            '''''x''''' - click to remove the ''specific'' vehicle from the rule
+
          '''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule
+
            '''''+''''' - click to add a ''type'' of vehicle from the session list
+
            '''''x''''' - click to remove the ''type'' of vehicle from the rule
+
          '''Drivers''''' - identify the ''drivers'' that will trigger the rule
+
            '''''+''''' - click to add a ''driver'' from the session list
+
            '''''x''''' - click to remove a ''driver'' from the rule
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
+
*'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
+
*'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
+
*'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
+
*'''[[#ScheduleAtTrackside Rule|ScheduleAtTrackside Rule]]''' - issues set of driver commands at a trackmark or trigger
+
*'''[[#Schedule Library Rule|Schedule Library Rule]]''' - creates a library of driver schedules (commands)
+
*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
+
  
 
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
 
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Enable/Disable_Driver_Commands_Rule</span>'''
+
*'''[[How_to_Use_Driver_Setup_Rule|How to Use the Driver Setup Rule]]'''
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''ScheduleAtTrackside Rule'''==
+
=='''Set Custom HUD (SP2 and later)'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Allows a set of driver commands to be given to a train when it reaches a trackmark or trigger.
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_SetCustomHUD.png|50px|link=]]</td>
 
+
<td>Sets a predefined HUD on the screen.</td>
*'''<kuid2:61392:2001:6>'''
+
 
+
*'''DLS Rule''' by '''pguy'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''''<Select trackmark>'' - ''<Select trigger>''''' - click one to select a trackmark from the Session list or a trigger from the Session list
+
    '''Schedule will be fired ''<in both directions/in trackside forward direction/in trackside backward direction>''''' - click to select one. Only available if '''trackmark''' has been selected
+
    '''This rule will be applied ''<all along the session>''''' - click to enter the number of times to trigger the rule. 0 = everytime (all along the session)
+
    '''Enter driver commands to schedule when train is at trackside'''
+
      '''''>>''''' - click to enter driver commands from those specified in the '''Driver Command Rule'''
+
    Select one of two option buttons:-
+
      '''( ) new schedule will replace current driver command''' - select to delete any current command list and replace it with the command list above
+
      '''( ) new schedule will be appended to current driver commands''' - select to add the command list above above to the current driver command list
+
    '''''<add a new trackside entry>''''' - click to add a new '''ScheduleAtTrackside''' entry below
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
+
*'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
+
*'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
+
*'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
+
*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
+
*'''[[#Schedule Library Rule|Schedule Library Rule]]''' - creates a library of driver schedules (commands)
+
*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Schedule Library Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Creates a library of driver schedules (driver command lists) that can be given to drivers during the creation or running of a session
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
 
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
  
*'''<kuid2:192081:12:5>'''
+
*'''<kuid2:61392:7006:37> SetCustomHud (SP2 and later)'''
  
*'''Built-in Rule''' by '''brummfondel'''
+
*'''DLS Command''' by '''pguy'''
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
  '''''<add schedule>''''' | '''''<add group>'''''
+
'''''<defHud>''''' - select the default HUD
      To add <u>individual schedules</u> click ''<add schedule>'' then
+
'''''<altHud>''''' - select the alternate HUD
        '''''<library Entry Name>''''' - enter a unique name for the schedule
+
'''''<named Hud>''''' - select from a number of user defined HUDs
          '''''<library Entry Name>''''' - click to edit name
+
          '''''<remove>''''' - click to delete this schedule from the list
+
          '''''<copy>''''' - click to add a copy this schedule to the current group
+
          '''''<move to group>''''' - click to move this schedule to a schedule group
+
          In the driver command bar:-
+
              '''''>>''''' - click to enter driver commands from those specified in the '''Driver Command Rule'''
+
      To add <u>groups of schedules</u> click ''<add group>'' then
+
        '''''<Group Name>''''' - enter a unique name for the group
+
            '''-''' - click to close the group list
+
            '''+''' - click to open the group list
+
            '''''<Group Name>''''' - click to edit name
+
            '''''<remove>''''' - click to delete this group from the schedule list
+
  
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
#Create the library schedules in this rule first.
+
#the '''Quick CustomHud Manager Rule (SP2 and later)''' must be added to a session for a HUD to be selected by this command
#In '''Surveyor''' (using the '''Driver Setup Rule''') or '''Driver''' (directly in a driver command bar) add the Driver Command '''Copy Commands From''' and select the command schedule to be added or appended. The driver command '''Copy Commands From''' must be enabled in the '''Driver Command Rule'''.
+
#the default and alternate HUDs are preset but can be edited using the above rule
 +
#additional user defined and named HUDs can be created with the '''Quick CustomHud Manager Rule (SP2 and later)'''
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:PageLink3.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Required Session Rules:</span><br>
*'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
+
:'''Rules that MUST be added to the Session for this Driver Command to operate'''
*'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
+
*'''[[Session_Rule_List_with_Parameters#Quick_CustomHud_Manager_Rule_(SP2_and_later)|Quick CustomHud Manager Rule (SP2 and later)]]'''
*'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
+
*'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
+
*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
+
*'''[[#ScheduleAtTrackside Rule|ScheduleAtTrackside Rule]]''' - issues set of driver commands at a trackmark or trigger
+
*'''[[#Schedule Rule|Schedule Rule]]''' - applies a schedule of timed events to a train
+
  
[[file:PageLink4.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Dependent Driver Commands:</span>
 
:'''The rule must be added to the Session for the following Driver Command to work'''
 
*'''[[Driver Commands List#Copy Commands From|Copy Commands From]]'''
 
 
 
<br>
 
<br>
<table width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Schedule Rule'''==
 
</td>
 
</tr>
 
</table>
 
  
Allows a schedule of timed events to be applied to a train
+
=='''Skip if Session-Variable'''==
 
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
 
+
*'''<kuid:-3:10185>'''
+
 
+
*'''Base Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''Insert track mark ''<select>''''' - select a track mark from the Session List
+
    '''Arrival and Departure Time ''<Select>''''' - set time
+
      '''''hh:mm:ss''''' - in hours/minutes/seconds
+
    '''Current Train ''<select>''''' - select from session list
+
    '''Insert destination ''<select>''''' - select from session list
+
 
+
[[file:BugMini.PNG|link=]] <span style="text-decoration: underline; font-weight: 700; color: red;">Known Bugs:</span>
+
:There are reports that this rule does not work correctly particularly if a train arrives late or early.
+
 
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+
:Times are Trainz clock times, not real time
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
+
*'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
+
*'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
+
*'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
+
*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
+
*'''[[#ScheduleAtTrackside Rule|ScheduleAtTrackside Rule]]''' - issues set of driver commands at a trackmark or trigger
+
*'''[[#Schedule Library Rule|Schedule Library Rule]]''' - creates a library of driver schedules (commands)
+
 
+
[[file:WWWLinks.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Other Links:</span>
+
*'''<span class="plainlinks">http://www.auran.com/games/gamefiles/trainz/tutorial1.html</span>'''
+
<br>
+
<table width="100%" bgcolor=#ffff88>
+
<tr>
+
<td>
+
'''[[#top|Back to Top]]'''
+
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
<table width="100%" bgcolor=#ffff88>
+
<table>
<tr>
+
<tr valign="top">
<td>
+
<td>[[file:CMD_SkipIfSVar.png|50px|link=]]</td>
 
+
<td>Jumps to the named command label if a selected session variable meets a set condition.</td>
='''Session Sequence Rules'''=
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
<br>
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Ordered List Rule'''==
+
</td>
+
</tr>
+
</table>
+
  
Executes child rules in order once this rule starts
+
*'''<kuid2:160293:101014:3> Skip if session-variable'''
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''DLS Command''' by '''trev999'''
  
*'''<kuid:-25:171>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
*'''Built-in Rule'''
+
'''Select ''<label number if>''''' - select the label number (1 to 20)
 +
    '''''<Variable Name>''''' - from the '''InputTable Rule'''
 +
      '''''<condition>''''' - from the '''InputTable Rule'''
  
*'''Parent Rule'''
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
+
#The '''InputTable Rule''' must be installed in the session before this command can be used. This rule must be configured to identify the session variable(s), test condition(s) and value(s).
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
#A '''label''' ('''Insert Buff Label''' driver command) with the matching label number must be added to the driver commands
 
+
    Select one of two option buttons:-
+
      '''( ) This process will repeat ''<value>'' time(s)''' - enter the number of times this rule is to be repeated
+
      '''( ) This process will repeat forever'''
+
  
 
[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
 
[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
:Some child rules will force a "wait" until certain conditions have been met (e.g. a mouse click or a set time has passed). These rules will delay the completion of any following child rules in the '''Ordered List Rule'''. If possible, place these rules last in the Ordered List.
+
*'''TANE''' Sessions containing driver commands that use variables ''may not'' work correctly when imported into '''TRS19''' and '''Trainz Plus'''. The solution is to delete and then reinsert these commands in the imported Sessions
::For example: The '''Message Popup Rule''' will wait until it is closed before allowing the next child rule to be executed.
+
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
*'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child on the second run, etc
+
*'''[[#Insert Buff Label|Insert Buff Label]]''' - inserts a driver command as a label for a block of driver commands
*'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule
+
*'''[[#Jump to Label|Jump to Label]]''' - unconditionally jumps to a named command label
*'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously
+
*'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously
+
  
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
[[file:PageLink3.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Required Session Rules:</span><br>
*'''[[How to Use Parent and Child Rules]]'''
+
:'''Rules that MUST be added to the Session for this Driver Command to operate'''
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Ordered_List</span>'''
+
*'''[[Session Rule List with Parameters#InputTable Rule|InputTable Rule]]'''
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Progressive List Rule'''==
+
 
 +
=='''Wait Until S-Variable V3'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes the first child rule on the first run, the second child on the second run, the third child on the third run, etc.
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_WaitSVariable.png|50px|link=]]</td>
 
+
<td>The AI driver will wait until the identified variable matches the condition specified before the next command will be executed</td>
*'''<kuid:-25:754>'''
+
 
+
*'''Built-in Rule'''
+
 
+
*'''Parent Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
  '''After last child has been executed ...'''
+
  '''''<successive runs will do nothing/the first child is chosen again>''''' - click to select one
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order
+
*'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule
+
*'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously
+
*'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[How to Use Parent and Child Rules]]'''
+
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Progressive_List</span>'''
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Random List Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes ONE randomly selected child rule once only. The rule will not repeat to randomly select another child rule
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:160293:101006:3> Wait Until S-variable V3'''
  
*'''<kuid:-25:758>'''
+
*'''DLS Command''' by '''trev999'''
  
*'''Built-in Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
*'''Parent Rule'''
+
'''Select ''<Variable Name>''''' - select the variable name from those entered in the '''InputTable Rule'''
 +
    '''Select <Condition><Value>''''' - select from those entered in the '''InputTable Rule'''
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 +
*The '''InputTable Rule''' must be installed in the session before this command can be used. This rule must be configured to identify the session variable(s), test condition(s) and value(s).
  
    '''None'''
+
[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
 +
*'''TANE''' Sessions containing driver commands that use variables ''may not'' work correctly when imported into '''TRS19''' and '''Trainz Plus'''. The solution is to delete and then reinsert these commands in the imported Sessions
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:PageLink3.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Required Session Rules:</span><br>
*'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order
+
:'''Rules that MUST be added to the Session for this Driver Command to operate'''
*'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child rule on the second run, etc
+
*'''[[Session Rule List with Parameters#InputTable Rule|InputTable Rule]]'''
*'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously
+
*'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[How to Use Parent and Child Rules]]'''
+
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Random_List</span>'''
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Reset List Rule'''==
+
 
 +
=='''WaitUntilSVariable'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes ALL child rules continuously in an ongoing infinite cycle
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_WaitSVar.png|50px|link=]]</td>
 
+
<td>The AI driver will wait until the identified variable matches the condition specified before the next command will be executed</td>
*'''<kuid:-25:762>'''
+
 
+
*'''Built-in Rule'''
+
 
+
*'''Parent Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''None'''
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order
+
*'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child rule on the second run, etc
+
*'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule
+
*'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[How to Use Parent and Child Rules]]'''
+
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Reset_List</span>'''
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Simultaneous List Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules simultaneously once this rule starts
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:131986:1006:1> WaitUntilSVariable'''
  
*'''<kuid:-25:1048>'''
+
*'''DLS Command''' by '''atilabarut'''
  
*'''Built-in Rule'''
+
*'''Legacy Command''' has been replaced by '''Wait Until S-Variable'''
  
*'''Parent Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
'''Select ''<Variable Name><Condition><Value>''''' - from the '''InputTable Rule'''
  
    '''Rule completes when ...''' - click to chose one of the following:-
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
      '''''one of the child rules has completed'''''
+
*The '''InputTable Rule''' must be installed in the session before this command can be used. This rule must be configured to identify the session variable(s), test condition(s) and value(s).
      '''''all child rules have reached a completed state'''''
+
      '''''all child rules have reached a "was completed" state'''''
+
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
*'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order
+
*'''TANE''' Sessions containing driver commands that use variables ''may not'' work correctly when imported into '''TRS19''' and '''Trainz Plus'''. The solution is to delete and then reinsert these commands in the imported Sessions
*'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child on the second run, etc
+
*'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule
+
*'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously
+
  
[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
*'''[[How to Use Message Popup Rule (Applications)#Application 1: Timed Message|How to Use Message Popup Rule (Applications): Timed Message]]
+
*'''[[#Wait Until S-Variable V3|Wait Until S-Variable V3]]''' - AI driver waits for specified variable condition
*'''[[How to Use Parent and Child Rules]]'''
+
*'''[[How to Use Variables in Sessions (Examples)#Example 2: Event Counter and Message Selection|How to Use Variables in Sessions (Examples): Event Counter and Message Selection]]
+
  
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
[[file:PageLink3.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Required Session Rules:</span><br>
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Simultaneous_List</span>'''
+
:'''Rules that MUST be added to the Session for this Driver Command to operate'''
 +
*'''[[Session Rule List with Parameters#InputTable Rule|InputTable Rule]]'''
 
<br>
 
<br>
<table width="100%" bgcolor=#ffff88>
+
<table bgcolor=#a8ff8a>
 
<tr>
 
<tr>
 
<td>
 
<td>
Line 5,208: Line 2,840:
 
</table>
 
</table>
  
<table width="100%" bgcolor=#ffff88>
+
<table width="100%" bgcolor=#a8ff8a>
 
<tr>
 
<tr>
 
<td>
 
<td>
='''Speed Rules'''=
+
 
 +
='''Train Operation Commands'''=
 
</td>
 
</td>
 
</tr>
 
</tr>
Line 5,217: Line 2,850:
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''ATP Speed Limiter Rule'''==
+
=='''Bellz'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Limits allowable speed over set limit
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_Bellz.png|50px|link=]]</td>
 
+
<td>Rings the train bell.</td>
*'''<kuid2:321959:1000:1>'''
+
 
+
*'''Built-in Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''Limits the speed to ''<value>'' mph over the set limit''' - enter speed value in mph
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#AWS Configuration Rule|AWS Configuration Rule]]''' - configures the Trainz implementation of the Automatic Warning System when approaching signals
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Speeding Check Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules if player controlled trains are over the local speed limit or over a set (custom) speed
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:66277:80002:1> bellz'''
  
*'''<kuid2:60850:89004:3>'''
+
*'''Built-in Command''' by '''smileyman'''
  
*'''Built-in Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
*'''Parent Rule'''
+
'''None'''
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 +
:the locomotive must be equipped with a working bell.
  
    Select one of two options to set a speed limit to be observed
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
      '''( ) Watch for trains travelling above the posted speed limit'''
+
*'''[[#Hornz|Hornz]]''' - gives a blast of the horn (or whistle)
          '''''<speed value>''''' - click to enter a new overspeed tolerance value
+
*'''[[#HornzExtended|HornzExtended]]''' - gives a specified number of horn blasts
          '''''<speed units>''''' - click to select one from the list:-
+
            '''''Km/h''''' - Kilometres per hour
+
            '''''MPH''''' - Miles per hour
+
            '''''mps''''' - metres per second
+
      '''( ) Watch for trains travelling above a custom speed'''
+
          '''''<speed value>''''' - click to enter a new custom speed value
+
          '''''<speed units>''''' - click to select one from the list:-
+
            '''''Km/h''''' - Kilometres per hour
+
            '''''MPH''''' - Miles per hour
+
            '''''mps''''' - metres per second
+
            '''Warning: This option is very performance intensive and should only be used in sessions with few trains'''
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[How to Use Parent and Child Rules]]'''
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''MaxPermittedSpeed Rule'''==
+
=='''Couple'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Sets the maximum permitted speed of locomotives under AI control
+
<table>
 +
<tr valign="top">
 +
<td>[[file:CMD_Couple.png|50px|link=]]</td>
 +
<td>The AI driver moves the train (or just the locomotive if it is by itself) to couple with the specified wagon.</td>
 +
</tr>
 +
</table>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
*'''<kuid2:60850:89000:7>'''
+
*'''<kuid:-3:10081> Couple'''
  
*'''Built-in Rule'''
+
*'''Base Command'''
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
 +
 
 +
  '''''<list of available wagons>''''' - select a wagon to couple to
 +
 
 +
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 +
#The target wagon must be at the end of a consist or by itself. If the target is coupled in between other wagons then no coupling will take place.
 +
#There must be a clear path to the target wagon.
  
    '''None'''
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
 +
*'''[[#Couple At Trackmark|Couple At Trackmark]]''' - couples to the wagon closest to a specified trackmark
 +
*'''[[#Decouple|Decouple]]''' - decouples a consist at a specific place (does not work in the '''Driver Setup Rule''')
 +
*'''[[#Decouple DLX|Decouple DLX]]''' - decouples a consist at a specific, or a random, place. Upto 99 wagons
 +
*'''[[#Decouple Head N|Decouple Head N]]''' - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
 +
*'''[[#Decouple Number #|Decouple Number #]]''' - decouples a consist at a specific place. Upto 40 wagons
 +
*'''[[#Uncouplez|Uncouplez]]''' - decouples the locomotive (or locomotive + tender) from a consist
 +
*'''[[#UncouplezFrom|UncouplezFrom]]''' - decouples a consist at a specific place. Upto 20 wagons
  
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
:This rule cannot be configured from the Session Rules list. It must be configured in the '''config.txt''' file of each locomotive. Instructions with an example are shown in the rule Properties
 
 
<br>
 
<br>
<table width="100%" bgcolor=#ffff88>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
'''[[#top|Back to Top]]'''
+
=='''Couple At Trackmark'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
<table width="100%" bgcolor=#ffff88>
+
<table>
<tr>
+
<tr valign="top">
<td>
+
<td>[[file:CMD_Couple_At_Trackmark.png|50px|link=]]</td>
='''Startup and Termination Rules'''=
+
<td>The AI driver moves the train (or just the locomotive if it is by itself) to couple with the wagon that is closest to a specified trackmark.</td>
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
<br>
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''End Session Rule'''==
+
</td>
+
</tr>
+
</table>  
+
  
End the Session with a fade out.
+
*'''<kuid:2:57145:81100:1> Couple At Trackmark'''
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''DLS Command''' by '''marzipan'''
  
*'''<kuid:-25:482>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
*'''Built-in Rule'''
+
  '''''<list of available trackmarks>''''' - select a trackmark
 +
 
 +
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 +
#The end wagon of a consist must be within the effect radius of the trackmark. If there is no wagon with the radius then no coupling will take place.
 +
#The train will couple to the wagon closest to the trackmark and that may mean navigating to the other end of the consist.
 +
#There must be a clear path to the target wagon.
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
 +
*'''[[#Couple|Couple]]''' - couples wagons in a consist
 +
*'''[[#Decouple|Decouple]]''' - decouples a consist at a specific place (does not work in the '''Driver Setup Rule''')
 +
*'''[[#Decouple DLX|Decouple DLX]]''' - decouples a consist at a specific, or a random, place. Upto 99 wagons
 +
*'''[[#Decouple Head N|Decouple Head N]]''' - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
 +
*'''[[#Decouple Number #|Decouple Number #]]''' - decouples a consist at a specific place. Upto 40 wagons
 +
*'''[[#Uncouplez|Uncouplez]]''' - decouples the locomotive (or locomotive + tender) from a consist
 +
*'''[[#UncouplezFrom|UncouplezFrom]]''' - decouples a consist at a specific place. Upto 20 wagons
  
    '''Fade out over ''<value>'' seconds''' - enter number of seconds for fade out.
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
 
+
*'''[[How to Use Track Markers]]'''
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+
:Seconds are Trainz clock time, not real time.
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Session Complete Rule|Session Complete Rule]]''' - set the session to a percentage of completion
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Multiplayer Rule'''==
+
 
 +
=='''Decouple'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Enables the session to be taken online in a Multiplayer environment.
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_Decouple.png|50px|link=]]</td>
 
+
<td>The train is decoupled at the specified wagon (does not work in '''Driver Setup Rule''').</td>
*'''<kuid:447264:1045>'''
+
 
+
*'''Built-in Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''Suggested maximum number of players for this session ''<value>''''' - enter a number
+
    '''Maximum number of drivers per player ''<value>''''' - enter a number
+
    '''Players are permitted to claim drivers            [x]''' - check to allow players to select a driver
+
    '''Players can see each other's driver orders        [x]''' - check to allow players to view orders for other players
+
    '''Automatically target an available train on clients [x]''' - automatically assign a driver to each player
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Randomize Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Generates a different set of random numbers each time the session is run.
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid:-3:10082> Decouple'''
  
*'''<kuid:169301:100129>'''
+
*'''Base Command'''
  
*'''DLS Rule''' by '''Terry_Wagstaff'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
  '''''<list of available wagons>''''' - select a wagon to decouple from
  
    '''None'''
+
[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
 +
*This command does not work when added to a driver's command list in the '''Driver Setup Rule''' in Surveyor but it does work when manually added to the driver's command list in Driver
  
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
:Place this rule near the top of the Session Rules list and ensure that there is at least 5 seconds before the call to a Random function.
+
#If programming a driver via the '''Driver Setup Rule''', use the alternative commands '''Decouple DLX''', '''Decouple Number #''', '''Uncouplez''' or '''UncouplezFrom'''
 +
#The main problem with using decoupling commands in the '''Driver Setup Rule''' is that the number and identity of the wagons in a consist may not be known when the command is added to a driver's command list.
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
*'''[[#Variable Random|Variable Random]]''' - sets a variable to a random integer value.
+
*'''[[#Couple|Couple]]''' - couples wagons in a consist
 +
*'''[[#Couple At Trackmark|Couple At Trackmark]]''' - couples to the wagon closest to a specified trackmark
 +
*'''[[#Decouple DLX|Decouple DLX]]''' - decouples a consist at a specific, or a random, place. Upto 99 wagons
 +
*'''[[#Decouple Head N|Decouple Head N]]''' - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
 +
*'''[[#Decouple Number #|Decouple Number #]]''' - decouples a consist at a specific place. Upto 40 wagons
 +
*'''[[#Uncouplez|Uncouplez]]''' - decouples the locomotive (or locomotive + tender) from a consist
 +
*'''[[#UncouplezFrom|UncouplezFrom]]''' - decouples a consist at a specific place. Upto 20 wagons
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Session Complete Rule'''==
+
=='''Decouple DLX'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Set session to a percentage of completion.
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_DecoupleDLX.png|50px|link=]]</td>
 
+
<td>The train is decoupled at the specified wagon identified by name or number (upto 99 wagons), or at a random location.</td>
*'''<kuid:447264:1011>'''
+
 
+
*'''Base Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''Set session to percent complete ''<value>''''' - enter number as a percentage
+
    '''[x] Separate achievements for completion''' - check to set
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#End Session Rule|End Session Rule]]''' - end the Session with a fade out.
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Startup Options Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Specifies the starting options for the session. The weather settings will set the ''initial'' conditions, including the variability. To manually change the weather during play, use the '''Weather Rule'''.
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:160293:100120:2> Decouple DLX'''
  
*'''<kuid:-16:10212>'''
+
*'''DLS Command''' by '''trev999'''
  
*'''Base Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
  '''When Used in Surveyor using the Driver Setup Rule'''
 
+
      '''''<1-33>''''' - select a wagon numbered 1 to 33 where 1 is the wagon (or tender) immediately following the locomotive
    '''Current control method is ''<select>''''' - select one from:-
+
      '''''<34-66>''''' - select a wagon from 34 to 66
      '''''Easy Mode''''' - DCC (standard keyboard and mouse) control
+
      '''''<67-99>''''' - select a wagon from 67 to 99
      '''''Ask User''''' - let the user decide
+
      '''''<at position determined by>'''''
      '''''Realistic Mode''''' - Cab controls (on screen levers, throttles, buttons, etc)
+
        '''''<consist_count>''''' - requires the use of the '''special_instruction''' driver command
    '''Set weather to ''<select mode>'' with ''<select frequency>'' changeability''' - select
+
        '''''<a random number>''''' - a random number which may be beyond the last wagon in the consist
      '''Weather mode:''' - select one of:-
+
  '''When used in Driver Mode'''
          '''''Clear'''''
+
      '''''<1-33>''''' - each wagon is numbered and named. Select a wagon numbered 1 to 33 (or to the last wagon in that range)
          '''''Cloudy'''''  
+
        where 1 is the wagon (or tender) immediately following the locomotive
          '''''Drizzle'''''
+
      '''If there are more than 33 wagons, then'''
          '''''Rain'''''
+
        '''''<34-66>''''' - each wagon is numbered and named. Select a wagon from 34 to 66 (or to the last wagon in that range)
          '''''Stormy'''''
+
      '''if there are more than 66 wagons, then'''
          '''''Light Snow'''''
+
        '''''<67-99>''''' - each wagon is numbered and named. Select a wagon from 67 to 99 (or to the last wagon in that range)
          '''''Medium Snow'''''
+
      '''''<at position determined by>'''''
          '''''Heavy Snow'''''
+
        '''''<consist_count>''''' - requires the use of the '''special_instruction''' driver command
      '''Changeability:''' - select one of:-
+
        '''''<a random number>''''' - a random number upto and including the last wagon in the consist
          '''''Off''''' - the weather will not change from the mode selected above
+
          '''''Periodic''''' - slow gradual changes to the weather
+
          '''''Extreme''''' - rapid and extreme changes to the weather
+
    '''Set time to ''<hours>'':''<minutes>'' with a rate of ''<select speed>''''' - set the starting time and the speed at which the Trainz clock will run
+
    '''Set derailment realism to ''<select reality level>''''' - select one of:-
+
      '''''None''''' - no train derailments will occur
+
      '''''Arcade''''' - train derailments will be exaggerated (beyond normal)
+
      '''''Realistic''''' - train derailments will occur as realistically as possible
+
    '''[x] Show in game help''' - check to switch on help options
+
    '''Use ''<select measurement system>'' units in Driver''' - select one of:-
+
      '''''Metric''''' - kilometres, metres. This will override the default settings in a session
+
      '''''Imperial''''' - miles, feet. This will override the default settings in a session
+
      '''''Default''''' - uses the measurement system specified in the session
+
  
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
:Times are Trainz clock time, not real time
+
:The main problem with using decoupling commands in the '''Driver Setup Rule''' is that the number and identity of the wagons in a consist may not be known when the command is added to a driver's command list.
 +
 
 +
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
 +
*'''[[#Couple|Couple]]''' - couples wagons in a consist
 +
*'''[[#Couple At Trackmark|Couple At Trackmark]]''' - couples to the wagon closest to a specified trackmark
 +
*'''[[#Decouple|Decouple]]''' - decouples a consist at a specific place (does not work in the '''Driver Setup Rule''')
 +
*'''[[#Decouple Head N|Decouple Head N]]''' - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
 +
*'''[[#Decouple Number #|Decouple Number #]]''' - decouples a consist at a specific place. Upto 40 wagons
 +
*'''[[#Uncouplez|Uncouplez]]''' - decouples the locomotive (or locomotive + tender) from a consist
 +
*'''[[#UncouplezFrom|UncouplezFrom]]''' - decouples a consist at a specific place. Upto 20 wagons
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
 
*'''[[#Time and Rate Rule|Time and Rate Rule]]''' - sets the session start time and the rate at which time passes.
 
*'''[[#Weather Rule|Weather Rule]]''' - changes weather conditions during Session play
 
 
<br>
 
<br>
<table width="100%" bgcolor=#ffff88>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
'''[[#top|Back to Top]]'''
+
=='''Decouple Head N'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
<table width="100%" bgcolor=#ffff88>
+
<table>
<tr>
+
<tr valign="top">
<td>
+
<td>[[file:CMD_Decouple.png|50px|link=]]</td>
='''Time Rules'''=
+
<td>The train is decoupled to leave the selected number ('''N''') of wagons left in the consist.</td>
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
<br>
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Clock Rule'''==
+
</td>
+
</tr>
+
</table>
+
  
Rule needed for animated clocks.
+
*'''<kuid2:46162:70002:12> Decouple Head N'''
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''DLS Command''' by '''josefpav'''
  
*'''<kuid2:62310:30041:2>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
*'''Built-in Rule'''
+
  '''<select wagon number>''' - select the number of wagons (sorted by ASCII code not numerical value) to be left in the consist after the decoupling.
 +
        1 = the lead loco only (without its tender), 2 = loco + first wagon (which could be the tender), upto 75.
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 +
:The main problem with using decoupling commands in the '''Driver Setup Rule''' is that the number and identity of the wagons in a consist may not be known when the command is added to a driver's command list.
  
    '''None'''
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
 
+
*'''[[#Couple|Couple]]''' - couples wagons in a consist
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>  
+
*'''[[#Couple At Trackmark|Couple At Trackmark]]''' - couples to the wagon closest to a specified trackmark
:Apply this rule to your session to make use of the animated clocks. See the forum for code to include in your clock object to work with this rule.
+
*'''[[#Decouple|Decouple]]''' - decouples a consist at a specific place (does not work in the '''Driver Setup Rule''')
 +
*'''[[#Decouple DLX|Decouple DLX]]''' - decouples a consist at a specific, or a random, place. Upto 99 wagons
 +
*'''[[#Decouple Number #|Decouple Number #]]''' - decouples a consist at a specific place. Upto 40 wagons
 +
*'''[[#Uncouplez|Uncouplez]]''' - decouples the locomotive (or locomotive + tender) from a consist
 +
*'''[[#UncouplezFrom|UncouplezFrom]]''' - decouples a consist at a specific place. Upto 20 wagons
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Time and Rate Rule'''==
+
=='''Decouple Number #'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Sets the session start time and the rate at which time passes.
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_DecoupleNumber.png|50px|link=]]</td>
 
+
<td>The specified wagon number (#) and any following wagons will be uncoupled from the locomotive and consist.</td>
*'''<kuid:-25:889>'''
+
 
+
*'''Built-in Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''Set time to ''<hours:minutes>''''' - enter the clock starting time as hours ('''0-23''') and minutes ('''0-59''')
+
    '''with a rate of ''<1x>''''' - select a speed at which time will pass from '''1x''' (normal) to '''1440x''' (extremely fast)
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Startup Options Rule|Startup Options Rule]]''' - sets the startup options for a session including time and rate
+
*'''[[#Timecheck Rule|Timecheck Rule]]''' - executes child rules at a set time.
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Timecheck Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules at a set time.
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:147570:80008:1> Decouple number #'''
  
*'''<kuid2:122381:10008:3>'''
+
*'''Built-in Command''' by '''erniesouchak'''
  
*'''Built-in Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
*'''Parent Rule'''
+
  '''''<number>''''' - select a wagon number (1-40) to decouple from.
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''''<hh:mm:ss>''''' - enter execution time as hours (0-23), minutes (0-59) and seconds (0-59).
+
    '''[x] Execution time is on the day after the start time''' - when checked delays execution until the following day.
+
 
+
[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
+
:Do not use this rule as a child of a repeating rule such as the '''Simultaneous List Rule''' or the '''Ordered List Rule'''.
+
  
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
:Times and days are Trainz clock times not real time.
+
#The first locomotive is #1, the second locomotive (if any) or the tender (on a steam locomotive) is #2, etc.
 +
#The main problem with using decoupling commands in the '''Driver Setup Rule''' is that the number and identity of the wagons in a consist may not be known when the command is added to a driver's command list.
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
*'''[[#Time and Rate Rule|Time and Rate Rule]]''' - sets the session start time and the rate at which time passes.
+
*'''[[#Couple|Couple]]''' - couples wagons in a consist
*'''[[#Wait Rule|Wait Rule]]''' - executes child rules after waiting for a set number of seconds.
+
*'''[[#Couple At Trackmark|Couple At Trackmark]]''' - couples to the wagon closest to a specified trackmark
 
+
*'''[[#Decouple|Decouple]]''' - decouples a consist at a specific place (does not work in the '''Driver Setup Rule''')
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[#Decouple DLX|Decouple DLX]]''' - decouples a consist at a specific, or a random, place. Upto 99 wagons
*'''[[How to Use Parent and Child Rules]]'''
+
*'''[[#Decouple Head N|Decouple Head N]]''' - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
 +
*'''[[#Uncouplez|Uncouplez]]''' - decouples the locomotive (or locomotive + tender) from a consist
 +
*'''[[#UncouplezFrom|UncouplezFrom]]''' - decouples a consist at a specific place. Upto 20 wagons
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Wait Rule'''==
+
=='''Hornz'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules after waiting for set number of seconds
+
<table>
 +
<tr valign="top">
 +
<td>[[file:CMD_Hornz.png|50px|link=]]</td>
 +
<td>Gives one blast of the train horn or whistle.</td>
 +
</tr>
 +
</table>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
*'''<kuid2:122381:10016:2>'''
+
*'''<kuid2:66277:80001:2> Hornz'''
  
*'''Built-in Rule'''
+
*'''Built-in Command''' by '''smileyman'''
  
*'''Parent Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
'''None'''
  
    '''''<click to set>''''' - enter the number of seconds for the wait delay
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
 +
*'''[[#Bellz|Bellz]]''' - rings the locomotive bell (if it has one)
 +
*'''[[#HornzExtended|HornzExtended]]''' - gives a specified number of horn blasts
  
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
:Seconds is in Trainz clock time, not real time
 
 
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
 
*'''[[#Timecheck Rule|Timecheck Rule]]''' - executes child rules at a set time.
 
 
[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
 
*'''[[How to Use Message Popup Rule (Applications)#Application 1: Timed Message|How to Use Message Popup Rule (Applications): Timed Message]]'''
 
*'''[[How to Use Navigation Point Rules (Applications)#Application 4: User Path Selection|How to Use Navigation Point Rules (Applications): User Path Selection]]
 
 
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
 
*'''[[How to Use Parent and Child Rules]]'''
 
 
<br>
 
<br>
<table width="100%" bgcolor=#ffff88>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
'''[[#top|Back to Top]]'''
+
=='''HornzExtended'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
<table width="100%" bgcolor=#ffff88>
+
<table>
<tr>
+
<tr valign="top">
<td>
+
<td>[[file:CMD_HornzExtended.png|50px|link=]]</td>
='''Variable Rules'''=
+
<td>Gives a specified number of blasts of the train horn or whistle.</td>
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
<br>
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Quick Session Variables Rule'''==
+
</td>
+
</tr>
+
</table>
+
  
Allows the editing of session variables
+
*'''<kuid:478639:100034> HornzExtended'''
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''Built-in Command''' by '''ffccnn'''
  
*'''<kuid2:61392:5003:30>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
*'''DLS Rule''' by '''pguy'''
+
Select one of '''''<Play once>'''''
 +
              '''''<Play twice>'''''
 +
              ... up to ...
 +
              '''''<Play 10 times>'''''
  
*'''Legacy Rule''' (use '''Variable Modify Rule''')
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 +
:When the command is executed, the AI will immediately move onto the next command in the sequence and will blast the horn during the execution of the following driver commands until the set count has been reached
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
 
+
*'''[[#Bellz|Bellz]]''' - rings the locomotive bell (if it has one)
    '''''<local>''''' - click to edit local variables
+
*'''[[#Hornz|Hornz]]''' - gives one blast of the horn or whistle
      '''''<add new session variable>''''' - click to enter the name of new local variable
+
          for each variable:-
+
          '''''<variable-name>''''' - click to change variable name
+
          '''''<type>''''' - click to select one of:-
+
            '''string''' - text characters
+
            '''int''' - integer
+
            '''float''' - real (decimal) numbers
+
            '''bool''' - boolean (true/false)
+
            '''stringset''' - ''meaning not known at this time''
+
            '''stringlist''' - ''meaning not known at this time''
+
            '''tkmlist''' - trackmark list (no longer supported in TANE SP2)
+
            '''platformlist''' - platform list (no longer supported in TANE SP2)
+
            '''''del''''' - delete variable
+
            '''''edit''''' - edit variable
+
    '''''<trains>''''' - click to edit a train variable
+
      '''''<train selected>''''' - click to select a train from the session list. Initially none is selected
+
          '''''<select train>''''' - click to select a locomotive
+
          '''''<select vehicle>''''' - click to select a rail vehicle
+
          for the selected loco/vehicle:-
+
            '''''<Add new session variable>''''' - click to enter the name of a new variable
+
              for the entered variable:-
+
                  '''''<variable-name>''''' - click to change variable name
+
                  '''''<type>''''' - click to select type (see list above)
+
    '''''<objects>''''' - no longer supported in TANE SP2
+
    '''''<global>''''' - no longer supported in TANE SP2
+
 
+
[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
+
:Rule creator, '''pguy''', has indicated that the future of this rule is uncertain as parts of it have been devalued in the latest releases of Trainz.
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Variable Check Rule|Variable Check Rule]]''' - executes child rules according to the value of a specified variable.
+
*'''[[#Variable Modify Rule|Variable Modify Rule]]''' - changes the value of a specified variable.
+
*'''[[#Variable Modify Continuous Rule|Variable Modify Continuous Rule]]''' - continuously changes the value of a specified variable.
+
*'''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.
+
*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Variable Check Rule'''==
+
=='''MoveTurntable'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Executes child rules when a specific variable matches set conditions
+
<table>
 +
<tr valign="top">
 +
<td>[[file:CMD_MoveTurntable.png|50px|link=]]</td>
 +
<td>Moves the specified turntable to the specified track position.</td>
 +
</tr>
 +
</table>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
*'''<kuid:-25:1049>'''
+
*'''<kuid2:609850:100018:1> MoveTurntable'''
  
*'''Built-in Rule'''
+
*'''Built-in Command''' by '''vandragonax'''
  
*'''Parent Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
  '''''<name of turntable>''''' - select the named turntable (see '''Notes''' below).
 +
  '''''<track #>'' or ''<relative track movement>''''' - select the track number (0 = 1st track) or a relative movement (prev, next)
  
    '''''<variable-name>''''' - enter a variable-name. Variable name is case sensitive.
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
    Mathematical relationship, select one of:-
+
:The '''InputTable Rule''' must be installed in the session before this command can be used. This rule must be configured to identify all the turntables and the number of tracks they have.
      '''''is less than''''' - enter a '''''<value>''''' to test against
+
      '''''is less than or equal to''''' - enter a '''''<value>''''' to test against
+
      '''''is equal to''''' - enter a '''''<value>''''' to test against
+
      '''''is greater than or equal to''''' - enter a '''''<value>''''' to test against
+
      '''''is greater than''''' - enter a '''''<value>''''' to test against
+
      '''''is not equal to''''' - enter a '''''<value>''''' to test against
+
      '''''is between x and y''''' - enter a minimum '''''<x-value>''''' and a maximum '''''<y-value>'''''
+
    Evaluation type. Select one from:-
+
      '''''<This condition will be evaluated only once ...>''''' - any changes to the variable that occur after
+
              it has been checked will not change the result of this rule
+
      '''''<This condition will be evaluated once every second>''''' - the rule will be rerun and the variable
+
              rechecked every second
+
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:PageLink3.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Required Session Rules:</span><br>
*'''[[#Quick Session Variables Rule|Quick Session Variables Rule]]''' - allows the editing of session variables.
+
:'''Rules that MUST be added to the Session for this Driver Command to operate'''
*'''[[#Variable Modify Rule|Variable Modify Rule]]''' - changes the value of a specified variable.
+
*'''[[Session Rule List with Parameters#InputTable Rule|InputTable Rule]]'''
*'''[[#Variable Modify Continuous Rule|Variable Modify Continuous Rule]]''' - continuously changes the value of a specified variable.
+
*'''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.
+
*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
+
 
+
[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+
*'''[[How to Use Variables in Sessions (Examples)]]
+
 
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+
*'''[[How to Use Parent and Child Rules]]'''
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Variable Modify Continuous Rule'''==
+
=='''Priorityz'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Adds, subtracts or sets a value to a specified variable every second.
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_Priorityz.png|50px|link=]]</td>
 
+
<td>Sets the train priority value.</td>
*'''<kuid:-25:1051>'''
+
 
+
*'''Built-in Rule'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
  '''''<Add/Subtract/Change variable to>''''' - select one.
+
      '''''<value>''''' - enter value to add, subtract or apply to ''<variable-name>''
+
      '''''<variable-name>''''' - enter variable-name. Variable-name is case sensitive.
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Quick Session Variables Rule|Quick Session Variables Rule]]''' - allows the editing of session variables.
+
*'''[[#Variable Check Rule|Variable Check Rule]]''' - executes child rules according to the value of a specified variable.
+
*'''[[#Variable Modify Rule|Variable Modify Rule]]''' - changes the value of a specified variable.
+
*'''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.
+
*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Variable Modify Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Change the value of a specified variable. This rule can also used to create a new variable and set its initial value by using the "Change variable" option.
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid2:66277:80003:1> priorityz'''
  
*'''<kuid:-25:1050>'''
+
*'''Built-in Command''' by '''smileyman'''
  
*'''Built-in Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
'''''<value>''''' - select train priority value 1, 2 or 3
  
    '''Change ''<Add to variable/Subtract from variable/Change variable>''''' - click to select one from:-
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
      '''Add to variable'''
+
:The Priority value identifies the importance of the train for the '''Priority Trackmarkers'''. Usually (a guide only):-
          '''Add ''<value>''''' to '''variable ''<variable-name>''''' - enter value to add to variable, enter variable-name. Variable-name is case sensitive.
+
:*Priority 1 = Express trains
          '''''<Do not undo the alteration if the rule is stopped/Undo the alteration if the rule is stopped>''''' - click to select one.
+
:*Priority 2 = Local Expresses or Fast Freights
      '''Subtract from variable'''
+
:*Priority 3 = Slow Local Freights or All Stops Services
          '''Subtract ''<value>''''' from '''variable ''<variable-name>''''' - enter value to subtract from variable, enter variable-name.
+
            Variable-name is case sensitive.
+
          '''''<Do not undo the alteration if the rule is stopped/Undo the alteration if the rule is stopped>''''' - click to select one.
+
      '''Change variable'''
+
          '''Change variable ''<variable-name>'' to ''<value>''''' - enter variable-name, enter new value.
+
            Variable-name is case sensitive. This change cannot be undone if the rule is stopped.
+
    '''[x] (optional) Set the minimum value''' of '''''<variable-name>''''' to '''''<value>''''' - enter variable-name
+
      (this will already be set by the change option) and a value. Variable-name is case sensitive.
+
    '''[x] (optional) Set the maximum value''' of '''''<variable-name>''''' to '''''<value>''''' - enter variable-name
+
      (this will already be set by the change option) and a value. Variable-name is case sensitive.
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Quick Session Variables Rule|Quick Session Variables Rule]]''' - allows the editing of session variables.
+
*'''[[#Variable Check Rule|Variable Check Rule]]''' - executes child rules according to the value of a specified variable.
+
*'''[[#Variable Modify Continuous Rule|Variable Modify Continuous Rule]]''' - continuously changes the value of a specified variable.
+
*'''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.
+
*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
+
 
+
[[file:Ex.PNG|link=]] '''<u>Examples of Use:</u>'''
+
*'''[[How to Use Variables in Sessions (Examples)]]
+
  
 
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
 
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Variable_Modify_Rule</span>'''
+
*'''[[How_to_Use_Track_Priority_Markers|How to Use Track Priority Markers]]'''
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Variable Random Rule'''==
+
=='''Run Around'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Assigns a random integer value to a variable.
+
<table>
 
+
<tr valign="top">
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
<td>[[file:CMD_RunAround.png|50px|link=]]</td>
 
+
<td>Uncouples the locomotive (plus tender if present) from the train, navigates to the other end of the train and couples to the last wagon.</td>
*'''<kuid:400260:100606>'''
+
 
+
*'''DLS Rule''' by '''tram_'''
+
 
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
 
+
    '''Random variable ''<name>'' in ''minimum'' to ''maximum'' interval''' - enter name of variable. Variable-name is case sensitive.
+
    '''The minimum possible value of ''variable_name'' is ''<value>''''' - enter the minimum value
+
    '''The maximum possible value of ''variable_name'' is ''<value>''''' - enter the maximum value
+
 
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Quick Session Variables Rule|Quick Session Variables Rule]]''' - allows the editing of session variables.
+
*'''[[#Randomize|Randomize]]''' - creates a different set of random numbers for each session run.
+
*'''[[#Variable Check Rule|Variable Check Rule]]''' - executes child rules according to the value of a specified variable.
+
*'''[[#Variable Modify Rule|Variable Modify Rule]]''' - changes the value of a specified variable.
+
*'''[[#Variable Modify Continuous Rule|Variable Modify Continuous Rule]]''' - continuously changes the value of a specified variable.
+
*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
+
 
+
[[file:Ex.PNG|link=]] '''<u>Examples of Use:</u>'''
+
*'''[[How to Use Variables in Sessions (Examples)]]
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Variable Show Rule'''==
+
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Adds or removes a specified variable and a descriptive label to the custom HUD. This rule does not make the custom HUD appear on the screen.
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
*'''<kuid:-3:10083> Run Around'''
  
*'''<kuid:-25:971>'''
+
*'''Base Command'''
  
*'''Built-in Rule'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
'''None'''
  
  '''[x] Add'''
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
      '''''<variable-name>''''' - enter variable-name to add to HUD. Variable-name is case sensitive.
+
#There must be a path for the locomotive to follow from one end of the train to the other.
      '''''<label>''''' - (optional) enter a short label to be displayed on the HUD in front of the variable value.
+
#The locomotive must have sufficient clear space, free of track switches and signals, at both ends of the train to perform this movement.
  '''[x] Remove'''
+
      '''''<variable-name>''''' - enter variable-name to remove from HUD. Variable-name is case sensitive.
+
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
*'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
+
*'''[[#Run Around Ex|Run Around Ex]]''' - performs the run around only if there is no loco already in position at the other end
*'''[[#Quick Session Variables Rule|Quick Session Variables Rule]]''' - allows the editing of session variables.
+
*'''[[#Variable Check Rule|Variable Check Rule]]''' - executes child rules according to the value of a specified variable.
+
*'''[[#Variable Modify Rule|Variable Modify Rule]]''' - changes the value of a specified variable.
+
*'''[[#Variable Modify Continuous Rule|Variable Modify Continuous Rule]]''' - continuously changes the value of a specified variable.
+
*'''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.
+
  
[[file:Ex.PNG|link=]] '''<u>Examples of Use:</u>'''
 
*'''[[How to Use Variables in Sessions (Examples)]]
 
 
<br>
 
<br>
<table width="100%" bgcolor=#ffff88>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
'''[[#top|Back to Top]]'''
+
=='''Run Around Ex'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
<table width="100%" bgcolor=#ffff88>
+
<table>
<tr>
+
<tr valign="top">
<td>
+
<td>[[file:CMD_RunAroundEx.png|50px|link=]]</td>
='''Weather Rules'''=
+
<td>Uncouples the locomotive(s) (plus tender if present) from the train, navigates to the other end of the train and couples to the last wagon but ONLY if the other end of the train does not already have a locomotive in place.</td>
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<table width=100% width=100% bgcolor=#ffffcc>
 
<tr>
 
<td>
 
=='''EIRS Weather Rule NE USA Rule'''==
 
</td>
 
</tr>
 
</table>
 
 
Customize random weather rule relative to the North East Region of the United States.
 
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
*'''<kuid2:487222:1037:3>'''
+
*'''<kuid2:117667:83:3> Run Around Ex'''
  
*'''Built-in Rule'''
+
*'''DLS Command''' by '''nicroman'''
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
    '''Season ''<select>''''' - select one of:-
+
'''None'''
      '''''Summer'''''
+
      '''''Fall'''''
+
      '''''Winter'''''
+
      '''''Spring'''''
+
    '''Random Changeability (minutes) ''<value>''''' - select one of:-
+
      '''''2/5/10/15/20/30/45/60''''' - minutes''
+
    '''Environment Settings ''<select>''''' - select one of:-
+
      '''''Disable/Enable'''''
+
  
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
:Minutes are Trainz clock times, not real times
+
#There must be a path for the locomotive to follow from one end of the train to the other.
 +
#The locomotive must have sufficient clear space, free of track switches and signals, at both ends of the train to perform this movement.
 +
#There must be no locomotive already coupled to the destination end of the train.
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
*'''[[#Random Weather Rule v2|Random Weather Rule v2]]''' - randomly changes the weather according to entered parameters
+
*'''[[#Run Around|Run Around]]''' - unconditionally performs the run around
*'''[[#Startup Options Rule|Startup Options Rule]]''' - sets the weather conditions at the start of a Session
+
*'''[[#Weather Rule|Weather Rule]]''' - changes the weather conditions during Session play
+
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Random Weather Rule v2'''==
+
=='''Uncouplez'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Randomly changes the weather conditions between set values over a set duration.
+
<table>
 +
<tr valign="top">
 +
<td>[[file:CMD_Uncouplez.png|50px|link=]]</td>
 +
<td>Uncouples the locomotive (plus tender if present) from the train.</td>
 +
</tr>
 +
</table>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
*'''<kuid:169301:100132>'''
+
*'''<kuid2:66277:80000:1> UnCouplez'''
  
*'''DLS Rule''' by '''terry_wagstaff'''
+
*'''Built-in Command''' by '''smileyman'''
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
    '''Starting weather ''<select>'' - select one of:-
+
'''None'''
          '''''Clear weather, no clouds, rain or snow'''''
+
          '''''Cloudy weather, no rain'''''
+
          '''''Drizzle, light rain'''''
+
          '''''Rain'''''
+
          '''''Stormy weather that includes lightning and thunder'''''
+
          '''''Snowing lightly'''''
+
          '''''Medium snowfall'''''
+
          '''''Heavy snow'''''
+
    '''Best weather ''<select>'' - select one of:-
+
          '''''Clear weather, no clouds, rain or snow'''''
+
          '''''Cloudy weather, no rain'''''
+
          '''''Drizzle, light rain'''''
+
          '''''Rain'''''
+
          '''''Stormy weather that includes lightning and thunder'''''
+
          '''''Snowing lightly'''''
+
          '''''Medium snowfall'''''
+
          '''''Heavy snow'''''
+
    '''Worst weather ''<select>'' - select one of:-
+
          '''''Clear weather, no clouds, rain or snow'''''
+
          '''''Cloudy weather, no rain'''''
+
          '''''Drizzle, light rain'''''
+
          '''''Rain'''''
+
          '''''Stormy weather that includes lightning and thunder'''''
+
          '''''Snowing lightly'''''
+
          '''''Medium snowfall'''''
+
          '''''Heavy snow'''''
+
    '''Changing about every: ''<value>'' mins''' - enter number of minutes between weather changes
+
  
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
:This rule, once started, will run continuously and will not terminate. If this rule is to be used as a child rule of an '''Ordered List Rule''' then place it '''LAST''' in the list.
+
*'''[[#Couple|Couple]]''' - couples wagons in a consist
 
+
*'''[[#Couple At Trackmark|Couple At Trackmark]]''' - couples to the wagon closest to a specified trackmark
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
*'''[[#Decouple|Decouple]]''' - decouples a consist at a specific place (does not work in the '''Driver Setup Rule''')
*'''[[#EIRS Weather Rule NE USA Rule|EIRS Weather Rule NE USA Rule]]''' - customize random weather rule relative to the North East Region of the United States
+
*'''[[#Decouple DLX|Decouple DLX]]''' - decouples a consist at a specific, or a random, place. Upto 99 wagons
*'''[[#Startup Options Rule|Startup Options Rule]]''' - sets the weather conditions at the start of a Session
+
*'''[[#Decouple Head N|Decouple Head N]]''' - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
*'''[[#Weather Rule|Weather Rule]]''' - changes the weather conditions during Session play
+
*'''[[#Decouple Number #|Decouple Number #]]''' - decouples a consist at a specific place. Upto 40 wagons
 +
*'''[[#UncouplezFrom|UncouplezFrom]]''' - decouples a consist at a specific place. Upto 20 wagons
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#d7ffc9>
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Weather Rule'''==
+
=='''UncouplezFrom'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Changes the weather conditions during Session play.
+
<table>
 +
<tr valign="top">
 +
<td>[[file:CMD_Uncouplez.png|50px|link=]]</td>
 +
<td>Uncouples the train at the wagon specified.</td>
 +
</tr>
 +
</table>
  
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
  
*'''<kuid:-25:960>'''
+
*'''<kuid2:66277:80005:2> UnCouplezFrom'''
  
*'''Built-in Rule'''
+
*'''Built-in Command''' by '''smileyman'''
  
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
  
    '''Set weather to ''<select mode>'' with ''<select frequency>'' changeability''' - select
+
  '''''<number>''''' - select a wagon number (0-20) to decouple from.
      '''Weather mode:''' - select one of:-
+
          '''''Clear'''''
+
          '''''Cloudy'''''
+
          '''''Drizzle'''''
+
          '''''Rain'''''
+
          '''''Stormy'''''
+
          '''''Light Snow'''''
+
          '''''Medium Snow'''''
+
          '''''Heavy Snow'''''
+
    '''Changeability:''' - select one of:-
+
          '''''Off''''' - the weather will not change from the mode selected above
+
          '''''Periodic''''' - slow gradual changes to the weather
+
          '''''Extreme''''' - rapid and extreme changes to the weather
+
  
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
*'''[[#EIRS Weather Rule NE USA Rule|EIRS Weather Rule NE USA Rule]]''' - customize random weather rule relative to the North East Region of the United States
+
#The first wagon '''after''' the locomotive (or the locomotive and tender) is #0, the second wagon is #1, etc.
*'''[[#Random Weather Rule v2|Random Weather Rule v2]]''' - randomly changes the weather according to entered parameters
+
#The main problem with using decoupling commands in the '''Driver Setup Rule''' is that the number and identity of the wagons in a consist may not be known when the command is added to a driver's command list.
*'''[[#Startup Options Rule|Startup Options Rule]]''' - sets the weather conditions at the start of a Session
+
 
 +
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
 +
*'''[[#Couple|Couple]]''' - couples wagons in a consist
 +
*'''[[#Couple At Trackmark|Couple At Trackmark]]''' - couples to the wagon closest to a specified trackmark
 +
*'''[[#Decouple|Decouple]]''' - decouples a consist at a specific place (does not work in the '''Driver Setup Rule''')
 +
*'''[[#Decouple DLX|Decouple DLX]]''' - decouples a consist at a specific, or a random, place. Upto 99 wagons
 +
*'''[[#Decouple Head N|Decouple Head N]]''' - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
 +
*'''[[#Decouple Number #|Decouple Number #]]''' - decouples a consist at a specific place. Upto 40 wagons
 +
*'''[[#Uncouplez|Uncouplez]]''' - decouples the locomotive (or locomotive + tender) from a consist
 
<br>
 
<br>
<table width="100%" bgcolor=#ffff88>
+
<table bgcolor=#a8ff8a>
 
<tr>
 
<tr>
 
<td>
 
<td>
Line 6,052: Line 3,431:
 
<span style="font-size: 17px; font-weight: 700;">More Tutorials and Guides to Using Trainz</span><br>
 
<span style="font-size: 17px; font-weight: 700;">More Tutorials and Guides to Using Trainz</span><br>
 
*'''<span class="plainlinks">[http://online.ts2009.com/mediaWiki/index.php/HowTo How to Guides]</span>'''
 
*'''<span class="plainlinks">[http://online.ts2009.com/mediaWiki/index.php/HowTo How to Guides]</span>'''
*'''[[Driver Commands List]]'''
 
 
*'''[[Session Rule List with Parameters|Session Rules List (Alphabetical) with Parameters]]'''
 
*'''[[Session Rule List with Parameters|Session Rules List (Alphabetical) with Parameters]]'''
 +
*'''[[Session Rules By Categories With Properties|Session Rules List (Categories) With Parameters]]'''
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 +
 
[[Category:How-to_guides|HowTo Guides]]
 
[[Category:How-to_guides|HowTo Guides]]
[[Category:Rules]]
 

Revision as of 21:47, 2 November 2019

The information in this Wiki Page applies to TANE, TRS19 and Trainz Plus.

This page is always under construction. As new driver commands appear and are tested they will be added to this list. Current Command Count: 57

Only driver commands supplied with Trainz or on the DLS are covered in this document.

The driver commands listed in this page are all found in Trainz Surveyor from the Edit Session option in the Main Menu and are accessed by the WikiLink.PNG Driver Command Rule and the WikiLink.PNG Driver Setup Rule.

See the Trainz Wiki Page WikiLink.PNG How to Use the Driver Setup Rule for more information on both rules.

Those commands that are identified as a DLS Command must be downloaded and installed from the Trainz DLS first.

Description Key:

  • <kuid number> is for the command version at the time of writing. This number will change if the command is updated.
  • DLS Command must be downloaded and installed from the DLS.
  • Base Command and Built-in Command are installed with Trainz.
  • Obsolete Command is no longer required (explanation given).
  • Legacy Command has been replaced by another command (new command will be identified).
  • SP2 and later means TANE SP2 and later versions including TRS19 and Trainz Plus.

Contents

Interlocking Tower and Mission Code Commands


AddMissionCode (SP2 and Later)

CMD AddMissionCode.PNG Adds a mission code (a sequence of IT or EIT paths) to any mission codes already loaded for the train. The mission code must be set by the Mission Code Manager Rule (SP2 and Later)

Properties.PNG Command Properties:

  • <kuid2:61392:8203:56> AddMissionCode (SP2 and later)
  • DLS Command by pguy

Settings.PNG Command Settings:

  <mission codes> - select a mission code from the Session list

Notes.PNG Notes:

The mission code must be created by the Mission Code Manager Rule (SP2 and Later) using paths created with Interlocking Towers

PageLink2.PNG Related Commands:

PageLink3.PNG Required Session Rules:

Rules that MUST be added to the Session for this Driver Command to operate


IT CancelEnhancedPath

CMD ITCancelEnhancedPath.png Cancels an active Enhanced Interlocking Tower (EIT) path for the train that had been set by the IT SetPath Command

Properties.PNG Command Properties:

  • <kuid2:61392:8114:54> IT CancelEnhancedPath
  • DLS Command by pguy

Settings.PNG Command Settings:

  <Select EIT> - select from list of session EITs
     <Select Path> - select the active path from that EIT

Notes.PNG Notes:

  1. The active path must be created using Enhanced Interlocking Towers
  2. Cancelling a path makes it available for other consists and allows conflicting paths to be made active
  3. An active path is automatically cancelled after it has been completed by a train

PageLink2.PNG Related Commands:


IT SetPath

CMD ITSetPath.png Selects and sets a path for the train from those available from Interlocking Towers (ITs) and Enhanced Interlocking Towers (EITs). If this path was created by an EIT it can be cancelled prior to its use by the IT CancelEnhancedPath Command

Properties.PNG Command Properties:

  • <kuid2:61392:8111:54> IT SetPath
  • DLS Command by pguy

Settings.PNG Command Settings:

  <Select IT or EIT> - select from list of session ITs and/or EITs
     <Select Path> - select from available paths for that IT/EIT

Notes.PNG Notes:

  1. The paths must be created using Interlocking Towers
  2. An active path is automatically cancelled after it has been completed by a train

PageLink2.PNG Related Commands:


IT SetPathAndWaitActive

CMD ITSetPath.png Selects and sets a path for the train from those available from Interlocking Towers (ITs) and Enhanced Interlocking Towers (EITs) and waits until the path becomes active. If this path was created by an EIT it can be cancelled prior to its use by the IT CancelEnhancedPath Command

Properties.PNG Command Properties:

  • <kuid2:61392:8113:54> IT SetPathAndWaitActive
  • DLS Command by pguy

Settings.PNG Command Settings:

  <Select IT or EIT> - select from list of session ITs and/or EITs
     <Select Path> - select from available paths for that IT/EIT

Notes.PNG Notes:

  1. The paths must be created using Interlocking Towers
  2. An active path is automatically cancelled after it has been completed by a train

PageLink2.PNG Related Commands:


IT SetPathAndWaitNotRed

CMD ITSetPath.png Selects and sets a path for the train from those available from Interlocking Towers (ITs) and Enhanced Interlocking Towers (EITs) and waits until the next signal is not showing red. If this path was created by an EIT it can be cancelled prior to its use by the IT CancelEnhancedPath Command

Properties.PNG Command Properties:

  • <kuid2:61392:8112:54> IT SetPathAndWaitNotRed
  • DLS Command by pguy

Settings.PNG Command Settings:

  <Select IT or EIT> - select from list of session ITs and/or EITs
     <Select Path> - select from available paths for that IT/EIT

Notes.PNG Notes:

  1. The paths must be created using Interlocking Towers
  2. An active path is automatically cancelled after it has been completed by a train

PageLink2.PNG Related Commands:


RemoveMissionCode (SP2 and Later)

CMD RemoveMissionCode.PNG Removes a mission code (a sequence of IT or EIT paths) from any mission codes already loaded for the train. The mission code must be set by the Mission Code Manager Rule (SP2 and Later) and given to the driver by the SetMissionCode (SP2 and later) or AddMissionCode (SP2 and Later) driver commands or by the Mission Code Manager Rule (SP2 and Later) itself

Properties.PNG Command Properties:

  • <kuid2:61392:8204:56> RemoveMissionCode (SP2 and later)
  • DLS Command by pguy

Settings.PNG Command Settings:

  <mission codes> - select a mission code from the Session list

Notes.PNG Notes:

The mission code must be created by the Mission Code Manager Rule (SP2 and Later) using paths created with Interlocking Towers

PageLink2.PNG Related Commands:

PageLink3.PNG Required Session Rules:

Rules that MUST be added to the Session for this Driver Command to operate


SetMissionCode (SP2 and Later)

CMD SetMissionCode.PNG Sets a mission code (a sequence of IT or EIT paths) for the train. The mission code must be set by the Mission Code Manager Rule (SP2 and Later). Mission codes can also be given to trains in Surveyor or Driver mode through the Mission Code Manager Rule (SP2 and Later)

Properties.PNG Command Properties:

  • <kuid2:61392:8201:56> SetMissionCode (SP2 and later)
  • DLS Command by pguy

Settings.PNG Command Settings:

  <*Reset mission code> - resets the currently loaded mission code, or
  <mission codes> - select a mission code from the Session list

Notes.PNG Notes:

The mission code must be created by the Mission Code Manager Rule (SP2 and Later) using paths created with Interlocking Towers

PageLink2.PNG Related Commands:

PageLink3.PNG Required Session Rules:

Rules that MUST be added to the Session for this Driver Command to operate


Back to Top

Junction and Signal Commands


ControlJunction

CMD ControlJunction.png Sets the direction for a single specified junction switch.

Properties.PNG Command Properties:

  • <kuid:131986:1011> ControlJunction
  • DLS Command by atilabarut

Settings.PNG Command Settings:

  Select switch direction, one of <LEFT/RIGHT/FORWARD>
     Select <switch name> from the session list

PageLink2.PNG Related Commands:

  • SetOneJunction - sets the direction for a single specified junction switch


SetOneJunction

CMD SetOneJunction.png Sets the direction for a single specified junction switch.

Properties.PNG Command Properties:

  • <kuid:121843:100445> SetOneJunction
  • DLS Command by pitkin

Settings.PNG Command Settings:

  Select <switch name> from the session list
     Select switch direction, one of <LEFT/RIGHT/FORWARD/BACKWARD>

PageLink2.PNG Related Commands:

  • ControlJunction - sets the direction for a single specified junction switch


Set Signal Ahead

CMD SignalAhead.png Sets the state of the next signal ahead.

Properties.PNG Command Properties:

  • <kuid2:368725:60003:6> Set Signal Ahead
  • DLS Command by elstoko

Settings.PNG Command Settings:

  <Set next signal to> - select one from
     <Stop>
     <Caution Straight>
     <Caution Left>
     <Caution Right>
     <Proceed Straight>
     <Proceed Left>
     <Proceed Right>
     <Advance Caution>
     <Call on 1 (State 9)>
     <Call on 2 (State 10)>
     <Automatic>

Notes.PNG Notes:

  1. This command only works on signals that will respond to the function "SetSignalStateEx", not all signals will respond
  2. The signal must support the selected state otherwise there will be no change
  3. The signal will be reset after the train has cleared the signal


Back to Top

Load and Unload Commands


Instant Load

CMD InstantLoad.png Instantly loads all rolling stock (except locos and tenders) in the train with the item(s) in their commodity queues.

Properties.PNG Command Properties:

  • <kuid2:45324:555017:7> Instant Load Command
  • DLS Command by norfolksouthern37

Settings.PNG Command Settings:

None


InstantLoadLocos

CMD InstantLoadLocos.png Instantly loads all locos and tenders in the train with the item(s) in their commodity queues (coal, water, diesel fuel).

Properties.PNG Command Properties:

  • <kuid2:117290:1022:1> InstantLoadLocos
  • Built-in Command by nzhorse

Settings.PNG Command Settings:

None


InstantUnLoad

CMD InstantUnLoad.png Instantly unloads the commodities in all rolling stock (except locos and tenders) in the train.

Properties.PNG Command Properties:

  • <kuid2:67585:1021:2> InstantUnload
  • DLS Command by robin_hoods

Settings.PNG Command Settings:

None


Load

CMD Load.png Instructs the AI driver to load the commodity or commodities waiting at an industry enabled asset into the rolling stock assets that have been configured to receive them. This may involve the AI driver moving the train forward a few wagons at a time until the entire length of the train has passed through the loading area. The Load command is also used for loading (and unloading) passengers at passenger enabled stations.

Properties.PNG Command Properties:

  • <kuid:-3:10076> Load
  • Base Command

Settings.PNG Command Settings:

None

Notes.PNG Notes:

  1. If the industry where the loading is taking place uses up all the available commodities before all the wagons are fully loaded, then any following wagons will not be loaded until the commodity is available again but the AI driver will not stop to wait.
  2. With passenger enabled stations the Load command will first execute an Unload command to unload some of the passengers.


Load At

CMD IndustryIcon.png Combines the Drive To and Load commands. Instructs the AI driver to drive to an industry (or passenger enabled station) and load the commodity or commodities waiting there into the rolling stock assets that have been configured to receive them. This may involve the AI driver moving the train forward a few wagons at a time until the entire length of the train has passed through the loading area. The Load At command is also used for loading (and unloading) passengers at passenger enabled stations. All signals and speed signs are obeyed during the "Drive To" operation.

Properties.PNG Command Properties:

  • <kuid2:75377:84:1> Load At
  • DLS Command by stagecoach

Settings.PNG Command Settings:

Select <name of industry> or industry enabled passenger station from the session list
  if applicable <name/number of track or platform> for industries and stations that have identified active platforms, tracks or loading bays

Notes.PNG Notes:

  1. The AI driver will select the shortest available path to the destination.
  2. If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will not attempt to find an alternative path to the destination. This can lead to the train stopping and waiting indefinately until the blockage is removed.
  3. If the industry where the loading is taking place uses up all the available commodities before all the wagons are fully loaded, then any following wagons will not be loaded until the commodity is available again but the AI driver will not stop to wait.
  4. With passenger enabled stations the Load command will first execute an Unload command to unload some of the passengers.

PageLink2.PNG Related Commands:

  • Drive To - drives to an industry but does not seek alternative paths if blocked
  • Load - loads commodities at an industry (including a station)


Terminate Passenger Train

CMD TerminateTrain.png An Unload command for passenger trains arriving at a terminal station. The train will be emptied of passengers.

Properties.PNG Command Properties:

  • <kuid2:116387:16:2> Terminate Passenger Train
  • Built-in Command by maggs

Settings.PNG Command Settings:

None

Notes.PNG Notes:

  1. Issue a Drive To command (or similar) to the station before using this command. The station must be industry active.


Unload

CMD Unload.png Instructs the AI driver to unload the commodity or commodities loaded in rolling stock assets to the industry enabled asset if it has been configured and is able to receive them. This may involve the AI driver moving the train forward a few wagons at a time until the entire length of the train has passed through the loading area. The Unload command is also used for unloading passengers at passenger enabled stations.

Properties.PNG Command Properties:

  • <kuid:-3:10077> Unload
  • Base Command

Settings.PNG Command Settings:

None

Notes.PNG Notes:

  1. If the industry where the unloading is taking place reaches its maximum capacity before all the wagons are fully unloaded, then any following wagons will not be unloaded until capacity is available again but the AI driver will not stop to wait.
  2. With passenger enabled stations the Unload command will unload a set number of passengers, specifically:-
  • Terminal stations = 100% of loaded passengers
  • Large stations = 50%
  • Standard stations = 25%
  • Small stations = 10%
The station size is set in the station properties


Back to Top

Movement Commands


AI Wait Until Green Signal

CMD WaitUntilGreen.png Instructs the AI driver to wait for a green signal ahead before executing the next driver command. The interface for this driver command is in Russian.

Properties.PNG Command Properties:

  • <kuid2:151055:100101:3> AI Wait until green signal
  • DLS Command by erendir

Settings.PNG Command Settings:

  Ждать, пока не будет зелёный > - Translation: "Wait until it is green >" 
     На любом светофоре - Translation: "At any traffic light" - select for the next signal up to 3000m ahead
     Только на станционном зале " Z7 " /Су - Translation: "Only at the station hall " Z7 " / su" - unknown meaning


Change Train Direction

CMD ChangeDirection.png Reverses the driving direction of the train.

Properties.PNG Command Properties:

  • <kuid2:70791:9001:1> Change Train Direction
  • Built-in Command by mgalling

Settings.PNG Command Settings:

None


Halt Train

CMD HaltTrain.png Brings the train to an immediate stop.

Properties.PNG Command Properties:

  • <kuid:401543:1090> Halt Train
  • Base Command

Settings.PNG Command Settings:

None


Set Max Speed To

CMD MaxSpeed.png Instructs the AI driver to drive up to the set maximum speed (mph). This speed limit has no effect on other AI trains. Lower speed limit signs are obeyed.

Properties.PNG Command Properties:

  • <kuid2:450022:90001:2> Set Max Speed To
  • DLS Command by nikkia

Settings.PNG Command Settings:

Select <No maximum speed> or <value> in mph

Notes.PNG Notes:

The maximum speed, once set, will remain in place throughout the session unless cancelled or reset by another Set Max Speed To command.

PageLink2.PNG Related Commands:


Set Max Speed To (km/h)

CMD MaxSpeed.png Instructs the AI driver to drive up to the set maximum speed (km/h). This speed limit has no effect on other AI trains. Lower speed limit signs are obeyed.

Properties.PNG Command Properties:

  • <kuid:450022:90002> Set Max Speed To (km/h)
  • DLS Command by nikkia

Settings.PNG Command Settings:

Select <No maximum speed> or <value> in km/h

Notes.PNG Notes:

The maximum speed, once set, will remain in place throughout the session unless cancelled or reset by another Set Max Speed To command.

PageLink2.PNG Related Commands:


WaitFor

CMD WaitFor.png Instructs the AI driver to wait for a set time period before executing the next instruction in the command list.

Properties.PNG Command Properties:

  • <kuid:-3:10090> WaitFor
  • Base Command

Settings.PNG Command Settings:

Select <time delay> from list

Notes.PNG Notes:

There are a limited range of available times from 5 seconds to 1 hour. A time delay that is not in this list (e.g. 3 minutes) can be achieved by using two (or more) WaitFor commands with the combined total of their times equaling the required time delay.


PageLink2.PNG Related Commands:


WaitForTrigger

CMD WaitForTrigger.png Instructs the AI driver to wait for a trigger event before executing the next instruction in the command list. The train triggering the event can be any train in the session.

Properties.PNG Command Properties:

  • <kuid2:57344:80001:5> WaitFor
  • Built-in Command by marinus

Settings.PNG Command Settings:

Select <trigger name> from the session list
   Select <any train> or locomotive from <list of locomotive names>

Issues.PNG Known Issues:

  • The presence of a large number of locos in a session can cause this command to fail due to a timeout error

Notes.PNG Notes:

  • Command will not appear in a drivers command list if there are no triggers set


Wait Until II

CMD WaitUntilII.png Instructs the AI driver to wait until the specified time

Properties.PNG Command Properties:

  • <kuid:32711:100025> Wait Until II
  • Built-in Command by dap

Settings.PNG Command Settings:

Select <hours> 1 to 24
   Select <minutesx10> minutes 0 to 50 in increments of 10
      Select <minutesx1> minutes 0 to 9

Notes.PNG Notes:

  • If the driver is running up to 4 hours late this command will terminate immediately
  • If the wait until time is more than 4 hours behind the game time, the command will wait until tomorrow
  • The game time rate must be set to x1 (normal speed) for the command to work correctly
  • Run-time editing is not available for this command. To edit in Driver the command must be removed first

PageLink2.PNG Related Commands:

  • WaitFor - sets the wait period for up to 1 hour


Back to Top

Navigation Commands


AutoDrivePastSignal

CMD AutoDrivePastSignal.png Instructs the AI driver to drive under Autopilot until the entire train clears the specified signal but the AI will not set any junction switches so the train will follow whatever path is set ahead of it. All signals and speed signs are obeyed. The train will slow to a halt after passing the signal.

Properties.PNG Command Properties:

  • <kuid2:61392:7101:1> AutoDrivePastSignal Command
  • DLS Command by pguy

Settings.PNG Command Settings:

  Select <signal name> from Session list

Notes.PNG Notes:

  • It is the users responsibility to set all junction switches ahead of the train. The AI will not set the switches

PageLink2.PNG Related Commands:

  • AutoPilot - drives continuously or until a specified trackmark has been passed


Autopilot

CMD AutoPilot.png Instructs the AI driver to drive but the AI will not set any junction switches so the train will follow whatever path is set ahead of it. All signals and speed signs are obeyed.

Properties.PNG Command Properties:

  • <kuid2:71155:60001:5> Autopilot Command
  • DLS Command by _mutton_

Settings.PNG Command Settings:

Select one of
   <activate> - starts the Autopilot Command. This will only terminate when the Autopilot Command is removed from the driver command line
   <stop at track mark> - select a trackmark from the session list. Starts the Autopilot Command and drives until the train reaches the selected trackmark (see Notes below)

Notes.PNG Notes:

  1. It is the users responsibility to set all junction switches ahead of the train. The AI will not set the switches
  2. If the Stop at track mark option is used then:-
  • the train will not set a path to the track mark, that is the users responsibility
  • the train will run at the full posted line speed upto the track mark and then it will slow to a stop
  • if the track mark is never reached because the correct path has not been set, the train will continue as it would for the activate option

PageLink2.PNG Related Commands:


Drive To

CMD IndustryIcon.png Instructs the AI driver to Drive, via the shortest available path, to the designated Industry (including Passenger Stations). Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will NOT attempt to find a way around blockages when calculating the shortest path to the industry. All signals and speed signs are obeyed.

Properties.PNG Command Properties:

  • <kuid:-3:11058> Drive To
  • Base Command

Settings.PNG Command Settings:

Select <name of industry> or industry enabled passenger station from the session list
  if applicable <name/number of track or platform> for industries and stations that have identified active platforms, tracks or loading bays

Notes.PNG Notes:

If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will not attempt to find an alternative path to the destination. This can lead to the train stopping and waiting indefinately until the blockage is removed.

PageLink2.PNG Related Commands:


Drive To Trackmark

CMD NavigateTo.png Instructs the AI driver to Drive, via the shortest available path, to the designated Trackmark. Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will NOT attempt to find a way around blockages when calculating the shortest path to the trackmark. All signals and speed signs are obeyed.

Properties.PNG Command Properties:

  • <kuid:-3:11149> Drive To Trackmark
  • Base Command

Settings.PNG Command Settings:

Select <name of trackmark> from the session list

Notes.PNG Notes:

If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will not attempt to find an alternative path to the destination. This can lead to the train stopping and waiting indefinately until the blockage is removed.

PageLink2.PNG Related Commands:

WikiLink.PNG Trainz Wiki Links:


Drive Via Trackmark

CMD NavigateTo.png Instructs the AI driver to Drive, via the shortest available path, to and through the designated Trackmark. If there are no further commands then the AI will halt after passing the trackmark. Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will NOT attempt to find a way around blockages when calculating the shortest path to the trackmark. All signals and speed signs are obeyed.

Properties.PNG Command Properties:

  • <kuid:-3:11209> Drive Via Trackmark
  • Base Command

Settings.PNG Command Settings:

Select <name of trackmark> from the session list

Notes.PNG Notes:

  1. This command is used to direct the AI along a set route to a final destination which is not normally the trackmark identified in this command.
  2. If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will not attempt to find an alternative path to the designated trackmark. This can lead to the train stopping and waiting indefinately until the blockage is removed.

PageLink2.PNG Related Commands:

WikiLink.PNG Trainz Wiki Links:


Navigate To

CMD IndustryIcon.png Instructs the AI driver to Navigate, via the shortest available path, to the designated Industry (including Passenger Station). Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will attempt to find a way around blockages when calculating the shortest path to the industry. All signals and speed signs are obeyed.

Properties.PNG Command Properties:

  • <kuid:-3:10058> Navigate To
  • Base Command

Settings.PNG Command Settings:

Select <name of industry> or industry enabled passenger station from the session list
  if applicable <name/number of track or platform> for industries and stations that have identified active platforms, tracks or loading bays

Notes.PNG Notes:

If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will attempt to find an alternative path to the destination. This can lead to the train traveling backwards and down the wrong track.

PageLink2.PNG Related Commands:

  • Drive To - does not seek alternative paths if blocked


Navigate To Trackmark

CMD NavigateTo.png Instructs the AI driver to Navigate, via the shortest available path, to the designated Trackmark. Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will attempt to find a way around blockages when calculating the shortest path to the trackmark. All signals and speed signs are obeyed.

Properties.PNG Command Properties:

  • <kuid:-3:10149> Navigate To Trackmark
  • Base Command

Settings.PNG Command Settings:

Select <name of trackmark> from the session list

Notes.PNG Notes:

If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will attempt to find an alternative path to the destination. This can lead to the train traveling backwards and down the wrong track.

PageLink2.PNG Related Commands:

WikiLink.PNG Trainz Wiki Links:


Navigate Via Trackmark

CMD NavigateTo.png Instructs the AI driver to Drive, via the shortest available path, to and through the designated Trackmark. If there are no further commands then the AI will halt after passing the trackmark. Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will attempt to find a way around blockages when calculating the shortest path to the trackmark. All signals and speed signs are obeyed.

Properties.PNG Command Properties:

  • <kuid:-3:10209> Navigate Via Trackmark
  • Base Command

Settings.PNG Command Settings:

Select <name of trackmark> from the session list

Notes.PNG Notes:

  1. This command is used to direct the AI along a set route to a final destination which is not normally the trackmark identified in this command.
  2. If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will attempt to find an alternative path to the designated trackmark. This can lead to the train traveling backwards and down the wrong track.

PageLink2.PNG Related Commands:

WikiLink.PNG Trainz Wiki Links:


Back to Top

Session Management Commands


Copy Commands From

CMD CopyCommandsFrom.png Copies a driver schedule from a schedule library or another driver.

Properties.PNG Command Properties:

  • <kuid2:192081:1:7> Copy Commands From
  • Built-in Command by brummfondel

Settings.PNG Command Settings:

Append - From Library - select a saved schedule from Schedule Library and add it to the end of the current schedule (if any)
Append - From Vehicle - select a vehicle, copy its driver commands and add them to the end of the current schedule (if any)
Insert - From Library - select a saved schedule from Schedule Library and insert it into the current schedule (if any)
Insert - From Vehicle - select a vehicle, copy its driver commands and insert them into the current schedule (if any)

PageLink3.PNG Required Session Rules:

Rules that MUST be added to the Session for this Driver Command to operate


Delete Train

CMD DeleteTrain.png Deletes the train from the session.

Properties.PNG Command Properties:

  • <kuid2:116387:15:3> Delete Train
  • Built-in Command by maggs

Settings.PNG Command Settings:

None


Insert Buff Label

CMD InsertBuffLabel.png Inserts a driver command as a label for a block of driver commands.

Properties.PNG Command Properties:

  • <kuid:160293:101002> Insert buff label
  • DLS Command by trev999

Settings.PNG Command Settings:

Select <label number> - select the label number (1 to 10)

Notes.PNG Notes:

Up to 10 labels can be inserted into each drivers command list

PageLink2.PNG Related Commands:

  • Jump to Label - unconditionally jumps to a named command label
  • Skip if Session Variable - conditionally jumps to the named command label if a selected session variable meets a set condition


Jump to Label

CMD JumpToLabel.png Unconditionally jumps to a named command label.

Properties.PNG Command Properties:

  • <kuid2:160293:101003:2> Jump to label
  • DLS Command by trev999

Settings.PNG Command Settings:

Select <label number> - select the label number (1 to 20)

Notes.PNG Notes:

A label (Insert Buff label driver command) with the matching label number must be added to the driver commands

PageLink2.PNG Related Commands:

  • Insert Buff Label - inserts a driver command as a label for a block of driver commands
  • Skip if Session Variable - conditionally jumps to the named command label if a selected session variable meets a set condition


Layer Control

CMD LayerControl.png Shows or hides a selected layer.

Properties.PNG Command Properties:

  • <kuid:160293:101080> Layer Control
  • DLS Command by trev999

Settings.PNG Command Settings:

Show <list of layers in route and session> - select a layer to make visible
Hide <list of layers in route and session> - select a layer to make invisible

PageLink.PNG Related Session Rules:

Ex.PNG Examples of Use:


Move to Train

CMD MoveToTrain.png Moves the driver with all their remaining driver commands to another train.

Properties.PNG Command Properties:

  • <kuid2:71155:60004:2> Move to train
  • DLS Command by _mutton_

Settings.PNG Command Settings:

All trains <list of locomotives> - select a locomotive from the Session list

Notes.PNG Notes:

  1. The new train must not already have a driver - make sure that the Generate New Drivers for Empty Trains option in the Driver Setup Rule is not ticked.
  2. If the new train does already have a driver then the command and any following commands will not be executed.

WikiLink.PNG Trainz Wiki Links:


Set Custom HUD (SP2 and later)

CMD SetCustomHUD.png Sets a predefined HUD on the screen.

Properties.PNG Command Properties:

  • <kuid2:61392:7006:37> SetCustomHud (SP2 and later)
  • DLS Command by pguy

Settings.PNG Command Settings:

<defHud> - select the default HUD
<altHud> - select the alternate HUD
<named Hud> - select from a number of user defined HUDs

Notes.PNG Notes:

  1. the Quick CustomHud Manager Rule (SP2 and later) must be added to a session for a HUD to be selected by this command
  2. the default and alternate HUDs are preset but can be edited using the above rule
  3. additional user defined and named HUDs can be created with the Quick CustomHud Manager Rule (SP2 and later)

PageLink3.PNG Required Session Rules:

Rules that MUST be added to the Session for this Driver Command to operate


Skip if Session-Variable

CMD SkipIfSVar.png Jumps to the named command label if a selected session variable meets a set condition.

Properties.PNG Command Properties:

  • <kuid2:160293:101014:3> Skip if session-variable
  • DLS Command by trev999

Settings.PNG Command Settings:

Select <label number if> - select the label number (1 to 20)
   <Variable Name> - from the InputTable Rule
      <condition> - from the InputTable Rule

Notes.PNG Notes:

  1. The InputTable Rule must be installed in the session before this command can be used. This rule must be configured to identify the session variable(s), test condition(s) and value(s).
  2. A label (Insert Buff Label driver command) with the matching label number must be added to the driver commands

Issues.PNG Known Issues:

  • TANE Sessions containing driver commands that use variables may not work correctly when imported into TRS19 and Trainz Plus. The solution is to delete and then reinsert these commands in the imported Sessions

PageLink2.PNG Related Commands:

  • Insert Buff Label - inserts a driver command as a label for a block of driver commands
  • Jump to Label - unconditionally jumps to a named command label

PageLink3.PNG Required Session Rules:

Rules that MUST be added to the Session for this Driver Command to operate


Wait Until S-Variable V3

CMD WaitSVariable.png The AI driver will wait until the identified variable matches the condition specified before the next command will be executed

Properties.PNG Command Properties:

  • <kuid2:160293:101006:3> Wait Until S-variable V3
  • DLS Command by trev999

Settings.PNG Command Settings:

Select <Variable Name> - select the variable name from those entered in the InputTable Rule
   Select <Condition><Value> - select from those entered in the InputTable Rule

Notes.PNG Notes:

  • The InputTable Rule must be installed in the session before this command can be used. This rule must be configured to identify the session variable(s), test condition(s) and value(s).

Issues.PNG Known Issues:

  • TANE Sessions containing driver commands that use variables may not work correctly when imported into TRS19 and Trainz Plus. The solution is to delete and then reinsert these commands in the imported Sessions

PageLink3.PNG Required Session Rules:

Rules that MUST be added to the Session for this Driver Command to operate


WaitUntilSVariable

CMD WaitSVar.png The AI driver will wait until the identified variable matches the condition specified before the next command will be executed

Properties.PNG Command Properties:

  • <kuid2:131986:1006:1> WaitUntilSVariable
  • DLS Command by atilabarut
  • Legacy Command has been replaced by Wait Until S-Variable

Settings.PNG Command Settings:

Select <Variable Name><Condition><Value> - from the InputTable Rule

Notes.PNG Notes:

  • The InputTable Rule must be installed in the session before this command can be used. This rule must be configured to identify the session variable(s), test condition(s) and value(s).

Issues.PNG Known Issues:

  • TANE Sessions containing driver commands that use variables may not work correctly when imported into TRS19 and Trainz Plus. The solution is to delete and then reinsert these commands in the imported Sessions

PageLink2.PNG Related Commands:

PageLink3.PNG Required Session Rules:

Rules that MUST be added to the Session for this Driver Command to operate


Back to Top

Train Operation Commands


Bellz

CMD Bellz.png Rings the train bell.

Properties.PNG Command Properties:

  • <kuid2:66277:80002:1> bellz
  • Built-in Command by smileyman

Settings.PNG Command Settings:

None

Notes.PNG Notes:

the locomotive must be equipped with a working bell.

PageLink2.PNG Related Commands:

  • Hornz - gives a blast of the horn (or whistle)
  • HornzExtended - gives a specified number of horn blasts


Couple

CMD Couple.png The AI driver moves the train (or just the locomotive if it is by itself) to couple with the specified wagon.

Properties.PNG Command Properties:

  • <kuid:-3:10081> Couple
  • Base Command

Settings.PNG Command Settings:

  <list of available wagons> - select a wagon to couple to
  

Notes.PNG Notes:

  1. The target wagon must be at the end of a consist or by itself. If the target is coupled in between other wagons then no coupling will take place.
  2. There must be a clear path to the target wagon.

PageLink2.PNG Related Commands:

  • Couple At Trackmark - couples to the wagon closest to a specified trackmark
  • Decouple - decouples a consist at a specific place (does not work in the Driver Setup Rule)
  • Decouple DLX - decouples a consist at a specific, or a random, place. Upto 99 wagons
  • Decouple Head N - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
  • Decouple Number # - decouples a consist at a specific place. Upto 40 wagons
  • Uncouplez - decouples the locomotive (or locomotive + tender) from a consist
  • UncouplezFrom - decouples a consist at a specific place. Upto 20 wagons


Couple At Trackmark

CMD Couple At Trackmark.png The AI driver moves the train (or just the locomotive if it is by itself) to couple with the wagon that is closest to a specified trackmark.

Properties.PNG Command Properties:

  • <kuid:2:57145:81100:1> Couple At Trackmark
  • DLS Command by marzipan

Settings.PNG Command Settings:

  <list of available trackmarks> - select a trackmark
  

Notes.PNG Notes:

  1. The end wagon of a consist must be within the effect radius of the trackmark. If there is no wagon with the radius then no coupling will take place.
  2. The train will couple to the wagon closest to the trackmark and that may mean navigating to the other end of the consist.
  3. There must be a clear path to the target wagon.

PageLink2.PNG Related Commands:

  • Couple - couples wagons in a consist
  • Decouple - decouples a consist at a specific place (does not work in the Driver Setup Rule)
  • Decouple DLX - decouples a consist at a specific, or a random, place. Upto 99 wagons
  • Decouple Head N - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
  • Decouple Number # - decouples a consist at a specific place. Upto 40 wagons
  • Uncouplez - decouples the locomotive (or locomotive + tender) from a consist
  • UncouplezFrom - decouples a consist at a specific place. Upto 20 wagons

WikiLink.PNG Trainz Wiki Links:


Decouple

CMD Decouple.png The train is decoupled at the specified wagon (does not work in Driver Setup Rule).

Properties.PNG Command Properties:

  • <kuid:-3:10082> Decouple
  • Base Command

Settings.PNG Command Settings:

  <list of available wagons> - select a wagon to decouple from

Issues.PNG Known Issues:

  • This command does not work when added to a driver's command list in the Driver Setup Rule in Surveyor but it does work when manually added to the driver's command list in Driver

Notes.PNG Notes:

  1. If programming a driver via the Driver Setup Rule, use the alternative commands Decouple DLX, Decouple Number #, Uncouplez or UncouplezFrom
  2. The main problem with using decoupling commands in the Driver Setup Rule is that the number and identity of the wagons in a consist may not be known when the command is added to a driver's command list.

PageLink2.PNG Related Commands:

  • Couple - couples wagons in a consist
  • Couple At Trackmark - couples to the wagon closest to a specified trackmark
  • Decouple DLX - decouples a consist at a specific, or a random, place. Upto 99 wagons
  • Decouple Head N - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
  • Decouple Number # - decouples a consist at a specific place. Upto 40 wagons
  • Uncouplez - decouples the locomotive (or locomotive + tender) from a consist
  • UncouplezFrom - decouples a consist at a specific place. Upto 20 wagons


Decouple DLX

CMD DecoupleDLX.png The train is decoupled at the specified wagon identified by name or number (upto 99 wagons), or at a random location.

Properties.PNG Command Properties:

  • <kuid2:160293:100120:2> Decouple DLX
  • DLS Command by trev999

Settings.PNG Command Settings:

  When Used in Surveyor using the Driver Setup Rule
     <1-33> - select a wagon numbered 1 to 33 where 1 is the wagon (or tender) immediately following the locomotive
     <34-66> - select a wagon from 34 to 66
     <67-99> - select a wagon from 67 to 99
     <at position determined by>
        <consist_count> - requires the use of the special_instruction driver command
        <a random number> - a random number which may be beyond the last wagon in the consist
  When used in Driver Mode
     <1-33> - each wagon is numbered and named. Select a wagon numbered 1 to 33 (or to the last wagon in that range) 
        where 1 is the wagon (or tender) immediately following the locomotive
     If there are more than 33 wagons, then
        <34-66> - each wagon is numbered and named. Select a wagon from 34 to 66 (or to the last wagon in that range)
     if there are more than 66 wagons, then
        <67-99> - each wagon is numbered and named. Select a wagon from 67 to 99 (or to the last wagon in that range)
     <at position determined by>
        <consist_count> - requires the use of the special_instruction driver command
        <a random number> - a random number upto and including the last wagon in the consist

Notes.PNG Notes:

The main problem with using decoupling commands in the Driver Setup Rule is that the number and identity of the wagons in a consist may not be known when the command is added to a driver's command list.

PageLink2.PNG Related Commands:

  • Couple - couples wagons in a consist
  • Couple At Trackmark - couples to the wagon closest to a specified trackmark
  • Decouple - decouples a consist at a specific place (does not work in the Driver Setup Rule)
  • Decouple Head N - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
  • Decouple Number # - decouples a consist at a specific place. Upto 40 wagons
  • Uncouplez - decouples the locomotive (or locomotive + tender) from a consist
  • UncouplezFrom - decouples a consist at a specific place. Upto 20 wagons


Decouple Head N

CMD Decouple.png The train is decoupled to leave the selected number (N) of wagons left in the consist.

Properties.PNG Command Properties:

  • <kuid2:46162:70002:12> Decouple Head N
  • DLS Command by josefpav

Settings.PNG Command Settings:

  <select wagon number> - select the number of wagons (sorted by ASCII code not numerical value) to be left in the consist after the decoupling. 
        1 = the lead loco only (without its tender), 2 = loco + first wagon (which could be the tender), upto 75.

Notes.PNG Notes:

The main problem with using decoupling commands in the Driver Setup Rule is that the number and identity of the wagons in a consist may not be known when the command is added to a driver's command list.

PageLink2.PNG Related Commands:

  • Couple - couples wagons in a consist
  • Couple At Trackmark - couples to the wagon closest to a specified trackmark
  • Decouple - decouples a consist at a specific place (does not work in the Driver Setup Rule)
  • Decouple DLX - decouples a consist at a specific, or a random, place. Upto 99 wagons
  • Decouple Number # - decouples a consist at a specific place. Upto 40 wagons
  • Uncouplez - decouples the locomotive (or locomotive + tender) from a consist
  • UncouplezFrom - decouples a consist at a specific place. Upto 20 wagons


Decouple Number #

CMD DecoupleNumber.png The specified wagon number (#) and any following wagons will be uncoupled from the locomotive and consist.

Properties.PNG Command Properties:

  • <kuid2:147570:80008:1> Decouple number #
  • Built-in Command by erniesouchak

Settings.PNG Command Settings:

  <number> - select a wagon number (1-40) to decouple from.

Notes.PNG Notes:

  1. The first locomotive is #1, the second locomotive (if any) or the tender (on a steam locomotive) is #2, etc.
  2. The main problem with using decoupling commands in the Driver Setup Rule is that the number and identity of the wagons in a consist may not be known when the command is added to a driver's command list.

PageLink2.PNG Related Commands:

  • Couple - couples wagons in a consist
  • Couple At Trackmark - couples to the wagon closest to a specified trackmark
  • Decouple - decouples a consist at a specific place (does not work in the Driver Setup Rule)
  • Decouple DLX - decouples a consist at a specific, or a random, place. Upto 99 wagons
  • Decouple Head N - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
  • Uncouplez - decouples the locomotive (or locomotive + tender) from a consist
  • UncouplezFrom - decouples a consist at a specific place. Upto 20 wagons


Hornz

CMD Hornz.png Gives one blast of the train horn or whistle.

Properties.PNG Command Properties:

  • <kuid2:66277:80001:2> Hornz
  • Built-in Command by smileyman

Settings.PNG Command Settings:

None

PageLink2.PNG Related Commands:

  • Bellz - rings the locomotive bell (if it has one)
  • HornzExtended - gives a specified number of horn blasts


HornzExtended

CMD HornzExtended.png Gives a specified number of blasts of the train horn or whistle.

Properties.PNG Command Properties:

  • <kuid:478639:100034> HornzExtended
  • Built-in Command by ffccnn

Settings.PNG Command Settings:

Select one of <Play once>
              <Play twice>
              ... up to ...
              <Play 10 times>

Notes.PNG Notes:

When the command is executed, the AI will immediately move onto the next command in the sequence and will blast the horn during the execution of the following driver commands until the set count has been reached

PageLink2.PNG Related Commands:

  • Bellz - rings the locomotive bell (if it has one)
  • Hornz - gives one blast of the horn or whistle


MoveTurntable

CMD MoveTurntable.png Moves the specified turntable to the specified track position.

Properties.PNG Command Properties:

  • <kuid2:609850:100018:1> MoveTurntable
  • Built-in Command by vandragonax

Settings.PNG Command Settings:

  <name of turntable> - select the named turntable (see Notes below).
  <track #> or <relative track movement> - select the track number (0 = 1st track) or a relative movement (prev, next)

Notes.PNG Notes:

The InputTable Rule must be installed in the session before this command can be used. This rule must be configured to identify all the turntables and the number of tracks they have.

PageLink3.PNG Required Session Rules:

Rules that MUST be added to the Session for this Driver Command to operate


Priorityz

CMD Priorityz.png Sets the train priority value.

Properties.PNG Command Properties:

  • <kuid2:66277:80003:1> priorityz
  • Built-in Command by smileyman

Settings.PNG Command Settings:

<value> - select train priority value 1, 2 or 3

Notes.PNG Notes:

The Priority value identifies the importance of the train for the Priority Trackmarkers. Usually (a guide only):-
  • Priority 1 = Express trains
  • Priority 2 = Local Expresses or Fast Freights
  • Priority 3 = Slow Local Freights or All Stops Services

WikiLink.PNG Trainz Wiki Links:


Run Around

CMD RunAround.png Uncouples the locomotive (plus tender if present) from the train, navigates to the other end of the train and couples to the last wagon.

Properties.PNG Command Properties:

  • <kuid:-3:10083> Run Around
  • Base Command

Settings.PNG Command Settings:

None

Notes.PNG Notes:

  1. There must be a path for the locomotive to follow from one end of the train to the other.
  2. The locomotive must have sufficient clear space, free of track switches and signals, at both ends of the train to perform this movement.

PageLink2.PNG Related Commands:

  • Run Around Ex - performs the run around only if there is no loco already in position at the other end


Run Around Ex

CMD RunAroundEx.png Uncouples the locomotive(s) (plus tender if present) from the train, navigates to the other end of the train and couples to the last wagon but ONLY if the other end of the train does not already have a locomotive in place.

Properties.PNG Command Properties:

  • <kuid2:117667:83:3> Run Around Ex
  • DLS Command by nicroman

Settings.PNG Command Settings:

None

Notes.PNG Notes:

  1. There must be a path for the locomotive to follow from one end of the train to the other.
  2. The locomotive must have sufficient clear space, free of track switches and signals, at both ends of the train to perform this movement.
  3. There must be no locomotive already coupled to the destination end of the train.

PageLink2.PNG Related Commands:

  • Run Around - unconditionally performs the run around


Uncouplez

CMD Uncouplez.png Uncouples the locomotive (plus tender if present) from the train.

Properties.PNG Command Properties:

  • <kuid2:66277:80000:1> UnCouplez
  • Built-in Command by smileyman

Settings.PNG Command Settings:

None

PageLink2.PNG Related Commands:

  • Couple - couples wagons in a consist
  • Couple At Trackmark - couples to the wagon closest to a specified trackmark
  • Decouple - decouples a consist at a specific place (does not work in the Driver Setup Rule)
  • Decouple DLX - decouples a consist at a specific, or a random, place. Upto 99 wagons
  • Decouple Head N - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
  • Decouple Number # - decouples a consist at a specific place. Upto 40 wagons
  • UncouplezFrom - decouples a consist at a specific place. Upto 20 wagons


UncouplezFrom

CMD Uncouplez.png Uncouples the train at the wagon specified.

Properties.PNG Command Properties:

  • <kuid2:66277:80005:2> UnCouplezFrom
  • Built-in Command by smileyman

Settings.PNG Command Settings:

  <number> - select a wagon number (0-20) to decouple from.

Notes.PNG Notes:

  1. The first wagon after the locomotive (or the locomotive and tender) is #0, the second wagon is #1, etc.
  2. The main problem with using decoupling commands in the Driver Setup Rule is that the number and identity of the wagons in a consist may not be known when the command is added to a driver's command list.

PageLink2.PNG Related Commands:

  • Couple - couples wagons in a consist
  • Couple At Trackmark - couples to the wagon closest to a specified trackmark
  • Decouple - decouples a consist at a specific place (does not work in the Driver Setup Rule)
  • Decouple DLX - decouples a consist at a specific, or a random, place. Upto 99 wagons
  • Decouple Head N - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
  • Decouple Number # - decouples a consist at a specific place. Upto 40 wagons
  • Uncouplez - decouples the locomotive (or locomotive + tender) from a consist


Back to Top

Navigation Commands


AutoDrivePastSignal

CMD AutoDrivePastSignal.png Instructs the AI driver to drive under Autopilot until the entire train clears the specified signal but the AI will not set any junction switches so the train will follow whatever path is set ahead of it. All signals and speed signs are obeyed. The train will slow to a halt after passing the signal.

Properties.PNG Command Properties:

  • <kuid2:61392:7101:1> AutoDrivePastSignal Command
  • DLS Command by pguy

Settings.PNG Command Settings:

  Select <signal name> from Session list

Notes.PNG Notes:

  • It is the users responsibility to set all junction switches ahead of the train. The AI will not set the switches

PageLink2.PNG Related Commands:

  • AutoPilot - drives continuously or until a specified trackmark has been passed


Autopilot

CMD AutoPilot.png Instructs the AI driver to drive but the AI will not set any junction switches so the train will follow whatever path is set ahead of it. All signals and speed signs are obeyed.

Properties.PNG Command Properties:

  • <kuid2:71155:60001:5> Autopilot Command
  • DLS Command by _mutton_

Settings.PNG Command Settings:

Select one of
   <activate> - starts the Autopilot Command. This will only terminate when the Autopilot Command is removed from the driver command line
   <stop at track mark> - select a trackmark from the session list. Starts the Autopilot Command and drives until the train reaches the selected trackmark (see Notes below)

Notes.PNG Notes:

  1. It is the users responsibility to set all junction switches ahead of the train. The AI will not set the switches
  2. If the Stop at track mark option is used then:-
  • the train will not set a path to the track mark, that is the users responsibility
  • the train will run at the full posted line speed upto the track mark and then it will slow to a stop
  • if the track mark is never reached because the correct path has not been set, the train will continue as it would for the activate option

PageLink2.PNG Related Commands:


Drive To

CMD IndustryIcon.png Instructs the AI driver to Drive, via the shortest available path, to the designated Industry (including Passenger Stations). Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will NOT attempt to find a way around blockages when calculating the shortest path to the industry. All signals and speed signs are obeyed.

Properties.PNG Command Properties:

  • <kuid:-3:11058> Drive To
  • Base Command

Settings.PNG Command Settings:

Select <name of industry> or industry enabled passenger station from the session list
  if applicable <name/number of track or platform> for industries and stations that have identified active platforms, tracks or loading bays

Notes.PNG Notes:

If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will not attempt to find an alternative path to the destination. This can lead to the train stopping and waiting indefinately until the blockage is removed.

PageLink2.PNG Related Commands:


Drive To Trackmark

CMD NavigateTo.png Instructs the AI driver to Drive, via the shortest available path, to the designated Trackmark. Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will NOT attempt to find a way around blockages when calculating the shortest path to the trackmark. All signals and speed signs are obeyed.

Properties.PNG Command Properties:

  • <kuid:-3:11149> Drive To Trackmark
  • Base Command

Settings.PNG Command Settings:

Select <name of trackmark> from the session list

Notes.PNG Notes:

If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will not attempt to find an alternative path to the destination. This can lead to the train stopping and waiting indefinately until the blockage is removed.

PageLink2.PNG Related Commands:

WikiLink.PNG Trainz Wiki Links:


Drive Via Trackmark

CMD NavigateTo.png Instructs the AI driver to Drive, via the shortest available path, to and through the designated Trackmark. If there are no further commands then the AI will halt after passing the trackmark. Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will NOT attempt to find a way around blockages when calculating the shortest path to the trackmark. All signals and speed signs are obeyed.

Properties.PNG Command Properties:

  • <kuid:-3:11209> Drive Via Trackmark
  • Base Command

Settings.PNG Command Settings:

Select <name of trackmark> from the session list

Notes.PNG Notes:

  1. This command is used to direct the AI along a set route to a final destination which is not normally the trackmark identified in this command.
  2. If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will not attempt to find an alternative path to the designated trackmark. This can lead to the train stopping and waiting indefinately until the blockage is removed.

PageLink2.PNG Related Commands:

WikiLink.PNG Trainz Wiki Links:


Navigate To

CMD IndustryIcon.png Instructs the AI driver to Navigate, via the shortest available path, to the designated Industry (including Passenger Station). Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will attempt to find a way around blockages when calculating the shortest path to the industry. All signals and speed signs are obeyed.

Properties.PNG Command Properties:

  • <kuid:-3:10058> Navigate To
  • Base Command

Settings.PNG Command Settings:

Select <name of industry> or industry enabled passenger station from the session list
  if applicable <name/number of track or platform> for industries and stations that have identified active platforms, tracks or loading bays

Notes.PNG Notes:

If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will attempt to find an alternative path to the destination. This can lead to the train traveling backwards and down the wrong track.

PageLink2.PNG Related Commands:

  • Drive To - does not seek alternative paths if blocked


Navigate To Trackmark

CMD NavigateTo.png Instructs the AI driver to Navigate, via the shortest available path, to the designated Trackmark. Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will attempt to find a way around blockages when calculating the shortest path to the trackmark. All signals and speed signs are obeyed.

Properties.PNG Command Properties:

  • <kuid:-3:10149> Navigate To Trackmark
  • Base Command

Settings.PNG Command Settings:

Select <name of trackmark> from the session list

Notes.PNG Notes:

If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will attempt to find an alternative path to the destination. This can lead to the train traveling backwards and down the wrong track.

PageLink2.PNG Related Commands:

WikiLink.PNG Trainz Wiki Links:


Navigate Via Trackmark

CMD NavigateTo.png Instructs the AI driver to Drive, via the shortest available path, to and through the designated Trackmark. If there are no further commands then the AI will halt after passing the trackmark. Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will attempt to find a way around blockages when calculating the shortest path to the trackmark. All signals and speed signs are obeyed.

Properties.PNG Command Properties:

  • <kuid:-3:10209> Navigate Via Trackmark
  • Base Command

Settings.PNG Command Settings:

Select <name of trackmark> from the session list

Notes.PNG Notes:

  1. This command is used to direct the AI along a set route to a final destination which is not normally the trackmark identified in this command.
  2. If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will attempt to find an alternative path to the designated trackmark. This can lead to the train traveling backwards and down the wrong track.

PageLink2.PNG Related Commands:

WikiLink.PNG Trainz Wiki Links:


Back to Top

Session Management Commands


Copy Commands From

CMD CopyCommandsFrom.png Copies a driver schedule from a schedule library or another driver.

Properties.PNG Command Properties:

  • <kuid2:192081:1:7> Copy Commands From
  • Built-in Command by brummfondel

Settings.PNG Command Settings:

Append - From Library - select a saved schedule from Schedule Library and add it to the end of the current schedule (if any)
Append - From Vehicle - select a vehicle, copy its driver commands and add them to the end of the current schedule (if any)
Insert - From Library - select a saved schedule from Schedule Library and insert it into the current schedule (if any)
Insert - From Vehicle - select a vehicle, copy its driver commands and insert them into the current schedule (if any)

PageLink3.PNG Required Session Rules:

Rules that MUST be added to the Session for this Driver Command to operate


Delete Train

CMD DeleteTrain.png Deletes the train from the session.

Properties.PNG Command Properties:

  • <kuid2:116387:15:3> Delete Train
  • Built-in Command by maggs

Settings.PNG Command Settings:

None


Insert Buff Label

CMD InsertBuffLabel.png Inserts a driver command as a label for a block of driver commands.

Properties.PNG Command Properties:

  • <kuid:160293:101002> Insert buff label
  • DLS Command by trev999

Settings.PNG Command Settings:

Select <label number> - select the label number (1 to 10)

Notes.PNG Notes:

Up to 10 labels can be inserted into each drivers command list

PageLink2.PNG Related Commands:

  • Jump to Label - unconditionally jumps to a named command label
  • Skip if Session Variable - conditionally jumps to the named command label if a selected session variable meets a set condition


Jump to Label

CMD JumpToLabel.png Unconditionally jumps to a named command label.

Properties.PNG Command Properties:

  • <kuid2:160293:101003:2> Jump to label
  • DLS Command by trev999

Settings.PNG Command Settings:

Select <label number> - select the label number (1 to 20)

Notes.PNG Notes:

A label (Insert Buff label driver command) with the matching label number must be added to the driver commands

PageLink2.PNG Related Commands:

  • Insert Buff Label - inserts a driver command as a label for a block of driver commands
  • Skip if Session Variable - conditionally jumps to the named command label if a selected session variable meets a set condition


Layer Control

CMD LayerControl.png Shows or hides a selected layer.

Properties.PNG Command Properties:

  • <kuid:160293:101080> Layer Control
  • DLS Command by trev999

Settings.PNG Command Settings:

Show <list of layers in route and session> - select a layer to make visible
Hide <list of layers in route and session> - select a layer to make invisible

PageLink.PNG Related Session Rules:

Ex.PNG Examples of Use:


Move to Train

CMD MoveToTrain.png Moves the driver with all their remaining driver commands to another train.

Properties.PNG Command Properties:

  • <kuid2:71155:60004:2> Move to train
  • DLS Command by _mutton_

Settings.PNG Command Settings:

All trains <list of locomotives> - select a locomotive from the Session list

Notes.PNG Notes:

  1. The new train must not already have a driver - make sure that the Generate New Drivers for Empty Trains option in the Driver Setup Rule is not ticked.
  2. If the new train does already have a driver then the command and any following commands will not be executed.

WikiLink.PNG Trainz Wiki Links:


Set Custom HUD (SP2 and later)

CMD SetCustomHUD.png Sets a predefined HUD on the screen.

Properties.PNG Command Properties:

  • <kuid2:61392:7006:37> SetCustomHud (SP2 and later)
  • DLS Command by pguy

Settings.PNG Command Settings:

<defHud> - select the default HUD
<altHud> - select the alternate HUD
<named Hud> - select from a number of user defined HUDs

Notes.PNG Notes:

  1. the Quick CustomHud Manager Rule (SP2 and later) must be added to a session for a HUD to be selected by this command
  2. the default and alternate HUDs are preset but can be edited using the above rule
  3. additional user defined and named HUDs can be created with the Quick CustomHud Manager Rule (SP2 and later)

PageLink3.PNG Required Session Rules:

Rules that MUST be added to the Session for this Driver Command to operate


Skip if Session-Variable

CMD SkipIfSVar.png Jumps to the named command label if a selected session variable meets a set condition.

Properties.PNG Command Properties:

  • <kuid2:160293:101014:3> Skip if session-variable
  • DLS Command by trev999

Settings.PNG Command Settings:

Select <label number if> - select the label number (1 to 20)
   <Variable Name> - from the InputTable Rule
      <condition> - from the InputTable Rule

Notes.PNG Notes:

  1. The InputTable Rule must be installed in the session before this command can be used. This rule must be configured to identify the session variable(s), test condition(s) and value(s).
  2. A label (Insert Buff Label driver command) with the matching label number must be added to the driver commands

Issues.PNG Known Issues:

  • TANE Sessions containing driver commands that use variables may not work correctly when imported into TRS19 and Trainz Plus. The solution is to delete and then reinsert these commands in the imported Sessions

PageLink2.PNG Related Commands:

  • Insert Buff Label - inserts a driver command as a label for a block of driver commands
  • Jump to Label - unconditionally jumps to a named command label

PageLink3.PNG Required Session Rules:

Rules that MUST be added to the Session for this Driver Command to operate


Wait Until S-Variable V3

CMD WaitSVariable.png The AI driver will wait until the identified variable matches the condition specified before the next command will be executed

Properties.PNG Command Properties:

  • <kuid2:160293:101006:3> Wait Until S-variable V3
  • DLS Command by trev999

Settings.PNG Command Settings:

Select <Variable Name> - select the variable name from those entered in the InputTable Rule
   Select <Condition><Value> - select from those entered in the InputTable Rule

Notes.PNG Notes:

  • The InputTable Rule must be installed in the session before this command can be used. This rule must be configured to identify the session variable(s), test condition(s) and value(s).

Issues.PNG Known Issues:

  • TANE Sessions containing driver commands that use variables may not work correctly when imported into TRS19 and Trainz Plus. The solution is to delete and then reinsert these commands in the imported Sessions

PageLink3.PNG Required Session Rules:

Rules that MUST be added to the Session for this Driver Command to operate


WaitUntilSVariable

CMD WaitSVar.png The AI driver will wait until the identified variable matches the condition specified before the next command will be executed

Properties.PNG Command Properties:

  • <kuid2:131986:1006:1> WaitUntilSVariable
  • DLS Command by atilabarut
  • Legacy Command has been replaced by Wait Until S-Variable

Settings.PNG Command Settings:

Select <Variable Name><Condition><Value> - from the InputTable Rule

Notes.PNG Notes:

  • The InputTable Rule must be installed in the session before this command can be used. This rule must be configured to identify the session variable(s), test condition(s) and value(s).

Issues.PNG Known Issues:

  • TANE Sessions containing driver commands that use variables may not work correctly when imported into TRS19 and Trainz Plus. The solution is to delete and then reinsert these commands in the imported Sessions

PageLink2.PNG Related Commands:

PageLink3.PNG Required Session Rules:

Rules that MUST be added to the Session for this Driver Command to operate


Back to Top

Train Operation Commands


Bellz

CMD Bellz.png Rings the train bell.

Properties.PNG Command Properties:

  • <kuid2:66277:80002:1> bellz
  • Built-in Command by smileyman

Settings.PNG Command Settings:

None

Notes.PNG Notes:

the locomotive must be equipped with a working bell.

PageLink2.PNG Related Commands:

  • Hornz - gives a blast of the horn (or whistle)
  • HornzExtended - gives a specified number of horn blasts


Couple

CMD Couple.png The AI driver moves the train (or just the locomotive if it is by itself) to couple with the specified wagon.

Properties.PNG Command Properties:

  • <kuid:-3:10081> Couple
  • Base Command

Settings.PNG Command Settings:

  <list of available wagons> - select a wagon to couple to
  

Notes.PNG Notes:

  1. The target wagon must be at the end of a consist or by itself. If the target is coupled in between other wagons then no coupling will take place.
  2. There must be a clear path to the target wagon.

PageLink2.PNG Related Commands:

  • Couple At Trackmark - couples to the wagon closest to a specified trackmark
  • Decouple - decouples a consist at a specific place (does not work in the Driver Setup Rule)
  • Decouple DLX - decouples a consist at a specific, or a random, place. Upto 99 wagons
  • Decouple Head N - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
  • Decouple Number # - decouples a consist at a specific place. Upto 40 wagons
  • Uncouplez - decouples the locomotive (or locomotive + tender) from a consist
  • UncouplezFrom - decouples a consist at a specific place. Upto 20 wagons


Couple At Trackmark

CMD Couple At Trackmark.png The AI driver moves the train (or just the locomotive if it is by itself) to couple with the wagon that is closest to a specified trackmark.

Properties.PNG Command Properties:

  • <kuid:2:57145:81100:1> Couple At Trackmark
  • DLS Command by marzipan

Settings.PNG Command Settings:

  <list of available trackmarks> - select a trackmark
  

Notes.PNG Notes:

  1. The end wagon of a consist must be within the effect radius of the trackmark. If there is no wagon with the radius then no coupling will take place.
  2. The train will couple to the wagon closest to the trackmark and that may mean navigating to the other end of the consist.
  3. There must be a clear path to the target wagon.

PageLink2.PNG Related Commands:

  • Couple - couples wagons in a consist
  • Decouple - decouples a consist at a specific place (does not work in the Driver Setup Rule)
  • Decouple DLX - decouples a consist at a specific, or a random, place. Upto 99 wagons
  • Decouple Head N - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
  • Decouple Number # - decouples a consist at a specific place. Upto 40 wagons
  • Uncouplez - decouples the locomotive (or locomotive + tender) from a consist
  • UncouplezFrom - decouples a consist at a specific place. Upto 20 wagons

WikiLink.PNG Trainz Wiki Links:


Decouple

CMD Decouple.png The train is decoupled at the specified wagon (does not work in Driver Setup Rule).

Properties.PNG Command Properties:

  • <kuid:-3:10082> Decouple
  • Base Command

Settings.PNG Command Settings:

  <list of available wagons> - select a wagon to decouple from

Issues.PNG Known Issues:

  • This command does not work when added to a driver's command list in the Driver Setup Rule in Surveyor but it does work when manually added to the driver's command list in Driver

Notes.PNG Notes:

  1. If programming a driver via the Driver Setup Rule, use the alternative commands Decouple DLX, Decouple Number #, Uncouplez or UncouplezFrom
  2. The main problem with using decoupling commands in the Driver Setup Rule is that the number and identity of the wagons in a consist may not be known when the command is added to a driver's command list.

PageLink2.PNG Related Commands:

  • Couple - couples wagons in a consist
  • Couple At Trackmark - couples to the wagon closest to a specified trackmark
  • Decouple DLX - decouples a consist at a specific, or a random, place. Upto 99 wagons
  • Decouple Head N - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
  • Decouple Number # - decouples a consist at a specific place. Upto 40 wagons
  • Uncouplez - decouples the locomotive (or locomotive + tender) from a consist
  • UncouplezFrom - decouples a consist at a specific place. Upto 20 wagons


Decouple DLX

CMD DecoupleDLX.png The train is decoupled at the specified wagon identified by name or number (upto 99 wagons), or at a random location.

Properties.PNG Command Properties:

  • <kuid2:160293:100120:2> Decouple DLX
  • DLS Command by trev999

Settings.PNG Command Settings:

  When Used in Surveyor using the Driver Setup Rule
     <1-33> - select a wagon numbered 1 to 33 where 1 is the wagon (or tender) immediately following the locomotive
     <34-66> - select a wagon from 34 to 66
     <67-99> - select a wagon from 67 to 99
     <at position determined by>
        <consist_count> - requires the use of the special_instruction driver command
        <a random number> - a random number which may be beyond the last wagon in the consist
  When used in Driver Mode
     <1-33> - each wagon is numbered and named. Select a wagon numbered 1 to 33 (or to the last wagon in that range) 
        where 1 is the wagon (or tender) immediately following the locomotive
     If there are more than 33 wagons, then
        <34-66> - each wagon is numbered and named. Select a wagon from 34 to 66 (or to the last wagon in that range)
     if there are more than 66 wagons, then
        <67-99> - each wagon is numbered and named. Select a wagon from 67 to 99 (or to the last wagon in that range)
     <at position determined by>
        <consist_count> - requires the use of the special_instruction driver command
        <a random number> - a random number upto and including the last wagon in the consist

Notes.PNG Notes:

The main problem with using decoupling commands in the Driver Setup Rule is that the number and identity of the wagons in a consist may not be known when the command is added to a driver's command list.

PageLink2.PNG Related Commands:

  • Couple - couples wagons in a consist
  • Couple At Trackmark - couples to the wagon closest to a specified trackmark
  • Decouple - decouples a consist at a specific place (does not work in the Driver Setup Rule)
  • Decouple Head N - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
  • Decouple Number # - decouples a consist at a specific place. Upto 40 wagons
  • Uncouplez - decouples the locomotive (or locomotive + tender) from a consist
  • UncouplezFrom - decouples a consist at a specific place. Upto 20 wagons


Decouple Head N

CMD Decouple.png The train is decoupled to leave the selected number (N) of wagons left in the consist.

Properties.PNG Command Properties:

  • <kuid2:46162:70002:12> Decouple Head N
  • DLS Command by josefpav

Settings.PNG Command Settings:

  <select wagon number> - select the number of wagons (sorted by ASCII code not numerical value) to be left in the consist after the decoupling. 
        1 = the lead loco only (without its tender), 2 = loco + first wagon (which could be the tender), upto 75.

Notes.PNG Notes:

The main problem with using decoupling commands in the Driver Setup Rule is that the number and identity of the wagons in a consist may not be known when the command is added to a driver's command list.

PageLink2.PNG Related Commands:

  • Couple - couples wagons in a consist
  • Couple At Trackmark - couples to the wagon closest to a specified trackmark
  • Decouple - decouples a consist at a specific place (does not work in the Driver Setup Rule)
  • Decouple DLX - decouples a consist at a specific, or a random, place. Upto 99 wagons
  • Decouple Number # - decouples a consist at a specific place. Upto 40 wagons
  • Uncouplez - decouples the locomotive (or locomotive + tender) from a consist
  • UncouplezFrom - decouples a consist at a specific place. Upto 20 wagons


Decouple Number #

CMD DecoupleNumber.png The specified wagon number (#) and any following wagons will be uncoupled from the locomotive and consist.

Properties.PNG Command Properties:

  • <kuid2:147570:80008:1> Decouple number #
  • Built-in Command by erniesouchak

Settings.PNG Command Settings:

  <number> - select a wagon number (1-40) to decouple from.

Notes.PNG Notes:

  1. The first locomotive is #1, the second locomotive (if any) or the tender (on a steam locomotive) is #2, etc.
  2. The main problem with using decoupling commands in the Driver Setup Rule is that the number and identity of the wagons in a consist may not be known when the command is added to a driver's command list.

PageLink2.PNG Related Commands:

  • Couple - couples wagons in a consist
  • Couple At Trackmark - couples to the wagon closest to a specified trackmark
  • Decouple - decouples a consist at a specific place (does not work in the Driver Setup Rule)
  • Decouple DLX - decouples a consist at a specific, or a random, place. Upto 99 wagons
  • Decouple Head N - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
  • Uncouplez - decouples the locomotive (or locomotive + tender) from a consist
  • UncouplezFrom - decouples a consist at a specific place. Upto 20 wagons


Hornz

CMD Hornz.png Gives one blast of the train horn or whistle.

Properties.PNG Command Properties:

  • <kuid2:66277:80001:2> Hornz
  • Built-in Command by smileyman

Settings.PNG Command Settings:

None

PageLink2.PNG Related Commands:

  • Bellz - rings the locomotive bell (if it has one)
  • HornzExtended - gives a specified number of horn blasts


HornzExtended

CMD HornzExtended.png Gives a specified number of blasts of the train horn or whistle.

Properties.PNG Command Properties:

  • <kuid:478639:100034> HornzExtended
  • Built-in Command by ffccnn

Settings.PNG Command Settings:

Select one of <Play once>
              <Play twice>
              ... up to ...
              <Play 10 times>

Notes.PNG Notes:

When the command is executed, the AI will immediately move onto the next command in the sequence and will blast the horn during the execution of the following driver commands until the set count has been reached

PageLink2.PNG Related Commands:

  • Bellz - rings the locomotive bell (if it has one)
  • Hornz - gives one blast of the horn or whistle


MoveTurntable

CMD MoveTurntable.png Moves the specified turntable to the specified track position.

Properties.PNG Command Properties:

  • <kuid2:609850:100018:1> MoveTurntable
  • Built-in Command by vandragonax

Settings.PNG Command Settings:

  <name of turntable> - select the named turntable (see Notes below).
  <track #> or <relative track movement> - select the track number (0 = 1st track) or a relative movement (prev, next)

Notes.PNG Notes:

The InputTable Rule must be installed in the session before this command can be used. This rule must be configured to identify all the turntables and the number of tracks they have.

PageLink3.PNG Required Session Rules:

Rules that MUST be added to the Session for this Driver Command to operate


Priorityz

CMD Priorityz.png Sets the train priority value.

Properties.PNG Command Properties:

  • <kuid2:66277:80003:1> priorityz
  • Built-in Command by smileyman

Settings.PNG Command Settings:

<value> - select train priority value 1, 2 or 3

Notes.PNG Notes:

The Priority value identifies the importance of the train for the Priority Trackmarkers. Usually (a guide only):-
  • Priority 1 = Express trains
  • Priority 2 = Local Expresses or Fast Freights
  • Priority 3 = Slow Local Freights or All Stops Services

WikiLink.PNG Trainz Wiki Links:


Run Around

CMD RunAround.png Uncouples the locomotive (plus tender if present) from the train, navigates to the other end of the train and couples to the last wagon.

Properties.PNG Command Properties:

  • <kuid:-3:10083> Run Around
  • Base Command

Settings.PNG Command Settings:

None

Notes.PNG Notes:

  1. There must be a path for the locomotive to follow from one end of the train to the other.
  2. The locomotive must have sufficient clear space, free of track switches and signals, at both ends of the train to perform this movement.

PageLink2.PNG Related Commands:

  • Run Around Ex - performs the run around only if there is no loco already in position at the other end


Run Around Ex

CMD RunAroundEx.png Uncouples the locomotive(s) (plus tender if present) from the train, navigates to the other end of the train and couples to the last wagon but ONLY if the other end of the train does not already have a locomotive in place.

Properties.PNG Command Properties:

  • <kuid2:117667:83:3> Run Around Ex
  • DLS Command by nicroman

Settings.PNG Command Settings:

None

Notes.PNG Notes:

  1. There must be a path for the locomotive to follow from one end of the train to the other.
  2. The locomotive must have sufficient clear space, free of track switches and signals, at both ends of the train to perform this movement.
  3. There must be no locomotive already coupled to the destination end of the train.

PageLink2.PNG Related Commands:

  • Run Around - unconditionally performs the run around


Uncouplez

CMD Uncouplez.png Uncouples the locomotive (plus tender if present) from the train.

Properties.PNG Command Properties:

  • <kuid2:66277:80000:1> UnCouplez
  • Built-in Command by smileyman

Settings.PNG Command Settings:

None

PageLink2.PNG Related Commands:

  • Couple - couples wagons in a consist
  • Couple At Trackmark - couples to the wagon closest to a specified trackmark
  • Decouple - decouples a consist at a specific place (does not work in the Driver Setup Rule)
  • Decouple DLX - decouples a consist at a specific, or a random, place. Upto 99 wagons
  • Decouple Head N - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
  • Decouple Number # - decouples a consist at a specific place. Upto 40 wagons
  • UncouplezFrom - decouples a consist at a specific place. Upto 20 wagons


UncouplezFrom

CMD Uncouplez.png Uncouples the train at the wagon specified.

Properties.PNG Command Properties:

  • <kuid2:66277:80005:2> UnCouplezFrom
  • Built-in Command by smileyman

Settings.PNG Command Settings:

  <number> - select a wagon number (0-20) to decouple from.

Notes.PNG Notes:

  1. The first wagon after the locomotive (or the locomotive and tender) is #0, the second wagon is #1, etc.
  2. The main problem with using decoupling commands in the Driver Setup Rule is that the number and identity of the wagons in a consist may not be known when the command is added to a driver's command list.

PageLink2.PNG Related Commands:

  • Couple - couples wagons in a consist
  • Couple At Trackmark - couples to the wagon closest to a specified trackmark
  • Decouple - decouples a consist at a specific place (does not work in the Driver Setup Rule)
  • Decouple DLX - decouples a consist at a specific, or a random, place. Upto 99 wagons
  • Decouple Head N - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
  • Decouple Number # - decouples a consist at a specific place. Upto 40 wagons
  • Uncouplez - decouples the locomotive (or locomotive + tender) from a consist


Back to Top



Trainz Wiki

TrainzWiki.png

More Tutorials and Guides to Using Trainz

Personal tools