Session Rules By Categories With Properties

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
m
m (Schedule Library Rule)
 
(79 intermediate revisions by one user not shown)
Line 1: Line 1:
'''Train Railroad Simulator 2019 (TRS19) and TRAINZ A New Era (TANE) SP3. List of Trainz Session Rules in Alphabetical Order with Properties. All rules are the Copyright of N3V Games'''
+
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.
  
 
<table bgcolor=#ffff00>
 
<table bgcolor=#ffff00>
 
<tr>
 
<tr>
 
<td>
 
<td>
'''This page is always under construction. As new rules appear and are tested they will be added to this list. Current Rule Count: 129'''</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 Count: 129</span></td>
 
</tr>
 
</tr>
 
</table>
 
</table>
'''Only rules supplied with TRS19/TANE or on the DLS are covered in this document.'''<br>
+
'''Only rules supplied with Trainz or on the DLS are covered in this document.'''<br>
  
 
<table width="100%" bgcolor=#ffffaa>
 
<table width="100%" bgcolor=#ffffaa>
 
<tr>
 
<tr>
 
<td>
 
<td>
The rules listed in this page are all accessible in Trainz '''Surveyor''' from the '''Edit Session''' option in the '''Main Menu'''. Those rules that are identified as '''DLS Rule''' must be downloaded and installed from the Trainz DLS first. For some examples see the Wiki page '''[[How to Use Parent and Child Rules|Parent and Child Rules (Session Editor)]]'''</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>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Also available '''[[Session Rule List with Parameters|Session Rule List (Alphabetical) with Parameters]]'''
+
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 rule version at the time of writing. This number will change if the rule is updated.
 
*'''DLS Rule''' must be downloaded and installed from the '''DLS'''.
 
*'''DLS Rule''' must be downloaded and installed from the '''DLS'''.
*'''Base Rule''' and '''Built-in Rule''' is installed with '''TRS19/TANE'''.
+
*'''Base Rule''' and '''Built-in Rule''' is installed with '''Trainz'''.
 
*'''Parent Rule''' will execute child rules if it returns a ''true'' result.
 
*'''Parent Rule''' will execute child rules if it returns a ''true'' result.
 
*'''Obsolete Rule''' is no longer required (explanation given).
 
*'''Obsolete Rule''' is no longer required (explanation given).
 
*'''Legacy Rule''' has been replaced by another rule (new rule will be identified).
 
*'''Legacy Rule''' has been replaced by another rule (new rule will be identified).
*Rules that are named '''TANE SP2''' or '''TANE SP3''' will work in '''TRS19'''.
+
*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=#ffff88>
 
<tr>
 
<tr>
Line 37: Line 37:
 
</tr>
 
</tr>
 
</table>
 
</table>
<br>
+
[[file:BackToTop.png|link=#top|alt=Top|Top]] [[file:NextDown.png|link=#Camera Rules|alt=Next Down|Camera Rules]] [[file:BackToBottom.png|link=#Trainz Wiki|alt=Bottom|Bottom]]
 +
 
 
<table width=100% width=100% bgcolor=#ffffcc>
 
<table width=100% width=100% bgcolor=#ffffcc>
 
<tr>
 
<tr>
Line 48: Line 49:
 
Executes child rules when achievement conditions have been met
 
Executes child rules when achievement conditions have been met
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:401543:1190>'''
 
*'''<kuid:401543:1190>'''
Line 56: Line 57:
 
*'''Parent Rule'''
 
*'''Parent Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[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
 
     '''''<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:-
+
       <span style="background-color: black; color: white; font-weight: 700;"> When an Achievement Asset has been selected, the following will appear:- </span>
 
       '''Achievement KUID: ''<selected asset name>''''' - click to change the selected '''Achievement Asset'''
 
       '''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
 
       '''Achievement name: ''<not set>''''' - click to select the achievement name from the selected asset
       '''Trigger if achievement: ''<select>''''' - choose one of:-
+
       '''Trigger if achievement: ''<select>''''' - <span style="background-color: black; color: white; font-weight: 700;"> choose one of:- </span>
 
           '''has been gained''' - the rule will be triggered when this achievement has been gained
 
           '''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
 
           '''has not been gained''' - the rule will be triggered when this achievement has '''NOT''' been gained
  
[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+
[[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 Parent and Child Rules]]'''
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#ffffcc>
 
<tr>
 
<tr>
 
<td>
 
<td>
Line 80: Line 80:
 
Executes child rules when a matching consist is found. The order of the vehicles in the consists is not important.  
 
Executes child rules when a matching consist is found. The order of the vehicles in the consists is not important.  
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-25:1068>'''
 
*'''<kuid:-25:1068>'''
Line 88: Line 88:
 
*'''Parent Rule'''
 
*'''Parent Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
     '''[x] Enforce strict exclusive testing''' - check to only accept an exact match with no unspecified vehicles in the consist.
 
     '''[x] Enforce strict exclusive testing''' - check to only accept an exact match with no unspecified vehicles in the consist.
 
       - leave unchecked to accept any consist that contains the specified vehicles.  
 
       - leave unchecked to accept any consist that contains the specified vehicles.  
     Select one of two option buttons:-
+
     <span style="background-color: black; color: white; font-weight: 700;"> Select one of two option buttons:- </span>
 
     '''( ) Rule disabled''' - select to disable the operation of this rule
 
     '''( ) Rule disabled''' - select to disable the operation of this rule
 
     '''( ) Complete whenever a train matching the description exists''' - When selected, enter the consist description:-
 
     '''( ) Complete whenever a train matching the description exists''' - When selected, enter the consist description:-
Line 105: Line 105:
 
           '''''x''''' - click to remove a ''driver'' from the rule
 
           '''''x''''' - click to remove a ''driver'' from the rule
  
[[file:Issues.PNG]] '''<u>Known Issues:</u>'''
+
[[file:Issues.PNG|link=]] <span style="background-color: yellow; color: black; font-weight: 700;"> Known Issues: </span>
 
: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.
 
: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.
  
[[file:Ex.PNG]] '''<u>Examples of Use</u>'''
+
[[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]]'''
 
*'''[[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]] '''<u>Trainz Wiki Links:</u>'''
+
[[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 Parent and Child Rules]]'''
 
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Consist_Check_Rule</span>'''
 
*'''<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=#ffffcc>
 
<tr>
 
<tr>
 
<td>
 
<td>
Line 126: Line 126:
 
Executes child rules if industries or vehicles reach set commodity levels. This rule replaces the older '''Resource Check Rule'''  
 
Executes child rules if industries or vehicles reach set commodity levels. This rule replaces the older '''Resource Check Rule'''  
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-25:656>'''
 
*'''<kuid:-25:656>'''
Line 134: Line 134:
 
*'''Parent Rule'''
 
*'''Parent Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[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:-
+
     '''<Product Level>''' - <span style="background-color: black; color: white; font-weight: 700;"> click to select a product test from two choices:- </span>
 
       '''''Reach/Exceed''''' - sets an upper limit for the resources being monitored.  
 
       '''''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.
 
           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.
Line 148: Line 148:
 
     '''''<Add object>''''' - click to select a source or target object. Multiple objects and their queues can be added to the rule.  
 
     '''''<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.  
 
       ALL the entered products must reach/exceed or fall below the specified value for the rule to be triggered.  
       For each object:-
+
       <span style="background-color: black; color: white; font-weight: 700;"> For each object:- </span>
 
           '''''<Object>''''' - click to select session active industry or product enabled rail vehicle  
 
           '''''<Object>''''' - click to select session active industry or product enabled rail vehicle  
 
           '''''<Queue>''''' - select product queue (there may be only one available)
 
           '''''<Queue>''''' - select product queue (there may be only one available)
 
           '''''<Remove>''''' - removes the object and its product queue from the rule
 
           '''''<Remove>''''' - removes the object and its product queue from the rule
  
[[file:Notes.PNG]] '''<u>Notes:</u>'''
+
[[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''.
 
: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]] '''<u>Related Rules:</u>'''
+
[[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 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
 
*'''[[#Resource Verify Rule (fixed)|Resource Verify Rule (fixed)]]''' - executes child rules when a set resource (commodity) level is reached
  
[[file:Ex.PNG]] '''<u>Examples of Use</u>'''
+
[[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]]'''
 
*'''[[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]] '''<u>Trainz Wiki Links:</u>'''
+
[[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 Parent and Child Rules]]'''
  
Line 177: Line 177:
 
Sets up a game Objective with ID and display Name
 
Sets up a game Objective with ID and display Name
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:401543:2001>'''
 
*'''<kuid:401543:2001>'''
Line 183: Line 183:
 
*'''Base Rule'''
 
*'''Base Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
     '''Priority ''<Select>''''' - select one of:-
+
     '''Priority ''<Select>''''' - <span style="background-color: black; color: white; font-weight: 700;"> select one of:- </span>
 
       '''''Above Normal'''''
 
       '''''Above Normal'''''
 
       '''''Below Normal'''''
 
       '''''Below Normal'''''
Line 197: Line 197:
 
     '''Custom Message ''<Text Box>''''' - insert typed message in text area
 
     '''Custom Message ''<Text Box>''''' - insert typed message in text area
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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 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
 
*'''[[#Objective Update Rule|Objective Update Rule]]''' - changes the progress of a game objective
Line 212: Line 212:
 
Executes child rules if an objective created with the '''Objective Add Rule''' is complete.
 
Executes child rules if an objective created with the '''Objective Add Rule''' is complete.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:401543:2003>'''
 
*'''<kuid:401543:2003>'''
Line 220: Line 220:
 
*'''Parent Rule'''
 
*'''Parent Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[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'''  
 
     '''Unique Objective ID ''<value>''''' - enter the unique ID created with the '''Objective Add Rule'''  
     '''Mode ''<select>''''' - select one of three:-
+
     '''Mode ''<select>''''' - <span style="background-color: black; color: white; font-weight: 700;"> select one of three:- </span>
 
       '''''Wait for completion'''''
 
       '''''Wait for completion'''''
 
       '''''Wait for failure'''''
 
       '''''Wait for failure'''''
 
       '''''Wait for progress'''''
 
       '''''Wait for progress'''''
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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 Add Rule|Objective Add Rule]]''' - sets up a game objective
 
*'''[[#Objective Update Rule|Objective Update Rule]]''' - changes the progress of a game objective
 
*'''[[#Objective Update Rule|Objective Update Rule]]''' - changes the progress of a game objective
  
[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+
[[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 Parent and Child Rules]]'''
  
Line 246: Line 246:
 
Changes progress of an objective outcome created with the '''Objective Add Rule''' according to Property choices
 
Changes progress of an objective outcome created with the '''Objective Add Rule''' according to Property choices
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:401543:2002>'''
 
*'''<kuid:401543:2002>'''
Line 252: Line 252:
 
*'''Base Rule'''
 
*'''Base Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[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'''  
 
     '''Unique Objective ID ''<value>''''' - enter the unique ID created with the '''Objective Add Rule'''  
     '''Mode ''<select>''''' - select one from the following options
+
     '''Mode ''<select>''''' - <span style="background-color: black; color: white; font-weight: 700;"> select one from the following options:- </span>
 
       '''''Decrement progress'''''
 
       '''''Decrement progress'''''
 
       '''''Increment progress'''''
 
       '''''Increment progress'''''
Line 265: Line 265:
 
     '''Amount ''<value>''''' - click to enter a value
 
     '''Amount ''<value>''''' - click to enter a value
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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 Add Rule|Objective Add Rule]]''' - sets up a game objective
 
*'''[[#Objective Check Rule|Objective Check Rule]]''' - executes child rules if an objective is completed
 
*'''[[#Objective Check Rule|Objective Check Rule]]''' - executes child rules if an objective is completed
 
 
<br>
 
<br>
 
<table width=100% width=100% bgcolor=#ffffcc>
 
<table width=100% width=100% bgcolor=#ffffcc>
Line 280: Line 279:
 
Begins a ranked Session
 
Begins a ranked Session
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:401543:2031>'''
 
*'''<kuid:401543:2031>'''
Line 286: Line 285:
 
*'''Base Rule'''
 
*'''Base Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
     '''Countdown Starting Value ''<value>'''''
 
     '''Countdown Starting Value ''<value>'''''
Line 293: Line 292:
 
       '''''sec:'''''
 
       '''''sec:'''''
 
     '''1 through 5 stars, points for each star ''<value>''''' - enter number of points for each star rating
 
     '''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:-
+
     '''Session timer mode:''' - <span style="background-color: black; color: white; font-weight: 700;"> select one of three option buttons:- </span>
 
       '''( ) Timer'''
 
       '''( ) Timer'''
 
       '''( ) Countdown Starting value ''<value>''''' - enter time ''hh:mm:ss''
 
       '''( ) Countdown Starting value ''<value>''''' - enter time ''hh:mm:ss''
 
       '''( ) None'''
 
       '''( ) None'''
  
[[file:Notes.PNG]] '''<u>Notes:</u>'''
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
:Times are Trainz clock time, not real time
 
:Times are Trainz clock time, not real time
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
 
*'''[[#Ranked Session Complete Rule|Ranked Session Complete Rule]]''' - completes the active ranked Session
 
*'''[[#Ranked Session Complete Rule|Ranked Session Complete Rule]]''' - completes the active ranked Session
  
Line 315: Line 314:
 
Completes the active ranked Session
 
Completes the active ranked Session
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:401543:2032>'''
 
*'''<kuid:401543:2032>'''
Line 321: Line 320:
 
*'''Base Rule'''
 
*'''Base Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[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:-
+
     '''Set the active ranked session as:''' - <span style="background-color: black; color: white; font-weight: 700;"> select one of two option buttons:- </span>
 
       '''( ) Complete'''
 
       '''( ) Complete'''
 
       '''( ) Failed'''
 
       '''( ) Failed'''
 
     '''[x] Customize the completion message ''<text>''''' - enter a text message
 
     '''[x] Customize the completion message ''<text>''''' - enter a text message
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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
 
*'''[[#Ranked Session Begin Rule|Ranked Session Begin Rule]]''' - begins a ranked Session
  
Line 342: Line 341:
 
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'''
 
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]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-25:1067>'''
 
*'''<kuid:-25:1067>'''
Line 352: Line 351:
 
*'''Parent Rule'''
 
*'''Parent Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
     Select one of two option buttons:-
+
     <span style="background-color: black; color: white; font-weight: 700;"> Select one of two option buttons:- </span>
 
       '''( ) Watch industry queue'''
 
       '''( ) Watch industry queue'''
 
           '''Target Object ''<select>''''' - select an industry from the session list
 
           '''Target Object ''<select>''''' - select an industry from the session list
Line 360: Line 359:
 
           '''Product ''<select>''''' - select a product from the selected queue
 
           '''Product ''<select>''''' - select a product from the selected queue
 
           '''Amount ''<value>''''' - enter a quantity
 
           '''Amount ''<value>''''' - enter a quantity
           Select one of two option buttons:-
+
           <span style="background-color: black; color: white; font-weight: 700;"> Select one of two option buttons:- </span>
 
             '''( ) Complete when designated queue equals or exceeds required amount'''
 
             '''( ) Complete when designated queue equals or exceeds required amount'''
 
             '''( ) Complete when designated queue falls below required amount'''
 
             '''( ) Complete when designated queue falls below required amount'''
Line 368: Line 367:
 
           '''Product ''<select>''''' - select a product from the selected queue
 
           '''Product ''<select>''''' - select a product from the selected queue
 
           '''Amount ''<value>''''' - enter a quantity
 
           '''Amount ''<value>''''' - enter a quantity
           Select one of two option buttons:-
+
           <span style="background-color: black; color: white; font-weight: 700;"> Select one of two option buttons:- </span>
 
             '''( ) Complete when designated queue equals or exceeds required amount'''
 
             '''( ) Complete when designated queue equals or exceeds required amount'''
 
             '''( ) Complete when designated queue falls below required amount'''
 
             '''( ) Complete when designated queue falls below required amount'''
  
[[file:Notes.PNG]] '''<u>Notes:</u>'''
+
[[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''.
 
: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]] '''<u>Related Rules:</u>'''
+
[[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
 
*'''[[#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
 
*'''[[#Resource Verify Rule (fixed)|Resource Verify Rule (fixed)]]''' - executes child rules when a set resource (commodity) level is reached
  
[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+
[[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 Parent and Child Rules]]'''
 
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Resource_Check_Rule</span>'''
 
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Resource_Check_Rule</span>'''
Line 394: Line 393:
 
Executes child rules if a selected industry or vehicle reaches a set commodity level. The rule resets when all child rules have completed.
 
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]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:160293:10060>'''
 
*'''<kuid:160293:10060>'''
Line 402: Line 401:
 
*'''Parent Rule'''
 
*'''Parent Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
     Select one of two option buttons:-
+
     <span style="background-color: black; color: white; font-weight: 700;"> Select one of two option buttons:- </span>
 
     '''( ) Watch industry queue'''
 
     '''( ) Watch industry queue'''
 
       '''Target object ''<click to select>''''' - click to select an industry from the session list.
 
       '''Target object ''<click to select>''''' - click to select an industry from the session list.
 
       '''Product ''<click to select>''''' - click to select an industry product.
 
       '''Product ''<click to select>''''' - click to select an industry product.
 
       '''Amount ''<value>''''' - enter a quantity for the selected product.
 
       '''Amount ''<value>''''' - enter a quantity for the selected product.
       Select one of two option buttons:-
+
       <span style="background-color: black; color: white; font-weight: 700;"> Select one of two option buttons:- </span>
 
       '''( ) Complete when designated queue equals or exceeds designated amount'''
 
       '''( ) Complete when designated queue equals or exceeds designated amount'''
 
       '''( ) Complete when designated queue falls below designated amount'''
 
       '''( ) Complete when designated queue falls below designated amount'''
Line 416: Line 415:
 
       '''Product ''<click to select>''''' - click to select a commodity product.
 
       '''Product ''<click to select>''''' - click to select a commodity product.
 
       '''Amount ''<value>''''' - enter a quantity for the selected product.
 
       '''Amount ''<value>''''' - enter a quantity for the selected product.
       Select one of two option buttons:-
+
       <span style="background-color: black; color: white; font-weight: 700;"> Select one of two option buttons:- </span>
 
       '''( ) Complete when designated queue equals or exceeds designated amount'''
 
       '''( ) Complete when designated queue equals or exceeds designated amount'''
 
       '''( ) Complete when designated queue falls below designated amount'''
 
       '''( ) Complete when designated queue falls below designated amount'''
  
[[file:Notes.PNG]] '''<u>Notes:</u>'''
+
[[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.
 
#This rule will only monitor a single commodity in a single industry or vehicle.
 
#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''.
 
#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]] '''<u>Related Rules:</u>'''
+
[[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
 
*'''[[#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
 
*'''[[#Resource Check Rule|Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
  
[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+
[[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 Parent and Child Rules]]'''
  
Line 442: Line 441:
 
Executes child rules if specific trains call at set stations or industries
 
Executes child rules if specific trains call at set stations or industries
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid2:60850:89005:3>'''
 
*'''<kuid2:60850:89005:3>'''
Line 450: Line 449:
 
*'''Parent Rule'''
 
*'''Parent Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
     '''Trigger: ''<select>''''' - click to select one of the following
+
     '''Trigger: ''<select>''''' - <span style="background-color: black; color: white; font-weight: 700;"> click to select one of the following:- </span>
 
       '''''Never''''' - stopping at the selected industries will never trigger the rule.
 
       '''''Never''''' - stopping at the selected industries will never trigger the rule.
 
       '''''Once only''''' - the rule is triggered on the first visit only to any one of the selected industries
 
       '''''Once only''''' - the rule is triggered on the first visit only to any one of the selected industries
Line 459: Line 458:
 
       '''''Once per vehicle''''' - each vehicle can only trigger the rule once.  
 
       '''''Once per vehicle''''' - each vehicle can only trigger the rule once.  
 
     '''''<select industry>''''' - select industry or industries from session list
 
     '''''<select industry>''''' - select industry or industries from session list
     Select one of two option buttons:-
+
     <span style="background-color: black; color: white; font-weight: 700;"> Select one of two option buttons:- </span>
 
       '''( ) click to accept all trains'''
 
       '''( ) click to accept all trains'''
 
       '''( ) click to accept trains matching specific criteria'''
 
       '''( ) click to accept trains matching specific criteria'''
           Selecting the second option will produce the following selection controls:-        
+
           <span style="background-color: black; color: white; font-weight: 700;"> Selecting the second option will produce the following selection controls:- </span>       
 
           '''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
 
           '''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
 
             '''''+''''' - click to add a ''specific'' vehicle from the session list
Line 473: Line 472:
 
             '''''x''''' - click to remove a ''driver'' from the rule
 
             '''''x''''' - click to remove a ''driver'' from the rule
  
[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+
[[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 Parent and Child Rules]]'''
 
<br>
 
<br>
<table width="100%" bgcolor=#ffff88>
 
<tr>
 
<td>
 
'''[[#top|Back to Top]]'''
 
</td>
 
</tr>
 
</table>
 
 
 
<table width="100%" bgcolor=#ffff88>
 
<table width="100%" bgcolor=#ffff88>
 
<tr>
 
<tr>
Line 491: Line 482:
 
</tr>
 
</tr>
 
</table>
 
</table>
 +
[[file:BackToTop.png|link=#top|alt=Top|Top]] [[file:NextDown.png|link=#Danger, Derailment and Safety Rules|alt=Next Down|Danger, Derailment and Safety Rules]] [[file:NextUp.png|link=#Achievement Rules|alt=Next Up|Achievement Rules]] [[file:BackToBottom.png|link=#Trainz Wiki|alt=Bottom|Bottom]]
  
<br>
 
 
<table width=100% width=100% bgcolor=#ffffcc>
 
<table width=100% width=100% bgcolor=#ffffcc>
 
<tr>
 
<tr>
Line 504: Line 495:
 
Use the '''Trackside Camera''' (tracking view) found in the '''Set Camera Rule''' during session play.
 
Use the '''Trackside Camera''' (tracking view) found in the '''Set Camera Rule''' during session play.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid2:401543:1166:3>'''
 
*'''<kuid2:401543:1166:3>'''
Line 510: Line 501:
 
*'''Built-in Rule'''
 
*'''Built-in Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
     '''[x] Lock camera controls for the duration''' - if checked user cannot alter camera view
 
     '''[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
 
     '''[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 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:-
+
     '''Camera mode:''' - <span style="background-color: black; color: white; font-weight: 700;"> select one of three option buttons:- </span>
 
       '''( ) Stationary'''
 
       '''( ) Stationary'''
 
       '''( ) Circle targeted object'''
 
       '''( ) Circle targeted object'''
Line 525: Line 516:
 
     '''Total time to animate:  ''<value>''''' - enter an animation time in seconds
 
     '''Total time to animate:  ''<value>''''' - enter an animation time in seconds
  
[[file:Notes.PNG]] '''<u>Notes:</u>'''
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
:Times are Trainz clock times, not real times
 
:Times are Trainz clock times, not real times
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
 
*'''[[#Focus Camera Rule|Focus Camera Rule]]''' - sets the initial camera view and starting vehicle for a session
 
*'''[[#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
 
*'''[[#Set Camera Rule|Set Camera Rule]]''' - sets the target object and properties of the camera
Line 534: Line 525:
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#ffffcc>
 
<tr>
 
<tr>
 
<td>
 
<td>
Line 544: Line 535:
 
Sets the initial camera view and starting vehicle for a session.
 
Sets the initial camera view and starting vehicle for a session.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid2:122381:10014:1>'''
 
*'''<kuid2:122381:10014:1>'''
Line 550: Line 541:
 
*'''DLS Rule''' by '''mizi'''
 
*'''DLS Rule''' by '''mizi'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
     '''Focus camera to:''' - select one of two option buttons
+
     '''Focus camera to:''' - <span style="background-color: black; color: white; font-weight: 700;"> select one of two option buttons:- </span>
 
       '''( ) Map object'''
 
       '''( ) Map object'''
 
       '''( ) Vehicle'''
 
       '''( ) Vehicle'''
 
     '''Named ''<?????>''''' - enter name of object or vehicle from session list
 
     '''Named ''<?????>''''' - enter name of object or vehicle from session list
     '''Additionally:'''
+
     <span style="background-color: black; color: white; font-weight: 700;"> Additionally: </span>
       '''[x] set view mode to''' - check to select one of four option buttons
+
       '''[x] set view mode to''' - <span style="background-color: black; color: white; font-weight: 700;"> check to select one of four option buttons:- </span>
 
           '''( ) Internal view'''
 
           '''( ) Internal view'''
 
           '''( ) External view'''
 
           '''( ) External view'''
Line 576: Line 567:
 
           '''Distance from the focused object: ''<value>'' metres''' - enter distance from camera to object
 
           '''Distance from the focused object: ''<value>'' metres''' - enter distance from camera to object
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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
 
*'''[[#Cinematic Camera Rule|Cinematic Camera Rule]]''' - provides several different cinematic style cameras with animations
 
*'''[[#Set Camera Rule|Set Camera Rule]]''' - sets the target object and properties of the camera
 
*'''[[#Set Camera Rule|Set Camera Rule]]''' - sets the target object and properties of the camera
Line 592: Line 583:
 
Sets the target object and properties of the camera.
 
Sets the target object and properties of the camera.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-25:179>'''
 
*'''<kuid:-25:179>'''
Line 598: Line 589:
 
*'''Built-in Rule'''
 
*'''Built-in Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[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:-
+
     '''[x] Set the target object of the camera to:''' - <span style="background-color: black; color: white; font-weight: 700;"> if checked, select one of three option buttons:- </span>
 
       '''( ) Vehicle ''<click to select>''''' - select a vehicle from the Session list
 
       '''( ) Vehicle ''<click to select>''''' - select a vehicle from the Session list
 
       '''( ) Junction ''<click to select>''''' - select a junction 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
 
       '''( ) 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
+
     '''[x] Change the camera view mode to ''<click to select>''''' - <span style="background-color: black; color: white; font-weight: 700;"> if checked, select one camera view mode from:- </span>
 
       '''Cab View'''
 
       '''Cab View'''
 
       '''External View'''
 
       '''External View'''
 
       '''Tracking View'''
 
       '''Tracking View'''
 
       '''Free Roaming'''
 
       '''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] Set the camera flags to enable/disable user access to''' - <span style="background-color: black; color: white; font-weight: 700;"> if checked, select as many of the following check boxes as needed:- </span>
 
       '''[x] Internal view mode''' - check to enable, uncheck to disable
 
       '''[x] Internal view mode''' - check to enable, uncheck to disable
 
       '''[x] External view mode''' - check to enable, uncheck to disable
 
       '''[x] External view mode''' - check to enable, uncheck to disable
Line 619: Line 610:
 
       '''[x] Camera adjustments (pan, zoom, etc)''' - check to enable, uncheck to disable
 
       '''[x] Camera adjustments (pan, zoom, etc)''' - check to enable, uncheck to disable
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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
 
*'''[[#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
 
*'''[[#Focus Camera Rule|Focus Camera Rule]]''' - sets the initial camera view and starting vehicle for a session
Line 635: Line 626:
 
Executes child rules when the camera view is changed to a selected view
 
Executes child rules when the camera view is changed to a selected view
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-25:192>'''
 
*'''<kuid:-25:192>'''
Line 643: Line 634:
 
*'''Parent Rule'''
 
*'''Parent Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
     '''[x] Trigger rule once''' - check to set
 
     '''[x] Trigger rule once''' - check to set
     '''Wait for the camera to change to the ''<click to select>''''' - select one camera view mode from:-
+
     '''Wait for the camera to change to the ''<click to select>''''' - <span style="background-color: black; color: white; font-weight: 700;"> select one camera view mode from:- </span>
 
       '''Cab View'''
 
       '''Cab View'''
 
       '''External View'''
 
       '''External View'''
Line 653: Line 644:
 
     '''[x] Wait for the camera to target vehicle ''<click to select>''''' - if checked, select a vehicle from the Session list
 
     '''[x] Wait for the camera to target vehicle ''<click to select>''''' - if checked, select a vehicle from the Session list
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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
 
*'''[[#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
 
*'''[[#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
 
*'''[[#Set Camera Rule|Set Camera Rule]]''' - sets the target object and properties of the camera
  
[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+
[[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 Parent and Child Rules]]'''
 
<br>
 
<br>
<table width="100%" bgcolor=#ffff88>
 
<tr>
 
<td>
 
'''[[#top|Back to Top]]'''
 
</td>
 
</tr>
 
</table>
 
 
 
<table width="100%" bgcolor=#ffff88>
 
<table width="100%" bgcolor=#ffff88>
 
<tr>
 
<tr>
Line 676: Line 659:
 
</tr>
 
</tr>
 
</table>
 
</table>
 +
[[file:BackToTop.png|link=#top|alt=Top|Top]] [[file:NextDown.png|link=#Driver Rules|alt=Next Down|Driver Rules]] [[file:NextUp.png|link=#Camera Rules|alt=Next Up|Camera Rules]][[file:BackToBottom.png|link=#Trainz Wiki|alt=Bottom|Bottom]]
  
<br>
 
 
<table width=100% width=100% bgcolor=#ffffcc>
 
<table width=100% width=100% bgcolor=#ffffcc>
 
<tr>
 
<tr>
Line 688: Line 671:
 
Limits allowable speed over set limit
 
Limits allowable speed over set limit
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid2:321959:1000:1>'''
 
*'''<kuid2:321959:1000:1>'''
Line 694: Line 677:
 
*'''Built-in Rule'''
 
*'''Built-in Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[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
 
     '''Limits the speed to ''<value>'' mph over the set limit''' - enter speed value in mph
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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
 
*'''[[#AWS Configuration Rule|AWS Configuration Rule]]''' - configures the Trainz implementation of the Automatic Warning System when approaching signals
  
Line 712: Line 695:
 
This rule configures the Trainz implementation of the Automatic Warning System when approaching signals
 
This rule configures the Trainz implementation of the Automatic Warning System when approaching signals
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid2:60850:89002:3>'''
 
*'''<kuid2:60850:89002:3>'''
Line 718: Line 701:
 
*'''Built-in Rule'''
 
*'''Built-in Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
     Select one of three option buttons:-
+
     <span style="background-color: black; color: white; font-weight: 700;"> Select one of three option buttons:- </span>
 
       '''( ) Active'''
 
       '''( ) Active'''
 
       '''( ) Passive'''
 
       '''( ) Passive'''
Line 726: Line 709:
 
     '''[x] Simulate AWS for unfitted cabs?'''
 
     '''[x] Simulate AWS for unfitted cabs?'''
 
     '''[x] Use modern sound set for unfitted cabs?'''
 
     '''[x] Use modern sound set for unfitted cabs?'''
 
+
----
<br>
+
<table width=100% bgcolor=#ffffcc>
<table width=100% width=100% bgcolor=#ffffcc>
+
 
<tr>
 
<tr>
 
<td>
 
<td>
Line 738: Line 720:
 
Cleans up derailed train cars after a set time delay
 
Cleans up derailed train cars after a set time delay
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid2:60850:89003:1>'''
 
*'''<kuid2:60850:89003:1>'''
Line 744: Line 726:
 
*'''Base Rule'''
 
*'''Base Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
     '''Set delay to clean up derailed traincars to'''
 
     '''Set delay to clean up derailed traincars to'''
Line 751: Line 733:
 
       '''''<ss>'':''' - click to enter the number of seconds (0-59) to wait
 
       '''''<ss>'':''' - click to enter the number of seconds (0-59) to wait
  
[[file:Notes.PNG]] '''<u>Notes:</u>'''
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
:Time is Trainz clock time, not real time.
 
:Time is Trainz clock time, not real time.
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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
 
*'''[[#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
 
*'''[[#Wait for Derailment Rule|Wait for Derailment Rule]]''' - executes child rules when a derailment occurs
  
[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+
[[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>'''
 
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Clean_up_Derailed_Trains_Rule</span>'''
  
Line 772: Line 754:
 
Executes child rules if there is a coupler breakage
 
Executes child rules if there is a coupler breakage
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid2:447264:1017:1>'''
 
*'''<kuid2:447264:1017:1>'''
Line 780: Line 762:
 
*'''Parent Rule'''
 
*'''Parent Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
     '''None'''
 
     '''None'''
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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
 
*'''[[#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
 
*'''[[#Set Coupler Masks Rule|Set Coupler Masks Rule]]''' - sets the coupling/decoupling masks on selected vehicles
  
[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+
[[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 Parent and Child Rules]]'''
  
Line 802: Line 784:
 
HUD displays warning about coupler stress and breakage
 
HUD displays warning about coupler stress and breakage
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-25:423>'''
 
*'''<kuid:-25:423>'''
Line 808: Line 790:
 
*'''Built-in Rule'''
 
*'''Built-in Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
     Select one of two option buttons:-
+
     <span style="background-color: black; color: white; font-weight: 700;"> Select one of two option buttons:- </span>
 
       '''( ) Show the Coupler Breakage Display'''
 
       '''( ) Show the Coupler Breakage Display'''
 
       '''( ) Hide the Coupler Breakage Display'''
 
       '''( ) Hide the Coupler Breakage Display'''
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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
 
*'''[[#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
 
*'''[[#Set Coupler Masks Rule|Set Coupler Masks Rule]]''' - sets the coupling/decoupling masks on selected vehicles
Line 829: Line 811:
 
Sets opposing (trailing) junctions ahead of a train to prevent derailments.  Works with both AI and manually driven trains.
 
Sets opposing (trailing) junctions ahead of a train to prevent derailments.  Works with both AI and manually driven trains.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid2:121843:100282:1>'''
 
*'''<kuid2:121843:100282:1>'''
Line 835: Line 817:
 
*'''DLS Rule''' by '''pitkin'''
 
*'''DLS Rule''' by '''pitkin'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
     '''None'''
 
     '''None'''
  
[[file:Notes.PNG]] '''<u>Notes:</u>'''
+
[[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'''.
 
: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]] '''<u>Related Rules:</u>'''
+
[[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  
 
*'''[[#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
 
*'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
Line 859: Line 841:
 
Produces new trains to replace missing vehicles that have been removed from the session by the '''Clean Up Derailed Trains Rule'''
 
Produces new trains to replace missing vehicles that have been removed from the session by the '''Clean Up Derailed Trains Rule'''
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:447264:1214>'''
 
*'''<kuid:447264:1214>'''
Line 865: Line 847:
 
*'''Built-in Rule'''
 
*'''Built-in Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[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'''
 
     '''[x] Respawn trains if they are abandoned for 10 minutes'''
     If checked:-
+
     <span style="background-color: black; color: white; font-weight: 700;"> If checked:- </span>
       Select one of two option buttons:-
+
       <span style="background-color: black; color: white; font-weight: 700;"> Select one of two option buttons:- </span>
 
           '''( ) Respawn trains at their original locations'''
 
           '''( ) Respawn trains at their original locations'''
 
           '''( ) Respawn trains from portals'''
 
           '''( ) Respawn trains from portals'''
 
             '''''<+ Add a new portal>''''' - click to enter the name of a portal, there can be more than one portal.
 
             '''''<+ 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
+
             <span style="background-color: red; color: white; font-weight: 700;"> Entered portal names that appear in red have not been found in the session </span>
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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
 
*'''[[#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
 
*'''[[#Wait for Derailment Rule|Wait for Derailment Rule]]''' - executes child rules when a derailment occurs
Line 890: Line 872:
 
Executes child rules if safety systems are applied.
 
Executes child rules if safety systems are applied.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:447264:1216>'''
 
*'''<kuid:447264:1216>'''
Line 898: Line 880:
 
*'''Parent Rule'''
 
*'''Parent Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
     '''[x] Trigger only once'''
 
     '''[x] Trigger only once'''
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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
 
*'''[[#Safety System Isolated Check Rule|Safety System Isolated Check Rule]]''' - executes child rules if safety systems have been isolated
  
[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+
[[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 Parent and Child Rules]]'''
  
Line 919: Line 901:
 
Executes child rules if safety systems are isolated (disengaged).
 
Executes child rules if safety systems are isolated (disengaged).
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:447264:1217>'''
 
*'''<kuid:447264:1217>'''
Line 927: Line 909:
 
*'''Parent Rule'''
 
*'''Parent Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
     '''[x] Trigger only once'''
 
     '''[x] Trigger only once'''
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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
 
*'''[[#Safety System Engaged Check Rule|Safety System Engaged Check Rule]]''' - executes child rules if safety systems have been engaged
  
[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+
[[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 Parent and Child Rules]]'''
  
Line 948: Line 930:
 
Set the coupling/decoupling  masks on the selected vehicles
 
Set the coupling/decoupling  masks on the selected vehicles
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-25:980>'''
 
*'''<kuid:-25:980>'''
Line 954: Line 936:
 
*'''Built-in Rule'''
 
*'''Built-in Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
     '''''<Add vehicle>''''' - click to select a vehicle from the session list
 
     '''''<Add vehicle>''''' - click to select a vehicle from the session list
 
     '''''<Add All>''''' - click to add all vehicles in the session list
 
     '''''<Add All>''''' - click to add all vehicles in the session list
 
     '''''<Delete All>''''' - click to remove all added vehicles from this rule
 
     '''''<Delete All>''''' - click to remove all added vehicles from this rule
       For each selected vehicle:-
+
       <span style="background-color: black; color: white; font-weight: 700;"> For each selected vehicle:- </span>
 
       '''Coupling Mask'''
 
       '''Coupling Mask'''
           '''Front''' and '''Back''' - choose for each
+
           '''Front''' and '''Back''' - <span style="background-color: black; color: white; font-weight: 700;"> choose for each:- </span>
 
             '''''Locked'''''
 
             '''''Locked'''''
 
             '''''Unlocked'''''
 
             '''''Unlocked'''''
 
       '''Decoupling Mask'''
 
       '''Decoupling Mask'''
           '''Front''' and '''Back''' - choose for each
+
           '''Front''' and '''Back''' - <span style="background-color: black; color: white; font-weight: 700;"> choose for each:- </span>
 
             '''''Locked'''''
 
             '''''Locked'''''
 
             '''''Unlocked'''''
 
             '''''Unlocked'''''
 
       '''''<Remove>''''' - click to remove this vehicle from the rule
 
       '''''<Remove>''''' - click to remove this vehicle from the rule
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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 when a coupler breaks
 
*'''[[#Coupler Breakage Check Rule|Coupler Breakage Check Rule]]''' - executes child rules when a coupler breaks
 
*'''[[#Coupler Breakage HUD Rule|Coupler Breakage HUD Rule]]''' - adds a coupler stress and breakage warning to the HUD
 
*'''[[#Coupler Breakage HUD Rule|Coupler Breakage HUD Rule]]''' - adds a coupler stress and breakage warning to the HUD
Line 985: Line 967:
 
Executes child rules if a signal or stop mark is ''Passed at Danger (STOP)''.
 
Executes child rules if a signal or stop mark is ''Passed at Danger (STOP)''.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid2:60850:89007:2>'''
 
*'''<kuid2:60850:89007:2>'''
Line 993: Line 975:
 
*'''Parent Rule'''
 
*'''Parent Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
     '''[x] Trigger only once'''
 
     '''[x] Trigger only once'''
  
[[file:Ex.PNG]] '''<u>Examples of Use</u>'''
+
[[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 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]] '''<u>Trainz Wiki Links:</u>'''
+
[[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 Parent and Child Rules]]'''
  
Line 1,014: Line 996:
 
Executes child rules if player controlled trains are over the local speed limit or over a set (custom) speed
 
Executes child rules if player controlled trains are over the local speed limit or over a set (custom) speed
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid2:60850:89004:3>'''
 
*'''<kuid2:60850:89004:3>'''
Line 1,022: Line 1,004:
 
*'''Parent Rule'''
 
*'''Parent Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
     Select one of two options to set a speed limit to be observed
+
     <span style="background-color: black; color: white; font-weight: 700;"> Select one of two options to set a speed limit to be observed:- </span>
 
       '''( ) Watch for trains travelling above the posted speed limit'''
 
       '''( ) Watch for trains travelling above the posted speed limit'''
 
           '''''<speed value>''''' - click to enter a new overspeed tolerance value
 
           '''''<speed value>''''' - click to enter a new overspeed tolerance value
           '''''<speed units>''''' - click to select one from the list:-
+
           '''''<speed units>''''' - <span style="background-color: black; color: white; font-weight: 700;"> click to select one from the list:- </span>
 
             '''''Km/h''''' - Kilometres per hour
 
             '''''Km/h''''' - Kilometres per hour
 
             '''''MPH''''' - Miles per hour
 
             '''''MPH''''' - Miles per hour
Line 1,033: Line 1,015:
 
       '''( ) Watch for trains travelling above a custom speed'''
 
       '''( ) Watch for trains travelling above a custom speed'''
 
           '''''<speed value>''''' - click to enter a new custom speed value
 
           '''''<speed value>''''' - click to enter a new custom speed value
           '''''<speed units>''''' - click to select one from the list:-
+
           '''''<speed units>''''' - <span style="background-color: black; color: white; font-weight: 700;"> click to select one from the list:- </span>
 
             '''''Km/h''''' - Kilometres per hour
 
             '''''Km/h''''' - Kilometres per hour
 
             '''''MPH''''' - Miles per hour
 
             '''''MPH''''' - Miles per hour
 
             '''''mps''''' - metres per second
 
             '''''mps''''' - metres per second
             '''Warning: This option is very performance intensive and should only be used in sessions with few trains'''
+
             <span style="background-color: red; color: white; font-weight: 700;"> Warning: This option is very performance intensive and should only be used in sessions with few trains </span>
  
[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+
[[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 Parent and Child Rules]]'''
  
Line 1,053: Line 1,035:
 
Overrides the default vehicle physics properties for all vehicles or for those matching set criteria
 
Overrides the default vehicle physics properties for all vehicles or for those matching set criteria
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-25:1052>'''
 
*'''<kuid:-25:1052>'''
Line 1,059: Line 1,041:
 
*'''Built-in Rule'''
 
*'''Built-in Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
 
    
 
    
     Select one of two option buttons:-
+
     <span style="background-color: black; color: white; font-weight: 700;"> Select one of two option buttons:- </span>
 
       '''( ) click to accept all trains'''
 
       '''( ) click to accept all trains'''
 
       '''( ) click to accept trains matching specific criteria'''
 
       '''( ) click to accept trains matching specific criteria'''
           Selecting the second option will produce the following selection controls:-
+
           <span style="background-color: black; color: white; font-weight: 700;"> Selecting the second option will produce the following selection controls:- </span>
 
           '''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
 
           '''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
 
             '''''+''''' - click to add a ''specific'' vehicle from the session list
Line 1,084: Line 1,066:
 
     '''Sway Parameters:'''
 
     '''Sway Parameters:'''
 
       '''Cab sway level is set to ''<value>'' %''' - enter value as a %
 
       '''Cab sway level is set to ''<value>'' %''' - enter value as a %
 
 
<br>
 
<br>
 
<table width=100% width=100% bgcolor=#ffffcc>
 
<table width=100% width=100% bgcolor=#ffffcc>
Line 1,096: Line 1,077:
 
Executes child rules when a derailment occurs
 
Executes child rules when a derailment occurs
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-25:1053>'''
 
*'''<kuid:-25:1053>'''
Line 1,104: Line 1,085:
 
*'''Parent Rule'''
 
*'''Parent Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
     '''[x] Trigger derailment watch once''' - check to execute the rule once only
 
     '''[x] Trigger derailment watch once''' - check to execute the rule once only
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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
 
*'''[[#Clean Up Derailed Trains Rule|Clean Up Derailed Trains Rule]]''' - cleans up derailed train cars after a set time delay
 
*'''[[#Replace Missing Vehicles Rule|Replace Missing Vehicles Rule]]''' - creates a replacement train after a derailment
 
*'''[[#Replace Missing Vehicles Rule|Replace Missing Vehicles Rule]]''' - creates a replacement train after a derailment
  
[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+
[[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 Parent and Child Rules]]'''
 
<br>
 
<br>
<table width="100%" bgcolor=#ffff88>
 
<tr>
 
<td>
 
'''[[#top|Back to Top]]'''
 
</td>
 
</tr>
 
</table>
 
 
 
<table width="100%" bgcolor=#ffff88>
 
<table width="100%" bgcolor=#ffff88>
 
<tr>
 
<tr>
Line 1,130: Line 1,103:
 
</tr>
 
</tr>
 
</table>
 
</table>
 +
[[file:BackToTop.png|link=#top|alt=Top|Top]] [[file:NextDown.png|link=#HUD (Heads Up Display) Rules|alt=Next Down|Heads Up Display Rules]] [[file:NextUp.png|link=#Danger, Derailment and Safety Rules|alt=Next Up|Danger, Derailment and Safety Rules]] [[file:BackToBottom.png|link=#Trainz Wiki|alt=Bottom|Bottom]]
  
<br>
 
 
<table width=100% width=100% bgcolor=#ffffcc>
 
<table width=100% width=100% bgcolor=#ffffcc>
 
<tr>
 
<tr>
Line 1,142: Line 1,115:
 
Restarts all halted AI controlled trains. Drivers will continue with the commands in their driver command list.
 
Restarts all halted AI controlled trains. Drivers will continue with the commands in their driver command list.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid2:400048:100981:1>'''
 
*'''<kuid2:400048:100981:1>'''
Line 1,148: Line 1,121:
 
*'''DLS Rule''' by '''callavsg'''
 
*'''DLS Rule''' by '''callavsg'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
     '''None'''
 
     '''None'''
 
 
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
 
*'''[[#AI Stop Rule|AI Stop Rule]]''' -  halts all AI drivers
 
*'''[[#AI Stop Rule|AI Stop Rule]]''' -  halts all AI drivers
 
*'''[[#Disallow AI Rule|Disallow AI Rule]]''' -  cancels all AI driver commands
 
*'''[[#Disallow AI Rule|Disallow AI Rule]]''' -  cancels all AI driver commands
Line 1,167: Line 1,140:
 
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.
 
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.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid2:400048:100980:1>'''
 
*'''<kuid2:400048:100980:1>'''
Line 1,173: Line 1,146:
 
*'''DLS Rule''' by '''callavsg'''
 
*'''DLS Rule''' by '''callavsg'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
     '''None'''
 
     '''None'''
 
 
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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
 
*'''[[#AI Start Rule|AI Start Rule]]''' -  restarts all halted AI drivers
 
*'''[[#Disallow AI Rule|Disallow AI Rule]]''' -  cancels all AI driver commands
 
*'''[[#Disallow AI Rule|Disallow AI Rule]]''' -  cancels all AI driver commands
Line 1,192: Line 1,165:
 
Executes child rules if the train control method has been altered or a specific method has been selected.
 
Executes child rules if the train control method has been altered or a specific method has been selected.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:401543:1191>'''
 
*'''<kuid:401543:1191>'''
Line 1,200: Line 1,173:
 
*'''Parent Rule'''
 
*'''Parent Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
   '''Execute child rules when:''' - select one of two option buttons:-
+
   '''Execute child rules when:''' - <span style="background-color: black; color: white; font-weight: 700;"> select one of two option buttons:- </span>
 
     '''( ) DCC mode is Selected'''
 
     '''( ) DCC mode is Selected'''
 
     '''( ) Cab mode is Selected'''
 
     '''( ) Cab mode is Selected'''
   '''Execute child rules:''' - select one of two option buttons:-
+
   '''Execute child rules:''' - <span style="background-color: black; color: white; font-weight: 700;"> select one of two option buttons:- </span>
 
     '''( ) Every time control method is set'''
 
     '''( ) Every time control method is set'''
 
     '''( ) Once only'''
 
     '''( ) Once only'''
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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
 
*'''[[#Control Type Rule|Control Type Rule]]''' - sets the control method
  
[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+
[[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 Parent and Child Rules]]'''
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#ffffcc>
 
<tr>
 
<tr>
 
<td>
 
<td>
Line 1,226: Line 1,199:
 
Sets the control method
 
Sets the control method
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-16:2030>'''
 
*'''<kuid:-16:2030>'''
Line 1,232: Line 1,205:
 
*'''Base Rule'''
 
*'''Base Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[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
+
   '''Current control method is: ''<select>''''' - <span style="background-color: black; color: white; font-weight: 700;"> click to select one of:- </span>
 
     '''''Easy Mode''''' - DCC (standard keyboard and mouse) control
 
     '''''Easy Mode''''' - DCC (standard keyboard and mouse) control
 
     '''''Ask User''''' - let the user decide
 
     '''''Ask User''''' - let the user decide
 
     '''''Realistic Mode''''' - Cab controls (on screen levers, throttles, buttons, etc)
 
     '''''Realistic Mode''''' - Cab controls (on screen levers, throttles, buttons, etc)
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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
 
*'''[[#Control Check Rule|Control Check Rule]]''' - executes child rules if the train control method changes
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#ffffcc>
 
<tr>
 
<tr>
 
<td>
 
<td>
Line 1,253: Line 1,226:
 
Cancels (deletes) all current and waiting AI commands for all drivers
 
Cancels (deletes) all current and waiting AI commands for all drivers
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:400048:100603>'''
 
*'''<kuid:400048:100603>'''
Line 1,259: Line 1,232:
 
*'''DLS Rule''' by '''callavsg'''
 
*'''DLS Rule''' by '''callavsg'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
   '''None'''
 
   '''None'''
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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
 
*'''[[#AI Start Rule|AI Start Rule]]''' -  restarts all halted AI drivers
 
*'''[[#AI Stop Rule|AI Stop Rule]]''' -  halts all AI drivers
 
*'''[[#AI Stop Rule|AI Stop Rule]]''' -  halts all AI drivers
Line 1,278: Line 1,251:
 
Executes child rules if the driver commands match a set list.
 
Executes child rules if the driver commands match a set list.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-25:447>'''
 
*'''<kuid:-25:447>'''
Line 1,286: Line 1,259:
 
*'''Parent Rule'''
 
*'''Parent Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
   '''[x] Trigger rule once''' - check to allow the rule to execute only once
 
   '''[x] Trigger rule once''' - check to allow the rule to execute only once
Line 1,295: Line 1,268:
 
     '''''<delete all>''''' - deletes all entered driver commands from the session rule
 
     '''''<delete all>''''' - deletes all entered driver commands from the session rule
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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 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 Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
Line 1,301: Line 1,274:
 
*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
 
*'''[[#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
 
*'''[[#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
 
*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
  
[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+
[[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 Parent and Child Rules]]'''
  
Line 1,317: Line 1,291:
 
Specifies which commands will be available for the drivers
 
Specifies which commands will be available for the drivers
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-3:10057>'''
 
*'''<kuid:-3:10057>'''
Line 1,323: Line 1,297:
 
*'''Base Rule'''
 
*'''Base Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
 
+
:
     For each installed Driver Command:-
+
     <span style="background-color: black; color: white; font-weight: 700;"> For each installed Driver Command:- </span>
 
     '''[x] ''Name of Driver Command'' and ''Description (if available)''''' - check to make that command available to the drivers
 
     '''[x] ''Name of Driver Command'' and ''Description (if available)''''' - check to make that command available to the drivers
  
[[file:Notes.PNG]] '''<u>Notes:</u>'''
+
[[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:
 
: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 ''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.
+
::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]] '''<u>Related Rules:</u>'''
+
[[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 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 Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
Line 1,339: Line 1,313:
 
*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
 
*'''[[#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
 
*'''[[#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
 
*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
  
[[file:Ex.PNG]] '''<u>Examples of Use</u>'''
+
[[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]]'''
 
*'''[[How to Use Driver Setup Rule#Driver Command Rule|How to Use Driver Command Rule]]'''
  
[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
 
*'''[[Driver_Commands_List|Driver Commands List]]'''
 
*'''[[Driver_Commands_List|Driver Commands List]]'''
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#ffffcc>
 
<tr>
 
<tr>
 
<td>
 
<td>
Line 1,358: Line 1,333:
 
Show/Hide the Driver Main Menu Bar
 
Show/Hide the Driver Main Menu Bar
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-25:448>'''
 
*'''<kuid:-25:448>'''
Line 1,364: Line 1,339:
 
*'''Built-in Rule'''
 
*'''Built-in Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[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
 
     '''''<Show/Hide>'' the Driver Main Menu Bar''' - click '''Show''' or '''Hide''' to select
Line 1,379: Line 1,354:
 
Sets up a list of basic scheduled commands
 
Sets up a list of basic scheduled commands
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
*'''<kuid2:82445:90001:9>'''
+
*'''<kuid2:82445:90001:9>''' by '''transiberiano'''
  
 
*'''Built-in Rule'''
 
*'''Built-in Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[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'''
 
     '''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'''   
 
     '''Next commands, will be executed'''   
 
       '''''>>''''' - click to enter driver commands from those specified in the '''Driver Command Rule'''
 
       '''''>>''''' - click to enter driver commands from those specified in the '''Driver Command Rule'''
     '''Style:''' - select one of four option buttons:-
+
     '''Style:''' - <span style="background-color: black; color: white; font-weight: 700;"> select one of four option buttons:- </span>
 
       '''( ) Classic style: If there is a schedule do not emit a new schedule''' - any currently assigned set of driver commands will not be replaced
 
       '''( ) 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
 
       '''( ) Killer style: If there is a schedule clean it and emit a new one''' - replace any currently assigned driver commands with the new commands
Line 1,396: Line 1,371:
 
       '''( ) Active style: Emit a new schedule, only if already a schedule running''' - only add the new commands if commands are currently running
 
       '''( ) 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]] '''<u>Related Rules:</u>'''
+
[[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 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 Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
Line 1,402: Line 1,377:
 
*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
 
*'''[[#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
 
*'''[[#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
 
*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
  
[[file:Ex.PNG]] '''<u>Examples of Use</u>'''
+
[[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 Variables in Sessions (Examples)#Example 2: Event Counter and Message Selection|How to Use Variables in Sessions (Examples): Event Counter and Message Selection]]
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#ffffcc>
 
<tr>
 
<tr>
 
<td>
 
<td>
Line 1,418: Line 1,394:
 
Creates the list of drivers for this session and assigns them their orders
 
Creates the list of drivers for this session and assigns them their orders
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-16:2025>'''
 
*'''<kuid:-16:2025>'''
Line 1,424: Line 1,400:
 
*'''Base Rule'''
 
*'''Base Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[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
 
     '''''<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
 
     '''''<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 name>''''' - click to enter a new name for the selected driver
     '''''<driver mode>''''' - click to select one of:-
+
     '''''<driver mode>''''' - <span style="background-color: black; color: white; font-weight: 700;"> click to select one of:- </span>
 
       '''''Autodetect''''' - the program will detect the driver mode to be used. For example, if driver commands have been entered for this driver
 
       '''''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
 
           then the '''AI driver''' mode will be selected
Line 1,437: Line 1,413:
 
     '''''<remove>''''' - this driver will be removed from the rule
 
     '''''<remove>''''' - this driver will be removed from the rule
 
     '''''>>''''' - click to enter driver commands from those specified in the '''Driver Command 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
+
     <span style="background-color: red; color: white; font-weight: 700;"> Scroll down to the bottom of the list of entered drivers for more options:- </span>
 
   '''''<Add another driver>''''' - click to add another driver  
 
   '''''<Add another driver>''''' - click to add another driver  
   '''[x] Remove all existing Drivers first''' - see '''Known Issues''' below
+
   '''[x] Remove all existing Drivers first''' - <span style="background-color: red; color: white; font-weight: 700;"> see Known Issues below </span>
 
   '''[x] Generate new Drivers for empty Trains''' - when checked all newly added locos will automatically be given drivers
 
   '''[x] Generate new Drivers for empty Trains''' - when checked all newly added locos will automatically be given drivers
  
[[file:Issues.PNG]] '''<u>Known Issues:</u>'''
+
[[file:Issues.PNG|link=]] <span style="background-color: yellow; color: black; font-weight: 700;"> Known Issues: </span>
:The '''Remove all existing Drivers first''' option does not appear to work in '''TANE''' (but works in '''TRS19''')
+
#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 '''TRS19 SP1''' and '''Trainz Plus'''
  
[[file:Notes.PNG]] '''<u>Notes:</u>'''
+
[[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
 
: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]] '''<u>Related Rules:</u>'''
+
[[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 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 Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
Line 1,454: Line 1,431:
 
*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
 
*'''[[#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
 
*'''[[#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
 
*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
  
[[file:Ex.PNG]] '''<u>Examples of Use</u>'''
+
[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
 
*'''[[How to Use Driver Setup Rule]]'''
 
*'''[[How to Use Driver Setup Rule]]'''
  
[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+
[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
 
*'''[[Driver_Commands_List|Driver Commands List]]'''
 
*'''[[Driver_Commands_List|Driver Commands List]]'''
 
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Driver_Setup_Rule</span>'''
 
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Driver_Setup_Rule</span>'''
Line 1,474: Line 1,452:
 
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
 
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]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-25:480>'''
 
*'''<kuid:-25:480>'''
Line 1,480: Line 1,458:
 
*'''Built-in Rule'''
 
*'''Built-in Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[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'''
 
     '''<Enable/Disable>'' the following driver commands ...''' - click to select '''Enable''' or '''Disable'''
     For each driver command:-
+
     <span style="background-color: black; color: white; font-weight: 700;"> For each driver command:- </span>
 
     '''[x] ''command name''''' - check to enable or disable
 
     '''[x] ''command name''''' - check to enable or disable
 
     '''[x] ''command name''''' - check to enable or disable
 
     '''[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
 
     etc
     Select one of two option buttons:-
+
     <span style="background-color: black; color: white; font-weight: 700;"> Select one of two option buttons:- </span>
 
       '''( ) click to accept all trains'''
 
       '''( ) click to accept all trains'''
 
       '''( ) click to accept trains matching specific criteria'''
 
       '''( ) click to accept trains matching specific criteria'''
           Selecting the second option will produce the following selection controls:-
+
           <span style="background-color: black; color: white; font-weight: 700;"> Selecting the second option will produce the following selection controls:- </span>
 
           '''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
 
           '''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
 
             '''''+''''' - click to add a ''specific'' vehicle from the session list
Line 1,502: Line 1,480:
 
             '''''x''''' - click to remove a ''driver'' from the rule
 
             '''''x''''' - click to remove a ''driver'' from the rule
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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 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 Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
Line 1,508: Line 1,486:
 
*'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
 
*'''[[#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
 
*'''[[#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
 
*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
  
[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+
[[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>'''
 
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Enable/Disable_Driver_Commands_Rule</span>'''
  
Line 1,524: Line 1,503:
 
Corrects the brightness of vehicle headlights. Now obsolete.
 
Corrects the brightness of vehicle headlights. Now obsolete.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid2:478657:999103:1>'''
 
*'''<kuid2:478657:999103:1>'''
Line 1,530: Line 1,509:
 
*'''DLS Rule''' by '''jtg-trainz'''
 
*'''DLS Rule''' by '''jtg-trainz'''
  
*''' Obsolete Rule''' (function is now built into TANE Driver Additional Tools Menu)
+
*''' Obsolete Rule''' (function is now built into '''Trainz''')
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
     '''None'''
 
     '''None'''
Line 1,540: Line 1,519:
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''QuickDrive Rule'''==
+
=='''ScheduleAtTrackside Rule'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Changes the Session settings.
+
Allows a set of driver commands to be given to a train when it reaches a trackmark or trigger.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
*'''<kuid:401543:1184>'''
+
*'''<kuid2:61392:2001:6>'''
  
*'''Base Rule'''
+
*'''DLS Rule''' by '''pguy'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[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
+
    '''''<Select trackmark>'' - ''<Select trigger>''''' - click one to select a trackmark from the Session list or a trigger from the Session list
  '''Set time to ''<hours:minutes>'' with a rate of ''<speed x>''''' - set start time and rate at which time advances
+
    '''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
  '''Enable gameplay Session Mode                            [x]''' - check to set. Gameplay mode restricts the players options
+
    '''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)
  '''Enable in game help by default                          [x]''' - check to allow help options to be displayed
+
    '''Enter driver commands to schedule when train is at trackside'''
  '''Set the default Control method to:''' - select one of two option buttons:-
+
      '''''>>''''' - click to enter driver commands from those specified in the '''Driver Command Rule'''
      '''( ) Easy Mode'''
+
    <span style="background-color: black; color: white; font-weight: 700;"> Select one of two option buttons:- </span>
      '''( ) Realistic Mode'''
+
      '''( ) new schedule will replace current driver command''' - select to delete any current command list and replace it with the command list above
      '''[x] Prevent player from changing this setting''' - check to set
+
      '''( ) new schedule will be appended to current driver commands''' - select to add the command list above above to the current driver command list
  '''Realistic mode requires achievement: ''<text>'' in asset ''<asset name>''''' - enter achievement name and select an asset from Aurans Achievements
+
    '''''<add a new trackside entry>''''' - click to add a new '''ScheduleAtTrackside''' entry below
  '''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]] '''<u>Trainz Wiki Links:</u>'''
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/QuickDrive_Rule</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>
 
<br>
Line 1,581: Line 1,557:
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''ScheduleAtTrackside Rule'''==
+
=='''Schedule Library Rule'''==
 
</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.
+
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]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
*'''<kuid2:61392:2001:6>'''
+
*'''<kuid2:192081:12:5>'''
  
*'''DLS Rule''' by '''pguy'''
+
*'''Built-in Rule''' by '''brummfondel'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[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
+
  '''''<add schedule>''''' | '''''<add group>'''''
    '''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
+
      <span style="background-color: black; color: white; font-weight: 700;"> To add <u>individual schedules</u> click <add schedule> then:- </span>
    '''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)
+
        '''''<library Entry Name>''''' - enter a unique name for the schedule
    '''Enter driver commands to schedule when train is at trackside'''
+
          '''''<library Entry Name>''''' - click to edit name
      '''''>>''''' - click to enter driver commands from those specified in the '''Driver Command Rule'''
+
          '''''<remove>''''' - click to delete this schedule from the list
    Select one of two option buttons:-
+
          '''''<copy>''''' - click to add a copy this schedule to the current group
      '''( ) new schedule will replace current driver command''' - select to delete any current command list and replace it with the command list above
+
          '''''<move to group>''''' - click to move this schedule to a schedule group
      '''( ) new schedule will be appended to current driver commands''' - select to add the command list above above to the current driver command list
+
          In the driver command bar:-
    '''''<add a new trackside entry>''''' - click to add a new '''ScheduleAtTrackside''' entry below
+
              '''''>>''''' - click to enter driver commands from those specified in the '''Driver Command Rule'''
 +
      <span style="background-color: black; color: white; font-weight: 700;"> To add <u>groups of schedules</u> click <add group> then:- </span>
 +
        '''''<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>
 +
#Create the library schedules in this rule first.
 +
#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]] '''<u>Related Rules:</u>'''
+
[[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 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 Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
Line 1,612: Line 1,598:
 
*'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
 
*'''[[#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
 
*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
+
*'''[[#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]]'''
 +
 
 +
[[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|SPAD Event Counter]]'''
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#ffffcc>
 
<tr>
 
<tr>
 
<td>
 
<td>
 +
 
=='''Schedule Rule'''==
 
=='''Schedule Rule'''==
 
</td>
 
</td>
Line 1,625: Line 1,620:
 
Allows a schedule of timed events to be applied to a train
 
Allows a schedule of timed events to be applied to a train
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-3:10185>'''
 
*'''<kuid:-3:10185>'''
Line 1,631: Line 1,626:
 
*'''Base Rule'''
 
*'''Base Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[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
 
     '''Insert track mark ''<select>''''' - select a track mark from the Session List
Line 1,639: Line 1,634:
 
     '''Insert destination ''<select>''''' - select from session list
 
     '''Insert destination ''<select>''''' - select from session list
  
[[file:BugMini.PNG]] '''<font color="red">Known Bugs:</font>'''
+
[[file:BugMini.PNG|link=]] <span style="background-color: red; color: white; font-weight: 700;"> Known Bugs: </span>
 
:There are reports that this rule does not work correctly particularly if a train arrives late or early.
 
:There are reports that this rule does not work correctly particularly if a train arrives late or early.
  
[[file:Notes.PNG]] '''<u>Notes:</u>'''
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
:Times are Trainz clock times, not real time
 
:Times are Trainz clock times, not real time
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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 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 Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
Line 1,652: Line 1,647:
 
*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
 
*'''[[#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
 
*'''[[#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]] '''<u>Other Links:</u>'''
+
[[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>'''
 
*'''<span class="plainlinks">http://www.auran.com/games/gamefiles/trainz/tutorial1.html</span>'''
  
Line 1,667: Line 1,663:
 
Executes child rules when a driver gets on or off a train
 
Executes child rules when a driver gets on or off a train
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-25:953>'''
 
*'''<kuid:-25:953>'''
Line 1,675: Line 1,671:
 
*'''Parent Rule'''
 
*'''Parent Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
   '''[x] Trigger Rule Once''' - click to set''  
 
   '''[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'''
 
   '''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:-
+
   <span style="background-color: black; color: white; font-weight: 700;"> Select one of two option buttons:- </span>
 
     '''( ) click to accept all trains'''
 
     '''( ) click to accept all trains'''
 
     '''( ) click to accept trains matching specific criteria'''
 
     '''( ) click to accept trains matching specific criteria'''
         Selecting the second option will produce the following selection controls:-
+
         <span style="background-color: black; color: white; font-weight: 700;"> Selecting the second option will produce the following selection controls:- </span>
 
         '''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
 
         '''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
 
           '''''+''''' - click to add a ''specific'' vehicle from the session list
Line 1,693: Line 1,689:
 
           '''''x''''' - click to remove a ''driver'' from the rule
 
           '''''x''''' - click to remove a ''driver'' from the rule
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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
+
*'''[[#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]] '''<u>Trainz Wiki Links:</u>'''
+
[[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 Parent and Child Rules]]'''
  
Line 1,710: Line 1,706:
 
Executes child rules when a specific driver or vehicle is locally owned. If the driver/vehicle becomes unowned again the child rules are paused
 
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]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid2:401543:1173:1>'''
 
*'''<kuid2:401543:1173:1>'''
Line 1,718: Line 1,714:
 
*'''Parent Rule'''
 
*'''Parent Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
   '''Assets Ownership:''' - select one of two option buttons:-
+
   '''Assets Ownership:''' - <span style="background-color: black; color: white; font-weight: 700;"> select one of two option buttons:- </span>
 
     '''( ) Wait for ownership of a specific Driver'''
 
     '''( ) Wait for ownership of a specific Driver'''
 
     '''( ) Wait for ownership of Driver'''
 
     '''( ) Wait for ownership of Driver'''
 
   '''Driver or Vehicle ''<select>''''' - choose from session list
 
   '''Driver or Vehicle ''<select>''''' - choose from session list
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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
+
*'''[[#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]] '''<u>Trainz Wiki Links:</u>'''
+
[[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 Parent and Child Rules]]'''
 +
 
<br>
 
<br>
<table width="100%" bgcolor=#ffff88>
 
<tr>
 
<td>
 
'''[[#top|Back to Top]]'''
 
</td>
 
</tr>
 
</table>
 
 
 
<table width="100%" bgcolor=#ffff88>
 
<table width="100%" bgcolor=#ffff88>
 
<tr>
 
<tr>
Line 1,747: Line 1,736:
 
</tr>
 
</tr>
 
</table>
 
</table>
 +
[[file:BackToTop.png|link=#top|alt=Top|Top]] [[file:NextDown.png|link=#Industry Rules|alt=Next Down|Industry Rules]] [[file:NextUp.png|link=#Driver Rules|alt=Next Up|Driver Rules]] [[file:BackToBottom.png|link=#Trainz Wiki|alt=Bottom|Bottom]]
  
<br>
 
 
<table width=100% width=100% bgcolor=#ffffcc>
 
<table width=100% width=100% bgcolor=#ffffcc>
 
<tr>
 
<tr>
Line 1,759: Line 1,748:
 
Was used to provide the HUD controls for the cabin view. Now obsolete.
 
Was used to provide the HUD controls for the cabin view. Now obsolete.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-16:287428>'''
 
*'''<kuid:-16:287428>'''
Line 1,765: Line 1,754:
 
*'''Base Rule'''
 
*'''Base Rule'''
  
*'''Obsolete Rule''' (function is now built into TANE)
+
*'''Obsolete Rule''' (function is now built into '''Trainz''')
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
     '''None'''
 
     '''None'''
Line 1,782: Line 1,771:
 
HUD displays warning about coupler stress and breakage
 
HUD displays warning about coupler stress and breakage
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-25:423>'''
 
*'''<kuid:-25:423>'''
Line 1,788: Line 1,777:
 
*'''Built-in Rule'''
 
*'''Built-in Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
     Select one of two option buttons:-
+
     <span style="background-color: black; color: white; font-weight: 700;"> Select one of two option buttons:- </span>
 
       '''( ) Show the Coupler Breakage Display'''
 
       '''( ) Show the Coupler Breakage Display'''
 
       '''( ) Hide the Coupler Breakage Display'''
 
       '''( ) Hide the Coupler Breakage Display'''
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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
 
*'''[[#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
 
*'''[[#Set Coupler Masks Rule|Set Coupler Masks Rule]]''' - sets the coupling/decoupling masks on selected vehicles
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#ffffcc>
 
<tr>
 
<tr>
 
<td>
 
<td>
Line 1,809: Line 1,798:
 
Show or hide the Custom Heads Up Display.
 
Show or hide the Custom Heads Up Display.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-3:10206>'''
 
*'''<kuid:-3:10206>'''
Line 1,815: Line 1,804:
 
*'''Base Rule'''
 
*'''Base Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
     '''Show or Hide the Custom Heads up Display''' - select one of two option buttons:-
+
     '''Show or Hide the Custom Heads up Display''' - <span style="background-color: black; color: white; font-weight: 700;"> select one of two option buttons:- </span>
 
       '''( ) Show the Custom Heads up Display'''
 
       '''( ) Show the Custom Heads up Display'''
 
       '''( ) Hide the Custom Heads up Display'''
 
       '''( ) Hide the Custom Heads up Display'''
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
 
*'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
 
*'''[[#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.
 
*'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
Line 1,829: Line 1,818:
 
*'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked
 
*'''[[#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]] '''<u>Trainz Wiki Links:</u>'''
+
[[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>'''
 
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Display_Custom_HUD_Rule</span>'''
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#ffffcc>
 
<tr>
 
<tr>
 
<td>
 
<td>
Line 1,843: Line 1,832:
 
Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.
 
Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-25:968>'''
 
*'''<kuid:-25:968>'''
Line 1,849: Line 1,838:
 
*'''Built-in Rule'''
 
*'''Built-in Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
     Select one of two option buttons:-
+
     <span style="background-color: black; color: white; font-weight: 700;"> Select one of two option buttons:- </span>
 
     '''( ) Flash the ''<click to select>'' icon on the ''<click to select>'' HUD panel for a period of ''<value>'' seconds'''
 
     '''( ) 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).
+
       <span style="background-color: red; color: white; font-weight: 700;"> TIP: </span> Select the HUD panel first (the second ''<click to select>'' link).
       Available HUD panels are (select one):-
+
       <span style="background-color: black; color: white; font-weight: 700;"> Available HUD panels are (select one):- </span>
 
           '''Bottom Right Menu'''
 
           '''Bottom Right Menu'''
 
           '''Camera Controls'''
 
           '''Camera Controls'''
 
           '''DCC Controls'''
 
           '''DCC Controls'''
 
           '''Driver Main Menu'''
 
           '''Driver Main Menu'''
       Available icons will depend on the HUD panel selected.
+
       <span style="background-color: black; color: white; font-weight: 700;"> Available icons will depend on the HUD panel selected. </span>
 
     '''( ) ''<Start/Stop>'' flashing the ''<click to select>'' icon on the ''<click to select>'' HUD panel'''
 
     '''( ) ''<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).
+
       <span style="background-color: red; color: white; font-weight: 700;"> TIP: </span> Select the HUD panel first (the second ''<click to select>'' link).
       Available HUD panels are (select one):-
+
       <span style="background-color: black; color: white; font-weight: 700;"> Available HUD panels are (select one):- </span>
 
           '''Bottom Right Menu'''
 
           '''Bottom Right Menu'''
 
           '''Camera Controls'''
 
           '''Camera Controls'''
 
           '''DCC Controls'''
 
           '''DCC Controls'''
 
           '''Driver Main Menu'''
 
           '''Driver Main Menu'''
       Available icons will depend on the HUD panel selected.
+
       <span style="background-color: black; color: white; font-weight: 700;"> Available icons will depend on the HUD panel selected. </span>
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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.
 
*'''[[#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.
 
*'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
Line 1,886: Line 1,875:
 
</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)'''
+
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]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid2:61392:1072:10>'''
 
*'''<kuid2:61392:1072:10>'''
  
*'''Legacy Rule''' (replaced by '''Quick CustomHUD Manager Rule (SP2 and later)''')
+
*'''Legacy Rule''' (replaced by '''Quick CustomHud Manager Rule (SP2 and later)''')
  
 
*'''DLS Rule''' by '''pguy'''
 
*'''DLS Rule''' by '''pguy'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
     '''Show or Hide the Custom Heads up Display''' - select one of two option buttons:-
+
     '''Show or Hide the Custom Heads up Display''' - <span style="background-color: black; color: white; font-weight: 700;"> select one of two option buttons:- </span>
 
     '''( ) Show the Custom Heads up Display'''
 
     '''( ) Show the Custom Heads up Display'''
 
     '''( ) Hide the Custom Heads up Display'''
 
     '''( ) Hide the Custom Heads up Display'''
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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.
 
*'''[[#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.
 
*'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
Line 1,921: Line 1,910:
 
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)'''
 
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)'''
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid2:61392:5020:47>'''
 
*'''<kuid2:61392:5020:47>'''
Line 1,927: Line 1,916:
 
*'''DLS Rule''' by '''pguy'''
 
*'''DLS Rule''' by '''pguy'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule 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'''.  
 
     '''''<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'''.  
       This is NOT the standard OS clipboard.
+
       <span style="background-color: red; color: white; font-weight: 700;"> This is NOT the standard OS clipboard. </span>
 
     '''''<Paste rule data from Clipboard>''''' - if data is held in the special clipboard area, then click to paste that data into the selected HUD.
 
     '''''<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.
+
       <span style="background-color: red; color: white; font-weight: 700;"> This is NOT the standard OS clipboard. </span>
 
     '''Current HUD Parameters'''
 
     '''Current HUD Parameters'''
 
       '''HUD to select: ''<HUD name>''''' - click to select a HUD from those available. One or two default HUDs will be supplied.
 
       '''HUD to select: ''<HUD name>''''' - click to select a HUD from those available. One or two default HUDs will be supplied.
Line 1,938: Line 1,927:
 
       '''''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
 
       '''''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
 
       '''''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:
+
     <span style="background-color: black; color: white; font-weight: 700;"> For new, cloned or copied HUDs, additional commands will be shown:- </span>
 
       '''''rename HUD''''' - rename the selected HUD. You will be required to enter a new name for the HUD
 
       '''''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
 
       '''''delete HUD''''' - delete the currently displayed HUD
     In '''Driver Mode''' an additional command will be shown:
+
     <span style="background-color: black; color: white; font-weight: 700;"> In Driver Mode an additional command will be shown:- </span>
 
       '''''Assign hud to current train''''' - click to assign the currently selected HUD to the currently selected driver
 
       '''''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'''
 
     '''[x] hud is displayed (on)''' - check to display HUD in '''Driver Mode'''
Line 1,947: Line 1,936:
 
     '''hud view limit: ''<value>''''' - enter the maximum look-ahead distance in metres for the HUD. Minimum value is 1000, maximum value is 10000.
 
     '''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'''
 
     '''[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:
+
     <span style="background-color: black; color: white; font-weight: 700;"> For each individual HUD property:- </span>
 
       '''[x] ''HUD property''''' - check to add this property to the HUD
 
       '''[x] ''HUD property''''' - check to add this property to the HUD
  
[[file:Notes.PNG]] '''<u>Notes:</u>'''
+
[[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.
 
: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.
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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#Set Custom HUD (SP2 and later)|Set Custom HUD (SP2 and later)]]'''
 +
 
 +
[[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.
 
*'''[[#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.
 
*'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
Line 1,960: Line 1,953:
 
*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
 
*'''[[#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
 
*'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked
 
[[file:PageLink2.PNG]] '''<u>Dependent Driver Commands</u>'''
 
*'''[[Driver Commands List#Set Custom HUD (SP2 and later)|Set Custom HUD (SP2 and later)]]'''
 
  
 
<br>
 
<br>
Line 1,968: Line 1,958:
 
<tr>
 
<tr>
 
<td>
 
<td>
 
 
=='''Show/Hide HUD Panel Rule'''==
 
=='''Show/Hide HUD Panel Rule'''==
 
</td>
 
</td>
Line 1,976: Line 1,965:
 
Shows or hides a HUD panel.
 
Shows or hides a HUD panel.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-25:1047>'''
 
*'''<kuid:-25:1047>'''
Line 1,982: Line 1,971:
 
*'''Built-in Rule'''
 
*'''Built-in Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[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
 
     '''''<Show/Hide>'' the ''<click to select>'' HUD panel''' - select '''''Show''''' or '''''Hide''''' and then select the HUD panel
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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.
 
*'''[[#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.
 
*'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
Line 2,005: Line 1,994:
 
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.
 
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]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-25:971>'''
 
*'''<kuid:-25:971>'''
Line 2,011: Line 2,000:
 
*'''Built-in Rule'''
 
*'''Built-in Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
   '''[x] Add'''
 
   '''[x] Add'''
Line 2,019: Line 2,008:
 
       '''''<variable-name>''''' - enter variable-name to remove from HUD. Variable-name is case sensitive.
 
       '''''<variable-name>''''' - enter variable-name to remove from HUD. Variable-name is case sensitive.
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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.
 
*'''[[#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.
 
*'''[[#Quick Session Variables Rule|Quick Session Variables Rule]]''' - allows the editing of session variables.
Line 2,027: Line 2,016:
 
*'''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.
 
*'''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.
  
[[file:Ex.PNG]] '''<u>Examples of Use:</u>'''
+
[[file:Ex.PNG|link=]] '''<u>Examples of Use:</u>'''
 
*'''[[How to Use Variables in Sessions (Examples)]]
 
*'''[[How to Use Variables in Sessions (Examples)]]
  
Line 2,041: Line 2,030:
 
Executes child rules when the user clicks on a selected HUD icon
 
Executes child rules when the user clicks on a selected HUD icon
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-25:951> <kuid:-25:970>''' - two versions built-in with different kuids, both have the same properties
 
*'''<kuid:-25:951> <kuid:-25:970>''' - two versions built-in with different kuids, both have the same properties
Line 2,049: Line 2,038:
 
*'''Parent Rule'''
 
*'''Parent Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
     '''[x] Trigger Once'''
 
     '''[x] Trigger Once'''
     '''HUD Panel ''<Click>''''' - click choose from list:-
+
     '''HUD Panel ''<Click>''''' - <span style="background-color: black; color: white; font-weight: 700;"> click to choose from list:- </span>
 
       '''Bottom Right Menu'''
 
       '''Bottom Right Menu'''
 
       '''Camera Controls'''
 
       '''Camera Controls'''
 
       '''DCC Controls'''
 
       '''DCC Controls'''
     '''Icon ''<Click>''''' - click to choose from list. Selections depends on HUD Panel chosen
+
     '''Icon ''<Click>''''' - <span style="background-color: black; color: white; font-weight: 700;"> click to choose from list. Selections depends on HUD Panel chosen. </span>
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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.
 
*'''[[#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.
 
*'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
Line 2,066: Line 2,055:
 
*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
 
*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
  
[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+
[[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 Parent and Child Rules]]'''
 
<br>
 
<br>
<table width="100%" bgcolor=#ffff88>
 
<tr>
 
<td>
 
'''[[#top|Back to Top]]'''
 
</td>
 
</tr>
 
</table>
 
 
 
<table width="100%" bgcolor=#ffff88>
 
<table width="100%" bgcolor=#ffff88>
 
<tr>
 
<tr>
Line 2,084: Line 2,065:
 
</tr>
 
</tr>
 
</table>
 
</table>
 +
[[file:BackToTop.png|link=#top|alt=Top|Top]] [[file:NextDown.png|link=#Interlocking Tower, Junction and Signal Rules|alt=Next Down|Interlocking Tower, Junction and Signal Rules]] [[file:NextUp.png|link=#HUD (Heads Up Display) Rules|alt=Next Up|HUD (Heads Up Display) Rules]] [[file:BackToBottom.png|link=#Trainz Wiki|alt=Bottom|Bottom]]
  
<br>
 
 
<table width=100% width=100% bgcolor=#ffffcc>
 
<table width=100% width=100% bgcolor=#ffffcc>
 
<tr>
 
<tr>
Line 2,096: Line 2,077:
 
Locks train controls when loading/unloading at an industry, overrides time settings for begin load and begin unload operations
 
Locks train controls when loading/unloading at an industry, overrides time settings for begin load and begin unload operations
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:30501:100007>'''
 
*'''<kuid:30501:100007>'''
Line 2,102: Line 2,083:
 
*'''Base Rule'''
 
*'''Base Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
     '''Target object ''<select>''''' - select industry object from session list
 
     '''Target object ''<select>''''' - select industry object from session list
Line 2,108: Line 2,089:
 
     '''[x] Override 'begin load' and 'begin unload' durations to ''<value>'' seconds''' - if checked enter number of seconds to override
 
     '''[x] Override 'begin load' and 'begin unload' durations to ''<value>'' seconds''' - if checked enter number of seconds to override
  
[[file:Notes.PNG]] '''<u>Notes:</u>'''
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
:Times are Trainz clock time, not real time
 
:Times are Trainz clock time, not real time
  
Line 2,122: Line 2,103:
 
Enables/Disables vehicle load/unload for industry
 
Enables/Disables vehicle load/unload for industry
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid2:401543:1171:1>'''
 
*'''<kuid2:401543:1171:1>'''
Line 2,128: Line 2,109:
 
*'''Built-in Rule'''
 
*'''Built-in Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
   '''Load/unload ''<Disable/Enable>''''' - click to set to '''Disable''' or '''Enable'''
 
   '''Load/unload ''<Disable/Enable>''''' - click to set to '''Disable''' or '''Enable'''
 
   '''Which Industry? ''<select>''''' - click to set Industry from Session List
 
   '''Which Industry? ''<select>''''' - click to set Industry from Session List
   '''Which Vehicles:''' - select one of two option buttons:-
+
   '''Which Vehicles:''' - <span style="background-color: black; color: white; font-weight: 700;"> select one of two option buttons:- </span>
 
       '''( ) Apply to every vehicle in the session'''
 
       '''( ) Apply to every vehicle in the session'''
 
       '''( ) Apply only to a specific vehicles from Session List'''
 
       '''( ) Apply only to a specific vehicles from Session List'''
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#ffffcc>
<tr>
+
<td>
+
=='''DisplayIndustryStatus Rule (color modified)'''==
+
</td>
+
</tr>
+
</table>
+
 
+
Displays a summary of industry product levels when the "k" key is pressed.
+
 
+
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
 
+
*'''<kuid:622415:100001>'''
+
 
+
*'''DLS Rule''' by '''lockheed02''' and '''marzipan'''
+
 
+
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
 
+
    '''None'''
+
 
+
[[file:Notes.PNG]] '''<u>Notes:</u>'''
+
:Pressing the '''k''' key in Driver mode will bring up a small window with a single link '''''Display Industry Status''''' (there may also be other links). Clicking this link will show the product levels of all industries.
+
 
+
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
*'''[[#ExTrainz Manager Rule - TANE SP2|ExTrainz Manager Rule - TANE SP2]]''' - displays information on consists, industries and products in Driver and Surveyor.
+
 
+
<br>
+
<table width=100% width=100% bgcolor=#ffffcc>
+
 
<tr>
 
<tr>
 
<td>
 
<td>
Line 2,174: Line 2,128:
 
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.
 
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]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:160293:10029>'''
 
*'''<kuid:160293:10029>'''
Line 2,180: Line 2,134:
 
*'''DLS Rule''' by '''trev999'''
 
*'''DLS Rule''' by '''trev999'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule 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.
 
     '''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.
 
     '''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.
+
     '''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 mode.
 
     '''Search only rolling stock already in session ''<Yes/No>''''' - click to select ''Yes'' or ''No''. When set to ''Yes'' only those rolling stock assets
 
     '''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.
 
       installed in the session can be searched.
Line 2,193: Line 2,147:
 
       which will exclude that specific industry from the management list, or partial (e.g. "Coal") which will exclude all  
 
       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.
 
       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:-
+
       <span style="background-color: black; color: white; font-weight: 700;"> Once industries have been excluded, additional commands will appear for each excluded industry:- </span>
 
       '''''<delete> <industry name begins with/class name begins with> <name>''''' - click ''delete'' to remove this entry.  
 
       '''''<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 ''industry name begins with/class name begins with'' to select between the two (see ''notes'' below).
 
           - click ''name'' to edit the name.
 
           - click ''name'' to edit the name.
  
[[file:Notes.PNG]] '''<u>Notes:</u>'''
+
[[file:Issues.PNG|link=]] <span style="background-color: yellow; color: black; font-weight: 700;"> Known Issues: </span>
#Rolling stock installed in '''TANE''' or 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.
+
 
+
[[file:Issues.PNG]] '''<u>Known Issues:</u>'''
+
 
:This rule is NOT compatible with all industries.
 
:This rule is NOT compatible with all industries.
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
*'''[[#DisplayIndustryStatus Rule (color modified)|DisplayIndustryStatus Rule (color modified)]]''' - displays information on industry product levels.
+
#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>
Line 2,220: Line 2,171:
 
Executes child rules if industries or vehicles reach set commodity levels. This rule replaces the older '''Resource Check Rule'''  
 
Executes child rules if industries or vehicles reach set commodity levels. This rule replaces the older '''Resource Check Rule'''  
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-25:656>'''
 
*'''<kuid:-25:656>'''
Line 2,228: Line 2,179:
 
*'''Parent Rule'''
 
*'''Parent Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[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:-
+
     '''<Product Level>''' - <span style="background-color: black; color: white; font-weight: 700;"> click to select a product test from two choices:- </span>
 
       '''''Reach/Exceed''''' - sets an upper limit for the resources being monitored.  
 
       '''''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.
 
           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.
Line 2,242: Line 2,193:
 
     '''''<Add object>''''' - click to select a source or target object. Multiple objects and their queues can be added to the rule.  
 
     '''''<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.  
 
       ALL the entered products must reach/exceed or fall below the specified value for the rule to be triggered.  
       For each object:-
+
       <span style="background-color: black; color: white; font-weight: 700;"> For each object:- </span>
 
           '''''<Object>''''' - click to select session active industry or product enabled rail vehicle  
 
           '''''<Object>''''' - click to select session active industry or product enabled rail vehicle  
 
           '''''<Queue>''''' - select product queue (there may be only one available)
 
           '''''<Queue>''''' - select product queue (there may be only one available)
 
           '''''<Remove>''''' - removes the object and its product queue from the rule
 
           '''''<Remove>''''' - removes the object and its product queue from the rule
  
[[file:Notes.PNG]] '''<u>Notes:</u>'''
+
[[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''.
 
: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]] '''<u>Related Rules:</u>'''
+
[[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 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
 
*'''[[#Resource Verify Rule (fixed)|Resource Verify Rule (fixed)]]''' - executes child rules when a set resource (commodity) level is reached
  
[[file:Ex.PNG]] '''<u>Examples of Use</u>'''
+
[[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]]'''
 
*'''[[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]] '''<u>Trainz Wiki Links:</u>'''
+
[[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 Parent and Child Rules]]'''
  
Line 2,271: Line 2,222:
 
Sets up a Power Station and its electricity consumers
 
Sets up a Power Station and its electricity consumers
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-25:746>'''
 
*'''<kuid:-25:746>'''
Line 2,277: Line 2,228:
 
*'''Base Rule'''
 
*'''Base Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[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.
 
     '''Power station ''<select>''''' - select a Power Station from the session list.
Line 2,294: Line 2,245:
 
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'''
 
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]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-25:1067>'''
 
*'''<kuid:-25:1067>'''
Line 2,304: Line 2,255:
 
*'''Parent Rule'''
 
*'''Parent Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
     Select one of two option buttons:-
+
     <span style="background-color: black; color: white; font-weight: 700;"> Select one of two option buttons:- </span>
 
       '''( ) Watch industry queue'''
 
       '''( ) Watch industry queue'''
 
           '''Target Object ''<select>''''' - select an industry from the session list
 
           '''Target Object ''<select>''''' - select an industry from the session list
Line 2,312: Line 2,263:
 
           '''Product ''<select>''''' - select a product from the selected queue
 
           '''Product ''<select>''''' - select a product from the selected queue
 
           '''Amount ''<value>''''' - enter a quantity
 
           '''Amount ''<value>''''' - enter a quantity
           Select one of two option buttons:-
+
           <span style="background-color: black; color: white; font-weight: 700;"> Select one of two option buttons:- </span>
 
             '''( ) Complete when designated queue equals or exceeds required amount'''
 
             '''( ) Complete when designated queue equals or exceeds required amount'''
 
             '''( ) Complete when designated queue falls below required amount'''
 
             '''( ) Complete when designated queue falls below required amount'''
Line 2,320: Line 2,271:
 
           '''Product ''<select>''''' - select a product from the selected queue
 
           '''Product ''<select>''''' - select a product from the selected queue
 
           '''Amount ''<value>''''' - enter a quantity
 
           '''Amount ''<value>''''' - enter a quantity
           Select one of two option buttons:-
+
           <span style="background-color: black; color: white; font-weight: 700;"> Select one of two option buttons:- </span>
 
             '''( ) Complete when designated queue equals or exceeds required amount'''
 
             '''( ) Complete when designated queue equals or exceeds required amount'''
 
             '''( ) Complete when designated queue falls below required amount'''
 
             '''( ) Complete when designated queue falls below required amount'''
  
[[file:Notes.PNG]] '''<u>Notes:</u>'''
+
[[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''.
 
: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]] '''<u>Related Rules:</u>'''
+
[[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
 
*'''[[#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
 
*'''[[#Resource Verify Rule (fixed)|Resource Verify Rule (fixed)]]''' - executes child rules when a set resource (commodity) level is reached
  
[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+
[[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 Parent and Child Rules]]'''
 
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Resource_Check_Rule</span>'''
 
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Resource_Check_Rule</span>'''
Line 2,346: Line 2,297:
 
Executes child rules if a selected industry or vehicle reaches a set commodity level. The rule resets when all child rules have completed.
 
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]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:160293:10060>'''
 
*'''<kuid:160293:10060>'''
Line 2,354: Line 2,305:
 
*'''Parent Rule'''
 
*'''Parent Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
     Select one of two option buttons:-
+
     <span style="background-color: black; color: white; font-weight: 700;"> Select one of two option buttons:- </span>
 
     '''( ) Watch industry queue'''
 
     '''( ) Watch industry queue'''
 
       '''Target object ''<click to select>''''' - click to select an industry from the session list.
 
       '''Target object ''<click to select>''''' - click to select an industry from the session list.
 
       '''Product ''<click to select>''''' - click to select an industry product.
 
       '''Product ''<click to select>''''' - click to select an industry product.
 
       '''Amount ''<value>''''' - enter a quantity for the selected product.
 
       '''Amount ''<value>''''' - enter a quantity for the selected product.
       Select one of two option buttons:-
+
       <span style="background-color: black; color: white; font-weight: 700;"> Select one of two option buttons:- </span>
 
       '''( ) Complete when designated queue equals or exceeds designated amount'''
 
       '''( ) Complete when designated queue equals or exceeds designated amount'''
 
       '''( ) Complete when designated queue falls below designated amount'''
 
       '''( ) Complete when designated queue falls below designated amount'''
Line 2,368: Line 2,319:
 
       '''Product ''<click to select>''''' - click to select a commodity product.
 
       '''Product ''<click to select>''''' - click to select a commodity product.
 
       '''Amount ''<value>''''' - enter a quantity for the selected product.
 
       '''Amount ''<value>''''' - enter a quantity for the selected product.
       Select one of two option buttons:-
+
       <span style="background-color: black; color: white; font-weight: 700;"> Select one of two option buttons:- </span>
 
       '''( ) Complete when designated queue equals or exceeds designated amount'''
 
       '''( ) Complete when designated queue equals or exceeds designated amount'''
 
       '''( ) Complete when designated queue falls below designated amount'''
 
       '''( ) Complete when designated queue falls below designated amount'''
  
[[file:Notes.PNG]] '''<u>Notes:</u>'''
+
[[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.
 
#This rule will only monitor a single commodity in a single industry or vehicle.
 
#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''.
 
#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]] '''<u>Related Rules:</u>'''
+
[[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
 
*'''[[#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
 
*'''[[#Resource Check Rule|Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
  
[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+
[[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 Parent and Child Rules]]'''
  
Line 2,394: Line 2,345:
 
Executes child rules if specific trains call at set stations or industries
 
Executes child rules if specific trains call at set stations or industries
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid2:60850:89005:3>'''
 
*'''<kuid2:60850:89005:3>'''
Line 2,402: Line 2,353:
 
*'''Parent Rule'''
 
*'''Parent Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
     '''Trigger: ''<select>''''' - click to select one of the following
+
     '''Trigger: ''<select>''''' - <span style="background-color: black; color: white; font-weight: 700;"> click to select one of the following:- </span>
 
       '''''Never''''' - stopping at the selected industries will never trigger the rule.
 
       '''''Never''''' - stopping at the selected industries will never trigger the rule.
 
       '''''Once only''''' - the rule is triggered on the first visit only to any one of the selected industries
 
       '''''Once only''''' - the rule is triggered on the first visit only to any one of the selected industries
Line 2,411: Line 2,362:
 
       '''''Once per vehicle''''' - each vehicle can only trigger the rule once.  
 
       '''''Once per vehicle''''' - each vehicle can only trigger the rule once.  
 
     '''''<select industry>''''' - select industry or industries from session list
 
     '''''<select industry>''''' - select industry or industries from session list
     Select one of two option buttons:-
+
     <span style="background-color: black; color: white; font-weight: 700;"> Select one of two option buttons:- </span>
 
       '''( ) click to accept all trains'''
 
       '''( ) click to accept all trains'''
 
       '''( ) click to accept trains matching specific criteria'''
 
       '''( ) click to accept trains matching specific criteria'''
           Selecting the second option will produce the following selection controls:-        
+
           <span style="background-color: black; color: white; font-weight: 700;"> Selecting the second option will produce the following selection controls:- </span>       
 
           '''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
 
           '''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
 
             '''''+''''' - click to add a ''specific'' vehicle from the session list
Line 2,425: Line 2,376:
 
             '''''x''''' - click to remove a ''driver'' from the rule
 
             '''''x''''' - click to remove a ''driver'' from the rule
  
[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+
[[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 Parent and Child Rules]]'''
 
<br>
 
<br>
<table width="100%" bgcolor=#ffff88>
 
<tr>
 
<td>
 
'''[[#top|Back to Top]]'''
 
</td>
 
</tr>
 
</table>
 
 
 
<table width="100%" bgcolor=#ffff88>
 
<table width="100%" bgcolor=#ffff88>
 
<tr>
 
<tr>
Line 2,443: Line 2,386:
 
</tr>
 
</tr>
 
</table>
 
</table>
 +
[[file:BackToTop.png|link=#top|alt=Top|Top]] [[file:NextDown.png|link=#Message Rules|alt=Next Down|Message Rules]] [[file:NextUp.png|link=#Industry Rules|alt=Next Up|Industry Rules]] [[file:BackToBottom.png|link=#Trainz Wiki|alt=Bottom|Bottom]]
  
<br>
 
 
<table width=100% width=100% bgcolor=#ffffcc>
 
<table width=100% width=100% bgcolor=#ffffcc>
 
<tr>
 
<tr>
Line 2,455: Line 2,398:
 
Sets the path for selected trains
 
Sets the path for selected trains
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:131986:158781>'''
 
*'''<kuid:131986:158781>'''
Line 2,463: Line 2,406:
 
*'''Legacy Rule''' (replaced by '''Interlocking Tower Rules''')
 
*'''Legacy Rule''' (replaced by '''Interlocking Tower Rules''')
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
   '''<add junction>''''' - click to add a junction from the Session list
 
   '''<add junction>''''' - click to add a junction from the Session list
     For each junction:-
+
     <span style="background-color: black; color: white; font-weight: 700;"> For each junction:- </span>
 
       '''Set switch to ''<RIGHT/LEFT/FORWARD>''''' - click to select one junction state
 
       '''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
 
       '''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.  
 
       '''Permit type ''<EXCLUSIVE/DIRECTIONAL>''''' - click to select permission type.  
           ''DIRECTIONAL'' permits all trains heading in the same direction to use the set path.
+
           '''''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
+
           '''''EXCLUSIVE''''' only allows one train to use the path at a time
 
       '''''<up>''''' - move the junction UP one level in the list
 
       '''''<up>''''' - move the junction UP one level in the list
 
       '''''<dn>''''' - move the junction DOWN one level in the list
 
       '''''<dn>''''' - move the junction DOWN one level in the list
Line 2,481: Line 2,424:
 
   '''Rule exits on train entering trigger ''<trigger name>''''' - click to select an end 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]] '''<u>Notes:</u>'''
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
#This rule may not be compatible with Interlocking Towers.
 
#This rule may not be compatible with Interlocking Towers.
 
#Triggers have to be placed before the first junction and controlling signal and after the final junction.
 
#Triggers have to be placed before the first junction and controlling signal and after the final junction.
 
#Multiple paths can be set up by placing multiple copies of this rule under an '''Ordered List''' or '''Simultaneous List'''
 
#Multiple paths can be set up by placing multiple copies of this rule under an '''Ordered List''' or '''Simultaneous List'''
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
 
*'''[[#Junction Derailment Prevention Rule|Junction Derailment Prevention Rule]]''' - sets opposing junctions ahead of a train to prevent derailments
 
*'''[[#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
 
*'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
Line 2,493: Line 2,436:
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#ffffcc>
 
<tr>
 
<tr>
 
<td>
 
<td>
Line 2,503: Line 2,446:
 
Alters settings on an interlocking tower path
 
Alters settings on an interlocking tower path
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:401543:3205>'''
 
*'''<kuid:401543:3205>'''
Line 2,509: Line 2,452:
 
*'''Base Rule'''  
 
*'''Base Rule'''  
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
   '''Interlocking Tower ''<select>''''' - to set Name and Objects
 
   '''Interlocking Tower ''<select>''''' - to set Name and Objects
  
[[file:BugMini.PNG]] '''<font color="red"><u>Known Bugs:</u></font>'''
+
[[file:BugMini.PNG|link=]] <span style="background-color: red; color: white; font-weight: 700;"> Known Bugs: </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 to this is to always use Session Surveyor when using ITs and EITs.
+
: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]] '''<u>Related Rules:</u>'''
+
[[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 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 Set Path Rule|Interlocking Tower Set Path Rule]]''' - sets the state of an interlocking tower path for a train
Line 2,532: Line 2,475:
 
Will automatically react to messages from Interlocking Towers and display a path selection dialog to the player. Disable by removing rule from session
 
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]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:401543:3203>'''
 
*'''<kuid:401543:3203>'''
Line 2,538: Line 2,481:
 
*'''Base Rule'''
 
*'''Base Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
   '''[Checkbox] Show path activation message in Driver'''
 
   '''[Checkbox] Show path activation message in Driver'''
  
[[file:BugMini.PNG]] '''<font color="red"><u>Known Bugs:</u></font>'''
+
[[file:BugMini.PNG|link=]] <span style="background-color: red; color: white; font-weight: 700;"> Known Bugs: </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 to this is to always use Session Surveyor when using ITs and EITs.
+
: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]] '''<u>Related Rules:</u>'''
+
[[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 Configure Path Rule|Interlocking Tower Configure Path Rule]]''' - alters the settings on an interlocking tower path
 
*'''[[#Interlocking Tower Set Path Rule|Interlocking Tower Set Path Rule]]''' - sets the state of an interlocking tower path for a train
 
*'''[[#Interlocking Tower Set Path Rule|Interlocking Tower Set Path Rule]]''' - sets the state of an interlocking tower path for a train
Line 2,561: Line 2,504:
 
Will set the state of an interlocking tower path for a train
 
Will set the state of an interlocking tower path for a train
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:401543:3204>'''
 
*'''<kuid:401543:3204>'''
Line 2,567: Line 2,510:
 
*'''Base Rule'''
 
*'''Base Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
   '''Interlocking Tower ''<select>''''' - to set Name and Objects
 
   '''Interlocking Tower ''<select>''''' - to set Name and Objects
  
[[file:BugMini.PNG]] '''<font color="red"><u>Known Bugs:</u></font>'''
+
[[file:BugMini.PNG|link=]] <span style="background-color: red; color: white; font-weight: 700;"> Known Bugs: </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 to this is to always use Session Surveyor when using ITs and EITs.
+
: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]] '''<u>Related Rules:</u>'''
+
[[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 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 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.
Line 2,590: Line 2,533:
 
Provides more management and control options for interlocking towers.
 
Provides more management and control options for interlocking towers.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid2:61392:8130:41>'''
 
*'''<kuid2:61392:8130:41>'''
Line 2,596: Line 2,539:
 
*'''DLS Rule''' by '''pguy'''
 
*'''DLS Rule''' by '''pguy'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
     '''''<towers>''''' - click to select interlocking towers from the session list
 
     '''''<towers>''''' - click to select interlocking towers from the session list
 
       '''''<do full check again>''''' - click to run an error check on all interlocking towers
 
       '''''<do full check again>''''' - click to run an error check on all interlocking towers
       '''List of all available interlocking towers''' - for each tower:-
+
       '''List of all available interlocking towers''' - <span style="background-color: black; color: white; font-weight: 700;"> for each tower:- </span>
 
           '''''<view details>''''' - click to view and edit the tower properties
 
           '''''<view details>''''' - click to view and edit the tower properties
 
           '''''<copy from>''''' - click to copy properties from another tower selected from the session list
 
           '''''<copy from>''''' - click to copy properties from another tower selected from the session list
 
     '''''<debug log>''''' - click to set the debug log properties
 
     '''''<debug log>''''' - click to set the debug log properties
  
[[file:Notes.PNG]] '''<u>Notes:</u>'''
+
[[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.
 
*It is recommended that you refer to the detailed instructions in the Trainz Wiki shown below.
  
[[file:BugMini.PNG]] '''<font color="red"><u>Known Bugs:</u></font>'''
+
[[file:BugMini.PNG|link=]] <span style="background-color: red; color: white; font-weight: 700;"> Known Bugs: </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 to this is to always use Session Surveyor when using ITs and EITs.
+
: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]] '''<u>Related Rules:</u>'''
+
[[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 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 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 Set Path Rule|Interlocking Tower Set Path Rule]]''' - sets the state of an interlocking tower path for a train
  
[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+
[[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>'''
 
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Enhanced_Interlocking_Tower_Manager_Rule</span>'''
  
Line 2,630: Line 2,573:
 
Sets opposing (trailing) junctions ahead of a train to prevent derailments.  Works with both AI and manually driven trains.
 
Sets opposing (trailing) junctions ahead of a train to prevent derailments.  Works with both AI and manually driven trains.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid2:121843:100282:1>'''
 
*'''<kuid2:121843:100282:1>'''
Line 2,636: Line 2,579:
 
*'''DLS Rule''' by '''pitkin'''
 
*'''DLS Rule''' by '''pitkin'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
     '''None'''
 
     '''None'''
  
[[file:Notes.PNG]] '''<u>Notes:</u>'''
+
[[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'''.
 
: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]] '''<u>Related Rules:</u>'''
+
[[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
 
*'''[[#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 Cleared Junctions Rule|Set Cleared Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.
Line 2,659: Line 2,602:
 
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.
 
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]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:400048:100971>'''
 
*'''<kuid:400048:100971>'''
Line 2,665: Line 2,608:
 
*'''DLS Rule''' by '''callavsg'''
 
*'''DLS Rule''' by '''callavsg'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
     '''None'''
 
     '''None'''
  
[[file:Notes.PNG]] '''<u>Notes:</u>'''
+
[[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'''
 
:Individual junctions can still be set, locked and unlocked by using the '''Set Junction Rule'''
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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 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).
 
*'''[[#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=#ffffcc>
 
<tr>
 
<tr>
 
<td>
 
<td>
Line 2,687: Line 2,630:
 
Enables the addition, editing and management of Mission Codes used to auto select paths in '''Interlocking Towers'''.  
 
Enables the addition, editing and management of Mission Codes used to auto select paths in '''Interlocking Towers'''.  
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid2:61392:8200:50>'''
 
*'''<kuid2:61392:8200:50>'''
Line 2,693: Line 2,636:
 
*'''DLS Rule''' by '''pguy'''
 
*'''DLS Rule''' by '''pguy'''
  
[[file:Notes.PNG]] '''<u>Notes:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
*It is recommended that you refer to the detailed instructions in the Trainz Wiki shown below.
+
  Refer to the detailed instructions in the '''Trainz Wiki Links''' shown below.
  
[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+
[[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>'''
 
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/MissionCodes_Manager</span>'''
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#ffffcc>
 
<tr>
 
<tr>
 
<td>
 
<td>
Line 2,710: Line 2,662:
 
Enables the creation, editing and management of stop zones and timetables for trains following a path defined using mission codes.
 
Enables the creation, editing and management of stop zones and timetables for trains following a path defined using mission codes.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid2:61392:8300:50>'''
 
*'''<kuid2:61392:8300:50>'''
Line 2,716: Line 2,668:
 
*'''DLS Rule''' by '''pguy'''
 
*'''DLS Rule''' by '''pguy'''
  
[[file:Notes.PNG]] '''<u>Notes:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
*It is recommended that you refer to the detailed instructions in the Trainz Wiki shown below.
+
  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>
 +
*'''[[#MissionCode Manager Rule (SP2 and later)|MissionCode Manager Rule (SP2 and later)]]''' - creates and edits mission codes for trains
  
[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+
[[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/Mission_Code_Stops_and_TimeTables_Manager</span>'''
 
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Mission_Code_Stops_and_TimeTables_Manager</span>'''
  
Line 2,733: Line 2,688:
 
Executes child rules if specific junctions are set.
 
Executes child rules if specific junctions are set.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-25:168>'''
 
*'''<kuid:-25:168>'''
Line 2,741: Line 2,696:
 
*'''Parent Rule'''
 
*'''Parent Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
     '''Wait until ''<selection>''''' - select from:-
+
     '''Wait until ''<selection>''''' - <span style="background-color: black; color: white; font-weight: 700;"> select from:- </span>
 
       '''any one''' - any of the junctions in the rule list (below) is set correctly
 
       '''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
 
       '''all''' - ALL of the junctions in the rule list are set correctly
Line 2,749: Line 2,704:
 
     '''''<Add all>''''' - click to select ALL junctions in 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
 
     '''''<Delete all>''''' - click to delete ALL selected junctions from the rule list
       For each selected junction:-
+
       <span style="background-color: black; color: white; font-weight: 700;"> For each selected junction:- </span>
       '''''<setting>''''' - click to select one switch direction from:-
+
       '''''<setting>''''' - <span style="background-color: black; color: white; font-weight: 700;"> click to select one switch direction from:- </span>
 
           '''Left'''
 
           '''Left'''
 
           '''Right'''
 
           '''Right'''
Line 2,757: Line 2,712:
 
       '''''<remove>''''' - to delete this junction from the rule list
 
       '''''<remove>''''' - to delete this junction from the rule list
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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  
 
*'''[[#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
 
*'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
Line 2,763: Line 2,718:
 
*'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).
 
*'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).
  
[[file:Ex.PNG]] '''<u>Examples of Use</u>'''
+
[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
 
*'''[[How to Control Junctions in Sessions]]'''
 
*'''[[How to Control Junctions in Sessions]]'''
  
[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+
[[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 Parent and Child Rules]]'''
  
Line 2,780: Line 2,735:
 
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'''
 
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]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid2:131986:157661:1>'''
 
*'''<kuid2:131986:157661:1>'''
Line 2,786: Line 2,741:
 
*'''DLS Rule''' by '''atilabarut'''
 
*'''DLS Rule''' by '''atilabarut'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[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 Junction''''' - click to select a junction from the session junction list
 
     '''''Add All''''' - click to add ALL junctions in 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
 
     '''''Delete All''''' - click to remove ALL entered junctions from the rule
       '''Junction Options:''' - for each selected junction:-
+
       '''Junction Options:''' - <span style="background-color: black; color: white; font-weight: 700;"> for each selected junction:- </span>
           '''''<direction>''''' - click to select the junction direction
+
           '''''<direction>''''' - <span style="background-color: black; color: white; font-weight: 700;"> click to select the junction direction:- </span>
 
             '''Left'''
 
             '''Left'''
 
             '''Center'''
 
             '''Center'''
 
             '''Right'''
 
             '''Right'''
 
             '''Don't change'''
 
             '''Don't change'''
           '''''<user control>''''' - click to select a user control option
+
           '''''<user control>''''' - <span style="background-color: black; color: white; font-weight: 700;"> click to select a user control option:- </span>
 
             '''Locked''' - the junction setting cannot be changed by the user
 
             '''Locked''' - the junction setting cannot be changed by the user
 
             '''Unlocked''' - the junction setting can be changed by the user
 
             '''Unlocked''' - the junction setting can be changed by the user
           '''''<AI control>''''' - click to select AI control
+
           '''''<AI control>''''' - <span style="background-color: black; color: white; font-weight: 700;"> click to select AI control:- </span>
 
             '''Allows AI control''' - an AI train can switch the junction
 
             '''Allows AI control''' - an AI train can switch the junction
 
             '''Blocks AI control''' - an AI train cannot switch the junction
 
             '''Blocks AI control''' - an AI train cannot switch the junction
 
           '''''Remove''''' - click to remove this junction from the rule list
 
           '''''Remove''''' - click to remove this junction from the rule list
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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  
 
*'''[[#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
 
*'''[[#Junction Derailment Prevention Rule|Junction Derailment Prevention Rule]]''' - sets opposing junctions ahead of a train to prevent derailments
Line 2,823: Line 2,778:
 
Sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control). '''''Warning:'' not compatible with Interlocking Tower Assets'''
 
Sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control). '''''Warning:'' not compatible with Interlocking Tower Assets'''
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-25:1065>'''
 
*'''<kuid:-25:1065>'''
Line 2,829: Line 2,784:
 
*'''Built-in Rule'''
 
*'''Built-in Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[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 Junction''''' - click to select a junction from the session junction list
Line 2,835: Line 2,790:
 
     '''''Delete All''''' - click to remove ALL entered junctions from the rule
 
     '''''Delete All''''' - click to remove ALL entered junctions from the rule
 
       '''Junction Options:''' - for each selected junction:-
 
       '''Junction Options:''' - for each selected junction:-
           '''''<direction>''''' - click to select the junction direction
+
           '''''<direction>''''' - <span style="background-color: black; color: white; font-weight: 700;"> click to select the junction direction:- </span>
 
             '''Left'''
 
             '''Left'''
 
             '''Center'''
 
             '''Center'''
 
             '''Right'''
 
             '''Right'''
 
             '''Don't change'''
 
             '''Don't change'''
           '''''<user control>''''' - click to select a user control option
+
           '''''<user control>''''' - <span style="background-color: black; color: white; font-weight: 700;"> click to select a user control option:- </span>
 
             '''Locked''' - the junction setting cannot be changed by the user
 
             '''Locked''' - the junction setting cannot be changed by the user
 
             '''Unlocked''' - the junction setting can be changed by the user
 
             '''Unlocked''' - the junction setting can be changed by the user
           '''''<AI control>''''' - click to select AI control
+
           '''''<AI control>''''' - <span style="background-color: black; color: white; font-weight: 700;"> click to select AI control:- </span>
 
             '''Allows AI control''' - an AI train can switch the junction
 
             '''Allows AI control''' - an AI train can switch the junction
 
             '''Blocks AI control''' - an AI train cannot switch the junction
 
             '''Blocks AI control''' - an AI train cannot switch the junction
 
           '''''Remove''''' - click to remove this junction from the rule list
 
           '''''Remove''''' - click to remove this junction from the rule list
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[file:Issues.PNG|link=]] <span style="background-color: yellow; color: black; font-weight: 700;"> Known Issues: </span>
 +
:Rule is NOT compatible with Interlocking Towers
 +
 
 +
[[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  
 
*'''[[#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
 
*'''[[#Junction Derailment Prevention Rule|Junction Derailment Prevention Rule]]''' - sets opposing junctions ahead of a train to prevent derailments
Line 2,855: Line 2,813:
 
*'''[[#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 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]] '''<u>Examples of Use</u>'''
+
[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
 
*'''[[How to Control Junctions in Sessions]]'''
 
*'''[[How to Control Junctions in Sessions]]'''
  
Line 2,869: Line 2,827:
 
Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''
 
Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid2:47662:20002:4>'''
 
*'''<kuid2:47662:20002:4>'''
Line 2,875: Line 2,833:
 
*'''Built-in Rule'''
 
*'''Built-in Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[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 -
+
     '''''<Select signal>'' to ''<signal state>''''' - click to select a signal from the session list and <span style="background-color: black; color: white; font-weight: 700;"> click to select a state from the list:- </span>
 
       '''Automatic'''
 
       '''Automatic'''
 
       '''Stop'''
 
       '''Stop'''
Line 2,893: Line 2,851:
 
       '''Medium'''
 
       '''Medium'''
  
[[file:Notes.PNG]] '''<u>Notes:</u>'''
+
[[file:Issues.PNG|link=]] <span style="background-color: yellow; color: black; font-weight: 700;"> Known Issues: </span>
 +
:Rule is NOT compatible with Interlocking Towers
 +
 
 +
[[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 signal must support the state selected otherwise there will be no change in the signal
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
 
*'''[[#Trigger Multiple Signals Rule|Trigger Multiple Signals Rule]]''' - sets selected signals to DANGER (STOP) when selected triggers are activated
 
*'''[[#Trigger Multiple Signals Rule|Trigger Multiple Signals Rule]]''' - sets selected signals to DANGER (STOP) when selected triggers are activated
  
Line 2,910: Line 2,871:
 
Sets selected signals to DANGER (STOP) when selected triggers are activated. Signals will be at AUTOMATIC when the triggers are not activated.
 
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]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid2:116387:26:1>'''
 
*'''<kuid2:116387:26:1>'''
Line 2,916: Line 2,877:
 
*'''DLS Rule''' by '''maggs'''
 
*'''DLS Rule''' by '''maggs'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[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.
 
     '''<add signal>''' - select a signal from the Session List. More than one signal can be added.
Line 2,923: Line 2,884:
 
       '''<delete>''' - remove a trigger from the rule.
 
       '''<delete>''' - remove a trigger from the rule.
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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
 
*'''[[#Set Signal Extended Rule|Set Signal Extended Rule]]''' -  sets a selected signal to a specific signal state
 
<br>
 
<br>
<table width="100%" bgcolor=#ffff88>
 
<tr>
 
<td>
 
'''[[#top|Back to Top]]'''
 
</td>
 
</tr>
 
</table>
 
 
 
<table width="100%" bgcolor=#ffff88>
 
<table width="100%" bgcolor=#ffff88>
 
<tr>
 
<tr>
Line 2,941: Line 2,894:
 
</tr>
 
</tr>
 
</table>
 
</table>
 +
[[file:BackToTop.png|link=#top|alt=Top|Top]] [[file:NextDown.png|link=#Miscellaneous Rules|alt=Next Down|Miscellaneous Rules]] [[file:NextUp.png|link=#Interlocking Tower, Junction and Signal Rules|alt=Next Up|Interlocking Tower, Junction and Signal Rules]]  [[file:BackToBottom.png|link=#Trainz Wiki|alt=Bottom|Bottom]]
  
<br>
 
 
<table width=100% width=100% bgcolor=#ffffcc>
 
<table width=100% width=100% bgcolor=#ffffcc>
 
<tr>
 
<tr>
Line 2,953: Line 2,906:
 
Closes open message popups
 
Closes open message popups
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:447264:1526>'''
 
*'''<kuid:447264:1526>'''
Line 2,959: Line 2,912:
 
*'''Built-in Rule'''
 
*'''Built-in Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
   '''None'''
 
   '''None'''
  
[[file:Issues.PNG]] '''<u>Known Issues:</u>'''
+
[[file:Issues.PNG|link=]] <span style="background-color: yellow; color: black; 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 rule only appears to work if it is a child of the rule that triggered the Message Popup Rule
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
 
*'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
 
*'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
  
[[file:Ex.PNG]] '''<u>Examples of Use</u>'''
+
[[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 Message Popup Rule (Applications)]]'''
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#ffffcc>
 
<tr>
 
<tr>
 
<td>
 
<td>
Line 2,983: Line 2,936:
 
Creates a list of destination names for a destination sign
 
Creates a list of destination names for a destination sign
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid2:206816:99004:2>'''
 
*'''<kuid2:206816:99004:2>'''
Line 2,989: Line 2,942:
 
*'''Built-in Rule'''
 
*'''Built-in Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[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
 
   '''''<add destination>''''' - enter a destination name to be added to the destination sign roll
Line 3,008: Line 2,961:
 
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'''  
 
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]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-25:442>'''
 
*'''<kuid:-25:442>'''
Line 3,016: Line 2,969:
 
*'''Base Rule'''
 
*'''Base Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
     '''''<Add Page>''''' - adds the HTML page ''index.html'' from the selected HTML asset
 
     '''''<Add Page>''''' - adds the HTML page ''index.html'' from the selected HTML asset
Line 3,030: Line 2,983:
 
     '''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
 
     '''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]] '''<u>Related Rules:</u>'''
+
[[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.
 
*'''[[#Close Message Popup Rule|Close Message Popup Rule]]''' - closes a displayed pop-up browser window.
 
*'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
 
*'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
Line 3,047: Line 3,000:
 
Displays a page containing a video clip from a HTML asset in a browser window.
 
Displays a page containing a video clip from a HTML asset in a browser window.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-25:138>'''
 
*'''<kuid:-25:138>'''
Line 3,053: Line 3,006:
 
*'''Built-in Rule'''
 
*'''Built-in Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[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
 
     '''Display page ''<index.html>'' of html asset ''<click to select>'' in a new browser window
Line 3,059: Line 3,012:
 
       '''''<click to select>''''' - select the HTML asset from those installed.
 
       '''''<click to select>''''' - select the HTML asset from those installed.
  
[[file:Notes.PNG]] '''<u>Notes:</u>'''
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>  
 
:Video must be in a valid web format.
 
:Video must be in a valid web format.
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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
 
*'''[[#Play Sound Rule|Play Sound Rule]]''' - plays a wav sound file
 
<br>
 
<table width=100% width=100% bgcolor=#ffffcc>
 
<tr>
 
<td>
 
=='''DisplayIndustryStatus Rule (color modified)'''==
 
</td>
 
</tr>
 
</table>
 
 
Displays a summary of industry product levels when the "k" key is pressed.
 
 
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
 
 
*'''<kuid:622415:100001>'''
 
 
*'''DLS Rule''' by '''lockheed02''' and '''marzipan'''
 
 
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
 
 
    '''None'''
 
 
[[file:Notes.PNG]] '''<u>Notes:</u>'''
 
:Pressing the '''k''' key in Driver mode will bring up a small window with a single link '''''Display Industry Status''''' (there may also be other links). Clicking this link will show the product levels of all industries.
 
 
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
 
*'''[[#ExTrainz Manager Rule - TANE SP2|ExTrainz Manager Rule - TANE SP2]]''' - displays information on consists, industries and products in Driver and Surveyor.
 
  
 
<br>
 
<br>
Line 3,103: Line 3,029:
 
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.
 
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]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:160293:10029>'''
 
*'''<kuid:160293:10029>'''
Line 3,109: Line 3,035:
 
*'''DLS Rule''' by '''trev999'''
 
*'''DLS Rule''' by '''trev999'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule 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.
 
     '''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.
 
     '''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.
+
     '''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 mode.
 
     '''Search only rolling stock already in session ''<Yes/No>''''' - click to select ''Yes'' or ''No''. When set to ''Yes'' only those rolling stock assets
 
     '''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.
 
       installed in the session can be searched.
Line 3,122: Line 3,048:
 
       which will exclude that specific industry from the management list, or partial (e.g. "Coal") which will exclude all  
 
       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.
 
       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:-
+
       <span style="background-color: black; color: white; font-weight: 700;"> Once industries have been excluded, additional commands will appear for each excluded industry:- </span>
 
       '''''<delete> <industry name begins with/class name begins with> <name>''''' - click ''delete'' to remove this entry.  
 
       '''''<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 ''industry name begins with/class name begins with'' to select between the two (see ''notes'' below).
 
           - click ''name'' to edit the name.
 
           - click ''name'' to edit the name.
  
[[file:Notes.PNG]] '''<u>Notes:</u>'''
+
[[file:Issues.PNG|link=]] <span style="background-color: yellow; color: black; font-weight: 700;"> Known Issues: </span>
#Rolling stock installed in '''TANE''' or 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.
+
 
+
[[file:Issues.PNG]] '''<u>Known Issues:</u>'''
+
 
:This rule is NOT compatible with all industries.
 
:This rule is NOT compatible with all industries.
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
*'''[[#DisplayIndustryStatus Rule (color modified)|DisplayIndustryStatus Rule (color modified)]]''' - displays information on industry product levels.
+
#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>
Line 3,149: Line 3,072:
 
Fade in or out within seconds, using specified color and opacity values.
 
Fade in or out within seconds, using specified color and opacity values.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid2:190611:200000:2>'''
 
*'''<kuid2:190611:200000:2>'''
Line 3,155: Line 3,078:
 
*'''Built-in Rule'''
 
*'''Built-in Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[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)
 
     '''Red percentage:            ''<value>''''' - enter the final % of red (0 = none, 100 = maximum)
Line 3,164: Line 3,087:
 
     '''''<help>''''' - click to bring up help instructions
 
     '''''<help>''''' - click to bring up help instructions
  
[[file:Notes.PNG]] '''<u>Notes:</u>'''
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
:Seconds are Trainz clock time, not real time.
 
:Seconds are Trainz clock time, not real time.
  
Line 3,178: Line 3,101:
 
Hides the commodity or product bar graphs that appear on active industries
 
Hides the commodity or product bar graphs that appear on active industries
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:400048:100970>'''
 
*'''<kuid:400048:100970>'''
Line 3,184: Line 3,107:
 
*'''DLS Rule''' by '''callavsg'''
 
*'''DLS Rule''' by '''callavsg'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
   '''None'''
 
   '''None'''
Line 3,199: Line 3,122:
 
Creates a list of message names to be used for various purposes including passing data to '''Driver Commands'''
 
Creates a list of message names to be used for various purposes including passing data to '''Driver Commands'''
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid2:131986:1012:1>'''
 
*'''<kuid2:131986:1012:1>'''
Line 3,205: Line 3,128:
 
*'''Built-in Rule'''
 
*'''Built-in Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
     '''''<add>''''' - click to add a new entry to the table
 
     '''''<add>''''' - click to add a new entry to the table
     Each new entry will require an input message
+
     <span style="background-color: black; color: white; font-weight: 700;"> Each new entry will require an input message </span>
 
       '''''<short message>''''' - enter a message. The message must be in a format that is specific for each purpose
 
       '''''<short message>''''' - enter a message. The message must be in a format that is specific for each purpose
       For the '''MoveTurntable''' driver command the message must be formatted as:-
+
       <span style="background-color: black; color: white; font-weight: 700;"> For the <u>MoveTurntable</u> driver command the message must be formatted as:- </span>
 
           '''turntable,name_of_turntable,number_of_connecting_roads''' - the first entry must be the word ''turntable'' in lower case.
 
           '''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,  
 
             ''name_of_turntable'' is the name of the turntable,  
 
             ''number_of_connecting_roads'' is the number of tracks connecting to 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:-
+
       <span style="background-color: black; color: white; font-weight: 700;"> For the <u>WaitUntilTime</u> driver command the message must be formatted as:- </span>
 
           '''time,hour,minute''' - the first entry must be the word ''time'' in lower case,  
 
           '''time,hour,minute''' - the first entry must be the word ''time'' in lower case,  
 
             ''hour'' must be from 0 to 23,  
 
             ''hour'' must be from 0 to 23,  
 
             ''minute'' must be from 0 to 59.
 
             ''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:-
+
       <span style="background-color: black; color: white; font-weight: 700;"> For the <u>Skip If Session-Variable</u> and <u>Wait Until S-Variable</u> driver commands the message must be formatted as:- </span>
 
           '''svar,svar_name,svar_condition,value''' - the first entry must be the word ''svar'' in lower case,  
 
           '''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_name'' is the name of the session variable,  
 
             ''svar_condition'' is an equality (eg eq for equal, gt for greater than, etc)
 
             ''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.
 
             ''value'' is an integer value to be compared to the session variable.
     Each entry in the table will be followed by the commands:-
+
     <span style="background-color: black; color: white; font-weight: 700;"> Each entry in the table will be followed by the commands:- </span>
 
       '''''cp''''' - click to copy this entry to a new entry
 
       '''''cp''''' - click to copy this entry to a new entry
 
       '''''up''''' - click to move this entry up one level
 
       '''''up''''' - click to move this entry up one level
Line 3,229: Line 3,152:
 
       '''''rm''''' - click to remove this entry from the table
 
       '''''rm''''' - click to remove this entry from the table
  
[[file:PageLink2.PNG]] '''<u>Dependent Driver Commands</u>'''
+
[[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#MoveTurntable|MoveTurntable]]'''
 
*'''[[Driver Commands List#MoveTurntable|MoveTurntable]]'''
 
*'''[[Driver Commands List#Skip if Session-Variable|Skip If Session-Variable]]'''
 
*'''[[Driver Commands List#Skip if Session-Variable|Skip If Session-Variable]]'''
Line 3,245: Line 3,169:
 
Displays a pop-up browser window and waits for it to be closed. Closure can be manual (by the user) or by another rule.
 
Displays a pop-up browser window and waits for it to be closed. Closure can be manual (by the user) or by another rule.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-25:1003>'''
 
*'''<kuid:-25:1003>'''
Line 3,251: Line 3,175:
 
*'''Built-in Rule'''
 
*'''Built-in Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[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] 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
 
     '''[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 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:-
+
     '''Message Source:''' - <span style="background-color: black; color: white; font-weight: 700;"> select one of three option buttons:- </span>
 
       '''( ) Custom text''' - the simplest and easiest option
 
       '''( ) 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 ''<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
 
           '''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.  
 
           '''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.
+
               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.
 
           '''''<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.  
 
           '''''<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
+
               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.  
 
           '''[x] Autoplay Wave:''' - plays the .wav sound file as soon as message is displayed.  
               If unchecked the sound will not be played.
+
               <span style="background-color: red; color: white; font-weight: 700;"> If unchecked the sound will not be played. </span>
 
       '''( ) A predefined HTML page''' - requires a working knowledge of HTML
 
       '''( ) 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 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.  
 
           '''''<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.
+
               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.  
 
           '''''<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.
+
               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.  
 
           '''''<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
+
               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.  
 
           '''[x] Autoplay Wave:''' - plays the .wav sound file as soon as message is displayed.  
             If unchecked sound will not be played.
+
             <span style="background-color: red; color: white; font-weight: 700;"> If unchecked sound will not be played. </span>
 
       '''( ) A predefined string-table entry from a HTML asset'''
 
       '''( ) 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.
 
           '''''<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.
 
           '''''<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.  
 
           '''''<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.
+
               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.  
 
           '''''<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
+
               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.  
 
           '''[x] Autoplay Wave:''' - plays the .wav sound file as soon as message is displayed.  
               If unchecked sound will not be played.
+
               <span style="background-color: red; color: white; font-weight: 700;"> If unchecked sound will not be played. </span>
  
[[file:Issues.PNG]] '''<u>Known Issues:</u>'''
+
[[file:Issues.PNG|link=]] <span style="background-color: yellow; color: black; 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.
 
: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]] '''<u>Related Rules:</u>'''
+
[[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.
 
*'''[[#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.
 
*'''[[#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.
 
*'''[[#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]] '''<u>Examples of Use</u>'''
+
[[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]]'''
 
*'''[[How to Use Message Popup Rule (Applications)]]'''
 
*'''[[How to Use Message Popup Rule (Applications)]]'''
  
[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+
[[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 HTML Asset|How to Create a HTML Asset (Session Introduction Page and In Game Messages)]]'''
 
*'''[[How to Create a Message Popup Icon]]'''
 
*'''[[How to Create a Message Popup Icon]]'''
Line 3,314: Line 3,238:
 
Sets the display options for the minimap.
 
Sets the display options for the minimap.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-25:636>'''
 
*'''<kuid:-25:636>'''
Line 3,320: Line 3,244:
 
*'''Built-in Rule'''
 
*'''Built-in Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
 
  ''Default values - all checked''
 
  ''Default values - all checked''
 
     '''[x] Map Textures'''
 
     '''[x] Map Textures'''
Line 3,334: Line 3,258:
 
     '''[x] Consists'''
 
     '''[x] Consists'''
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
*'''[[#Show/Hide Minimap Rule|Show/Hide Minimap Rule]]''' - shows the minimap window in Driver.
+
*'''[[#Show/Hide Minimap Rule|Show/Hide Minimap Rule]]''' - shows the minimap window in Driver mode.
  
 
<br>
 
<br>
Line 3,348: Line 3,272:
 
Plays a wav sound file.
 
Plays a wav sound file.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-25:1045>'''
 
*'''<kuid:-25:1045>'''
Line 3,354: Line 3,278:
 
*'''Built-in Rule'''
 
*'''Built-in Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[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
 
     '''Default HTML ''<Click>''''' - click to to enter Sound File Name
 
     '''HTML Assets ''<Click>''''' - click to select HTML asset
 
     '''HTML Assets ''<Click>''''' - click to select HTML asset
     '''Rule Completes ''<Click>''''' -  to select one of:-
+
     '''Rule Completes ''<Click>''''' -  <span style="background-color: black; color: white; font-weight: 700;"> to select one of:- </span>
 
       '''sound has just started'''
 
       '''sound has just started'''
 
       '''sound has finished playing'''
 
       '''sound has finished playing'''
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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
 
*'''[[#Display Video Rule|Display Video Rule]]''' - displays a page containing a video clip from a HTML asset in a browser window
  
Line 3,376: Line 3,300:
 
Sets session metadata in the config file. Info can be read by other systems and displayed to the player.
 
Sets session metadata in the config file. Info can be read by other systems and displayed to the player.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:401543:2036>'''
 
*'''<kuid:401543:2036>'''
Line 3,382: Line 3,306:
 
*'''Base Rule'''
 
*'''Base Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
     '''Type ''<Click>''''' - click to select one of:-
+
     '''Type ''<Click>''''' - <span style="background-color: black; color: white; font-weight: 700;"> click to select one of:- </span>
 
       '''Simulation'''
 
       '''Simulation'''
 
       '''Challenge'''
 
       '''Challenge'''
 
     '''Length ''<value>''''' - to enter number of minutes, default is 30 minutes
 
     '''Length ''<value>''''' - to enter number of minutes, default is 30 minutes
     '''Difficulty ''<Click>''''' - click to select one of:-
+
     '''Difficulty ''<Click>''''' - <span style="background-color: black; color: white; font-weight: 700;"> click to select one of:- </span>
 
       '''Normal''' - default
 
       '''Normal''' - default
 
       '''Tutorial'''
 
       '''Tutorial'''
Line 3,395: Line 3,319:
 
       '''Expert'''
 
       '''Expert'''
  
[[file:Notes.PNG]] '''<u>Notes:</u>'''
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>  
 
:Time is Trainz clock time, not real time
 
:Time is Trainz clock time, not real time
  
Line 3,409: Line 3,333:
 
Sets the size of helper icons such as the junction lever arrows.
 
Sets the size of helper icons such as the junction lever arrows.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-25:791>'''
 
*'''<kuid:-25:791>'''
Line 3,415: Line 3,339:
 
*'''Built-in Rule'''
 
*'''Built-in Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[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%
 
   '''Junction Arrows Size ''<Click>''''' - to set scale ratio smaller than default, default is 100%
Line 3,430: Line 3,354:
 
Instructs the Display HTML Pages rule to perform specific operations. This rule has been superseded by the '''Message Popup Rule'''
 
Instructs the Display HTML Pages rule to perform specific operations. This rule has been superseded by the '''Message Popup Rule'''
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-25:792>'''
 
*'''<kuid:-25:792>'''
Line 3,438: Line 3,362:
 
*'''Built-in Rule'''
 
*'''Built-in Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
     '''Operations to preform on the display HTML pages sequence browser'''
 
     '''Operations to preform on the display HTML pages sequence browser'''
     Select one of six option buttons:-
+
     <span style="background-color: black; color: white; font-weight: 700;"> Select one of six option buttons:- </span>
 
       '''( ) to instruct the sequence browser to ''<select>''''' - to choose page operations
 
       '''( ) to instruct the sequence browser to ''<select>''''' - to choose page operations
 
       '''( ) to instruct the sequence browser to open the page ''<select>''''' - enter the HTML page name
 
       '''( ) to instruct the sequence browser to open the page ''<select>''''' - enter the HTML page name
       '''( ) to set browser parameters ''<select>''''' - choose one of:-
+
       '''( ) to set browser parameters ''<select>''''' - <span style="background-color: black; color: white; font-weight: 700;"> choose one of:- </span>
 
           '''to Enable/Disable closing of the browser window by the user'''
 
           '''to Enable/Disable closing of the browser window by the user'''
 
           '''to Enable/Disable scrolling on the sequence browser window'''
 
           '''to Enable/Disable scrolling on the sequence browser window'''
 
           '''to Show/Hide 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
 
       '''( ) Set the following flag for the page named ''<select>''''' - enter the HTML page name
           '''[x] Hide/Close window on 'done' action'''
+
           '''[x] Hide/Close window on "done" action'''
           '''[x] Window has no 'done' button'''
+
           '''[x] Window has no "done" button'''
           '''[x] Disable scrolling(not implemented yet)'''
+
           '''[x] Disable scrolling (not implemented yet)'''
 
           '''[x] Spare setting 1'''
 
           '''[x] Spare setting 1'''
 
           '''[x] Spare setting 2'''
 
           '''[x] Spare setting 2'''
Line 3,460: Line 3,384:
 
       '''( ) Use the string table entry ''<select>''''' (enter Index) '''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]] '''<u>Related Rules:</u>'''
+
[[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.
 
*'''[[#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.
 
*'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
Line 3,469: Line 3,393:
 
<tr>
 
<tr>
 
<td>
 
<td>
=='''Show/Hide Layer Rule'''==
+
=='''Show/Hide HUD Panel Rule'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
Shows or hides a layer from Driver.
+
Shows or hides a HUD panel.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
*'''<kuid2:401543:1170:1>'''
+
*'''<kuid:-25:1047>'''
  
 
*'''Built-in Rule'''
 
*'''Built-in Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
  '''''<visibility>''''' - select one of two options
+
    '''''<Show/Hide>'' the ''<click to select>'' HUD panel''' - select '''''Show''''' or '''''Hide''''' and then select the HUD panel
      '''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]] '''<font color="red"><u>Known Bugs:</u></font>'''
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
:Layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded
+
*'''[[#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.
[[file:Issues.PNG]] '''<u>Known Issues:</u>'''
+
*'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
:Rule will NOT check to see if the named layer exists or not
+
*'''[[#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.
[[file:Ex.PNG]] '''<u>Examples of Use</u>'''
+
*'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked
*'''[[How to Use Layers#Layers in Driver Mode|How to Use Layers: Layers in Driver Mode]]
+
  
 
<br>
 
<br>
Line 3,507: Line 3,427:
 
</table>
 
</table>
  
Shows the minimap window in Driver.
+
Shows the minimap window in Driver mode.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-25:794>'''
 
*'''<kuid:-25:794>'''
Line 3,515: Line 3,435:
 
*'''Built-in Rule'''
 
*'''Built-in Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
     '''''<Show/Hide>'' the driver Minimap Window''' - click to switch between '''Show''' and '''Hide'''.
 
     '''''<Show/Hide>'' the driver Minimap Window''' - click to switch between '''Show''' and '''Hide'''.
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
 
*'''[[#Minimap Options Rule|Minimap Options Rule]]''' - sets the display options for the minimap.
 
*'''[[#Minimap Options Rule|Minimap Options Rule]]''' - sets the display options for the minimap.
  
Line 3,531: Line 3,451:
 
</table>
 
</table>
  
Shows or hides On-screen help in Driver.
+
Shows or hides On-screen help in Driver mode.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:401543:2020>'''
 
*'''<kuid:401543:2020>'''
Line 3,539: Line 3,459:
 
*'''Built-in Rule'''
 
*'''Built-in Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[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:-
+
     '''On screen help (junction overlays, etc)''' - <span style="background-color: black; color: white; font-weight: 700;"> select one of three option buttons:- </span>
 
       '''( ) Show
 
       '''( ) Show
 
       '''( ) Hide
 
       '''( ) Hide
 
       '''( ) Leave Unchanged
 
       '''( ) Leave Unchanged
     '''On Screen Vehicle Names:''' - - select one of three option buttons:-
+
     '''On Screen Vehicle Names:''' - <span style="background-color: black; color: white; font-weight: 700;"> select one of three option buttons:- </span>
 
       '''( ) Show
 
       '''( ) Show
 
       '''( ) Hide
 
       '''( ) Hide
Line 3,561: Line 3,481:
 
Displays an HTML browser window for a limited time.
 
Displays an HTML browser window for a limited time.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid2:61392:2005:32>'''
 
*'''<kuid2:61392:2005:32>'''
Line 3,567: Line 3,487:
 
*'''DLS Rule''' by '''pguy'''
 
*'''DLS Rule''' by '''pguy'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
   '''HTML Asset Name : ''<[Click to select HTML asset]>''''' - click to select an HTML asset from those installed
 
   '''HTML Asset Name : ''<[Click to select HTML asset]>''''' - click to select an HTML asset from those installed
Line 3,578: Line 3,498:
 
   '''[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.
 
   '''[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]] '''<u>Notes:</u>'''
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
 
:Seconds are Trainz clock time, not real time.
 
:Seconds are Trainz clock time, not real time.
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
 
*'''[[#Close Message Popup Rule|Close Message Popup Rule]]''' - closes open message popups
 
*'''[[#Close Message Popup Rule|Close Message Popup Rule]]''' - closes open message popups
 
*'''[[#Display HTML Pages Rule|Display HTML Pages Rule]]''' - displays HTML pages in a browser window.
 
*'''[[#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.
 
*'''[[#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'''
 
*'''[[#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>
Line 3,598: Line 3,521:
 
Executes child rules when the Waybill window is opened or closed
 
Executes child rules when the Waybill window is opened or closed
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-25:957>'''
 
*'''<kuid:-25:957>'''
Line 3,606: Line 3,529:
 
*'''Parent Rule'''
 
*'''Parent Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
     '''[x] Trigger rule once''' - check to trigger the rule once only
 
     '''[x] Trigger rule once''' - check to trigger the rule once only
 
     '''Wait for the Waybill window to be ''<opened/closed>''''' - select either '''opened''' or '''closed'''.
 
     '''Wait for the Waybill window to be ''<opened/closed>''''' - select either '''opened''' or '''closed'''.
  
[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+
[[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 Parent and Child Rules]]'''
 
<br>
 
<br>
<table width="100%" bgcolor=#ffff88>
 
<tr>
 
<td>
 
'''[[#top|Back to Top]]'''
 
</td>
 
</tr>
 
</table>
 
 
 
<table width="100%" bgcolor=#ffff88>
 
<table width="100%" bgcolor=#ffff88>
 
<tr>
 
<tr>
 
<td>
 
<td>
 
='''Miscellaneous Rules'''=
 
='''Miscellaneous Rules'''=
</td>
+
Some of these rules have no user accessible functions but may be used by other rules. Others do not fit in any other category.</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 +
[[file:BackToTop.png|link=#top|alt=Top|Top]] [[file:NextDown.png|link=#Navigation Rules|alt=Next Down|Navigation Rules]] [[file:NextUp.png|link=#Message Rules|alt=Next Up|Message Rules]] [[file:BackToBottom.png|link=#Trainz Wiki|alt=Bottom|Bottom]]
  
Some of these rules have no user accessible functions but may be used by other rules. Others do not fit in any other category.
 
 
<br>
 
 
<table width=100% width=100% bgcolor=#ffffcc>
 
<table width=100% width=100% bgcolor=#ffffcc>
 
<tr>
 
<tr>
Line 3,643: Line 3,556:
 
Was used by the '''QuickDrive Rule''' to place consists onto a route. Now obsolete.
 
Was used by the '''QuickDrive Rule''' to place consists onto a route. Now obsolete.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:401543:1180>'''
 
*'''<kuid:401543:1180>'''
  
*'''Obsolete Rule''' (function is now built into '''TANE''')  
+
*'''Obsolete Rule''' (function is now built into '''Trainz''')  
  
 
*'''Base Rule'''
 
*'''Base Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
     '''None'''
 
     '''None'''
Line 3,666: Line 3,579:
 
No description
 
No description
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:447264:1526>'''
 
*'''<kuid:447264:1526>'''
Line 3,672: Line 3,585:
 
*'''Built-in Rule'''
 
*'''Built-in Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
   '''None'''
 
   '''None'''
Line 3,687: Line 3,600:
 
No description.
 
No description.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:30501:1042>'''
 
*'''<kuid:30501:1042>'''
Line 3,693: Line 3,606:
 
*'''Base Rule'''
 
*'''Base Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
     '''None'''
 
     '''None'''
Line 3,708: Line 3,621:
 
Executes the first child if ''Debug'' mode is selected. Otherwise executes the second child rule.
 
Executes the first child if ''Debug'' mode is selected. Otherwise executes the second child rule.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:30501:100180>'''
 
*'''<kuid:30501:100180>'''
Line 3,716: Line 3,629:
 
*'''Parent Rule'''  
 
*'''Parent Rule'''  
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
     '''None'''
 
     '''None'''
  
[[file:Notes.PNG]] '''<u>Notes:</u>'''
+
[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>  
 
: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.
 
: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.
  
[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+
[[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 Parent and Child Rules]]'''
 
<br>
 
<br>
<table width="100%" bgcolor=#ffff88>
+
<table width=100% bgcolor=#ffffcc>
 
<tr>
 
<tr>
 
<td>
 
<td>
'''[[#top|Back to Top]]'''
+
=='''Show/Hide Layer Rule'''==
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
<table width="100%" bgcolor=#ffff88>
+
Shows or hides a layer in Driver mode.
<tr>
+
<td>
+
='''Portal Rules'''=
+
</td>
+
</tr>
+
</table>
+
  
<br>
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
<table width=100% width=100% bgcolor=#ffffcc>
+
<tr>
+
<td>
+
=='''Quick Portal Manager Standard Edition Rule (SP2 and later)'''==
+
</td>
+
</tr>
+
</table>
+
  
Manages portals and adds flexible timetables.
+
*'''<kuid2:401543:1170:1>'''
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
*'''Built-in Rule'''
  
*'''<kuid2:61392:5011:45>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
*'''DLS Rule''' by '''pguy'''
+
  '''''<visibility>''''' - <span style="background-color: black; color: white; font-weight: 700;"> select one of two options:- </span>
 +
      '''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:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:BugMini.PNG|link=]] <span style="background-color: red; color: white; font-weight: 700;"> Known Bugs: </span>
 +
*In '''TANE''' layers set to '''Hide''' when a game is saved will be '''Shown''' when the saved game is reloaded
 +
*This bug has been fixed in '''TRS19'''
  
    '''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:Issues.PNG|link=]] <span style="background-color: yellow; color: black; font-weight: 700;"> Known Issues: </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'''.
+
:Rule will NOT check to see if the named layer exists or not
      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 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]] '''<u>Related Rules:</u>'''
+
[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Driver Commands:</span>
*'''[[#MissionCode Manager Rule (SP2 and later)|MissionCode Manager Rule (SP2 and later)]]''' - creates and manages '''Mission Codes''' for '''Interlocking Tower''' paths
+
*'''[[Driver_Commands_List#Layer_Control|Layer Control]]'''
*'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - create driver HUDs
+
*'''[[#Un-Portal Rule|Un-Portal Rule]]''' - configures trackmarks as portals
+
 
+
[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+
*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Quick_Portal_Manager</span>'''
+
  
<br>
+
[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
<table width=100% width=100% bgcolor=#ffffcc>
+
*'''[[How to Use Layers#Layers in Driver Mode|How to Use Layers: Layers in Driver Mode]]
<tr>
+
<td>
+
=='''Un-Portal Rule'''==
+
</td>
+
</tr>
+
</table>
+
 
+
Provides portals to routes that have no portals by configuring track marks as portals.
+
 
+
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
 
+
*'''<kuid2:117746:1024:10>'''
+
 
+
*'''DLS Rule''' by '''sforget'''
+
 
+
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
    '''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]] '''<u>Notes:</u>'''
+
#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]] '''<u>Related Rules:</u>'''
+
*'''[[#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]] '''<u>Trainz Wiki Links:</u>'''
+
*'''[[How to Use Portals]]'''
+
 
<br>
 
<br>
 
<table width="100%" bgcolor=#ffff88>
 
<table width="100%" bgcolor=#ffff88>
 
<tr>
 
<tr>
 
<td>
 
<td>
'''[[#top|Back to Top]]'''
 
</td>
 
</tr>
 
</table>
 
 
<table width="100%" bgcolor=#ffff88>
 
<tr>
 
<td>
 
 
 
='''Navigation Rules'''=
 
='''Navigation Rules'''=
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 +
[[file:BackToTop.png|link=#top|alt=Top|Top]] [[file:NextDown.png|link=#Portal Rules|alt=Next Down|Portal Rules]] [[file:NextUp.png|link=#Miscellaneous Rules|alt=Next Up|Miscellaneous Rules]] [[file:BackToBottom.png|link=#Trainz Wiki|alt=Bottom|Bottom]]
  
<br>
 
 
<table width=100% width=100% bgcolor=#ffffcc>
 
<table width=100% width=100% bgcolor=#ffffcc>
 
<tr>
 
<tr>
Line 3,880: Line 3,694:
 
Executes child rules when a set train enters a set trigger in a set direction. Adds direction to the '''Trigger Check Rule'''.
 
Executes child rules when a set train enters a set trigger in a set direction. Adds direction to the '''Trigger Check Rule'''.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid2:532391:100003:1>'''
 
*'''<kuid2:532391:100003:1>'''
Line 3,888: Line 3,702:
 
*'''Parent Rule'''
 
*'''Parent Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
     '''[x] Trigger only once '''
 
     '''[x] Trigger only once '''
 
     '''[x] Wait for child rules to complete even if no trains are present in rule trigger'''
 
     '''[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:-
+
     '''[x] Only activate when the entering vehicle of the train is heading ''<select direction>'' into the trigger''' - <span style="background-color: black; color: white; font-weight: 700;"> select one of two directions:- </span>
 
       '''''forward'''''
 
       '''''forward'''''
 
       '''''backward'''''
 
       '''''backward'''''
Line 3,898: Line 3,712:
 
       '''''<add trigger>''''' - select a trigger from the session list
 
       '''''<add trigger>''''' - select a trigger from the session list
 
       '''''<delete trigger>''''' - delete a selected trigger from the rule
 
       '''''<delete trigger>''''' - delete a selected trigger from the rule
     Select one of two option buttons:-
+
     <span style="background-color: black; color: white; font-weight: 700;"> Select one of two option buttons:- </span>
 
       '''( ) click to accept all trains'''
 
       '''( ) click to accept all trains'''
 
       '''( ) click to accept trains matching specific criteria'''
 
       '''( ) click to accept trains matching specific criteria'''
           Selecting the second option will produce the following selection controls:-
+
           <span style="background-color: black; color: white; font-weight: 700;"> Selecting the second option will produce the following selection controls:- </span>
 
           '''Specific vehicle''' - identify the specific vehicle(s) that will trigger the rule
 
           '''Specific vehicle''' - identify the specific vehicle(s) that will trigger the rule
 
             '''''+''''' - click to add a ''specific'' vehicle from the session list
 
             '''''+''''' - click to add a ''specific'' vehicle from the session list
Line 3,912: Line 3,726:
 
             '''''x''''' - click to remove a ''driver'' from the rule
 
             '''''x''''' - click to remove a ''driver'' from the rule
  
[[file:Notes.PNG]] '''<u>Notes:</u>'''
+
[[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.  
 
#This rule works best when used with the '''Directional Trigger''' track object available on the DLS.  
 
#The Directional Trigger, when installed, will appear as a ''Signal'' not as a ''Trackmark''.
 
#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.
 
#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]] '''<u>Related Rules:</u>'''
+
[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
 
*'''[[#Trackside Check Rule|Trackside Check Rule]]''' - executes child rules when activated by a train. Provides different options to the '''Trigger Check Rule'''
 
*'''[[#Trackside Check Rule|Trackside Check Rule]]''' - executes child rules when activated by a train. Provides different options to the '''Trigger Check Rule'''
 
*'''[[#Trigger Check Rule|Trigger Check Rule]]''' - executes child rules when a set train enters a set trigger (non-directional)
 
*'''[[#Trigger Check Rule|Trigger Check Rule]]''' - executes child rules when a set train enters a set trigger (non-directional)
  
[[file:Ex.PNG]] '''<u>Examples of Use</u>'''
+
[[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]]'''
 
*'''[[How to Control Signals in Sessions#Application 2: Halt Before Clear|How to Control Signals in Sessions: Halt Before Clear]]'''
  
[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+
[[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 Parent and Child Rules]]'''
 
*'''[[How to Use Track Triggers]]'''
 
*'''[[How to Use Track Triggers]]'''
  
 
<br>
 
<br>
<table width=100% width=100% bgcolor=#ffffcc>
+
<table width=100% bgcolor=#ffffcc>
 
<tr>
 
<tr>
 
<td>
 
<td>
Line 3,937: Line 3,751:
 
</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.
+
Creates and displays a set of navigation points. Multiple sets can be created by adding additional copies of this rule.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid2:401543:1161:1>'''
 
*'''<kuid2:401543:1161:1>'''
Line 3,945: Line 3,759:
 
*'''Base Rule'''
 
*'''Base Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[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.
+
     '''Unique set ID: ''<click here to set>''''' - enter a unique name for the navigation set. <span style="background-color: red; color: white; font-weight: 700;"> Name must be in lowercase and have no spaces. </span>
 
     '''Train (optional): ''<click here to set>''''' - select a rolling stock asset from the session list shown.
 
     '''Train (optional): ''<click here to set>''''' - select a rolling stock asset from the session list shown.
     Select one of three option buttons:-
+
     <span style="background-color: black; color: white; font-weight: 700;"> Select one of three option buttons:- </span>
 
     '''( ) All points must be completed in sequence:'''
 
     '''( ) All points must be completed in sequence:'''
 
       - the first uncompleted navigation point will be shown and must be completed next.
 
       - the first uncompleted navigation point will be shown and must be completed next.
Line 3,959: Line 3,773:
 
       - all uncompleted navigation points will be shown.
 
       - all uncompleted navigation points will be shown.
 
       - you may complete them in any order.
 
       - you may complete them in any order.
   For each navigation point:
+
   <span style="background-color: black; color: white; font-weight: 700;"> For each navigation point: </span>
 
       '''''<Click here to set>''''' - select an item (trigger, trackmark, track object, rolling stock) from the session list to become the 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.
 
       '''''<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.
 
       '''Icon ''<icon list>''''' - select an icon for the navigation point.
       '''''<Style>''''' - click to select one from three choices
+
       '''''<Style>''''' - <span style="background-color: black; color: white; font-weight: 700;"> click to select one from three choices:- </span>
 
         '''''Automatic''''' - the navigation point will be completed as soon as the consist reaches the point.
 
         '''''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'''.
 
         '''''Manual''''' - the navigation point must be set as complete by using the '''Navigation point complete rule''' or the '''Navigation set clear rule'''.
Line 3,969: Line 3,783:
 
         '''''Require Stop''''' - the navigation point will be completed when the consist comes to a complete stop on the point.
 
         '''''Require Stop''''' - the navigation point will be completed when the consist comes to a complete stop on the point.
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[file:Issues.PNG|link=]] <span style="background-color: yellow; color: black; font-weight: 700;"> Known Issues: </span>
 +
:The Session Editor '''Copy and Paste''' procedure will '''not''' copy the parameter settings in this rule.
 +
 
 +
[[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 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 Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set has completed or is incomplete.
Line 3,976: Line 3,793:
 
*'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed
 
*'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed
  
[[file:Ex.PNG]] '''<u>Examples of Use</u>'''
+
[[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]]'''
 
*'''[[How to Use Navigation Point Rules (Applications)]]'''
 
*'''[[How to Use Navigation Point Rules (Applications)]]'''
Line 3,991: Line 3,808:
 
Manually completes a navigation point in a set
 
Manually completes a navigation point in a set
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:401543:1167>'''
 
*'''<kuid:401543:1167>'''
Line 3,997: Line 3,814:
 
*'''Base Rule'''
 
*'''Base Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
     '''Mark navigation point ''<click here to set>''''' - enter the navigation point number to be completed
 
     '''Mark navigation point ''<click here to set>''''' - enter the navigation point number to be completed
 
     '''complete in set ''<click here to set>''''' - enter the unique name for the navigation set created using the '''Navigation Display Rule'''.
 
     '''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.
+
         <span style="background-color: red; color: white; font-weight: 700;"> Name must be in lowercase and have no spaces. </span>
  
[[file:Issues.PNG]] '''<u>Known Issues:</u>'''
+
[[file:Issues.PNG|link=]] <span style="background-color: yellow; color: black; font-weight: 700;"> Known Issues: </span>
 
:The rule will '''NOT''' check to see if the named navigation set and point exists or not.
 
:The rule will '''NOT''' check to see if the named navigation set and point exists or not.
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[file:Notes.PNG|link=]] '''<u>Notes:</u>'''
 +
:The navigation set and point 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 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 Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.
Line 4,013: Line 3,833:
 
*'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed
 
*'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed
  
[[file:Ex.PNG]] '''<u>Examples of Use</u>'''
+
[[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]]'''
 
*'''[[How to Use Navigation Point Rules (Applications)]]'''
 
*'''[[How to Use Navigation Point Rules (Applications)]]'''
Line 4,028: Line 3,848:
 
Executes child rules if a navigation set created with the '''Navigation Display Rule''' is complete (or incomplete).
 
Executes child rules if a navigation set created with the '''Navigation Display Rule''' is complete (or incomplete).
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:401543:1165>'''
 
*'''<kuid:401543:1165>'''
Line 4,036: Line 3,856:
 
*'''Parent Rule'''
 
*'''Parent Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
     '''Checks if navigation point set ''<name>'':''' - enter the unique name for the navigation set created using the '''Navigation Display Rule'''.
 
     '''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.
+
         <span style="background-color: red; color: white; font-weight: 700;"> Name must be in lowercase and have no spaces. </span>
 
     '''is ''<Complete/Incomplete>''''' - click to select one
 
     '''is ''<Complete/Incomplete>''''' - click to select one
  
[[file:Issues.PNG]] '''<u>Known Issues:</u>'''
+
[[file:Issues.PNG|link=]] <span style="background-color: yellow; color: black; font-weight: 700;"> Known Issues: </span>
 
:The rule will '''NOT''' check to see if the named navigation set exists or not.
 
:The rule will '''NOT''' check to see if the named navigation set exists or not.
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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 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 Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.
Line 4,052: Line 3,875:
 
*'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed
 
*'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed
  
[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+
[[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]]'''
 
*'''[[How to Use Navigation Point Rules (Applications)]]'''
 
*'''[[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 Parent and Child Rules]]'''
 
*'''[[How to Use Parent and Child Rules]]'''
  
Line 4,068: Line 3,893:
 
Clears a navigation set removing any uncompleted navigation points
 
Clears a navigation set removing any uncompleted navigation points
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:401543:1164>'''
 
*'''<kuid:401543:1164>'''
Line 4,074: Line 3,899:
 
*'''Base Rule'''
 
*'''Base Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[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'''.
 
     '''''<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.
+
         <span style="background-color: red; color: white; font-weight: 700;"> Name must be in lowercase and have no spaces. </span>
  
[[file:Issues.PNG]] '''<u>Known Issues:</u>'''
+
[[file:Issues.PNG|link=]] <span style="background-color: yellow; color: black; font-weight: 700;"> Known Issues: </span>
 
:The rule will '''NOT''' check to see if the named navigation set exists or not.
 
:The rule will '''NOT''' check to see if the named navigation set exists or not.
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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 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 Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.
Line 4,089: Line 3,917:
 
*'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed
 
*'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed
  
[[file:Ex.PNG]] '''<u>Examples of Use</u>'''
+
[[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]]'''
 
*'''[[How to Use Navigation Point Rules (Applications)]]'''
 
*'''[[How to Use Navigation Point Rules (Applications)]]'''
Line 4,104: Line 3,932:
 
Shows and hides navigation sets. You can have multiple sets visible and hidden at the same time.
 
Shows and hides navigation sets. You can have multiple sets visible and hidden at the same time.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:401543:1163>'''
 
*'''<kuid:401543:1163>'''
Line 4,110: Line 3,938:
 
*'''Base rule'''
 
*'''Base rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
     '''''<visibility>''''' - click to select one
+
     '''''<visibility>''''' - <span style="background-color: black; color: white; font-weight: 700;"> click to select one:- </span>
 
       '''Hide''' - select to make the navigation set invisible
 
       '''Hide''' - select to make the navigation set invisible
 
       '''Show''' - select to make the navigation set visible
 
       '''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'''.
 
     '''''<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.
+
         <span style="background-color: red; color: white; font-weight: 700;"> Name must be in lowercase and have no spaces. </span>
  
[[file:Issues.PNG]] '''<u>Known Issues:</u>'''
+
[[file:Issues.PNG|link=]] <span style="background-color: yellow; color: black; font-weight: 700;"> Known Issues: </span>
 
:The rule will '''NOT''' check to see if the named navigation set exists or not.
 
:The rule will '''NOT''' check to see if the named navigation set exists or not.
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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 Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
 
*'''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set has completed or is incomplete.
 
*'''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set has completed or is incomplete.
Line 4,128: Line 3,959:
 
*'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed
 
*'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed
  
[[file:Ex.PNG]] '''<u>Examples of Use</u>'''
+
[[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]]'''
 
*'''[[How to Use Navigation Point Rules (Applications)]]'''
 
*'''[[How to Use Navigation Point Rules (Applications)]]'''
 
<br>
 
<table width=100% width=100% bgcolor=#ffffcc>
 
<tr>
 
<td>
 
=='''Schedule Rule'''==
 
</td>
 
</tr>
 
</table>
 
 
Allows a schedule of timed events to be applied to a train
 
 
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
 
 
*'''<kuid:-3:10185>'''
 
 
*'''Base Rule'''
 
 
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
 
 
    '''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]] '''<font color="red">Known Bugs:</font>'''
 
:There are reports that this rule does not work correctly particularly if a train arrives late or early.
 
 
[[file:Notes.PNG]] '''<u>Notes:</u>'''
 
:Times are Trainz clock times, not real time
 
 
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
 
*'''[[#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]] '''<u>Other Links:</u>'''
 
*'''<span class="plainlinks">http://www.auran.com/games/gamefiles/trainz/tutorial1.html</span>'''
 
  
 
<br>
 
<br>
Line 4,185: Line 3,974:
 
Executes child rules when a set train enters a set trigger. Similar to the '''Trigger Check Rule''' but provides different options.
 
Executes child rules when a set train enters a set trigger. Similar to the '''Trigger Check Rule''' but provides different options.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid2:46162:100207:1>'''
 
*'''<kuid2:46162:100207:1>'''
Line 4,193: Line 3,982:
 
*'''Parent Rule'''
 
*'''Parent Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
     '''Applies to:''' - select one of three option buttons:-
+
     '''Applies to:''' - <span style="background-color: black; color: white; font-weight: 700;"> select one of three option buttons:- </span>
 
       '''( ) Junction'''
 
       '''( ) Junction'''
 
       '''( ) Trigger'''
 
       '''( ) Trigger'''
 
       '''( ) Trackmark'''
 
       '''( ) Trackmark'''
     '''Trackside object name: ''<specify>''''' - select object name from session list
+
     '''Trackside object name: ''<specify>''''' - select object name from session list:-
     '''Wait for train to:''' - select one of three option buttons:-
+
     '''Wait for train to:''' - <span style="background-color: black; color: white; font-weight: 700;"> select one of three option buttons:- </span>
 
       '''( ) Enter'''
 
       '''( ) Enter'''
 
       '''( ) Stop at'''
 
       '''( ) Stop at'''
Line 4,209: Line 3,998:
 
     '''''del''''' - click to remove a selected vehicle from the rule
 
     '''''del''''' - click to remove a selected vehicle from the rule
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[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.
+
*'''[[#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
 
*'''[[#Trigger Check Rule|Trigger Check Rule]]''' - executes child rules when activated by a train
  
[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+
[[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 Parent and Child Rules]]'''
  
Line 4,227: Line 4,016:
 
Executes child rules when a set train enters a set trigger. This rule replaces the older and less versatile '''Trigger Rule'''.
 
Executes child rules when a set train enters a set trigger. This rule replaces the older and less versatile '''Trigger Rule'''.
  
[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+
[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
  
 
*'''<kuid:-25:1071>'''
 
*'''<kuid:-25:1071>'''
Line 4,235: Line 4,024:
 
*'''Parent Rule'''
 
*'''Parent Rule'''
  
[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+
[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
  
 
     '''[x] Trigger only once '''
 
     '''[x] Trigger only once '''
Line 4,245: Line 4,034:
 
       '''''<add trigger>''''' - select a trigger from the session list
 
       '''''<add trigger>''''' - select a trigger from the session list
 
       '''''<delete trigger>''''' - delete a selected trigger from the rule
 
       '''''<delete trigger>''''' - delete a selected trigger from the rule
     Select one of two option buttons:-
+
     <span style="background-color: black; color: white; font-weight: 700;"> Select one of two option buttons:- </span>
 
       '''( ) click to accept all trains'''
 
       '''( ) click to accept all trains'''
 
       '''( ) click to accept trains matching specific criteria'''
 
       '''( ) click to accept trains matching specific criteria'''
           Selecting the second option will produce the following selection controls:-
+
           <span style="background-color: black; color: white; font-weight: 700;"> Selecting the second option will produce the following selection controls:- </span>
 
           '''Specific vehicle''' - identify the specific vehicle(s) that will trigger the rule
 
           '''Specific vehicle''' - identify the specific vehicle(s) that will trigger the rule
 
             '''''+''''' - click to add a ''specific'' vehicle from the session list
 
             '''''+''''' - click to add a ''specific'' vehicle from the session list
Line 4,259: Line 4,048:
 
             '''''x''''' - click to remove a ''driver'' from the rule
 
             '''''x''''' - click to remove a ''driver'' from the rule
  
[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+
[[file:PageLink.PNG