Session Rule List with Parameters: Difference between revisions

From TrainzOnline
Jump to navigationJump to search
← Older editNewer edit →

Pware (talk | contribs)

26,544 edits
Pware (talk | contribs)
26,544 edits
mNo edit summary
Pware (talk | contribs)
26,544 edits
mNo edit summary
Line 1: Line 1:
'''TRAINZ A New Era (TANE) SP2. List of Trainz Session Rules in Alphabetical Order with Properties. All rules are the Copyright of N3V Games'''
'''TRAINZ A New Era (TANE) SP2. List of Trainz Session Rules by Categories with Properties. All rules are the Copyright of N3V Games'''


'''This page is always under construction. As new rules appear they will be added to this list.'''
'''This page is always under construction. As new rules appear they will be added to this list.'''
'''Only rules supplied with TANE or on the DLS are covered in this document.'''
'''Only rules supplied with TANE or on the DLS are covered in this document.'''


Also available '''[[Session Rules By Categories With Properties]]'''
Also available '''[[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.
Line 15: Line 17:
*'''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).


----
'''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''


=='''A, B'''==
=='''Achievement Rules'''==


==='''Achievement Check Rule'''===
==='''Achievement Check Rule'''===
Line 39: Line 39:
           '''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


==='''Advanced Industry Load Configuration Rule'''===
==='''Consist Check Rule'''===
 
Executes child rules when a matching consist is found. The order of the vehicles in the consists is not important.


Locks train controls when loading/unloading at an industry, overrides time settings for begin load and begin unload operations
*'''<kuid:-25:1068>'''


*'''<kuid:30501:100007>'''
*'''Built-in Rule'''


*'''Base Rule'''
*'''Parent Rule'''


  '''Properties:'''
  '''Properties:'''
     '''Target object ''<select>''''' - select industry object from session list
     '''[Check Box] Enforce strict exclusive testing''' - check to only accept an exact match with no unspecified vehicles in the consist.
    '''[Check Box] Lock the train's controls during a stopped load/unload operation''' - check to disable driver controls while train is stopped and loading/unloading
      - leave unchecked to accept any consist that contains the specified vehicles.
    '''[Check Box] Override 'begin load' and 'begin unload' durations to ''<value>'' seconds''' - if checked enter number of seconds to override
    Select one of two option buttons:-
    '''( ) Rule disabled''' - select to disable the operation of this rule
    '''( ) Complete whenever a train matching the description exists''' - When selected, enter the consist description:-
      '''Specific vehicle''' - identify the specific vehicle(s) that will trigger the rule
          '''''+''''' - click to add a ''specific'' vehicle from the session list
          '''''x''''' - click to remove the ''specific'' vehicle from the rule
      '''Vehicle types''''' - identify the ''type'' of vehicle(s) that will trigger the rule
          '''''+''''' - click to add a ''type'' of vehicle from the session list
          '''''x''''' - click to remove the ''type'' of vehicle from the rule
      '''Drivers''''' - identify the ''driver(s)'' that will trigger the rule
          '''''+''''' - click to add a ''driver'' from the session list
          '''''x''''' - click to remove a ''driver'' from the rule


*'''Notes:'''
*'''Known Issues:'''
:Times are Trainz clock time, not real time
: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.


==='''AI Start Rule'''===
*'''Trainz Wiki Links:'''
**'''http://online.ts2009.com/mediaWiki/index.php/Consist_Check_Rule'''
**'''[[How to Use Variables in Sessions (Examples)#Example 3: Counting Consist Checks|How to Use Variables in Sessions (Examples): Counting Consist Checks]]'''


Restarts all halted AI controlled trains. Drivers will continue with the commands in their driver command list.
==='''Multiple Resource Check Rule'''===
 
Executes child rules if industries or vehicles reach set commodity levels. This rule replaces the older '''Resource Check Rule'''
 
*'''<kuid:-25:656>'''


*'''<kuid2:400048:100981:1>'''
*'''Built-in Rule'''


*'''DLS Rule''' by '''callavsg'''
*'''Parent Rule'''


  '''Properties:'''
  '''Properties:'''
     '''None'''
     '''<Product Level>''' - click to select a product test from two choices:-
      '''''Reach/Exceed''''' - sets an upper limit for the resources being monitored.
*'''Related Rules:'''
          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.
**'''[[#AI Stop Rule|AI Stop Rule]]''' - halts all AI drivers
          The initial level in the object must be below the set upper limit.
**'''[[#Disallow AI Rule|Disallow AI Rule]]''' - cancels all AI driver commands
      '''''Fall below''''' - sets a lower limit for the resources being monitored.
          For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon falls below a specified level.
          The initial level in the object must be above the set lower limit.
          To test when a resource level reaches zero (i.e. is empty) set the lower limit to a very low value but not zero as the level can never fall below zero.
    '''''<value>''''' - enter required quantity value
    '''''<select>''''' - select a product from session list of products
    '''''<Add object>''''' - click to select a source or target object. Multiple objects and their queues can be added to the rule.
      ALL the entered products must reach/exceed or fall below the specified value for the rule to be triggered.
      For each object:-
          '''''<Object>''''' - click to select session active industry or product enabled rail vehicle
          '''''<Queue>''''' - select product queue (there may be only one available)
          '''''<Remove>''''' - removes the object and its product queue from the rule


==='''AI Stop Rule'''===
*'''Notes:'''
: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''.


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.
*'''Related Rules:'''
**'''[[#Resource Check Rule|Resource Check Rule]]'''http: 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


*'''<kuid2:400048:100980:1>'''
*'''Trainz Wiki Links:'''
**'''[[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]]'''


*'''DLS Rule''' by '''callavsg'''
==='''Objective Add Rule'''===


'''Properties:'''
Sets up a game Objective with ID and display Name
    '''None'''
*'''Related Rules:'''
**'''[[#AI Start Rule|AI Start Rule]]''' - restarts all halted AI drivers
**'''[[#Disallow AI Rule|Disallow AI Rule]]''' - cancels all AI driver commands


==='''ATP Speed Limiter Rule'''===
*'''<kuid:401543:2001>'''


Limits allowable speed over set limit
*'''Base Rule'''


*'''<kuid2:321959:1000:1>'''
'''Properties:'''
    '''Priority ''<Select>''''' - select one of:-
      '''''Above Normal'''''
      '''''Below Normal'''''
      '''''Normal'''''
      '''''Optional'''''
      '''''Urgent'''''
    '''Completion Target Number ''<value>''''' - to set Completion Target Number
    '''Icon ''<select>''''' - to select Icon from list
    '''Display Name ''<enter>''''' - to insert Name
    '''Unique Objective ID ''<enter>''''' - enter a unique objective ID
    '''Custom Message ''<Text Box>''''' - insert typed message in text area


*'''Built-in Rule'''
*'''Related Rules:'''
**'''[[#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


'''Properties:'''
==='''Objective Check Rule'''===
    '''Limits the speed to ''<value>'' mph over the set limit''' - enter speed value in mph


==='''AWS Configuration Rule'''===
Executes child rules if an objective created with the '''Objective Add Rule''' is complete.


This rule configures the Trainz implementation of the Automatic Warning System when approaching signals
*'''<kuid:401543:2003>'''


*'''<kuid2:60850:89002:3>'''
*'''Base Rule'''


*'''Built-in Rule'''
*'''Parent Rule'''


  '''Properties:'''
  '''Properties:'''
     Select one of three option buttons:-
     '''Unique Objective ID ''<value>''''' - enter the unique ID created with the '''Objective Add Rule'''  
      '''( ) Active'''
     '''Mode ''<select>''''' - select one of three:-
      '''( ) Passive'''
      '''''Wait for completion'''''
      '''( ) Passive with HUD hidden'''
      '''''Wait for failure'''''
     '''[Check Box] Simulate AWS for unfitted cabs?'''
      '''''Wait for progress'''''
    '''[Check Box] Use modern sound set for unfitted cabs?'''
----
'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''


=='''C'''==
*'''Related Rules:'''
**'''[[#Objective Add Rule|Objective Add Rule]]''' - sets up a game objective
**'''[[#Objective Update Rule|Objective Update Rule]]''' - changes the progress of a game objective


==='''Cab Controls HUD Rule'''===
==='''Objective Update Rule'''===


Was used to provide the HUD controls for the cabin view. Now obsolete.
Changes progress of an objective outcome created with the '''Objective Add Rule''' according to Property choices


*'''<kuid:-16:287428>'''
*'''<kuid:401543:2002>'''


*'''Base Rule'''
*'''Base Rule'''
*'''Obsolete Rule''' (function is now built into TANE)


  '''Properties:'''
  '''Properties:'''
     '''None'''
     '''Unique Objective ID ''<value>''''' - enter the unique ID created with the '''Objective Add Rule'''
    '''Mode ''<select>''''' - select one from the following options
      '''''Decrement progress'''''
      '''''Increment progress'''''
      '''''Reset Objective'''''
      '''''Set objects as complete'''''
      '''''Set objects as failed'''''
      '''''Set progress'''''
      '''''Set progress only if greater'''''
    '''Amount ''<value>''''' - click to enter a value


==='''Cinematic Camera Rule'''===
*'''Related Rules:'''
**'''[[#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


Provides several different cinematic style cameras with animations. Best used at the start of a session.
==='''Ranked Session Begin Rule'''===
Use the '''Trackside Camera''' (tracking view) found in the '''Set Camera Rule''' during session play.
 
Begins a ranked Session


*'''<kuid2:401543:1166:3>'''
*'''<kuid:401543:2031>'''


*'''Built-in Rule'''
*'''Base Rule'''


  '''Properties:'''
  '''Properties:'''
     '''[Check Box] Lock camera controls for the duration''' - if checked user cannot alter camera view
     '''Countdown Starting Value ''<value>'''''
    '''[Check Box] Prevent train control for duration - if checked user cannot control train
      '''''hrs:'''''
    '''Camera target: ''<click to select>''''' - click to select the object from the session list that will be the camera target
      '''''min:'''''
    '''Camera mode:''' - select one of three option buttons:-
       '''''sec:'''''
      '''( ) Stationary'''
     '''1 through 5 stars, points for each star ''<value>''''' - enter number of points for each star rating
       '''( ) Circle targeted object'''
    '''Session timer mode:''' - select one of three option buttons:-
      '''( ) Move from one point to another (zoom, pan, etc)'''
      '''( ) Timer'''
     '''Initial camera values:'''
       '''( ) Countdown Starting value ''<value>''''' - enter time ''hh:mm:ss''
      '''[Check Box] Pitch: ''<value>''''' - check to select then click ''value'' to enter a pitch value
      '''( ) None'''
      '''[Check Box] Yaw:   ''<value>''''' - check to select then click ''value'' to enter a yaw value
       '''[Check Box] Zoom:  ''<value>''''' - check to select then click ''value'' to enter a zoom value
    '''Total time to animate:  ''<value>''''' - enter an animation time in seconds


*'''Notes:'''
*'''Notes:'''
:Times are Trainz clock times, not real times
:Times are Trainz clock time, not real time


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Focus Camera Rule|Focus Camera Rule]]''' - sets the initial camera view and starting vehicle for a session
**'''[[#Ranked Session Complete Rule|Ranked Session Complete Rule]]''' - completes the active ranked Session
**'''[[#Set Camera Rule|Set Camera Rule]]''' - sets the target object and properties of the camera
**'''[[#Wait for Camera View Mode Rule|Wait for Camera View Mode Rule]]''' - executes child rules when the camera view is changed


==='''Clean Up Derailed Trains Rule'''===
==='''Ranked Session Complete Rule'''===


Cleans up derailed train cars after a set time delay
Completes the active ranked Session


*'''<kuid2:60850:89003:1>'''
*'''<kuid:401543:2032>'''


*'''Base Rule'''
*'''Base Rule'''


  '''Properties:'''
  '''Properties:'''
     '''Set delay to clean up derailed traincars to'''
     '''Set the active ranked session as:''' - select one of two option buttons:-
      '''''<h>'':''' - click to enter the number of hours (0-23) to wait
       '''( ) Complete'''
       '''''<mm>'':''' - click to enter the number of minutes (0-59) to wait
      '''( ) Failed'''
      '''''<ss>'':''' - click to enter the number of seconds (0-59) to wait
    '''[Check Box] Customize the completion message ''<text>''''' - enter a text message
 
*'''Notes:'''
:Time is Trainz clock time, not real time.


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Replace Missing Vehicles Rule|Replace Missing Vehicles Rule]]''' - creates a replacement train after a derailment
**'''[[#Ranked Session Begin Rule|Ranked Session Begin Rule]]''' - begins a ranked Session
**'''[[#Wait for Derailment Rule|Wait for Derailment Rule]]''' - executes child rules when a derailment occurs


*'''Trainz Wiki Links:'''
==='''Resource Check Rule'''===
**'''http://online.ts2009.com/mediaWiki/index.php/Clean_up_Derailed_Trains_Rule'''


==='''Clock 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'''


Rule needed for animated clocks.
*'''<kuid:-25:1067>'''


*'''<kuid2:62310:30041:2>'''
*'''Legacy Rule''' (replaced by '''Multiple Resource Check Rule''')


*'''Built-in Rule'''
*'''Built-in Rule'''
*'''Parent Rule'''


  '''Properties:'''
  '''Properties:'''
     '''None'''
     Select one of two option buttons:-
 
      '''( ) Watch industry queue'''
*'''Notes:'''  
          '''Target Object ''<select>''''' - select an industry from the session list
:Apply this rule to your session to make use of the animated clocks. See the forum for code to include in your clock object to work with this rule.
          '''Queue ''<select>''''' - select a product queue from the selected industry
          '''Product ''<select>''''' - select a product from the selected queue
          '''Amount ''<value>''''' - enter a quantity
          Select one of two option buttons:-
            '''( ) Complete when designated queue equals or exceeds required amount'''
            '''( ) Complete when designated queue falls below required amount'''
      '''( ) Watch vehicle'''
          '''Target Object ''<select>''''' - select a rolling stock asset from the session list
          '''Queue ''<select>''''' - select a product queue from the selected rolling stock
          '''Product ''<select>''''' - select a product from the selected queue
          '''Amount ''<value>''''' - enter a quantity
          Select one of two option buttons:-
            '''( ) Complete when designated queue equals or exceeds required amount'''
            '''( ) Complete when designated queue falls below required amount'''


==='''Close Message Popup Rule'''===
*'''Notes:'''
: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''.


Closes open message popups
*'''Related Rules:'''
**'''[[#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


*'''<kuid:447264:1526>'''
*'''Trainz Wiki Links:'''
**'''http://online.ts2009.com/mediaWiki/index.php/Resource_Check_Rule'''


*'''Built-in Rule'''
==='''Resource Verify Rule (fixed)'''===


'''Properties:'''
Executes child rules if a selected industry or vehicle reaches a set commodity level. The rule resets when all child rules have completed.
  '''None'''


*'''Known Issues:'''
*'''<kuid:160293:10060>'''
:This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule


*'''Related Rule:'''
*'''DLS Rule''' by '''trev999
**'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.


*'''Trainz Wiki Links:'''
*'''Parent Rule'''
**'''[[Message Popup Rule Applications]]'''
**'''[[Message Popup Example|Message Popup Examples]]'''


==='''Consist Check Rule'''===
'''Properties:'''
    Select one of two option buttons:-
    '''( ) Watch industry queue'''
      '''Target object ''<click to select>''''' - click to select an industry from the session list.
      '''Product ''<click to select>''''' - click to select an industry product.
      '''Amount ''<value>''''' - enter a quantity for the selected product.
      Select one of two option buttons:-
      '''( ) Complete when designated queue equals or exceeds designated amount'''
      '''( ) Complete when designated queue falls below designated amount'''
    '''( ) Watch vehicle queue'''
      '''Target object ''<click to select>''''' - click to select a rolling stock vehicle from the session list.
      '''Product ''<click to select>''''' - click to select a commodity product.
      '''Amount ''<value>''''' - enter a quantity for the selected product.
      Select one of two option buttons:-
      '''( ) Complete when designated queue equals or exceeds designated amount'''
      '''( ) Complete when designated queue falls below designated amount'''
 
*'''Notes:'''
#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''.
 
*'''Related Rules:'''
**'''[[#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
 
==='''Station Visited Check Rule'''===


Executes child rules when a matching consist is found. The order of the vehicles in the consists is not important.
Executes child rules if specific trains call at set stations or industries


*'''<kuid:-25:1068>'''
*'''<kuid2:60850:89005:3>'''


*'''Built-in Rule'''
*'''Built-in Rule'''
Line 230: Line 309:


  '''Properties:'''
  '''Properties:'''
     '''[Check Box] Enforce strict exclusive testing''' - check to only accept an exact match with no unspecified vehicles in the consist.
     '''Trigger: ''<select>''''' - click to select one of the following
       - leave unchecked to accept any consist that contains the specified vehicles.  
      '''''Never''''' - stopping at the selected industries will never trigger the rule.
     Select one of two option buttons:-
       '''''Once only''''' - the rule is triggered on the first visit only to any one of the selected industries
    '''( ) Rule disabled''' - select to disable the operation of this rule
      '''''Once per industry''''' - the rule is triggered on the first visit to each industry with each individual product
    '''( ) Complete whenever a train matching the description exists''' - When selected, enter the consist description:-
      '''''Once per visit''''' - the rule is triggered on the first visit to each industry regardless of the product
      '''Specific vehicle''' - identify the specific vehicle(s) that will trigger the rule
      '''''Once per vehicle''''' - each vehicle can only trigger the rule once.  
          '''''+''''' - click to add a ''specific'' vehicle from the session list
    '''''<select industry>''''' - select industry or industries from session list
          '''''x''''' - click to remove the ''specific'' vehicle from the rule
     Select one of two option buttons:-
      '''Vehicle types''''' - identify the ''type'' of vehicle(s) that will trigger the rule
      '''( ) click to accept all trains'''
          '''''+''''' - click to add a ''type'' of vehicle from the session list
      '''( ) click to accept trains matching specific criteria'''
          '''''x''''' - click to remove the ''type'' of vehicle from the rule
          Selecting the second option will produce the following selection controls:-        
      '''Drivers''''' - identify the ''driver(s)'' 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 ''driver'' from the session list
            '''''+''''' - click to add a ''specific'' vehicle from the session list
          '''''x''''' - click to remove a ''driver'' from the rule
            '''''x''''' - click to remove the ''specific'' vehicle from the rule
          '''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule
            '''''+''''' - click to add a ''type'' of vehicle from the session list
            '''''x''''' - click to remove the ''type'' of vehicle from the rule
          '''Drivers''''' - identify the ''drivers'' that will trigger the rule
            '''''+''''' - click to add a ''driver'' from the session list
            '''''x''''' - click to remove a ''driver'' from the rule


*'''Known Issues:'''
'''[[#top|Back to Top]]'''
: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.
----
=='''Camera Rules'''==


*'''Trainz Wiki Links:'''
==='''Cinematic Camera Rule'''===
**'''http://online.ts2009.com/mediaWiki/index.php/Consist_Check_Rule'''
**'''[[How to Use Variables in Sessions (Examples)#Example 3: Counting Consist Checks|How to Use Variables in Sessions (Examples): Counting Consist Checks]]'''


==='''ConsistDataHandler Rule'''===
Provides several different cinematic style cameras with animations. Best used at the start of a session.
Use the '''Trackside Camera''' (tracking view) found in the '''Set Camera Rule''' during session play.


Was used by the '''QuickDrive Rule''' to place consists onto a route. Now obsolete.
*'''<kuid2:401543:1166:3>'''


*'''<kuid:401543:1180>'''
*'''Built-in Rule'''


*'''Obsolete Rule''' (function is now built into '''TANE''')  
'''Properties:'''
    '''[Check Box] Lock camera controls for the duration''' - if checked user cannot alter camera view
    '''[Check Box] Prevent train control for duration - if checked user cannot control train
    '''Camera target: ''<click to select>''''' - click to select the object from the session list that will be the camera target
    '''Camera mode:''' - select one of three option buttons:-
      '''( ) Stationary'''
      '''( ) Circle targeted object'''
      '''( ) Move from one point to another (zoom, pan, etc)'''
    '''Initial camera values:'''
      '''[Check Box] Pitch: ''<value>''''' - check to select then click ''value'' to enter a pitch value
      '''[Check Box] Yaw:  ''<value>''''' - check to select then click ''value'' to enter a yaw value
      '''[Check Box] Zoom:  ''<value>''''' - check to select then click ''value'' to enter a zoom value
    '''Total time to animate:  ''<value>''''' - enter an animation time in seconds


*'''Base Rule'''
*'''Notes:'''
:Times are Trainz clock times, not real times


'''Properties:'''
*'''Related Rules:'''
    '''None'''
**'''[[#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
**'''[[#Wait for Camera View Mode Rule|Wait for Camera View Mode Rule]]''' - executes child rules when the camera view is changed


==='''Control Check Rule'''===
==='''Focus Camera Rule'''===


Executes child rules if the train control method has been altered or a specific method has been selected.
Sets the initial camera view and starting vehicle for a session.


*'''<kuid:401543:1191>'''
*'''<kuid2:122381:10014:1>'''


*'''Built-in Rule'''
*'''DLS Rule''' by '''mizi'''
 
*'''Parent Rule'''


  '''Properties:'''
  '''Properties:'''
  '''Execute child rules when:''' - select one of two option buttons:-
    '''Focus camera to:''' - select one of two option buttons
    '''( ) DCC mode is Selected'''
      '''( ) Map object'''
    '''( ) Cab mode is Selected'''
      '''( ) Vehicle'''
  '''Execute child rules:''' - select one of two option buttons:-
    '''Named ''<?????>''''' - enter name of object or vehicle from session list
    '''( ) Every time control method is set'''
    '''Additionally:'''
    '''( ) Once only'''
      '''[Check Box] set view mode to''' - check to select one of four option buttons
          '''( ) Internal view'''
          '''( ) External view'''
          '''( ) Tracking view'''
          '''( ) Roaming view'''
      '''[Check Box] restrict user to manipulate the camera''' - check to set user limits on camera controls
          '''[Check Box] allow internal view'''
          '''[Check Box] allow external view'''
          '''[Check Box] allow tracking view'''
          '''[Check Box] allow roaming view'''
          '''[Check Box] allow change of view mode'''
          '''[Check Box] allow change vehicle in train'''
          '''[Check Box] allow change trains'''
          '''[Check Box] allow adjust camera viewpoint'''
      '''[Check Box] set camera angles''' - check to set the initial camera view point
          '''Yaw (90 = look at front of train): ''<value>'' degrees''' - enter yaw angle
          '''Pitch (-90 = down, 90 = up): ''<value>'' degrees''' - enter pitch angle
          '''Distance from the focused object: ''<value>'' metres''' - enter distance from camera to object


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Control Type Rule|Control Type Rule]]''' - sets the control method
**'''[[#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
**'''[[#Wait for Camera View Mode Rule|Wait for Camera View Mode Rule]]''' - executes child rules when the camera view is changed


==='''Control Type Rule'''===
==='''Set Camera Rule'''===


Sets the control method
Sets the target object and properties of the camera.


*'''<kuid:-16:2030>'''
*'''<kuid:-25:179>'''


*'''Base Rule'''
*'''Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
  '''Current control method is: ''<select>''''' - click to select one of
    '''[Check Box] Set the target object of the camera to:''' - if checked, select one of three option buttons:-
    '''''Easy Mode''''' - DCC (standard keyboard and mouse) control
      '''( ) Vehicle ''<click to select>''''' - select a vehicle from the Session list
    '''''Ask User''''' - let the user decide
      '''( ) Junction ''<click to select>''''' - select a junction from the Session list
    '''''Realistic Mode''''' - Cab controls (on screen levers, throttles, buttons, etc)
      '''( ) Map Object ''<click to select>''''' - select a named map object from the Session list
    '''[Check Box] Change the camera view mode to ''<click to select>''''' - if checked, select one camera view mode from
      '''Cab View'''
      '''External View'''
      '''Tracking View'''
      '''Free Roaming'''
    '''[Check Box] Set the camera flags to enable/disable user access to''' - if checked, select as many of the following check boxes as needed
      '''[Check Box] Internal view mode''' - check to enable, uncheck to disable
      '''[Check Box] External view mode''' - check to enable, uncheck to disable
      '''[Check Box] Tracking view mode''' - check to enable, uncheck to disable
      '''[Check Box] Roaming view mode''' - check to enable, uncheck to disable
      '''[Check Box] View switching''' - check to enable, uncheck to disable
      '''[Check Box] Vehicle view switching''' - check to enable, uncheck to disable
      '''[Check Box] Train view switching''' - check to enable, uncheck to disable
      '''[Check Box] Camera adjustments (pan, zoom, etc)''' - check to enable, uncheck to disable


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Control Check Rule|Control Check Rule]]''' - executes child rules if the train control method changes
**'''[[#Cinematic Camera Rule|Cinematic Camera Rule]]''' - provides several different cinematic style cameras with animations
**'''[[#Focus Camera Rule|Focus Camera Rule]]''' - sets the initial camera view and starting vehicle for a session
**'''[[#Wait for Camera View Mode Rule|Wait for Camera View Mode Rule]]''' - executes child rules when the camera view is changed


==='''Coupler Breakage Check Rule'''===
==='''Wait for Camera View Mode Rule'''===


Executes child rules if there is a coupler breakage
Executes child rules when the camera view is changed to a selected view


*'''<kuid2:447264:1017:1>'''
*'''<kuid:-25:192>'''


*'''Built-in Rule'''
*'''Built-in Rule'''
Line 314: Line 447:


  '''Properties:'''
  '''Properties:'''
     '''None'''
     '''[Check Box] Trigger rule once''' - check to set
 
    '''Wait for the camera to change to the ''<click to select>''''' - select one camera view mode from:-
      '''Cab View'''
      '''External View'''
      '''Tracking View'''
      '''Free Roaming'''
    '''[Check Box] Wait for the camera to target vehicle ''<click to select>''''' - if checked, select a vehicle from the Session list
 
*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Coupler Breakage HUD Rule|Coupler Breakage HUD Rule]]''' - adds a coupler stress and breakage warning to the HUD
**'''[[#Cinematic Camera Rule|Cinematic Camera Rule]]''' - provides several different cinematic style cameras with animations
**'''[[#Set Coupler Masks Rule|Set Coupler Masks Rule]]''' - sets the coupling/decoupling masks on selected vehicles
**'''[[#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
 
'''[[#top|Back to Top]]'''
----
=='''Danger, Derailment and Safety Rules'''==


==='''Coupler Breakage HUD Rule'''===
==='''ATP Speed Limiter Rule'''===


HUD displays warning about coupler stress and breakage
Limits allowable speed over set limit


*'''<kuid:-25:423>'''
*'''<kuid2:321959:1000:1>'''


*'''Built-in Rule'''
*'''Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     Select one of two option buttons:-
     '''Limits the speed to ''<value>'' mph over the set limit''' - enter speed value in mph
      '''( ) Show the Coupler Breakage Display'''
      '''( ) Hide the Coupler Breakage Display'''


*'''Related Rules:'''
'''Related Rules:'''
**'''[[#Coupler Breakage Check Rule|Coupler Breakage Check Rule]]''' - executes child rules if a coupler breaks
    '''[[#AWS Configuration Rule|AWS Configuration Rule]]''' - configures the Trainz implementation of the Automatic Warning System when approaching signals
**'''[[#Set Coupler Masks Rule|Set Coupler Masks Rule]]''' - sets the coupling/decoupling masks on selected vehicles


==='''Custom Script Rule'''===
==='''AWS Configuration Rule'''===


No description
This rule configures the Trainz implementation of the Automatic Warning System when approaching signals


*'''<kuid:447264:1526>'''
*'''<kuid2:60850:89002:3>'''


*'''Built-in Rule'''
*'''Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
  '''None'''
    Select one of three option buttons:-
----
      '''( ) Active'''
'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''
      '''( ) Passive'''
 
      '''( ) Passive with HUD hidden'''
=='''D'''==
    '''[Check Box] Simulate AWS for unfitted cabs?'''
    '''[Check Box] Use modern sound set for unfitted cabs?'''


==='''DestSign Table Rule'''===
==='''Clean Up Derailed Trains Rule'''===


Creates a list of destination names for a destination sign
Cleans up derailed train cars after a set time delay


*'''<kuid2:206816:99004:2>'''
*'''<kuid2:60850:89003:1>'''


*'''Built-in Rule'''
*'''Base Rule'''


  '''Properties:'''
  '''Properties:'''
  '''''<add destination>''''' - enter a destination name to be added to the destination sign roll
    '''Set delay to clean up derailed traincars to'''
  '''''<import destinations from texture-group>''''' - select a list of destination names from session
      '''''<h>'':''' - click to enter the number of hours (0-23) to wait
  '''[Check Box] Enable industries/stations as destination''' - check to set
      '''''<mm>'':''' - click to enter the number of minutes (0-59) to wait
  '''[Check Box] Enable Track Marks as destinations''' - check to set
      '''''<ss>'':''' - click to enter the number of seconds (0-59) to wait
  '''[Check Box] Enable table of destinations''' - check to set
 
*'''Notes:'''
:Time is Trainz clock time, not real time.
 
*'''Related Rules:'''
**'''[[#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


==='''Directional Trigger Check Rule'''===
*'''Trainz Wiki Links:'''
**'''http://online.ts2009.com/mediaWiki/index.php/Clean_up_Derailed_Trains_Rule'''


Executes child rules when a set train enters a set trigger in a set direction. Adds direction to the '''Trigger Check Rule'''.
==='''Coupler Breakage Check Rule'''===


*'''<kuid2:532391:100003:1>'''
Executes child rules if there is a coupler breakage


*'''DLS Rule''' by '''bobhahn'''
*'''<kuid2:447264:1017:1>'''


'''Properties:'''
*'''Built-in Rule'''
    '''[Check Box] Trigger only once '''
 
    '''[Check Box] Wait for child rules to complete even if no trains are present in rule trigger'''
*'''Parent Rule'''
    '''[Check Box] Only activate when the entering vehicle of the train is heading ''<select direction>'' into the trigger''' - select one of two directions:-
      '''''forward'''''
      '''''backward'''''
    '''Triggers List'''
      '''''<add trigger>''''' - select a trigger from the session list
      '''''<delete trigger>''''' - delete a selected trigger from the rule
    Select one of two option buttons:-
      '''( ) click to accept all trains'''
      '''( ) click to accept trains matching specific criteria'''
          Selecting the second option will produce the following selection controls:-
          '''Specific vehicle''' - identify the specific vehicle(s) that will trigger the rule
            '''''+''''' - click to add a ''specific'' vehicle from the session list
            '''''x''''' - click to remove the ''specific'' vehicle from the rule
          '''Vehicle types''''' - identify the ''type'' of vehicle(s) that will trigger the rule
            '''''+''''' - click to add a ''type'' of vehicle from the session list
            '''''x''''' - click to remove the ''type'' of vehicle from the rule
          '''Drivers''''' - identify the ''driver(s)'' that will trigger the rule
            '''''+''''' - click to add a ''driver'' from the session list
            '''''x''''' - click to remove a ''driver'' from the rule


*'''Notes:'''
'''Properties:'''
#This rule works best when used with the '''Directional Trigger''' track object available on the DLS.
    '''None'''
#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.


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Trackside Check Rule|Trackside Check Rule]]''' - executes child rules when activated by a train. Provides different options to the '''Trigger Check Rule'''
**'''[[#Coupler Breakage HUD Rule|Coupler Breakage HUD Rule]]''' - adds a coupler stress and breakage warning to the HUD
**'''[[#Trigger Check Rule|Trigger Check Rule]]''' - executes child rules when a set train enters a set trigger (non-directional)
**'''[[#Set Coupler Masks Rule|Set Coupler Masks Rule]]''' - sets the coupling/decoupling masks on selected vehicles


*'''Trainz Wiki Links:'''
==='''Coupler Breakage HUD Rule'''===
**'''[[How to Control Signals in Sessions#Application 2: Halt Before Clear|How to Control Junctions in Sessions: Halt Before Clear]]'''
**'''[[Message Popup Rule Applications]]'''
**'''[[How to Use Navigation Point Rules (Applications)#Application 3: Wait for Loading to be Completed|How to Use Navigation Point Rules (Applications): Wait for Loading to be Completed]]'''
**'''[[How to Use Track Triggers]]'''
**'''[[How to Use Variables in Sessions (Examples)]]'''


==='''Disable/Enable Industry Rule'''===
HUD displays warning about coupler stress and breakage


Enables/Disables vehicle load/unload for industry
*'''<kuid:-25:423>'''
 
*'''<kuid2:401543:1171:1>'''


*'''Built-in Rule'''
*'''Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
  '''Load/unload ''<Disable/Enable>''''' - click to set to '''Disable''' or '''Enable'''
    Select one of two option buttons:-
  '''Which Industry? ''<select>''''' - click to set Industry from Session List
      '''( ) Show the Coupler Breakage Display'''
  '''Which Vehicles:''' - select one of two option buttons:-
      '''( ) Hide the Coupler Breakage Display'''
      '''( ) Apply to every vehicle in the session'''
 
      '''( ) Apply only to a specific vehicles from Session List'''
*'''Related Rules:'''
**'''[[#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


==='''Disallow AI Rule'''===
==='''Junction Derailment Prevention Rule'''===


Cancels (deletes) all current and waiting AI commands for all drivers
Sets opposing (trailing) junctions ahead of a train to prevent derailments.  Works with both AI and manually driven trains.


*'''<kuid:400048:100603>'''
*'''<kuid2:121843:100282:1>'''


*'''DLS Rule''' by '''callavsg'''
*'''DLS Rule''' by '''pitkin'''


  '''Properties:'''
  '''Properties:'''
  '''None'''
    '''None'''
 
*'''Notes:'''
:This rule will not overrule a junction already locked by another AI train or locked against AI control using the '''Set Junctions Rule'''.


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#AI Start Rule|AI Start Rule]]''' - restarts all halted AI drivers
**'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
**'''[[#AI Stop Rule|AI Stop Rule]]''' - halts all AI drivers
**'''[[#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).


==='''Display Custom HUD Rule'''===
==='''Replace Missing Vehicles Rule'''===


Show or hide the Custom Heads Up Display.
Produces new trains to replace missing vehicles that have been removed from the session by the '''Clean Up Derailed Trains Rule'''


*'''<kuid:-3:10206>'''
*'''<kuid:447264:1214>'''


*'''Base Rule'''
*'''Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''Show or Hide the Custom Heads up Display''' - select one of two option buttons:-
     '''[Check Box] Respawn trains if they are abandoned for 10 minutes'''
      '''( ) Show the Custom Heads up Display'''
    If checked:-
      '''( ) Hide the Custom Heads up Display'''
      Select one of two option buttons:-
          '''( ) Respawn trains at their original locations'''
          '''( ) Respawn trains from portals'''
            '''''<+ Add a new portal>''''' - click to enter the name of a portal, there can be more than one portal.
            Entered portal names that appear in red have not been found in the session


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
**'''[[#Clean Up Derailed Trains Rule|Clean Up Derailed Trains Rule]]''' - cleans up derailed train cars after a set time delay
**'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
**'''[[#Wait for Derailment Rule|Wait for Derailment Rule]]''' - executes child rules when a derailment occurs
**'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers
**'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
**'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
**'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked


*'''Trainz Wiki Links:'''
==='''Safety System Engaged Check Rule'''===
**'''http://online.ts2009.com/mediaWiki/index.php/Display_Custom_HUD_Rule'''


==='''Display HTML Pages Rule'''===
Executes child rules if safety systems are applied.


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'''  
*'''<kuid:447264:1216>'''


*'''<kuid:-25:442>'''
*'''Built-in Rule'''


*'''Legacy Rule''' (replaced by '''Message Popup Rule''')
*'''Parent Rule'''


*'''Base Rule'''
  '''Properties:'''
 
     '''[Check Box] Trigger only once'''
  '''Properties:'''
    '''''<Add Page>''''' - adds the HTML page ''index.html'' from the selected HTML asset
      '''''<index.html>''''' - click to change the page name. The extension ''.html'' is optional
    '''''<Add All>''''' - adds all HTML pages from the session list '''(this appears to be disabled in TANE)'''
    '''''<Delete All>''''' - delete all HTML pages from this property list
     '''[Check Box] Prevent user from exiting browser until all pages viewed'''
    '''[Check Box] Disable closing of browser window by user'''
    '''[Check Box] Disable browser window scrolling'''
    '''[Check Box] Make browser window invisible'''
    '''[Check Box] Set position-Under Construction!!!''' - not implemented
    '''[Check Box] Set size-Under Construction!!!''' - not implemented
    '''Use the page ''<index.html>'' from asset ''<select>'' as the hidden button''' - the link buttons at the bottom of the page will be taken from the selected page in the selected HTML asset


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Close Message Popup Rule|Close Message Popup Rule]]''' - closes a displayed pop-up browser window.
**'''[[#Safety System Isolated Check Rule|Safety System Isolated Check Rule]]''' - executes child rules if safety systems have been isolated
**'''[[#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'''
**'''[[#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.


==='''Display Video Rule'''===
==='''Safety System Isolated Check Rule'''===


Displays a page containing a video clip from a HTML asset in a browser window.
Executes child rules if safety systems are isolated (disengaged).


*'''<kuid:-25:138>'''
*'''<kuid:447264:1217>'''


*'''Built-in Rule'''
*'''Built-in Rule'''
*'''Parent Rule'''


  '''Properties:'''
  '''Properties:'''
     '''Display page ''<index.html>'' of html asset ''<click to select>'' in a new browser window
     '''[Check Box] Trigger only once'''
      '''''index.html''''' - enter the filename of a HTML page in the selected HTML asset. The ''.html'' is optional in the filename.
      '''''<click to select>''''' - select the HTML asset from those installed.
 
*'''Notes:'''
:Video must be in a valid web format.


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Play Sound Rule|Play Sound Rule]]''' - plays a wav sound file
**'''[[#Safety System Engaged Check Rule|Safety System Engaged Check Rule]]''' - executes child rules if safety systems have been engaged


==='''DisplayIndustryStatus Rule (color modified)'''===
==='''Set Coupler Masks Rule'''===


Displays a summary of industry product levels when the "k" key is pressed.
Set the coupling/decoupling  masks on the selected vehicles


*'''<kuid:622415:100001>'''
*'''<kuid:-25:980>'''


*'''DLS Rule''' by '''lockheed02''' and '''marzipan'''
*'''Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''None'''
     '''''<Add vehicle>''''' - click to select a vehicle from the session list
 
    '''''<Add All>''''' - click to add all vehicles in the session list
*'''Notes:'''
    '''''<Delete All>''''' - click to remove all added vehicles from this rule
: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.
      For each selected vehicle:-
      '''Coupling Mask'''
          '''Front''' and '''Back''' - choose for each
            '''''Locked'''''
            '''''Unlocked'''''
      '''Decoupling Mask'''
          '''Front''' and '''Back''' - choose for each
            '''''Locked'''''
            '''''Unlocked'''''
      '''''<Remove>''''' - click to remove this vehicle from the rule


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#ExTrainz Manager Rule - TANE SP2|ExTrainz Manager Rule - TANE SP2]]''' - displays information on consists, industries and products in Driver and Surveyor.
**'''[[#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


==='''Driver Command Check Rule'''===
==='''Signal Passed At Danger Check Rule'''===


Executes child rules if the driver commands match a set list.
Executes child rules if a signal or stop mark is ''Passed at Danger (STOP)''.


*'''<kuid:-25:447>'''
*'''<kuid2:60850:89007:2>'''


*'''Built-in Rule'''
*'''Built-in Rule'''
Line 544: Line 662:


  '''Properties:'''
  '''Properties:'''
  '''[Check Box] Trigger rule once''' - check to allow the rule to execute only once
    '''[Check Box] Trigger only once'''
  '''Driver character to watch the command list of ''<select>''' - select a driver name from the Session List''
  '''Wait for driver character to have a command list that matches this:'''
    '''''<add driver command>''''' - add a driver command from the session list. More commands can be added. Commands can be deleted.
    '''''<add all>''''' - adds ALL driver commands in the session list. Individual commands can be removed.
    '''''<delete all>''''' - deletes all entered driver commands from the session rule


*'''Related Rules:'''
*'''Trainz Wiki Links:'''
**'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
**'''[[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]]
**'''[[#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
==='''Speeding Check Rule'''===
**'''[[#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


*'''Trainz Wiki Links:'''
Executes child rules if player controlled trains are over the local speed limit or over a set (custom) speed
**'''http://online.ts2009.com/mediaWiki/index.php/Driver_Command_Rule'''


==='''Driver Command Rule'''===
*'''<kuid2:60850:89004:3>'''


Specifies which commands will be available for the drivers
*'''Built-in Rule'''


*'''<kuid:-3:10057>'''
*'''Parent Rule'''


*'''Base Rule'''
'''Properties:'''
    Select one of two options to set a speed limit to be observed
      '''( ) Watch for trains travelling above the posted speed limit'''
          '''''<speed value>''''' - click to enter a new overspeed tolerance value
          '''''<speed units>''''' - click to select one from the list:-
            '''''Km/h''''' - Kilometres per hour
            '''''MPH''''' - Miles per hour
            '''''mps''''' - metres per second
      '''( ) Watch for trains travelling above a custom speed'''
          '''''<speed value>''''' - click to enter a new custom speed value
          '''''<speed units>''''' - click to select one from the list:-
            '''''Km/h''''' - Kilometres per hour
            '''''MPH''''' - Miles per hour
            '''''mps''''' - metres per second
            '''Warning: This option is very performance intensive and should only be used in sessions with few trains'''


'''Properties:''':
==='''Vehicle Physics Rule'''===
    For each installed Driver Command:-
    '''[Check Box] ''Name of Driver Command'' and ''Description (if available)''''' - check to make that command available to the drivers


*'''Notes:'''
Overrides the default vehicle physics properties for all vehicles or for those matching set criteria
:Some Driver Commands that have been checked will not appear in the Command Lists for drivers if there is no target for their action. For example:
::The ''Wait For Trigger'' command will not be available to any drivers if there are no triggers set.
::The ''Call At'' command will not be available to any drivers if there are no industry active assets or passenger enabled stations.


*'''Related Rules:'''
*'''<kuid:-25:1052>'''
**'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
**'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
**'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
**'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
**'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
 
==='''Driver Main Menu Options Rule'''===
 
Show/Hide the Driver Main Menu Bar
 
*'''<kuid:-25:448>'''


*'''Built-in Rule'''
*'''Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''''<Show/Hide>'' the Driver Main Menu Bar''' - click '''Show''' or '''Hide''' to select
     Select one of two option buttons:-
 
      '''( ) click to accept all trains'''
==='''Driver Schedule Rule'''===
      '''( ) click to accept trains matching specific criteria'''
 
          Selecting the second option will produce the following selection controls:-
Sets up a list of basic scheduled commands
          '''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
*'''<kuid2:82445:90001:9>'''
            '''''x''''' - click to remove the ''specific'' vehicle from the rule
 
          '''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule
*'''Built-in Rule'''
            '''''+''''' - click to add a ''type'' of vehicle from the session list
            '''''x''''' - click to remove the ''type'' of vehicle from the rule
          '''Drivers''''' - identify the ''drivers'' that will trigger the rule
            '''''+''''' - click to add a ''driver'' from the session list
            '''''x''''' - click to remove a ''driver'' from the rule
    '''Coupler Parameters:'''
      '''Couplers break at ''<value>'' kN expansion force''' - enter force value
      '''Couplers break at when coupling above ''<value>'' kph''' - enter speed value
      '''[Check Box] Show coupler breakage in HUD''' - check to display breakage in on-screen HUD
    '''Wheelslip Parameters:'''
      '''Maximum tractive effort adjusted by ''<value>'' %''' - enter adjustment as a %
      '''Traction is reduced to ''<value>'' % while wheelslipping''' - enter value as a %
      '''Traction boost is ''<value>'' % while sanding''' - enter value as a %
    '''Sway Parameters:'''
      '''Cab sway level is set to ''<value>'' %''' - enter value as a %


'''Properties:'''
==='''Wait for Derailment 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''' 
      '''''>>''''' - click to enter driver commands from those specified in the '''Driver Command Rule'''
    '''Style:''' - select one of four option buttons:-
      '''( ) Classic style: If there is a schedule do not emit a new schedule''' - any currently assigned set of driver commands will not be replaced
      '''( ) Killer style: If there is a schedule clean it and emit a new one''' - replace any currently assigned driver commands with the new commands
      '''( ) Cooperative style: If there is a schedule append the new one''' - add the new driver commands to the end of any existing commands
      '''( ) Active style: Emit a new schedule, only if already a schedule running''' - only add the new commands if commands are currently running


*'''Related Rules:'''
Executes child rules when a derailment occurs
**'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
**'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
**'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
**'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
**'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train


*'''Trainz Wiki Links:'''
*'''<kuid:-25:1053>'''
**'''[[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]]


==='''Driver Setup Rule'''===
*'''Built-in Rule'''


Creates the list of drivers for this session and assign them their orders
*'''Parent Rule'''


*'''<kuid:-16:2025>'''
  '''Properties:'''
 
     '''[Check Box] Trigger derailment watch once''' - check to execute the rule once only
*'''Base Rule'''
 
  '''Properties:'''
     '''''<driver icon>''''' - click to select a new driver from the list of installed and built in drivers
    '''''<loco>''''' - click to select a new locomotive from the session list and assign it to this driver. Locos displayed in red have not been found in the session list
    '''''<driver name>''''' - click to enter a new name for the selected driver
    '''''<driver mode>''''' - click to select one of:-
      '''''Autodetect''''' - the program will detect the driver mode to be used. For example, if driver commands have been entered for this driver
          then the '''AI driver''' mode will be selected
      '''''First Human Player''''' - the driver will wait until he/she has been selected by the player
      '''''AI driver''''' - the AI will be given control even if no commands are present
      '''''Multiplayer Driver''''' - the driver will be assigned to a multiplayer user
    '''''<remove>''''' - this driver will be removed from the rule
    '''''>>''''' - click to enter driver commands from those specified in the '''Driver Command Rule'''
    --> Scroll down to the bottom of the list of entered drivers for more options
  '''''<Add another driver>''''' - click to add another driver
  '''[Check Box] Remove all existing Drivers first'''
  '''[Check Box] Generate new Drivers for empty Trains''' 


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
**'''[[#Clean Up Derailed Trains Rule|Clean Up Derailed Trains Rule]]''' - cleans up derailed train cars after a set time delay
**'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
**'''[[#Replace Missing Vehicles Rule|Replace Missing Vehicles Rule]]''' - creates a replacement train after a derailment
**'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
**'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
**'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train


*'''Trainz Wiki Links:'''
'''[[#top|Back to Top]]'''
**'''http://online.ts2009.com/mediaWiki/index.php/Driver_Setup_Rule'''
----
----
'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''
=='''Driver Rules'''==


=='''E, F, G'''==
==='''AI Start Rule'''===


==='''EIRS Weather Rule NE USA Rule'''===
Restarts all halted AI controlled trains. Drivers will continue with the commands in their driver command list.


Customize random weather rule relative to the North East Region of the United States.
*'''<kuid2:400048:100981:1>'''


*'''<kuid2:487222:1037:3>'''
*'''DLS Rule''' by '''callavsg'''


*'''Built-in Rule'''
'''Properties:'''
    '''None'''
*'''Related Rules:'''
**'''[[#AI Stop Rule|AI Stop Rule]]''' -  halts all AI drivers
**'''[[#Disallow AI Rule|Disallow AI Rule]]''' - cancels all AI driver commands
 
==='''AI Stop Rule'''===
 
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.


'''Properties:'''
*'''<kuid2:400048:100980:1>'''
    '''Season ''<select>''''' - select one of:-
      '''''Summer'''''
      '''''Fall'''''
      '''''Winter'''''
      '''''Spring'''''
    '''Random Changeability (minutes) ''<value>''''' - select one of:-
      '''''2/5/10/15/20/30/45/60''''' - minutes''
    '''Environment Settings ''<select>''''' - select one of:-
      '''''Disable/Enable'''''


*'''Notes:'''
*'''DLS Rule''' by '''callavsg'''
:Minutes are Trainz clock times, not real times


'''Properties:'''
    '''None'''
*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Random Weather Rule v2|Random Weather Rule v2]]''' - randomly changes the weather according to entered parameters
**'''[[#AI Start Rule|AI Start Rule]]''' - restarts all halted AI drivers
**'''[[#Startup Options Rule|Startup Options Rule]]''' - sets the weather conditions at the start of a Session
**'''[[#Disallow AI Rule|Disallow AI Rule]]''' - cancels all AI driver commands
**'''[[#Weather Rule|Weather Rule]]''' - changes the weather conditions during Session play


==='''Enable/Disable Driver Commands Rule'''===
==='''Control Check Rule'''===


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
Executes child rules if the train control method has been altered or a specific method has been selected.


*'''<kuid:-25:480>'''
*'''<kuid:401543:1191>'''


*'''Built-in Rule'''
*'''Built-in Rule'''
*'''Parent Rule'''


  '''Properties:'''
  '''Properties:'''
    '''<Enable/Disable>'' the following driver commands ...''' - click to select '''Enable''' or '''Disable'''
  '''Execute child rules when:''' - select one of two option buttons:-
    For each driver command:-
    '''( ) DCC mode is Selected'''
    '''[Check Box] ''command name''''' - check to enable or disable
    '''( ) Cab mode is Selected'''
    '''[Check Box] ''command name''''' - check to enable or disable
  '''Execute child rules:''' - select one of two option buttons:-
    '''[Check Box] ''command name''''' - check to enable or disable
    '''( ) Every time control method is set'''
    etc
    '''( ) Once only'''
    Select one of two option buttons:-
      '''( ) click to accept all trains'''
      '''( ) click to accept trains matching specific criteria'''
          Selecting the second option will produce the following selection controls:-
          '''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
            '''''+''''' - click to add a ''specific'' vehicle from the session list
            '''''x''''' - click to remove the ''specific'' vehicle from the rule
          '''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule
            '''''+''''' - click to add a ''type'' of vehicle from the session list
            '''''x''''' - click to remove the ''type'' of vehicle from the rule
          '''Drivers''''' - identify the ''drivers'' that will trigger the rule
            '''''+''''' - click to add a ''driver'' from the session list
            '''''x''''' - click to remove a ''driver'' from the rule


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
**'''[[#Control Type Rule|Control Type Rule]]''' - sets the control method
**'''[[#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
**'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train


*'''Trainz Wiki Links:'''
==='''Control Type Rule'''===
**'''http://online.ts2009.com/mediaWiki/index.php/Enable/Disable_Driver_Commands_Rule'''


==='''End Session Rule'''===
Sets the control method


End the Session with a fade out.
*'''<kuid:-16:2030>'''


*'''<kuid:-25:482>'''
*'''Base Rule'''


*'''Built-in Rule'''
'''Properties:'''
  '''Current control method is: ''<select>''''' - click to select one of
    '''''Easy Mode''''' - DCC (standard keyboard and mouse) control
    '''''Ask User''''' - let the user decide
    '''''Realistic Mode''''' - Cab controls (on screen levers, throttles, buttons, etc)
 
*'''Related Rules:'''
**'''[[#Control Check Rule|Control Check Rule]]''' - executes child rules if the train control method changes
 
==='''Disallow AI Rule'''===
 
Cancels (deletes) all current and waiting AI commands for all drivers
 
*'''<kuid:400048:100603>'''
 
*'''DLS Rule''' by '''callavsg'''


  '''Properties:'''
  '''Properties:'''
    '''Fade out over ''<value>'' seconds''' - enter number of seconds for fade out.
  '''None'''


*'''Notes:'''
*'''Related Rules:'''
:Seconds are Trainz clock time, not real time.
**'''[[#AI Start Rule|AI Start Rule]]''' -  restarts all halted AI drivers
**'''[[#AI Stop Rule|AI Stop Rule]]''' -  halts all AI drivers


*'''Related Rules:'''
==='''Driver Command Check Rule'''===
**'''[[#Session Complete Rule|Session Complete Rule]]''' - set the session to a percentage of completion


==='''ExTrainz Manager Rule - TANE SP2'''===
Executes child rules if the driver commands match a set list.


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.
*'''<kuid:-25:447>'''


*'''<kuid:160293:10029>'''
*'''Built-in Rule'''


*'''DLS Rule''' by '''trev999'''
*'''Parent Rule'''


  '''Properties:'''
  '''Properties:'''
    '''Diagnostic mode is ''<On/Off>''''' - click to select ''On'' or ''Off''. When set ''On'' diagnostic messages will be added to the Trainz Log file.
  '''[Check Box] Trigger rule once''' - check to allow the rule to execute only once
    '''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.
  '''Driver character to watch the command list of ''<select>''' - select a driver name from the Session List''
    '''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.
  '''Wait for driver character to have a command list that matches this:'''
    '''Search only rolling stock already in session ''<Yes/No>''''' - click to select ''Yes'' or ''No''. When set to ''Yes'' only those rolling stock assets
    '''''<add driver command>''''' - add a driver command from the session list. More commands can be added. Commands can be deleted.
      installed in the session can be searched.
    '''''<add all>''''' - adds ALL driver commands in the session list. Individual commands can be removed.
    '''Graphic colours: ''<When Red, the industry does not require service/When Green, the industry does not require service>''''' - click to switch
    '''''<delete all>''''' - deletes all entered driver commands from the session rule
      between the two colour options.
    '''Industry page size: ''<value>''''' - enter the number of industries to be displayed in the Industry List window (maximum 250).
    '''The following industries are excluded: ''<Add an industry to be excluded>''''' - name can be complete (e.g. "Coal Mine 2")
      which will exclude that specific industry from the management list, or partial (e.g. "Coal") which will exclude all
      industries with the word "Coal" in their names. Entries are not case sensitive.
      Once industries have been excluded, additional commands will appear for each excluded industry:-
      '''''<delete> <industry name begins with/class name begins with> <name>''''' - click ''delete'' to remove this entry.
          - click ''industry name begins with/class name begins with'' to select between the two (see ''notes'' below).
          - click ''name'' to edit the name.


*'''Notes:'''
*'''Related Rules:'''
#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.
**'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
#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.
**'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
#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.
**'''[[#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 Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train


*'''Known Issues:'''
*'''Trainz Wiki Links:'''
:This rule is NOT compatible with all industries.
**'''http://online.ts2009.com/mediaWiki/index.php/Driver_Command_Rule'''


*'''Related Rules:'''
==='''Driver Command Rule'''===
**'''[[#DisplayIndustryStatus Rule (color modified)|DisplayIndustryStatus Rule (color modified)]]''' - displays information on industry product levels.


==='''Fade In/Out Rule'''===
Specifies which commands will be available for the drivers


Fade in or out within seconds, using specified color and opacity values.
*'''<kuid:-3:10057>'''


*'''<kuid2:190611:200000:2>'''
*'''Base Rule'''


*'''Built-in Rule'''
'''Properties:''':
    For each installed Driver Command:-
    '''[Check Box] ''Name of Driver Command'' and ''Description (if available)''''' - check to make that command available to the drivers


'''Properties:'''
*'''Notes:'''
    '''Red percentage:             ''<value>''''' - enter the final % of red (0 = none, 100 = maximum)
: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:
    '''Green percentage:           ''<value>''''' - enter the final % of green
::The ''Wait For Trigger'' command will not be available to any drivers if there are no triggers set.
    '''Blue percentage:           ''<value>''''' - enter the final % of blue
::The ''Call At'' command will not be available to any drivers if there are no industry active assets or passenger enabled stations.
    '''Alpha percentage (opacity): ''<value>''''' - enter the final % of opacity (0 = invisible, 100 = solid)
    '''Fading duration:           ''<value>''''' - enter the number of seconds required for the fade
    '''''<help>''''' - click to bring up help instructions


*'''Notes:'''
*'''Related Rules:'''
:Seconds are Trainz clock time, not real time.
**'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
**'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
**'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
**'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
**'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train


==='''Flash HUD Icon Rule'''===
==='''Driver Main Menu Options Rule'''===


Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.
Show/Hide the Driver Main Menu Bar


*'''<kuid:-25:968>'''
*'''<kuid:-25:448>'''


*'''Built-in Rule'''
*'''Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
    Select one of two option buttons:-
     '''''<Show/Hide>'' the Driver Main Menu Bar''' - click '''Show''' or '''Hide''' to select
     '''( ) 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).
==='''Driver Schedule Rule'''===
      Available HUD panels are (select one):-
 
          '''Bottom Right Menu'''
Sets up a list of basic scheduled commands
          '''Camera Controls'''
          '''DCC Controls'''
          '''Driver Main Menu'''
      Available icons will depend on the HUD panel selected.
    '''( ) ''<Start/Stop>'' flashing the ''<click to select>'' icon on the ''<click to select>'' HUD panel'''
      TIP: Select the HUD panel first (the second ''<click to select>'' link).
      Available HUD panels are (select one):-
          '''Bottom Right Menu'''
          '''Camera Controls'''
          '''DCC Controls'''
          '''Driver Main Menu'''
      Available icons will depend on the HUD panel selected.


*'''Related Rules:'''
*'''<kuid2:82445:90001:9>'''
**'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
**'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
**'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers
**'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
**'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
**'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked


==='''Focus Camera Rule'''===
*'''Built-in Rule'''


Sets the initial camera view and starting vehicle for a session.
'''Properties:'''
    '''Driver Schedule Assigned to ''name of driver <icon>''''' - click '''icon''' to select a driver from those assigned in the '''Driver Setup Rule'''
    '''Next commands, will be executed''' 
      '''''>>''''' - click to enter driver commands from those specified in the '''Driver Command Rule'''
    '''Style:''' - select one of four option buttons:-
      '''( ) Classic style: If there is a schedule do not emit a new schedule''' - any currently assigned set of driver commands will not be replaced
      '''( ) Killer style: If there is a schedule clean it and emit a new one''' - replace any currently assigned driver commands with the new commands
      '''( ) Cooperative style: If there is a schedule append the new one''' - add the new driver commands to the end of any existing commands
      '''( ) Active style: Emit a new schedule, only if already a schedule running''' - only add the new commands if commands are currently running


*'''<kuid2:122381:10014:1>'''
*'''Related Rules:'''
 
**'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
*'''DLS Rule''' by '''mizi'''
**'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
**'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
**'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
**'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train


'''Properties:'''
*'''Trainz Wiki Links:'''
    '''Focus camera to:''' - select one of two option buttons
**'''[[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]]
      '''( ) Map object'''
      '''( ) Vehicle'''
    '''Named ''<?????>''''' - enter name of object or vehicle from session list
    '''Additionally:'''
      '''[Check Box] set view mode to''' - check to select one of four option buttons
          '''( ) Internal view'''
          '''( ) External view'''
          '''( ) Tracking view'''
          '''( ) Roaming view'''
      '''[Check Box] restrict user to manipulate the camera''' - check to set user limits on camera controls
          '''[Check Box] allow internal view'''
          '''[Check Box] allow external view'''
          '''[Check Box] allow tracking view'''
          '''[Check Box] allow roaming view'''
          '''[Check Box] allow change of view mode'''
          '''[Check Box] allow change vehicle in train'''
          '''[Check Box] allow change trains'''
          '''[Check Box] allow adjust camera viewpoint'''
      '''[Check Box] set camera angles''' - check to set the initial camera view point
          '''Yaw (90 = look at front of train): ''<value>'' degrees''' - enter yaw angle
          '''Pitch (-90 = down, 90 = up): ''<value>'' degrees''' - enter pitch angle
          '''Distance from the focused object: ''<value>'' metres''' - enter distance from camera to object


*'''Related Rules:'''
==='''Driver Setup Rule'''===
**'''[[#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
**'''[[#Wait for Camera View Mode Rule|Wait for Camera View Mode Rule]]''' - executes child rules when the camera view is changed


==='''Generic TreeNode Debug Window Rule'''===
Creates the list of drivers for this session and assign them their orders


No description.
*'''<kuid:-16:2025>'''
 
*'''<kuid:30501:1042>'''


*'''Base Rule'''
*'''Base Rule'''


  '''Properties:'''
  '''Properties:'''
     '''None'''
     '''''<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
'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''
    '''''<driver name>''''' - click to enter a new name for the selected driver
    '''''<driver mode>''''' - click to select one of:-
      '''''Autodetect''''' - the program will detect the driver mode to be used. For example, if driver commands have been entered for this driver
          then the '''AI driver''' mode will be selected
      '''''First Human Player''''' - the driver will wait until he/she has been selected by the player
      '''''AI driver''''' - the AI will be given control even if no commands are present
      '''''Multiplayer Driver''''' - the driver will be assigned to a multiplayer user
    '''''<remove>''''' - this driver will be removed from the rule
    '''''>>''''' - click to enter driver commands from those specified in the '''Driver Command Rule'''
    --> Scroll down to the bottom of the list of entered drivers for more options
  '''''<Add another driver>''''' - click to add another driver
  '''[Check Box] Remove all existing Drivers first'''
  '''[Check Box] Generate new Drivers for empty Trains'''


=='''H, I, J'''==
*'''Related Rules:'''
**'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
**'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
**'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
**'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
**'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train


==='''Hide Product Overlays Rule'''===
*'''Trainz Wiki Links:'''
**'''http://online.ts2009.com/mediaWiki/index.php/Driver_Setup_Rule'''
 
==='''Enable/Disable Driver Commands Rule'''===


Hides the commodity or product bar graphs that appear on active industries
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


*'''<kuid:400048:100970>'''
*'''<kuid:-25:480>'''


*'''DLS Rule''' by '''callavsg'''
*'''Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
  '''None'''
    '''<Enable/Disable>'' the following driver commands ...''' - click to select '''Enable''' or '''Disable'''
    For each driver command:-
    '''[Check Box] ''command name''''' - check to enable or disable
    '''[Check Box] ''command name''''' - check to enable or disable
    '''[Check Box] ''command name''''' - check to enable or disable
    etc
    Select one of two option buttons:-
      '''( ) click to accept all trains'''
      '''( ) click to accept trains matching specific criteria'''
          Selecting the second option will produce the following selection controls:-
          '''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
            '''''+''''' - click to add a ''specific'' vehicle from the session list
            '''''x''''' - click to remove the ''specific'' vehicle from the rule
          '''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule
            '''''+''''' - click to add a ''type'' of vehicle from the session list
            '''''x''''' - click to remove the ''type'' of vehicle from the rule
          '''Drivers''''' - identify the ''drivers'' that will trigger the rule
            '''''+''''' - click to add a ''driver'' from the session list
            '''''x''''' - click to remove a ''driver'' from the rule
 
*'''Related Rules:'''
**'''[[#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
**'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train


==='''InputTable Rule'''===
*'''Trainz Wiki Links:'''
**'''http://online.ts2009.com/mediaWiki/index.php/Enable/Disable_Driver_Commands_Rule'''


Creates a list of message names to be used for various purposes including passing data to '''Driver Commands'''
==='''JTG Correct Vehicle Lights'''===


*'''<kuid2:131986:1012:1>'''
Corrects the brightness of vehicle headlights. Now obsolete.


*'''Built-in Rule'''
*'''<kuid2:478657:999103:1>'''


'''Properties:'''
*'''DLS Rule''' by '''jtg-trainz'''
    '''''<add>''''' - click to add a new entry to the table
    Each new entry will require an input message
      '''''<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:-
          '''turntable,name_of_turntable,number_of_connecting_roads''' - the first entry must be the word ''turntable'' in lower case.
            ''name_of_turntable'' is the name of the turntable,
            ''number_of_connecting_roads'' is the number of tracks connecting to the turntable
      For the '''WaitUntilTime''' driver command the message must be formatted as:-
          '''time,hour,minute''' - the first entry must be the word ''time'' in lower case,
            ''hour'' must be from 0 to 23,
            ''minute'' must be from 0 to 59.
      For the '''WaitUntilSVariable''' driver command the message must be formatted as:-
          '''svar,svar_name,svar_condition,value''' - the first entry must be the word ''svar'' in lower case,
            ''svar_name'' is the name of the session variable,
            ''svar_condition'' is an equality (eg eq for equal, gt for greater than, etc)
            ''value'' is an integer value to be compared to the session variable.
    Each entry in the table will be followed by the commands:-
      '''''cp''''' - click to copy this entry to a new entry
      '''''up''''' - click to move this entry up one level
      '''''dn''''' - click to move this entry down one level
      '''''rm''''' - click to remove this entry from the table


==='''Interlocking Tower Configure Path Rule'''===
*''' Obsolete Rule''' (function is now built into TANE Driver Additional Tools Menu)


Alters settings on an interlocking tower path
'''Properties:'''
    '''None'''


*'''<kuid:401543:3205>'''
==='''Quick Portal Manager Standard Edition Rule (SP2 and later)'''===


*'''Base Rule'''
Manages portals and adds flexible timetables.


'''Properties:'''
*'''<kuid2:61392:5011:45>'''
  '''Interlocking Tower ''<select>''''' - to set Name and Objects


*'''Related Rules:'''
*'''DLS Rule''' by '''pguy'''
**'''[[#Interlocking Tower Path Selection UI Rule|Interlocking Tower Path Selection UI Rule]]''' - automatically reacts to messages from Interlocking Towers and displays a path selection dialog to the player.
**'''[[#Interlocking Tower Set Path Rule|Interlocking Tower Set Path Rule]]''' - sets the state of an interlocking tower path for a train
**'''[[#Interlocking Tower Enhanced Manager Rule (SP2 and later)|Interlocking Tower Enhanced Manager Rule (SP2 and later)]]''' - more management and control options for interlocking towers.
 
==='''Interlocking Tower Path Selection UI Rule'''===
 
Will automatically react to messages from Interlocking Towers and display a path selection dialog to the player. Disable by removing rule from session
 
*'''<kuid:401543:3203>'''
 
*'''Base Rule'''


  '''Properties:'''
  '''Properties:'''
  '''[Checkbox] Show path activation message in Driver'''
    '''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.
 
    '''''<Copy rule data to Clipboard>''''' - click to copy the currently entered data to a special clipboard area used by the rules created by '''pguy'''.
*'''Related Rules:'''
      This is NOT the standard OS clipboard.
**'''[[#Interlocking Tower Configure Path Rule|Interlocking Tower Configure Path Rule]]''' - alters the settings on an interlocking tower path
    '''''<Paste rule data from Clipboard>''''' - if data is held in the special clipboard area, then click to paste that data into the rule.
**'''[[#Interlocking Tower Set Path Rule|Interlocking Tower Set Path Rule]]''' - sets the state of an interlocking tower path for a train
      This is NOT the standard OS clipboard.
**'''[[#Interlocking Tower Enhanced Manager Rule (SP2 and later)|Interlocking Tower Enhanced Manager Rule (SP2 and later)]]''' - more management and control options for interlocking towers.
    '''[Check Box] This rule is enabled''' - check to activate (enable) the rule.
 
    '''[Check Box] 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.
==='''Interlocking Tower Set Path Rule'''===
    '''[Check Box] 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:
Will set the state of an interlocking tower path for a train
      '''''<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.
*'''<kuid:401543:3204>'''
    '''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.
*'''Base Rule'''
    '''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.


'''Properties:'''
*'''Related Rules:'''
  '''Interlocking Tower ''<select>''''' - to set Name and Objects
**'''[[#MissionCode Manager Rule (SP2 and later)|MissionCode Manager Rule (SP2 and later)]]''' - creates and manages '''Mission Codes''' for '''Interlocking Tower''' paths
**'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - create driver HUDs


*'''Related Rules:'''
*'''Trainz Wiki Links:'''
**'''[[#Interlocking Tower Configure Path Rule|Interlocking Tower Configure Path Rule]]''' - alters the settings on an interlocking tower path
**'''http://online.ts2009.com/mediaWiki/index.php/Quick_Portal_Manager'''
**'''[[#Interlocking Tower Path Selection UI Rule|Interlocking Tower Path Selection UI Rule]]''' - automatically reacts to messages from Interlocking Towers and displays a path selection dialog to the player.
**'''[[#Interlocking Tower Enhanced Manager Rule (SP2 and later)|Interlocking Tower Enhanced Manager Rule (SP2 and later)]]''' - more management and control options for interlocking towers.


==='''Interlocking Tower Enhanced Manager Rule (SP2 and later)'''===
==='''QuickDrive Rule'''===


Provides more management and control options for interlocking towers.
Changes the Session settings.


*'''<kuid2:61392:8130:41>'''
*'''<kuid:401543:1184>'''


*'''DLS Rule''' by '''pguy'''
*'''Base Rule'''


  '''Properties:'''
  '''Properties:'''
    '''''<towers>''''' - click to select interlocking towers from the session list
  '''Open QuickDrive window when session is started          [Check Box]''' - check to set
      '''''<do full check again>''''' - click to run an error check on all interlocking towers
  '''Set time to ''<hours:minutes>'' with a rate of ''<speed x>''''' - set start time and rate at which time advances
      '''List of all available interlocking towers''' - for each tower:-
  '''Enable gameplay Session Mode                            [Check Box]''' - check to set. Gameplay mode restricts the players options
          '''''<view details>''''' - click to view and edit the tower properties
  '''Enable in game help by default                          [Check Box]''' - check to allow help options to be displayed
          '''''<copy from>''''' - click to copy properties from another tower selected from the session list
  '''Set the default Control method to:''' - select one of two option buttons:-
    '''''<debug log>''''' - click to set the debug log properties
      '''( ) Easy Mode'''
 
      '''( ) Realistic Mode'''
*'''Related Rules:'''
      '''[Check Box] Prevent player from changing this setting''' - check to set
**'''[[#Interlocking Tower Configure Path Rule|Interlocking Tower Configure Path Rule]]''' - alters the settings on an interlocking tower path
  '''Realistic mode requires achievement: ''<text>'' in asset ''<asset name>''''' - enter achievement name and select an asset from Aurans Achievements
**'''[[#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.
  '''Set the default derailment realism to:''' - select one of three option buttons:-
**'''[[#Interlocking Tower Set Path Rule|Interlocking Tower Set Path Rule]]''' - sets the state of an interlocking tower path for a train
      '''( ) None'''
      '''( ) Arcade'''
      '''( ) Realistic'''
      '''[Check Box] Prevent player from changing this setting''' - check to set
  '''Set the default units to:''' - select one of three option buttons:-
      '''( ) Imperial'''
      '''( ) Metric'''
      '''( ) Default'''


*'''Trainz Wiki Links:'''
*'''Trainz Wiki Links:'''
**'''http://online.ts2009.com/mediaWiki/index.php/Enhanced_Interlocking_Tower_Manager_Rule'''
**'''http://online.ts2009.com/mediaWiki/index.php/QuickDrive_Rule'''


==='''JTG Correct Vehicle Lights'''===
==='''Wait for Driver On/Off Train Rule'''===


Corrects the brightness of vehicle headlights. Now obsolete.
Executes child rules when a driver gets on or off a train


*'''<kuid2:478657:999103:1>'''
*'''<kuid:-25:953>'''


*'''DLS Rule''' by '''jtg-trainz'''
*'''Built-in Rule'''


*''' Obsolete Rule''' (function is now built into TANE Driver Additional Tools Menu)
*'''Parent Rule'''


  '''Properties:'''
  '''Properties:'''
    '''None'''
  '''[Check Box] Trigger Rule Once''' - click to set''
  '''Wait for a driver character to get ''<On/Off>''''' a train that matches the following criteria''' - select '''On''' or '''Off'''
  Select one of two option buttons:-
    '''( ) click to accept all trains'''
    '''( ) click to accept trains matching specific criteria'''
        Selecting the second option will produce the following selection controls:-
        '''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
          '''''+''''' - click to add a ''specific'' vehicle from the session list
          '''''x''''' - click to remove the ''specific'' vehicle from the rule
        '''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule
          '''''+''''' - click to add a ''type'' of vehicle from the session list
          '''''x''''' - click to remove the ''type'' of vehicle from the rule
        '''Drivers''''' - identify the ''drivers'' that will trigger the rule
          '''''+''''' - click to add a ''driver'' from the session list
          '''''x''''' - click to remove a ''driver'' from the rule
 
*'''Related Rules:'''
**'''[[#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'''===


==='''Junction Derailment Prevention Rule'''===
Executes child rules when a specific driver or vehicle is locally owned. If the driver/vehicle becomes unowned again the child rules are paused


Sets opposing (trailing) junctions ahead of a train to prevent derailments.  Works with both AI and manually driven trains.
*'''<kuid2:401543:1173:1>'''


*'''<kuid2:121843:100282:1>'''
*'''Built-in Rule'''


*'''DLS Rule''' by '''pitkin'''
*'''Parent Rule'''


  '''Properties:'''
  '''Properties:'''
    '''None'''
  '''Assets Ownership:''' - select one of two option buttons:-
    '''( ) Wait for ownership of a specific Driver'''
    '''( ) Wait for ownership of Driver'''
  '''Driver or Vehicle ''<select>''''' - choose from session list


*'''Notes:'''  
*'''Related Rules:'''
:This rule will not overrule a junction already locked by another AI train or locked against AI control using the '''Set Junctions Rule'''.
**'''[[#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


*'''Related Rules:'''
'''[[#top|Back to Top]]'''
**'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
**'''[[#Set Cleared Junctions Rule|Set Cleared Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.
**'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).
----
----
'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''
=='''HUD (Heads Up Display) Rules'''==


=='''K, L, M'''==
==='''Cab Controls HUD Rule'''===


==='''Lock All Junctions Rule'''===
Was used to provide the HUD controls for the cabin view. Now obsolete.


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.
*'''<kuid:-16:287428>'''


*'''<kuid:400048:100971>'''
*'''Base Rule'''


*'''DLS Rule''' by '''callavsg'''
*'''Obsolete Rule''' (function is now built into TANE)


  '''Properties:'''
  '''Properties:'''
     '''None'''
     '''None'''


*'''Notes:'''
==='''Coupler Breakage HUD Rule'''===
:Individual junctions can still be set, locked and unlocked by using the '''Set Junction Rule'''


*'''Related Rules:'''
HUD displays warning about coupler stress and breakage
**'''[[#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).


==='''MaxPermittedSpeed Rule'''===
*'''<kuid:-25:423>'''
 
Sets the maximum permitted speed of locomotives under AI control
 
*'''<kuid2:60850:89000:7>'''


*'''Built-in Rule'''
*'''Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''None'''
     Select one of two option buttons:-
      '''( ) Show the Coupler Breakage Display'''
      '''( ) Hide the Coupler Breakage Display'''


*'''Notes:'''
*'''Related Rules:'''
:This rule cannot be configured from the Session Rules list. It must be configured in the '''config.txt''' file of each locomotive. Instructions with an example are shown in the rule Properties
**'''[[#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


==='''mc Display Custom HUD V2 Rule (SP2 and later)'''===
==='''Display Custom HUD Rule'''===


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)'''
Show or hide the Custom Heads Up Display.


*'''<kuid2:61392:1072:10>'''
*'''<kuid:-3:10206>'''


*'''Legacy Rule''' (replaced by '''Quick CustomHUD Manager Rule (SP2 and later)''')
*'''Base Rule'''
 
*'''DLS Rule''' by '''pguy'''


  '''Properties:'''
  '''Properties:'''
    '''Show or Hide the Custom Heads up Display''' - select one of two option buttons:-
    '''Show or Hide the Custom Heads up Display''' - select one of two option buttons:-
    '''( ) Show the Custom Heads up Display'''
      '''( ) Show the Custom Heads up Display'''
    '''( ) Hide the Custom Heads up Display'''
      '''( ) Hide the Custom Heads up Display'''


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#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.
**'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
**'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers
**'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers
**'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
**'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
Line 1,094: Line 1,193:
**'''[[#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


==='''Message Popup Rule'''===
*'''Trainz Wiki Links:'''
**'''http://online.ts2009.com/mediaWiki/index.php/Display_Custom_HUD_Rule'''
 
==='''Flash HUD Icon 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.
Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.


*'''<kuid:-25:1003>'''
*'''<kuid:-25:968>'''


*'''Built-in Rule'''
*'''Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''[Check Box] Pause game while message is displayed''' - stops the game until this message is closed
     Select one of two option buttons:-
    '''[Check Box] Close previous popup windows''' - closes any Message Popups currently displayed before this message is shown
    '''( ) Flash the ''<click to select>'' icon on the ''<click to select>'' HUD panel for a period of ''<value>'' seconds'''
    '''Message location ''<Top Left/Top Right/Bottom Left/Bottom Right>''''' - select one to position the browser window on the screen
      TIP: Select the HUD panel first (the second ''<click to select>'' link).
    '''Message Source:''' - select one of three option buttons:-
       Available HUD panels are (select one):-
      '''( ) Custom text''' - the simplest and easiest option
           '''Bottom Right Menu'''
          '''Icon ''<Click here to set>''''' - (optional) shows a list of message icons. Select one to be displayed with the message
           '''Camera Controls'''
          '''Icon ''<Clear icon>''''' - clears any currently displayed message icon
           '''DCC Controls'''
          '''Custom text box''' Enter text to be displayed. You will be limited to about 6 lines of text.
           '''Driver Main Menu'''
              For longer messages or to include graphics, use the '''A predefined HTML page''' option.
      Available icons will depend on the HUD panel selected.
          '''''<HTML Wave>''''' - (optional) select the name of the HTML asset from the list shown that contains the wave file to be played.
    '''( ) ''<Start/Stop>'' flashing the ''<click to select>'' icon on the ''<click to select>'' HUD panel'''
          '''''<Wave Name>''''' - (optional) enter the name of a wave (.wav) sound file to be played.
      TIP: Select the HUD panel first (the second ''<click to select>'' link).
              The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension ".wav" is optional
      Available HUD panels are (select one):-
          '''[Check Box] Autoplay Wave:''' - plays the .wav sound file as soon as message is displayed.
           '''Bottom Right Menu'''
              If unchecked the sound will not be played.
           '''Camera Controls'''
       '''( ) A predefined HTML page''' - requires a working knowledge of HTML
          '''DCC Controls'''
           '''''<HTML Asset>''''' - select the name of the HTML asset that contains the required HTML page from the list shown.
          '''Driver Main Menu'''
           '''''<HTML Page>''''' - enter the filename of the HTML page to be displayed. The page must be in the HTML asset identified above.
      Available icons will depend on the HUD panel selected.
              Filename is not case sensitive. Extension ".html" is optional.
           '''''<HTML Wave>''''' - (optional) select the name of the HTML file containing the wave file to be played.
              The page must be in the HTML asset identified above. Filename is not case sensitive. Extension ".html" is optional.
          '''''<Wave Name>''''' - (optional) enter the name of a wave (.wav) sound file to be played.
              The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension ".wav" is optional
           '''[Check Box] Autoplay Wave:''' - plays the .wav sound file as soon as message is displayed.
            If unchecked sound will not be played.
      '''( ) A predefined string-table entry from a HTML asset'''
          '''''<HTML Asset>''''' - select the name of the HTML asset from those installed that contains the required string-table.
          '''''<String Table Token>''''' - enter the "tag name" of the text in the string-table of the HTML assets '''config.txt''' file.
          '''''<HTML Wave>''''' - (optional) select the name of the HTML file containing the wave file to be played.  
              The page must be in the HTML asset identified above. Filename is not case sensitive. Extension ".html" is optional.
           '''''<Wave Name>''''' - (optional) enter the name of a wave (.wav) sound file to be played.
              The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension ".wav" is optional
           '''[Check Box] Autoplay Wave:''' - plays the .wav sound file as soon as message is displayed.
              If unchecked sound will not be played.
 
*'''Known Issues:'''
: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.


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Close Message Popup Rule|Close Message Popup Rule]]''' - closes a displayed pop-up browser window.
**'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
**'''[[#Display HTML Pages Rule|Display HTML Pages Rule]]''' - display listed HTML files in order as a navigable sequence of pages.
**'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
**'''[[#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.
**'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers
**'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
**'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
**'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked


*'''Trainz Wiki Links:'''
==='''mc Display Custom HUD V2 Rule (SP2 and later)'''===
**'''[[How to Create a HTML Asset]]'''
**'''[[Message Popup Rule Applications|Message Popup Applications]]'''
**'''[[Message Popup Example|Message Popup Examples]]'''


==='''Minimap Options Rule'''===
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)'''


Sets the display options for the minimap.
*'''<kuid2:61392:1072:10>'''


*'''<kuid:-25:636>'''
*'''Legacy Rule''' (replaced by '''Quick CustomHUD Manager Rule (SP2 and later)''')


*'''Built-in Rule'''
*'''DLS Rule''' by '''pguy'''


  '''Properties:''' ''Default values - all checked''
  '''Properties:'''
    '''[Check Box] Map Textures'''
    '''Show or Hide the Custom Heads up Display''' - select one of two option buttons:-
    '''[Check Box] Gradients'''
    '''( ) Show the Custom Heads up Display'''
    '''[Check Box] Junctions'''
    '''( ) Hide the Custom Heads up Display'''
    '''[Check Box] Signals'''
    '''[Check Box] Triggers'''
    '''[Check Box] Markers'''
    '''[Check Box] Trackside Labels'''
    '''[Check Box] Terrain Objects'''
    '''[Check Box] Industrial Names'''
    '''[Check Box] Named Objects'''
    '''[Check Box] Consists'''


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Show/Hide Minimap Rule|Show/Hide Minimap Rule]]''' - shows the minimap window in Driver.
**'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
**'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
**'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers
**'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
**'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
**'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked


==='''MissionCode Manager Rule (SP2 and later)'''===
==='''Quick CustomHud Manager Rule (SP2 and later)'''===


Enables the addition, editing and management of Mission Codes used to auto select paths in '''Interlocking Towers'''.
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)'''


*'''<kuid2:61392:8200:50>'''
*'''<kuid2:61392:5020:47>'''


*'''DLS Rule''' by '''pguy'''
*'''DLS Rule''' by '''pguy'''


ENTRY UNDER CONSTRUCTION
'''Properties:'''
    '''''<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.
    '''''<Paste rule data from Clipboard>''''' - if data is held in the special clipboard area, then click to paste that data into the selected HUD.
      This is NOT the standard OS clipboard.
    '''Current HUD Parameters'''
      '''HUD to select: ''<HUD name>''''' - click to select a HUD from those available. One or two default HUDs will be supplied.
      '''''new HUD''''' - click to create a new HUD display with default properties. You will be required to enter a name for the new HUD
      '''''clone HUD''''' - click to create a new HUD using the properties of the currently selected HUD. You will be required to enter a name for the new HUD
      '''''copy HUD''''' - copies (overwrites) the currently selected HUD with the properties of another HUD. You will be required to enter the name of the HUD to be copied
    For new, cloned or copied HUDs, additional commands will be shown:
      '''''rename HUD''''' - rename the selected HUD. You will be required to enter a new name for the HUD
      '''''delete HUD''''' - delete the currently displayed HUD
    In '''Driver Mode''' an additional command will be shown:
      '''''Assign hud to current train''''' - click to assign the currently selected HUD to the currently selected driver
    '''[Check Box] hud is displayed (on)''' - check to display HUD in '''Driver Mode'''
    '''hud items nb entries max: ''<value>''''' - enter the maximum number of items to be displayed in the HUD. Maximum is 30.
    '''hud view limit: ''<value>''''' - enter the maximum look-ahead distance in metres for the HUD. Minimum value is 1000, maximum value is 10000.
    '''[Check Box] 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:
      '''[Check Box] ''HUD property''''' - check to add this property to the HUD


*'''Trainz Wiki Links:'''
*'''Notes:'''
**'''http://online.ts2009.com/mediaWiki/index.php/MissionCodes_Manager'''
: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.
 
*'''Related Rules:'''
**'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
**'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
**'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
**'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
**'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
**'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked


==='''MissionCode Stops and Timetable Manager Rule (SP2 and later)'''===
==='''Show/Hide HUD Panel Rule'''===


Enables the creation, editing and management of stop zones and timetables for trains following a path defined using mission codes.
Shows or hides a HUD panel.


*'''<kuid2:61392:8300:50>'''
*'''<kuid:-25:1047>'''


*'''DLS Rule''' by '''pguy'''
*'''Built-in Rule'''


ENTRY UNDER CONSTRUCTION
'''Properties:'''
    '''''<Show/Hide>'' the ''<click to select>'' HUD panel''' - select '''''Show''''' or '''''Hide''''' and then select the HUD panel


*'''Trainz Wiki Links:'''
*'''Related Rules:'''
**'''http://online.ts2009.com/mediaWiki/index.php/Mission_Code_Stops_and_TimeTables_Manager'''
**'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
**'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
**'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
**'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers
**'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
**'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked


==='''Multiplayer Rule'''===
==='''Variable Show Rule'''===


Enables the session to be taken online in a Multiplayer environment.
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.


*'''<kuid:447264:1045>'''
*'''<kuid:-25:971>'''


*'''Built-in Rule'''
*'''Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
    '''Suggested maximum number of players for this session ''<value>''''' - enter a number
  '''[Check Box] Add'''
    '''Maximum number of drivers per player ''<value>''''' - enter a number
      '''''<variable-name>''''' - enter variable-name to add to HUD. Variable-name is case sensitive.
    '''Players are permitted to claim drivers            [Check Box]''' - check to allow players to select a driver
      '''''<label>''''' - (optional) enter a short label to be displayed on the HUD in front of the variable value.
    '''Players can see each other's driver orders        [Check Box]''' - check to allow players to view orders for other players
  '''[Check Box] Remove'''
    '''Automatically target an available train on clients [Check Box]''' - automatically assign a driver to each player
      '''''<variable-name>''''' - enter variable-name to remove from HUD. Variable-name is case sensitive.
 
*'''Related Rules:'''
**'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
**'''[[#Quick Session Variables Rule|Quick Session Variables Rule]]''' - allows the editing of session variables.
**'''[[#Variable Check Rule|Variable Check Rule]]''' - executes child rules according to the value of a specified variable.
**'''[[#Variable Modify Rule|Variable Modify Rule]]''' - changes the value of a specified variable.
**'''[[#Variable Modify Continuous Rule|Variable Modify Continuous Rule]]''' - continuously changes the value of a specified variable.
**'''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.
 
*'''Trainz Wiki Links:'''
**'''[[How to Use Variables in Sessions (Examples)]]


==='''Multiple Junction Alignment Check Rule'''===
==='''Wait for Click on HUD Icon Rule'''===


Executes child rules if specific junctions are set.
Executes child rules when the user clicks on a selected HUD icon


*'''<kuid:-25:168>'''
*'''<kuid:-25:951> <kuid:-25:970>''' - two versions built-in with different kuids, both have the same properties


*'''Built-in Rule'''
*'''Built-in Rule'''
Line 1,226: Line 1,351:


  '''Properties:'''
  '''Properties:'''
     '''Wait until ''<selection>''''' - select from:-
     '''[Check Box] Trigger Once'''
      '''any one''' - any of the junctions in the rule list (below) is set correctly
     '''HUD Panel ''<Click>''''' - click choose from list:-
      '''all''' - ALL of the junctions in the rule list are set correctly
       '''Bottom Right Menu'''
     '''''<Add junction>''''' - click to select a junction from the session list
      '''Camera Controls'''
    '''''<Add all>''''' - click to select ALL junctions in the session list
      '''DCC Controls'''
    '''''<Delete all>''''' - click to delete ALL selected junctions from the rule list
    '''Icon ''<Click>''''' - click to choose from list. Selections depends on HUD Panel chosen
      For each selected junction:-
 
       '''''<setting>''''' - click to select one switch direction from:-
          '''Left'''
          '''Right'''
          '''Center'''
          '''Any'''
      '''''<remove>''''' - to delete this junction from the rule list
 
*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
**'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
**'''[[#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.
**'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
**'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).
**'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
**'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers
**'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
**'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.


*'''Trainz Wiki Links:'''
'''[[#top|Back to Top]]'''
**'''[[How to Control Junctions in Sessions]]'''
----
=='''Industry Rules'''==


==='''Multiple Resource Check Rule'''===
==='''Advanced Industry Load Configuration Rule'''===


Executes child rules if industries or vehicles reach set commodity levels. This rule replaces the older '''Resource Check Rule'''
Locks train controls when loading/unloading at an industry, overrides time settings for begin load and begin unload operations


*'''<kuid:-25:656>'''
*'''<kuid:30501:100007>'''


*'''Built-in Rule'''
*'''Base Rule'''


*'''Parent Rule'''
'''Properties:'''
    '''Target object ''<select>''''' - select industry object from session list
    '''[Check Box] Lock the train's controls during a stopped load/unload operation''' - check to disable driver controls while train is stopped and loading/unloading
    '''[Check Box] Override 'begin load' and 'begin unload' durations to ''<value>'' seconds''' - if checked enter number of seconds to override


'''Properties:'''
*'''Notes:'''
    '''<Product Level>''' - click to select a product test from two choices:-
:Times are Trainz clock time, not real time
      '''''Reach/Exceed''''' - sets an upper limit for the resources being monitored.
          For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon reaches or exceeds a specified level.
          The initial level in the object must be below the set upper limit.
      '''''Fall below''''' - sets a lower limit for the resources being monitored.
          For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon falls below a specified level.
          The initial level in the object must be above the set lower limit.
          To test when a resource level reaches zero (i.e. is empty) set the lower limit to a very low value but not zero as the level can never fall below zero.
    '''''<value>''''' - enter required quantity value
    '''''<select>''''' - select a product from session list of products
    '''''<Add object>''''' - click to select a source or target object. Multiple objects and their queues can be added to the rule.
      ALL the entered products must reach/exceed or fall below the specified value for the rule to be triggered.
      For each object:-
          '''''<Object>''''' - click to select session active industry or product enabled rail vehicle
          '''''<Queue>''''' - select product queue (there may be only one available)
          '''''<Remove>''''' - removes the object and its product queue from the rule


*'''Notes:'''
==='''Disable/Enable Industry Rule'''===
: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''.


*'''Related Rules:'''
Enables/Disables vehicle load/unload for industry
**'''[[#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


*'''Trainz Wiki Links:'''
*'''<kuid2:401543:1171:1>'''
**'''[[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]]'''
----
'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''


=='''N, O'''==
*'''Built-in Rule'''


==='''Navigation Display Rule'''===
'''Properties:'''
  '''Load/unload ''<Disable/Enable>''''' - click to set to '''Disable''' or '''Enable'''
  '''Which Industry? ''<select>''''' - click to set Industry from Session List
  '''Which Vehicles:''' - select one of two option buttons:-
      '''( ) Apply to every vehicle in the session'''
      '''( ) Apply only to a specific vehicles from Session List'''


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.
==='''DisplayIndustryStatus Rule (color modified)'''===


*'''<kuid2:401543:1161:1>'''
Displays a summary of industry product levels when the "k" key is pressed.


*'''Base Rule'''
*'''<kuid:622415:100001>'''
 
*'''DLS Rule''' by '''lockheed02''' and '''marzipan'''


  '''Properties:'''
  '''Properties:'''
     '''Unique set ID: ''<click here to set>''''' - enter a unique name for the navigation set. Name must be in lowercase and have no spaces.
     '''None'''
    '''Train (optional): ''<click here to set>''''' - select a rolling stock asset from the session list shown.
 
    Select one of three option buttons:-
*'''Notes:'''
    '''( ) All points must be completed in sequence:'''
: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.
      - the first uncompleted navigation point will be shown and must be completed next.
      - the next point (if any) will also be shown partly transparent.
    '''( ) Points will be completed in sequence, but can be skipped:'''
      - navigation points can be skipped but must be completed in order.
      - you cannot go back to complete a missed point.
    '''( ) All points must be completed, but in any order:'''
      - all uncompleted navigation points will be shown.
      - you may complete them in any order.
  For each navigation point:
      '''''<Click here to set>''''' - select an item (trigger, trackmark, track object, rolling stock) from the session list to become the navigation point.
      '''''<Display text>''''' - enter a text message to display with the navigation point. You are limited to 25 characters.
      '''Icon ''<icon list>''''' - select an icon for the navigation point.
      '''''<Style>''''' - click to select one from three choices
        '''''Automatic''''' - the navigation point will be completed as soon as the consist reaches the point.
        '''''Manual''''' - the navigation point must be set as complete by using the '''Navigation point complete rule''' or the '''Navigation set clear rule'''.
            The '''Manual''' style option allows you to execute other rules (e.g. consist check, wait, etc) before completing the navigation point.
        '''''Require Stop''''' - the navigation point will be completed when the consist comes to a complete stop on the point.


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Navigation Set Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.
**'''[[#ExTrainz Manager Rule - TANE SP2|ExTrainz Manager Rule - TANE SP2]]''' - displays information on consists, industries and products in Driver and Surveyor.
**'''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set has completed or is incomplete.
**'''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
**'''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.
**'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed


*'''Trainz Wiki Links:'''
==='''ExTrainz Manager Rule - TANE SP2'''===
**'''[[How to Use Navigation Point Rules (Applications)]]'''
**'''[[How to Use Navigation Point Rules]]'''


==='''Navigation Point Complete Rule'''===
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.


Manually completes a navigation point in a set
*'''<kuid:160293:10029>'''


*'''<kuid:401543:1167>'''
*'''DLS Rule''' by '''trev999'''


*'''Base Rule'''
'''Properties:'''
    '''Diagnostic mode is ''<On/Off>''''' - click to select ''On'' or ''Off''. When set ''On'' diagnostic messages will be added to the Trainz Log file.
    '''Turn on message overlay ''<Yes/No>''''' - click to select ''Yes'' or ''No''. When set to ''Yes'' the message overlay (lower left of screen) will be active.
    '''Show rolling stock in Driver mode ''<Yes/No>''''' - click to select ''Yes'' or ''No''. When set to ''Yes'' rolling stock can be searched in Driver.
    '''Search only rolling stock already in session ''<Yes/No>''''' - click to select ''Yes'' or ''No''. When set to ''Yes'' only those rolling stock assets
      installed in the session can be searched.
    '''Graphic colours: ''<When Red, the industry does not require service/When Green, the industry does not require service>''''' - click to switch
      between the two colour options.
    '''Industry page size: ''<value>''''' - enter the number of industries to be displayed in the Industry List window (maximum 250).
    '''The following industries are excluded: ''<Add an industry to be excluded>''''' - name can be complete (e.g. "Coal Mine 2")
      which will exclude that specific industry from the management list, or partial (e.g. "Coal") which will exclude all
      industries with the word "Coal" in their names. Entries are not case sensitive.
      Once industries have been excluded, additional commands will appear for each excluded industry:-
      '''''<delete> <industry name begins with/class name begins with> <name>''''' - click ''delete'' to remove this entry.
          - click ''industry name begins with/class name begins with'' to select between the two (see ''notes'' below).
          - click ''name'' to edit the name.


'''Properties:'''
*'''Notes:'''
    '''Mark navigation point ''<click here to set>''''' - enter the navigation point number to be completed
#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.
    '''complete in set ''<click here to set>''''' - enter the unique name for the navigation set created using the '''Navigation Display Rule'''.
#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.
        Name must be in lowercase and have no spaces.
#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.


*'''Known Issues:'''
*'''Known Issues:'''
:The rule will '''NOT''' check to see if the named navigation set and point exists or not.
:This rule is NOT compatible with all industries.


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
**'''[[#DisplayIndustryStatus Rule (color modified)|DisplayIndustryStatus Rule (color modified)]]''' - displays information on industry product levels.
**'''[[#Navigation Set Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.
**'''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set has completed or is incomplete.
**'''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
**'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed


*'''Trainz Wiki Links:'''
==='''Multiple Resource Check Rule'''===
**'''[[How to Use Navigation Point Rules (Applications)]]'''
**'''[[How to Use Navigation Point Rules]]'''


==='''Navigation Set Check Rule'''===
Executes child rules if industries or vehicles reach set commodity levels. This rule replaces the older '''Resource Check Rule'''  


Executes child rules if a navigation set created with the '''Navigation Display Rule''' is complete (or incomplete).
*'''<kuid:-25:656>'''


*'''<kuid:401543:1165>'''
*'''Built-in Rule'''
 
*'''Base Rule'''


*'''Parent Rule'''
*'''Parent Rule'''


  '''Properties:'''
  '''Properties:'''
     '''Checks if navigation point set ''<name>'':''' - enter the unique name for the navigation set created using the '''Navigation Display Rule'''.
     '''<Product Level>''' - click to select a product test from two choices:-
        Name must be in lowercase and have no spaces.
      '''''Reach/Exceed''''' - sets an upper limit for the resources being monitored.
    '''is ''<Complete/Incomplete>''''' - click to select one
          For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon reaches or exceeds a specified level.
          The initial level in the object must be below the set upper limit.
      '''''Fall below''''' - sets a lower limit for the resources being monitored.
          For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon falls below a specified level.
          The initial level in the object must be above the set lower limit.
          To test when a resource level reaches zero (i.e. is empty) set the lower limit to a very low value but not zero as the level can never fall below zero.
    '''''<value>''''' - enter required quantity value
    '''''<select>''''' - select a product from session list of products
    '''''<Add object>''''' - click to select a source or target object. Multiple objects and their queues can be added to the rule.  
      ALL the entered products must reach/exceed or fall below the specified value for the rule to be triggered.  
      For each object:-
          '''''<Object>''''' - click to select session active industry or product enabled rail vehicle
          '''''<Queue>''''' - select product queue (there may be only one available)
          '''''<Remove>''''' - removes the object and its product queue from the rule


*'''Known Issues:'''
*'''Notes:'''
:The rule will '''NOT''' check to see if the named navigation set exists or not.
: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''.


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
**'''[[#Resource Check Rule|Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
**'''[[#Navigation Set Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.
**'''[[#Resource Verify Rule (fixed)|Resource Verify Rule (fixed)]]''' - executes child rules when a set resource (commodity) level is reached
**'''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
**'''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.
**'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed


*'''Trainz Wiki Links:'''
*'''Trainz Wiki Links:'''
**'''[[How to Use Navigation Point Rules (Applications)]]'''
**'''[[How to Use Navigation Point Rules (Applications)#Application 3: Wait for Loading to be Completed|How to Use Navigation Point Rules (Applications): Wait for Loading to be Completed]]'''
**'''[[How to Use Navigation Point Rules]]'''


==='''Navigation Set Clear Rule'''===
==='''Power Station Rule'''===


Clears a navigation set removing any uncompleted navigation points
Sets up a Power Station and its electricity consumers


*'''<kuid:401543:1164>'''
*'''<kuid:-25:746>'''


*'''Base Rule'''
*'''Base Rule'''


  '''Properties:'''
  '''Properties:'''
     '''''<Click here to set>''''' - enter the unique name for the navigation set created using the '''Navigation Display Rule'''.
     '''Power station ''<select>''''' - select a Power Station from the session list.
        Name must be in lowercase and have no spaces.
    '''Consumers:'''
      '''''<add object>''''' - add power consumers from the session list


*'''Known Issues:'''
==='''Resource Check Rule'''===
:The rule will '''NOT''' check to see if the named navigation set exists or not.


*'''Related Rules:'''
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'''
**'''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
**'''[[#Navigation Set Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.
**'''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set has completed or is incomplete.
**'''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.
**'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed


*'''Trainz Wiki Links:'''
*'''<kuid:-25:1067>'''
**'''[[How to Use Navigation Point Rules (Applications)]]'''
**'''[[How to Use Navigation Point Rules]]'''


==='''Navigation Set Hide/Show Rule'''===
*'''Legacy Rule''' (replaced by '''Multiple Resource Check Rule''')


Shows and hides navigation sets. You can have multiple sets visible and hidden at the same time.
*'''Built-in Rule'''


*'''<kuid:401543:1163>'''
*'''Parent Rule'''
 
*'''Base rule'''


  '''Properties:'''
  '''Properties:'''
     '''''<visibility>''''' - click to select one
     Select one of two option buttons:-
      '''Hide''' - select to make the navigation set invisible
      '''( ) Watch industry queue'''
      '''Show''' - select to make the navigation set visible
          '''Target Object ''<select>''''' - select an industry from the session list
    '''''<click here to set>''''' - enter the unique name for the navigation set created using the '''Navigation Display Rule'''.
          '''Queue ''<select>''''' - select a product queue from the selected industry
        Name must be in lowercase and have no spaces.
          '''Product ''<select>''''' - select a product from the selected queue
          '''Amount ''<value>''''' - enter a quantity
          Select one of two option buttons:-
            '''( ) Complete when designated queue equals or exceeds required amount'''
            '''( ) Complete when designated queue falls below required amount'''
      '''( ) Watch vehicle'''
          '''Target Object ''<select>''''' - select a rolling stock asset from the session list
          '''Queue ''<select>''''' - select a product queue from the selected rolling stock
          '''Product ''<select>''''' - select a product from the selected queue
          '''Amount ''<value>''''' - enter a quantity
          Select one of two option buttons:-
            '''( ) Complete when designated queue equals or exceeds required amount'''
            '''( ) Complete when designated queue falls below required amount'''


*'''Known Issues:'''
*'''Notes:'''
:The rule will '''NOT''' check to see if the named navigation set exists or not.
: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''.


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
**'''[[#Multiple Resource Check Rule|Multiple Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
**'''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set has completed or is incomplete.
**'''[[#Resource Verify Rule (fixed)|Resource Verify Rule (fixed)]]''' - executes child rules when a set resource (commodity) level is reached
**'''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
**'''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.
**'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed


*'''Trainz Wiki Links:'''
*'''Trainz Wiki Links:'''
**'''[[How to Use Navigation Point Rules (Applications)]]'''
**'''http://online.ts2009.com/mediaWiki/index.php/Resource_Check_Rule'''
**'''[[How to Use Navigation Point Rules]]'''


==='''Objective Add Rule'''===
==='''Resource Verify Rule (fixed)'''===


Sets up a game Objective with ID and display Name
Executes child rules if a selected industry or vehicle reaches a set commodity level. The rule resets when all child rules have completed.


*'''<kuid:401543:2001>'''
*'''<kuid:160293:10060>'''


*'''Base Rule'''
*'''DLS Rule''' by '''trev999
 
'''Properties:'''
    '''Priority ''<Select>''''' - select one of:-
      '''''Above Normal'''''
      '''''Below Normal'''''
      '''''Normal'''''
      '''''Optional'''''
      '''''Urgent'''''
    '''Completion Target Number ''<value>''''' - to set Completion Target Number
    '''Icon ''<select>''''' - to select Icon from list
    '''Display Name ''<enter>''''' - to insert Name
    '''Unique Objective ID ''<enter>''''' - enter a unique objective ID
    '''Custom Message ''<Text Box>''''' - insert typed message in text area
 
*'''Related Rules:'''
**'''[[#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 Check Rule'''===
 
Executes child rules if an objective created with the '''Objective Add Rule''' is complete.
 
*'''<kuid:401543:2003>'''
 
*'''Base Rule'''


*'''Parent Rule'''
*'''Parent Rule'''


  '''Properties:'''
  '''Properties:'''
     '''Unique Objective ID ''<value>''''' - enter the unique ID created with the '''Objective Add Rule'''  
     Select one of two option buttons:-
     '''Mode ''<select>''''' - select one of three:-
    '''( ) Watch industry queue'''
       '''''Wait for completion'''''
      '''Target object ''<click to select>''''' - click to select an industry from the session list.
       '''''Wait for failure'''''
      '''Product ''<click to select>''''' - click to select an industry product.
       '''''Wait for progress'''''
      '''Amount ''<value>''''' - enter a quantity for the selected product.
      Select one of two option buttons:-
      '''( ) Complete when designated queue equals or exceeds designated amount'''
      '''( ) Complete when designated queue falls below designated amount'''
     '''( ) Watch vehicle queue'''
      '''Target object ''<click to select>''''' - click to select a rolling stock vehicle from the session list.
       '''Product ''<click to select>''''' - click to select a commodity product.
       '''Amount ''<value>''''' - enter a quantity for the selected product.
      Select one of two option buttons:-
      '''( ) Complete when designated queue equals or exceeds designated amount'''
       '''( ) Complete when designated queue falls below designated amount'''
 
*'''Notes:'''
#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''.


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Objective Add Rule|Objective Add Rule]]''' - sets up a game objective
**'''[[#Multiple Resource Check Rule|Multiple Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
**'''[[#Objective Update Rule|Objective Update Rule]]''' - changes the progress of a game objective
**'''[[#Resource Check Rule|Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
 
==='''Station Visited Check Rule'''===


==='''Objective Update Rule'''===
Executes child rules if specific trains call at set stations or industries


Changes progress of an objective outcome created with the '''Objective Add Rule''' according to Property choices
*'''<kuid2:60850:89005:3>'''


*'''<kuid:401543:2002>'''
*'''Built-in Rule'''


*'''Base Rule'''
*'''Parent Rule'''


  '''Properties:'''
  '''Properties:'''
     '''Unique Objective ID ''<value>''''' - enter the unique ID created with the '''Objective Add Rule'''  
     '''Trigger: ''<select>''''' - click to select one of the following
     '''Mode ''<select>''''' - select one from the following options
      '''''Never''''' - stopping at the selected industries will never trigger the rule.
      '''''Decrement progress'''''
      '''''Once only''''' - the rule is triggered on the first visit only to any one of the selected industries
      '''''Increment progress'''''
      '''''Once per industry''''' - the rule is triggered on the first visit to each industry with each individual product
      '''''Reset Objective'''''
      '''''Once per visit''''' - the rule is triggered on the first visit to each industry regardless of the product
      '''''Set objects as complete'''''
      '''''Once per vehicle''''' - each vehicle can only trigger the rule once.
      '''''Set objects as failed'''''
     '''''<select industry>''''' - select industry or industries from session list
      '''''Set progress'''''
    Select one of two option buttons:-
      '''''Set progress only if greater'''''
      '''( ) click to accept all trains'''
    '''Amount ''<value>''''' - click to enter a value
      '''( ) click to accept trains matching specific criteria'''
          Selecting the second option will produce the following selection controls:-         
          '''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
            '''''+''''' - click to add a ''specific'' vehicle from the session list
            '''''x''''' - click to remove the ''specific'' vehicle from the rule
          '''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule
            '''''+''''' - click to add a ''type'' of vehicle from the session list
            '''''x''''' - click to remove the ''type'' of vehicle from the rule
          '''Drivers''''' - identify the ''drivers'' that will trigger the rule
            '''''+''''' - click to add a ''driver'' from the session list
            '''''x''''' - click to remove a ''driver'' from the rule


*'''Related Rules:'''
'''[[#top|Back to Top]]'''
**'''[[#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
=='''Interlocking Tower, Junction and Signal Rules'''==


==='''Ordered List Rule'''===
==='''Interlocking Tower Configure Path Rule'''===


Executes child rules in order once this rule starts
Alters settings on an interlocking tower path


*'''<kuid:-25:171>'''
*'''<kuid:401543:3205>'''


*'''Built-in Rule'''
*'''Base Rule'''  


*'''Parent Rule'''
'''Properties:'''
  '''Interlocking Tower ''<select>''''' - to set Name and Objects


'''Properties:'''
*'''Related Rules:'''
    Select one of two option buttons:-
**'''[[#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.
      '''( ) This process will repeat ''<value>'' time(s)''' - enter the number of times this rule is to be repeated
**'''[[#Interlocking Tower Set Path Rule|Interlocking Tower Set Path Rule]]''' - sets the state of an interlocking tower path for a train
      '''( ) This process will repeat forever'''
**'''[[#Interlocking Tower Enhanced Manager Rule (SP2 and later)|Interlocking Tower Enhanced Manager Rule (SP2 and later)]]''' - more management and control options for interlocking towers.


*'''Known Issues:'''
==='''Interlocking Tower Path Selection UI Rule'''===
:Some child rules will force a "wait" until certain conditions have been met (e.g. a mouse click or a set time has passed). These rules will delay the completion of any following child rules in the '''Ordered List Rule'''. If possible, place these rules last in the Ordered List.
::For example: The '''Message Popup Rule''' will wait until it is closed before allowing the next child rule to be executed.


*'''Related Rules:'''
Will automatically react to messages from Interlocking Towers and display a path selection dialog to the player. Disable by removing rule from session
**'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child on the second run, etc
**'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule
**'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously
**'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously


*'''Trainz Wiki Links:'''
*'''<kuid:401543:3203>'''
**'''http://online.ts2009.com/mediaWiki/index.php/Ordered_List'''
**'''[[How to Use Parent and Child Rules]]'''
----
'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''


=='''P, Q'''==
*'''Base Rule'''


==='''Play Sound Rule'''===
'''Properties:'''
  '''[Checkbox] Show path activation message in Driver'''


Plays a wav sound file.
*'''Related Rules:'''
**'''[[#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 Enhanced Manager Rule (SP2 and later)|Interlocking Tower Enhanced Manager Rule (SP2 and later)]]''' - more management and control options for interlocking towers.


*'''<kuid:-25:1045>'''
==='''Interlocking Tower Set Path Rule'''===


*'''Built-in Rule'''
Will set the state of an interlocking tower path for a train


'''Properties:'''
*'''<kuid:401543:3204>'''
    '''Default HTML ''<Click>''''' - click to to enter Sound File Name
    '''HTML Assets ''<Click>''''' - click to select HTML asset
    '''Rule Completes ''<Click>''''' -  to select one of:-
      '''sound has just started'''
      '''sound has finished playing'''
 
*'''Related Rules:'''
**'''[[#Display Video Rule|Display Video Rule]]''' - displays a page containing a video clip from a HTML asset in a browser window
 
==='''Power Station Rule'''===
 
Sets up a Power Station and its electricity consumers
 
*'''<kuid:-25:746>'''


*'''Base Rule'''
*'''Base Rule'''


  '''Properties:'''
  '''Properties:'''
    '''Power station ''<select>''''' - select a Power Station from the session list.
  '''Interlocking Tower ''<select>''''' - to set Name and Objects
    '''Consumers:'''
      '''''<add object>''''' - add power consumers from the session list


==='''Progressive List Rule'''===
*'''Related Rules:'''
**'''[[#Interlocking Tower Configure Path Rule|Interlocking Tower Configure Path Rule]]''' - alters the settings on an interlocking tower path
**'''[[#Interlocking Tower Path Selection UI Rule|Interlocking Tower Path Selection UI Rule]]''' - automatically reacts to messages from Interlocking Towers and displays a path selection dialog to the player.
**'''[[#Interlocking Tower Enhanced Manager Rule (SP2 and later)|Interlocking Tower Enhanced Manager Rule (SP2 and later)]]''' - more management and control options for interlocking towers.


Executes the first child rule on the first run, the second child on the second run, the third child on the third run, etc.
==='''Interlocking Tower Enhanced Manager Rule (SP2 and later)'''===


*'''<kuid:-25:754>'''
Provides more management and control options for interlocking towers.


*'''Built-in Rule'''
*'''<kuid2:61392:8130:41>'''


*'''Parent Rule'''
*'''DLS Rule''' by '''pguy'''


  '''Properties:'''
  '''Properties:'''
  '''After last child has been executed ...'''
    '''''<towers>''''' - click to select interlocking towers from the session list
  '''''<successive runs will do nothing/the first child is chosen again>''''' - click to select one
      '''''<do full check again>''''' - click to run an error check on all interlocking towers
      '''List of all available interlocking towers''' - for each tower:-
          '''''<view details>''''' - click to view and edit the tower properties
          '''''<copy from>''''' - click to copy properties from another tower selected from the session list
    '''''<debug log>''''' - click to set the debug log properties


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order
**'''[[#Interlocking Tower Configure Path Rule|Interlocking Tower Configure Path Rule]]''' - alters the settings on an interlocking tower path
**'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule
**'''[[#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.
**'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously
**'''[[#Interlocking Tower Set Path Rule|Interlocking Tower Set Path Rule]]''' - sets the state of an interlocking tower path for a train
**'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously


*'''Trainz Wiki Links:'''
*'''Trainz Wiki Links:'''
**'''http://online.ts2009.com/mediaWiki/index.php/Progressive_List'''
**'''http://online.ts2009.com/mediaWiki/index.php/Enhanced_Interlocking_Tower_Manager_Rule'''
**'''[[How to Use Parent and Child Rules]]'''


==='''Quick CustomHud Manager Rule (SP2 and later)'''===
==='''Junction Derailment Prevention Rule'''===


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)'''
Sets opposing (trailing) junctions ahead of a train to prevent derailments. Works with both AI and manually driven trains.


*'''<kuid2:61392:5020:47>'''
*'''<kuid2:121843:100282:1>'''


*'''DLS Rule''' by '''pguy'''
*'''DLS Rule''' by '''pitkin'''


  '''Properties:'''
  '''Properties:'''
     '''''<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'''.
     '''None'''
      This is NOT the standard OS clipboard.
 
    '''''<Paste rule data from Clipboard>''''' - if data is held in the special clipboard area, then click to paste that data into the selected HUD.
*'''Notes:'''  
      This is NOT the standard OS clipboard.
:This rule will not overrule a junction already locked by another AI train or locked against AI control using the '''Set Junctions Rule'''.
    '''Current HUD Parameters'''
 
      '''HUD to select: ''<HUD name>''''' - click to select a HUD from those available. One or two default HUDs will be supplied.
*'''Related Rules:'''
      '''''new HUD''''' - click to create a new HUD display with default properties. You will be required to enter a name for the new HUD
**'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
      '''''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
**'''[[#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.
      '''''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
**'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).
    For new, cloned or copied HUDs, additional commands will be shown:
 
      '''''rename HUD''''' - rename the selected HUD. You will be required to enter a new name for the HUD
==='''Lock All Junctions Rule'''===
      '''''delete HUD''''' - delete the currently displayed HUD
    In '''Driver Mode''' an additional command will be shown:
      '''''Assign hud to current train''''' - click to assign the currently selected HUD to the currently selected driver
    '''[Check Box] hud is displayed (on)''' - check to display HUD in '''Driver Mode'''
    '''hud items nb entries max: ''<value>''''' - enter the maximum number of items to be displayed in the HUD. Maximum is 30.
    '''hud view limit: ''<value>''''' - enter the maximum look-ahead distance in metres for the HUD. Minimum value is 1000, maximum value is 10000.
    '''[Check Box] 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:
      '''[Check Box] ''HUD property''''' - check to add this property to the HUD


*'''Notes:'''
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.
: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.


*'''Related Rules:'''
*'''<kuid:400048:100971>'''
**'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
**'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
**'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
**'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
**'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
**'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked


==='''Quick Portal Manager Standard Edition Rule (SP2 and later)'''===
*'''DLS Rule''' by '''callavsg'''


Manages portals and adds flexible timetables.
'''Properties:'''
    '''None'''


*'''<kuid2:61392:5011:45>'''
*'''Notes:'''
:Individual junctions can still be set, locked and unlocked by using the '''Set Junction Rule'''


*'''DLS Rule''' by '''pguy'''
*'''Related Rules:'''
**'''[[#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).


'''Properties:'''
==='''MissionCode Manager Rule (SP2 and later)'''===
    '''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.
    '''''<Copy rule data to Clipboard>''''' - click to copy the currently entered data to a special clipboard area used by the rules created by '''pguy'''.
      This 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.
    '''[Check Box] This rule is enabled''' - check to activate (enable) the rule.
    '''[Check Box] 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.
    '''[Check Box] 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.


*'''Related Rules:'''
Enables the addition, editing and management of Mission Codes used to auto select paths in '''Interlocking Towers'''.
**'''[[#MissionCode Manager Rule (SP2 and later)|MissionCode Manager Rule (SP2 and later)]]''' - creates and manages '''Mission Codes''' for '''Interlocking Tower''' paths
 
**'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - create driver HUDs
*'''<kuid2:61392:8200:50>'''
 
*'''DLS Rule''' by '''pguy'''
 
ENTRY UNDER CONSTRUCTION


*'''Trainz Wiki Links:'''
*'''Trainz Wiki Links:'''
**'''http://online.ts2009.com/mediaWiki/index.php/Quick_Portal_Manager'''
**'''http://online.ts2009.com/mediaWiki/index.php/MissionCodes_Manager'''


==='''Quick Session Variables Rule'''===
==='''MissionCode Stops and Timetable Manager Rule (SP2 and later)'''===


Allows the editing of session variables
Enables the creation, editing and management of stop zones and timetables for trains following a path defined using mission codes.


*'''<kuid2:61392:5003:30>'''
*'''<kuid2:61392:8300:50>'''


*'''DLS Rule''' by '''pguy'''
*'''DLS Rule''' by '''pguy'''
ENTRY UNDER CONSTRUCTION
*'''Trainz Wiki Links:'''
**'''http://online.ts2009.com/mediaWiki/index.php/Mission_Code_Stops_and_TimeTables_Manager'''
==='''Multiple Junction Alignment Check Rule'''===
Executes child rules if specific junctions are set.
*'''<kuid:-25:168>'''
*'''Built-in Rule'''
*'''Parent Rule'''


  '''Properties:'''
  '''Properties:'''
     '''''<local>''''' - click to edit local variables
     '''Wait until ''<selection>''''' - select from:-
      '''''<add new session variable>''''' - click to enter the name of new local variable
      '''any one''' - any of the junctions in the rule list (below) is set correctly
          for each variable:-
      '''all''' - ALL of the junctions in the rule list are set correctly
          '''''<variable-name>''''' - click to change variable name
     '''''<Add junction>''''' - click to select a junction from the session list
          '''''<type>''''' - click to select one of:-
    '''''<Add all>''''' - click to select ALL junctions in the session list
            '''string''' - text characters
    '''''<Delete all>''''' - click to delete ALL selected junctions from the rule list
            '''int''' - integer
      For each selected junction:-
            '''float''' - real (decimal) numbers
      '''''<setting>''''' - click to select one switch direction from:-
            '''bool''' - boolean (true/false)
          '''Left'''
            '''stringset''' - ''meaning not known at this time''
          '''Right'''
            '''stringlist''' - ''meaning not known at this time''
          '''Center'''
            '''tkmlist''' - trackmark list (no longer supported in TANE SP2)
          '''Any'''
            '''platformlist''' - platform list (no longer supported in TANE SP2)
      '''''<remove>''''' - to delete this junction from the rule list
            '''''del''''' - delete variable
            '''''edit''''' - edit variable
     '''''<trains>''''' - click to edit a train variable
      '''''<train selected>''''' - click to select a train from the session list. Initially none is selected
          '''''<select train>''''' - click to select a locomotive
          '''''<select vehicle>''''' - click to select a rail vehicle
          for the selected loco/vehicle:-
            '''''<Add new session variable>''''' - click to enter the name of a new variable
              for the entered variable:-
                  '''''<variable-name>''''' - click to change variable name
                  '''''<type>''''' - click to select type (see list above)
    '''''<objects>''''' - no longer supported in TANE SP2
    '''''<global>''''' - no longer supported in TANE SP2
 
*'''Known Issues:'''
:Rule creator, '''pguy''', has indicated that the future of this rule is uncertain as parts of it have been devalued in the latest release of TANE.


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Variable Check Rule|Variable Check Rule]]''' - executes child rules according to the value of a specified variable.
**'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
**'''[[#Variable Modify Rule|Variable Modify Rule]]''' - changes the value of a specified variable.
**'''[[#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.
**'''[[#Variable Modify Continuous Rule|Variable Modify Continuous Rule]]''' - continuously changes the value of a specified variable.
**'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).
**'''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.
 
**'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
*'''Trainz Wiki Links:'''
**'''[[How to Control Junctions in Sessions]]'''


==='''QuickDrive Rule'''===
==='''Set Cleared Junctions Rule'''===


Changes the Session settings.
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'''


*'''<kuid:401543:1184>'''
*'''<kuid2:131986:157661:1>'''


*'''Base Rule'''
*'''DLS Rule''' by '''atilabarut'''


  '''Properties:'''
  '''Properties:'''
  '''Open QuickDrive window when session is started          [Check Box]''' - check to set
    '''''Add Junction''''' - click to select a junction from the session junction list
  '''Set time to ''<hours:minutes>'' with a rate of ''<speed x>''''' - set start time and rate at which time advances
    '''''Add All''''' - click to add ALL junctions in the session junction list
  '''Enable gameplay Session Mode                            [Check Box]''' - check to set. Gameplay mode restricts the players options
    '''''Delete All''''' - click to remove ALL entered junctions from the rule
  '''Enable in game help by default                          [Check Box]''' - check to allow help options to be displayed
      '''Junction Options:''' - for each selected junction:-
  '''Set the default Control method to:''' - select one of two option buttons:-
          '''''<direction>''''' - click to select the junction direction
      '''( ) Easy Mode'''
            '''Left'''
      '''( ) Realistic Mode'''
            '''Center'''
      '''[Check Box] Prevent player from changing this setting''' - check to set
            '''Right'''
  '''Realistic mode requires achievement: ''<text>'' in asset ''<asset name>''''' - enter achievement name and select an asset from Aurans Achievements
            '''Don't change'''
  '''Set the default derailment realism to:''' - select one of three option buttons:-
          '''''<user control>''''' - click to select a user control option
      '''( ) None'''
            '''Locked''' - the junction setting cannot be changed by the user
      '''( ) Arcade'''
            '''Unlocked''' - the junction setting can be changed by the user
      '''( ) Realistic'''
          '''''<AI control>''''' - click to select AI control
      '''[Check Box] Prevent player from changing this setting''' - check to set
            '''Allows AI control''' - an AI train can switch the junction
  '''Set the default units to:''' - select one of three option buttons:-
            '''Blocks AI control''' - an AI train cannot switch the junction
      '''( ) Imperial'''
          '''''Remove''''' - click to remove this junction from the rule list
      '''( ) Metric'''
 
      '''( ) Default'''
*'''Related Rules:'''
**'''[[#Junction Derailment Prevention Rule|Junction Derailment Prevention Rule]]''' - sets opposing junctions ahead of a train to prevent derailments
**'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
**'''[[#Multiple Junction Alignment Check Rule|Multiple Junction Alignment Check Rule]]''' - executes child rules when junctions are aligned
**'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).


*'''Trainz Wiki Links:'''
*'''Trainz Wiki Links:'''
**'''http://online.ts2009.com/mediaWiki/index.php/QuickDrive_Rule'''
**'''[[How to Control Junctions in Sessions]]'''
----
'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''


=='''R'''==
==='''Set Junctions Rule'''===


==='''Random List Rule'''===
Sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control). '''''Warning:'' not compatible with Interlocking Tower Assets'''


Executes ONE randomly selected child rule once only. The rule will not repeat to randomly select another child rule
*'''<kuid:-25:1065>'''
 
*'''<kuid:-25:758>'''


*'''Built-in Rule'''
*'''Built-in Rule'''
*'''Parent Rule'''


  '''Properties:'''
  '''Properties:'''
     '''None'''
     '''''Add Junction''''' - click to select a junction from the session junction list
 
    '''''Add All''''' - click to add ALL junctions in the session junction list
*'''Related Rules:'''
    '''''Delete All''''' - click to remove ALL entered junctions from the rule
**'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order
      '''Junction Options:''' - for each selected junction:-
**'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child rule on the second run, etc
          '''''<direction>''''' - click to select the junction direction
**'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously
            '''Left'''
**'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously
            '''Center'''
            '''Right'''
            '''Don't change'''
          '''''<user control>''''' - click to select a user control option
            '''Locked''' - the junction setting cannot be changed by the user
            '''Unlocked''' - the junction setting can be changed by the user
          '''''<AI control>''''' - click to select AI control
            '''Allows AI control''' - an AI train can switch the junction
            '''Blocks AI control''' - an AI train cannot switch the junction
          '''''Remove''''' - click to remove this junction from the rule list
 
*'''Related Rules:'''
**'''[[#Junction Derailment Prevention Rule|Junction Derailment Prevention Rule]]''' - sets opposing junctions ahead of a train to prevent derailments
**'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
**'''[[#Multiple Junction Alignment Check Rule|Multiple Junction Alignment Check Rule]]''' - executes child rules when junctions are aligned
**'''[[#Set Cleared Junctions Rule|Set Cleared Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.


*'''Trainz Wiki Links:'''
*'''Trainz Wiki Links:'''
**'''[[How to Use Parent and Child Rules]]'''
**'''[[How to Control Junctions in Sessions]]'''
**'''http://online.ts2009.com/mediaWiki/index.php/Random_List'''


==='''Random Weather Rule v2'''===
==='''Set Signal Extended Rule'''===


Randomly changes the weather conditions between set values over a set duration.
Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''


*'''<kuid:169301:100132>'''
*'''<kuid2:47662:20002:4>'''


*'''DLS Rule''' by '''terry_wagstaff'''
*'''Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''Starting weather ''<select>'' - select one of:-
     '''''<Select signal>'' to ''<signal state>''''' - click to select a signal from the session list and click to select a state from the list -
          '''''Clear weather, no clouds, rain or snow'''''
      '''Automatic'''
          '''''Cloudy weather, no rain'''''
      '''Stop'''
          '''''Drizzle, light rain'''''
      '''Stop then Continue'''
          '''''Rain'''''
      '''Caution Left'''
          '''''Stormy weather that includes lightning and thunder'''''
      '''Caution Right'''
          '''''Snowing lightly'''''
      '''Caution'''
          '''''Medium snowfall'''''
      '''Advance Caution Left'''
          '''''Heavy snow'''''
      '''Advance Caution Right'''
    '''Best weather ''<select>'' - select one of:-
      '''Advance Caution'''
          '''''Clear weather, no clouds, rain or snow'''''
      '''Proceed Left'''
          '''''Cloudy weather, no rain'''''  
      '''Proceed Right'''
          '''''Drizzle, light rain'''''
      '''Proceed'''
          '''''Rain'''''
      '''Slow'''
          '''''Stormy weather that includes lightning and thunder'''''
      '''Medium'''
          '''''Snowing lightly'''''
          '''''Medium snowfall'''''
          '''''Heavy snow'''''
    '''Worst weather ''<select>'' - select one of:-
          '''''Clear weather, no clouds, rain or snow'''''
          '''''Cloudy weather, no rain'''''  
          '''''Drizzle, light rain'''''
          '''''Rain'''''
          '''''Stormy weather that includes lightning and thunder'''''
          '''''Snowing lightly'''''
          '''''Medium snowfall'''''
          '''''Heavy snow'''''
    '''Changing about every: ''<value>'' mins''' - enter number of minutes between weather changes


*'''Known issues:'''
*'''Notes:'''
:This rule, once started, will run continuously and will not terminate so do NOT use this rule as a child rule in an '''Ordered List Rule''' because any following child rules will never be executed.
:The signal must support the state selected otherwise there will be no change in the signal


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#EIRS Weather Rule NE USA Rule|EIRS Weather Rule NE USA Rule]]''' - customize random weather rule relative to the North East Region of the United States
**'''[[#Trigger Multiple Signals Rule|Trigger Multiple Signals Rule]]''' - sets selected signals to DANGER (STOP) when selected triggers are activated
**'''[[#Startup Options Rule|Startup Options Rule]]''' - sets the weather conditions at the start of a Session


==='''Randomize Rule'''===
==='''Trigger Multiple Signals Rule'''===


Generates a different set of random numbers each time the session is run.
Sets selected signals to DANGER (STOP) when selected triggers are activated. Signals will be at AUTOMATIC when the triggers are not activated.


*'''<kuid:169301:100129>'''
*'''<kuid2:116387:26:1>'''


*'''DLS Rule''' by '''Terry_Wagstaff'''
*'''DLS Rule''' by '''maggs'''


  '''Properties:'''
  '''Properties:'''
     '''None'''
     '''<add signal>''' - select a signal from the Session List. More than one signal can be added.
      '''<delete>''' - remove a signal from the rule.
    '''<add trigger>''' - select a trigger from the Session List. More than one trigger can be added.
      '''<delete>''' - remove a trigger from the rule.


*'''Notes:'''
*'''Related Rules:'''
:Place this rule near the top of the Session Rules list and ensure that there is at least 5 seconds before the call to a Random function.
**'''[[#Set Signal Extended Rule|Set Signal Extended Rule]]''' -  sets a selected signal to a specific signal state


*'''Related Rules:'''
'''[[#top|Back to Top]]'''
**'''[[#Variable Random|Variable Random]]''' - sets a variable to a random integer value.
----
=='''Message Rules'''==


==='''Ranked Session Begin Rule'''===
==='''Close Message Popup Rule'''===


Begins a ranked Session
Closes open message popups


*'''<kuid:401543:2031>'''
*'''<kuid:447264:1526>'''


*'''Base Rule'''
*'''Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
    '''Countdown Starting Value ''<value>'''''
  '''None'''
      '''''hrs:'''''
 
      '''''min:'''''
*'''Known Issues:'''
      '''''sec:'''''
:This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule
    '''1 through 5 stars, points for each star ''<value>''''' - enter number of points for each star rating
    '''Session timer mode:''' - select one of three option buttons:-
      '''( ) Timer'''
      '''( ) Countdown Starting value ''<value>''''' - enter time ''hh:mm:ss''
      '''( ) None'''


*'''Notes:'''
*'''Related Rule:'''
:Times are Trainz clock time, not real time
**'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.


*'''Related Rules:'''
*'''Trainz Wiki Links:'''
**'''[[#Ranked Session Complete Rule|Ranked Session Complete Rule]]''' - completes the active ranked Session
**'''[[Message Popup Rule Applications]]'''
**'''[[Message Popup Example|Message Popup Examples]]'''


==='''Ranked Session Complete Rule'''===
==='''DestSign Table Rule'''===


Completes the active ranked Session
Creates a list of destination names for a destination sign


*'''<kuid:401543:2032>'''
*'''<kuid2:206816:99004:2>'''


*'''Base Rule'''
*'''Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
    '''Set the active ranked session as:''' - select one of two option buttons:-
  '''''<add destination>''''' - enter a destination name to be added to the destination sign roll
      '''( ) Complete'''
  '''''<import destinations from texture-group>''''' - select a list of destination names from session
      '''( ) Failed'''
  '''[Check Box] Enable industries/stations as destination''' - check to set
    '''[Check Box] Customize the completion message ''<text>''''' - enter a text message
  '''[Check Box] Enable Track Marks as destinations''' - check to set
  '''[Check Box] Enable table of destinations''' - check to set


*'''Related Rules:'''
==='''Display HTML Pages Rule'''===
**'''[[#Ranked Session Begin Rule|Ranked Session Begin Rule]]''' - begins a ranked Session


==='''Replace Missing Vehicles 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'''  


Produces new trains to replace missing vehicles that have been removed from the session by the '''Clean Up Derailed Trains Rule'''
*'''<kuid:-25:442>'''


*'''<kuid:447264:1214>'''
*'''Legacy Rule''' (replaced by '''Message Popup Rule''')


*'''Built-in Rule'''
*'''Base Rule'''


  '''Properties:'''
  '''Properties:'''
     '''[Check Box] Respawn trains if they are abandoned for 10 minutes'''
    '''''<Add Page>''''' - adds the HTML page ''index.html'' from the selected HTML asset
     If checked:-
      '''''<index.html>''''' - click to change the page name. The extension ''.html'' is optional
      Select one of two option buttons:-
    '''''<Add All>''''' - adds all HTML pages from the session list '''(this appears to be disabled in TANE)'''
          '''( ) Respawn trains at their original locations'''
    '''''<Delete All>''''' - delete all HTML pages from this property list
          '''( ) Respawn trains from portals'''
     '''[Check Box] Prevent user from exiting browser until all pages viewed'''
            '''''<+ Add a new portal>''''' - click to enter the name of a portal, there can be more than one portal.
     '''[Check Box] Disable closing of browser window by user'''
            Entered portal names that appear in red have not been found in the session
    '''[Check Box] Disable browser window scrolling'''
    '''[Check Box] Make browser window invisible'''
    '''[Check Box] Set position-Under Construction!!!''' - not implemented
    '''[Check Box] Set size-Under Construction!!!''' - not implemented
    '''Use the page ''<index.html>'' from asset ''<select>'' as the hidden button''' - the link buttons at the bottom of the page will be taken from the selected page in the selected HTML asset


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Clean Up Derailed Trains Rule|Clean Up Derailed Trains Rule]]''' - cleans up derailed train cars after a set time delay
**'''[[#Close Message Popup Rule|Close Message Popup Rule]]''' - closes a displayed pop-up browser window.
**'''[[#Wait for Derailment Rule|Wait for Derailment Rule]]''' - executes child rules when a derailment occurs
**'''[[#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'''
**'''[[#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.


==='''Reset List Rule'''===
==='''Display Video Rule'''===


Executes ALL child rules continuously in an ongoing infinite cycle
Displays a page containing a video clip from a HTML asset in a browser window.


*'''<kuid:-25:762>'''
*'''<kuid:-25:138>'''


*'''Built-in Rule'''
*'''Built-in Rule'''
*'''Parent Rule'''


  '''Properties:'''
  '''Properties:'''
     '''None'''
     '''Display page ''<index.html>'' of html asset ''<click to select>'' in a new browser window
      '''''index.html''''' - enter the filename of a HTML page in the selected HTML asset. The ''.html'' is optional in the filename.
      '''''<click to select>''''' - select the HTML asset from those installed.
 
*'''Notes:'''
:Video must be in a valid web format.


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order
**'''[[#Play Sound Rule|Play Sound Rule]]''' - plays a wav sound file
**'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child rule on the second run, etc
 
**'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule
==='''DisplayIndustryStatus Rule (color modified)'''===
**'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously
 
Displays a summary of industry product levels when the "k" key is pressed.
 
*'''<kuid:622415:100001>'''
 
*'''DLS Rule''' by '''lockheed02''' and '''marzipan'''


*'''Trainz Wiki Links:'''
'''Properties:'''
**'''http://online.ts2009.com/mediaWiki/index.php/Reset_List'''
    '''None'''
**'''[[How to Use Parent and Child Rules]]'''


==='''Resource Check Rule'''===
*'''Notes:'''
: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.


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'''
*'''Related Rules:'''
**'''[[#ExTrainz Manager Rule - TANE SP2|ExTrainz Manager Rule - TANE SP2]]''' - displays information on consists, industries and products in Driver and Surveyor.


*'''<kuid:-25:1067>'''
==='''ExTrainz Manager Rule - TANE SP2'''===


*'''Legacy Rule''' (replaced by '''Multiple Resource Check Rule''')
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.


*'''Built-in Rule'''
*'''<kuid:160293:10029>'''


*'''Parent Rule'''
*'''DLS Rule''' by '''trev999'''


  '''Properties:'''
  '''Properties:'''
     Select one of two option buttons:-
     '''Diagnostic mode is ''<On/Off>''''' - click to select ''On'' or ''Off''. When set ''On'' diagnostic messages will be added to the Trainz Log file.
      '''( ) Watch industry queue'''
    '''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.
          '''Target Object ''<select>''''' - select an industry from the session list
    '''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.
          '''Queue ''<select>''''' - select a product queue from the selected industry
    '''Search only rolling stock already in session ''<Yes/No>''''' - click to select ''Yes'' or ''No''. When set to ''Yes'' only those rolling stock assets
          '''Product ''<select>''''' - select a product from the selected queue
      installed in the session can be searched.
          '''Amount ''<value>''''' - enter a quantity
    '''Graphic colours: ''<When Red, the industry does not require service/When Green, the industry does not require service>''''' - click to switch
          Select one of two option buttons:-
      between the two colour options.
            '''( ) Complete when designated queue equals or exceeds required amount'''
    '''Industry page size: ''<value>''''' - enter the number of industries to be displayed in the Industry List window (maximum 250).
            '''( ) Complete when designated queue falls below required amount'''
    '''The following industries are excluded: ''<Add an industry to be excluded>''''' - name can be complete (e.g. "Coal Mine 2")
      '''( ) Watch vehicle'''
      which will exclude that specific industry from the management list, or partial (e.g. "Coal") which will exclude all
          '''Target Object ''<select>''''' - select a rolling stock asset from the session list
      industries with the word "Coal" in their names. Entries are not case sensitive.
          '''Queue ''<select>''''' - select a product queue from the selected rolling stock
      Once industries have been excluded, additional commands will appear for each excluded industry:-
          '''Product ''<select>''''' - select a product from the selected queue
      '''''<delete> <industry name begins with/class name begins with> <name>''''' - click ''delete'' to remove this entry.
          '''Amount ''<value>''''' - enter a quantity
          - click ''industry name begins with/class name begins with'' to select between the two (see ''notes'' below).
          Select one of two option buttons:-
          - click ''name'' to edit the name.
            '''( ) Complete when designated queue equals or exceeds required amount'''
            '''( ) Complete when designated queue falls below required amount'''


*'''Notes:'''
*'''Notes:'''
: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''.
#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.


*'''Related Rules:'''
*'''Known Issues:'''
**'''[[#Multiple Resource Check Rule|Multiple Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
:This rule is NOT compatible with all industries.
**'''[[#Resource Verify Rule (fixed)|Resource Verify Rule (fixed)]]''' - executes child rules when a set resource (commodity) level is reached


*'''Trainz Wiki Links:'''
*'''Related Rules:'''
**'''http://online.ts2009.com/mediaWiki/index.php/Resource_Check_Rule'''
**'''[[#DisplayIndustryStatus Rule (color modified)|DisplayIndustryStatus Rule (color modified)]]''' - displays information on industry product levels.


==='''Resource Verify Rule (fixed)'''===
==='''Fade In/Out Rule'''===


Executes child rules if a selected industry or vehicle reaches a set commodity level. The rule resets when all child rules have completed.
Fade in or out within seconds, using specified color and opacity values.


*'''<kuid:160293:10060>'''
*'''<kuid2:190611:200000:2>'''


*'''DLS Rule''' by '''trev999
*'''Built-in Rule'''
 
*'''Parent Rule'''


  '''Properties:'''
  '''Properties:'''
    Select one of two option buttons:-
     '''Red percentage:            ''<value>''''' - enter the final % of red (0 = none, 100 = maximum)
     '''( ) Watch industry queue'''
    '''Green percentage:          ''<value>''''' - enter the final % of green
      '''Target object ''<click to select>''''' - click to select an industry from the session list.
    '''Blue percentage:            ''<value>''''' - enter the final % of blue
      '''Product ''<click to select>''''' - click to select an industry product.
     '''Alpha percentage (opacity): ''<value>''''' - enter the final % of opacity (0 = invisible, 100 = solid)
      '''Amount ''<value>''''' - enter a quantity for the selected product.
    '''Fading duration:            ''<value>''''' - enter the number of seconds required for the fade
      Select one of two option buttons:-
    '''''<help>''''' - click to bring up help instructions
      '''( ) Complete when designated queue equals or exceeds designated amount'''
      '''( ) Complete when designated queue falls below designated amount'''
     '''( ) Watch vehicle queue'''
      '''Target object ''<click to select>''''' - click to select a rolling stock vehicle from the session list.
      '''Product ''<click to select>''''' - click to select a commodity product.
      '''Amount ''<value>''''' - enter a quantity for the selected product.
      Select one of two option buttons:-
      '''( ) Complete when designated queue equals or exceeds designated amount'''
      '''( ) Complete when designated queue falls below designated amount'''


*'''Notes:'''
*'''Notes:'''
#This rule will only monitor a single commodity in a single industry or vehicle.
:Seconds are Trainz clock time, not real time.
#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''.


*'''Related Rules:'''
==='''Hide Product Overlays Rule'''===
**'''[[#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
----
'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''


=='''S-Se'''==
Hides the commodity or product bar graphs that appear on active industries


==='''Safety System Engaged Check Rule'''===
*'''<kuid:400048:100970>'''


Executes child rules if safety systems are applied.
*'''DLS Rule''' by '''callavsg'''
 
*'''<kuid:447264:1216>'''
 
*'''Built-in Rule'''
 
*'''Parent Rule'''


  '''Properties:'''
  '''Properties:'''
    '''[Check Box] Trigger only once'''
  '''None'''


*'''Related Rules:'''
==='''InputTable Rule'''===
**'''[[#Safety System Isolated Check Rule|Safety System Isolated Check Rule]]''' - executes child rules if safety systems have been isolated


==='''Safety System Isolated Check Rule'''===
Creates a list of message names to be used for various purposes including passing data to '''Driver Commands'''


Executes child rules if safety systems are isolated (disengaged).
*'''<kuid2:131986:1012:1>'''
 
*'''<kuid:447264:1217>'''


*'''Built-in Rule'''
*'''Built-in Rule'''
*'''Parent Rule'''


  '''Properties:'''
  '''Properties:'''
     '''[Check Box] Trigger only once'''
     '''''<add>''''' - click to add a new entry to the table
 
    Each new entry will require an input message
*'''Related Rules:'''
      '''''<short message>''''' - enter a message. The message must be in a format that is specific for each purpose
**'''[[#Safety System Engaged Check Rule|Safety System Engaged Check Rule]]''' - executes child rules if safety systems have been engaged
      For the '''MoveTurntable''' driver command the message must be formatted as:-
          '''turntable,name_of_turntable,number_of_connecting_roads''' - the first entry must be the word ''turntable'' in lower case.
            ''name_of_turntable'' is the name of the turntable,
            ''number_of_connecting_roads'' is the number of tracks connecting to the turntable
      For the '''WaitUntilTime''' driver command the message must be formatted as:-
          '''time,hour,minute''' - the first entry must be the word ''time'' in lower case,
            ''hour'' must be from 0 to 23,
            ''minute'' must be from 0 to 59.
      For the '''WaitUntilSVariable''' driver command the message must be formatted as:-
          '''svar,svar_name,svar_condition,value''' - the first entry must be the word ''svar'' in lower case,
            ''svar_name'' is the name of the session variable,
            ''svar_condition'' is an equality (eg eq for equal, gt for greater than, etc)
            ''value'' is an integer value to be compared to the session variable.
    Each entry in the table will be followed by the commands:-
      '''''cp''''' - click to copy this entry to a new entry
      '''''up''''' - click to move this entry up one level
      '''''dn''''' - click to move this entry down one level
      '''''rm''''' - click to remove this entry from the table


==='''Schedule Rule'''===
==='''Message Popup Rule'''===


Allows a schedule of timed events to be applied to a train
Displays a pop-up browser window and waits for it to be closed. Closure can be manual (by the user) or by another rule.


*'''<kuid:-3:10185>'''
*'''<kuid:-25:1003>'''


*'''Base Rule'''
*'''Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''Insert track mark ''<select>''''' - select a track mark from the Session List
     '''[Check Box] Pause game while message is displayed''' - stops the game until this message is closed
     '''Arrival and Departure Time ''<Select>''''' - set time
    '''[Check Box] Close previous popup windows''' - closes any Message Popups currently displayed before this message is shown
      '''''hh:mm:ss''''' - in hours/minutes/seconds
    '''Message location ''<Top Left/Top Right/Bottom Left/Bottom Right>''''' - select one to position the browser window on the screen
    '''Current Train ''<select>''''' - select from session list
     '''Message Source:''' - select one of three option buttons:-
    '''Insert destination ''<select>''''' - select from session list
      '''( ) Custom text''' - the simplest and easiest option
          '''Icon ''<Click here to set>''''' - (optional) shows a list of message icons. Select one to be displayed with the message
          '''Icon ''<Clear icon>''''' - clears any currently displayed message icon
          '''Custom text box''' Enter text to be displayed. You will be limited to about 6 lines of text.
              For longer messages or to include graphics, use the '''A predefined HTML page''' option.
          '''''<HTML Wave>''''' - (optional) select the name of the HTML asset from the list shown that contains the wave file to be played.
          '''''<Wave Name>''''' - (optional) enter the name of a wave (.wav) sound file to be played.
              The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension ".wav" is optional
          '''[Check Box] Autoplay Wave:''' - plays the .wav sound file as soon as message is displayed.
              If unchecked the sound will not be played.
      '''( ) A predefined HTML page''' - requires a working knowledge of HTML
          '''''<HTML Asset>''''' - select the name of the HTML asset that contains the required HTML page from the list shown.
          '''''<HTML Page>''''' - enter the filename of the HTML page to be displayed. The page must be in the HTML asset identified above.
              Filename is not case sensitive. Extension ".html" is optional.
          '''''<HTML Wave>''''' - (optional) select the name of the HTML file containing the wave file to be played.
              The page must be in the HTML asset identified above. Filename is not case sensitive. Extension ".html" is optional.
          '''''<Wave Name>''''' - (optional) enter the name of a wave (.wav) sound file to be played.
              The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension ".wav" is optional
          '''[Check Box] Autoplay Wave:''' - plays the .wav sound file as soon as message is displayed.
            If unchecked sound will not be played.
      '''( ) A predefined string-table entry from a HTML asset'''
          '''''<HTML Asset>''''' - select the name of the HTML asset from those installed that contains the required string-table.
          '''''<String Table Token>''''' - enter the "tag name" of the text in the string-table of the HTML assets '''config.txt''' file.
          '''''<HTML Wave>''''' - (optional) select the name of the HTML file containing the wave file to be played.
              The page must be in the HTML asset identified above. Filename is not case sensitive. Extension ".html" is optional.
          '''''<Wave Name>''''' - (optional) enter the name of a wave (.wav) sound file to be played.
              The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension ".wav" is optional
          '''[Check Box] Autoplay Wave:''' - plays the .wav sound file as soon as message is displayed.
              If unchecked sound will not be played.


*'''Notes:'''
*'''Known Issues:'''
:Times are Trainz clock times, not real time
: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.


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
**'''[[#Close Message Popup Rule|Close Message Popup Rule]]''' - closes a displayed pop-up browser window.
**'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
**'''[[#Display HTML Pages Rule|Display HTML Pages Rule]]''' - display listed HTML files in order as a navigable sequence of pages.
**'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
**'''[[#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.
**'''[[#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
*'''Trainz Wiki Links:'''
**'''[[How to Create a HTML Asset]]'''
**'''[[Message Popup Rule Applications|Message Popup Applications]]'''
**'''[[Message Popup Example|Message Popup Examples]]'''


==='''Session Complete Rule'''===
==='''Minimap Options Rule'''===


Set session to a percentage of completion.
Sets the display options for the minimap.


*'''<kuid:447264:1011>'''
*'''<kuid:-25:636>'''


*'''Base Rule'''
*'''Built-in Rule'''


  '''Properties:'''
  '''Properties:''' ''Default values - all checked''
     '''Set session to percent complete ''<value>''''' - enter number as a percentage
    '''[Check Box] Map Textures'''
     '''[Check Box] Separate achievements for completion''' - check to set
    '''[Check Box] Gradients'''
     '''[Check Box] Junctions'''
    '''[Check Box] Signals'''
    '''[Check Box] Triggers'''
    '''[Check Box] Markers'''
    '''[Check Box] Trackside Labels'''
    '''[Check Box] Terrain Objects'''
    '''[Check Box] Industrial Names'''
    '''[Check Box] Named Objects'''
     '''[Check Box] Consists'''


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#End Session Rule|End Session Rule]]''' - end the Session with a fade out.
**'''[[#Show/Hide Minimap Rule|Show/Hide Minimap Rule]]''' - shows the minimap window in Driver.


==='''Session Debug Rule'''===
==='''Play Sound Rule'''===


Executes the first child if ''Debug'' mode is selected. Otherwise executes the second child rule.
Plays a wav sound file.


*'''<kuid:30501:100180>'''
*'''<kuid:-25:1045>'''


*'''Built-in Rule'''
*'''Built-in Rule'''


*'''Parent Rule'''  
'''Properties:'''
    '''Default HTML ''<Click>''''' - click to to enter Sound File Name
    '''HTML Assets ''<Click>''''' - click to select HTML asset
    '''Rule Completes ''<Click>''''' -  to select one of:-
      '''sound has just started'''
      '''sound has finished playing'''


'''Properties:'''
*'''Related Rules:'''
    '''None'''
**'''[[#Display Video Rule|Display Video Rule]]''' - displays a page containing a video clip from a HTML asset in a browser window
 
*'''Notes:'''  
: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.


==='''Session Metadata Rule'''===
==='''Session Metadata Rule'''===
Line 2,135: Line 2,226:
:Time is Trainz clock time, not real time
:Time is Trainz clock time, not real time


==='''Set Camera Rule'''===
==='''Set Helper Icon Size Rule'''===


Sets the target object and properties of the camera.
Sets the size of helper icons such as the junction lever arrows.


*'''<kuid:-25:179>'''
*'''<kuid:-25:791>'''


*'''Built-in Rule'''
*'''Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
    '''[Check Box] Set the target object of the camera to:''' - if checked, select one of three option buttons:-
  '''Junction Arrows Size ''<Click>''''' - to set scale ratio smaller than default, default is 100%
      '''( ) Vehicle ''<click to select>''''' - select a vehicle from the Session list
      '''( ) Junction ''<click to select>''''' - select a junction from the Session list
      '''( ) Map Object ''<click to select>''''' - select a named map object from the Session list
    '''[Check Box] Change the camera view mode to ''<click to select>''''' - if checked, select one camera view mode from
      '''Cab View'''
      '''External View'''
      '''Tracking View'''
      '''Free Roaming'''
    '''[Check Box] Set the camera flags to enable/disable user access to''' - if checked, select as many of the following check boxes as needed
      '''[Check Box] Internal view mode''' - check to enable, uncheck to disable
      '''[Check Box] External view mode''' - check to enable, uncheck to disable
      '''[Check Box] Tracking view mode''' - check to enable, uncheck to disable
      '''[Check Box] Roaming view mode''' - check to enable, uncheck to disable
      '''[Check Box] View switching''' - check to enable, uncheck to disable
      '''[Check Box] Vehicle view switching''' - check to enable, uncheck to disable
      '''[Check Box] Train view switching''' - check to enable, uncheck to disable
      '''[Check Box] Camera adjustments (pan, zoom, etc)''' - check to enable, uncheck to disable


*'''Related Rules:'''
==='''Set HTML Pages Rule'''===
**'''[[#Cinematic Camera Rule|Cinematic Camera Rule]]''' - provides several different cinematic style cameras with animations
**'''[[#Focus Camera Rule|Focus Camera Rule]]''' - sets the initial camera view and starting vehicle for a session
**'''[[#Wait for Camera View Mode Rule|Wait for Camera View Mode Rule]]''' - executes child rules when the camera view is changed


==='''Set Coupler Masks Rule'''===
Instructs the Display HTML Pages rule to perform specific operations. This rule has been superseded by the '''Message Popup Rule'''


Set the coupling/decoupling  masks on the selected vehicles
*'''<kuid:-25:792>'''


*'''<kuid:-25:980>'''
*'''Legacy Rule''' (replaced by '''Message Popup Rule''')


*'''Built-in Rule'''
*'''Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''''<Add vehicle>''''' - click to select a vehicle from the session list
     '''Operations to preform on the display HTML pages sequence browser'''
    '''''<Add All>''''' - click to add all vehicles in the session list
    Select one of six option buttons:-
    '''''<Delete All>''''' - click to remove all added vehicles from this rule
      '''( ) to instruct the sequence browser to ''<select>''''' - to choose page operations
      For each selected vehicle:-
      '''( ) to instruct the sequence browser to open the page ''<select>''''' - enter the HTML page name
      '''Coupling Mask'''
      '''( ) to set browser parameters ''<select>''''' - choose one of:-
           '''Front''' and '''Back''' - choose for each
          '''to Enable/Disable closing of the browser window by the user'''
            '''''Locked'''''
          '''to Enable/Disable scrolling on the sequence browser window'''
            '''''Unlocked'''''
           '''to Show/Hide the sequence browser window'''
      '''Decoupling Mask'''
      '''( ) Set the following flag for the page named ''<select>''''' - enter the HTML page name
           '''Front''' and '''Back''' - choose for each
          '''[Check Box] Hide/Close window on 'done' action'''
            '''''Locked'''''
          '''[Check Box] Window has no 'done' button'''
            '''''Unlocked'''''
          '''[Check Box] Disable scrolling(not implemented yet)'''
       '''''<Remove>''''' - click to remove this vehicle from the rule
          '''[Check Box] Spare setting 1'''
          '''[Check Box] Spare setting 2'''
          '''[Check Box] Spare setting 3'''
           '''[Check Box] Spare setting 4'''
          '''[Check Box] Spare setting 5'''
      '''( ) Use the page ''<select>''''' (enter HTML page name) '''from the HTML asset ''<select>''''' (select HTML asset)
       '''( ) Use the string table entry ''<select>''''' (enter Index) '''from the HTML asset ''<select>''''' (select HTML asset)


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Coupler Breakage Check Rule|Coupler Breakage Check Rule]]''' - executes child rules when a coupler breaks
**'''[[#Display HTML Pages Rule|Display HTML Pages Rule]]''' - displays HTML pages in a browser window.
**'''[[#Coupler Breakage HUD Rule|Coupler Breakage HUD Rule]]''' - adds a coupler stress and breakage warning to the HUD
**'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
**'''[[#Timed Limited Display HTML Rule (SP2 and later)|Timed Limited Display HTML Rule (SP2 and later)]]''' - displays a HTML page in a browser window for a set time.


==='''Set Cleared Junctions Rule'''===
==='''Show/Hide Layer Rule'''===


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'''
Shows or hides a layer from Driver.


*'''<kuid2:131986:157661:1>'''
*'''<kuid2:401543:1170:1>'''


*'''DLS Rule''' by '''atilabarut'''
*'''Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
    '''''Add Junction''''' - click to select a junction from the session junction list
  '''''<visibility>''''' - select one of two options
    '''''Add All''''' - click to add ALL junctions in the session junction list
      '''Show''' - select to make the layer visible
    '''''Delete All''''' - click to remove ALL entered junctions from the rule
      '''Hide''' - select to make the layer invisible
      '''Junction Options:''' - for each selected junction:-
  '''''<click here to set>''''' - enter name of layer. Name is case sensitive.
          '''''<direction>''''' - click to select the junction direction
            '''Left'''
            '''Center'''
            '''Right'''
            '''Don't change'''
          '''''<user control>''''' - click to select a user control option
            '''Locked''' - the junction setting cannot be changed by the user
            '''Unlocked''' - the junction setting can be changed by the user
          '''''<AI control>''''' - click to select AI control
            '''Allows AI control''' - an AI train can switch the junction
            '''Blocks AI control''' - an AI train cannot switch the junction
          '''''Remove''''' - click to remove this junction from the rule list


*'''Related Rules:'''
*'''Known Bugs:'''
**'''[[#Junction Derailment Prevention Rule|Junction Derailment Prevention Rule]]''' - sets opposing junctions ahead of a train to prevent derailments
:Layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded
**'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
 
**'''[[#Multiple Junction Alignment Check Rule|Multiple Junction Alignment Check Rule]]''' - executes child rules when junctions are aligned
*'''Known Issues:'''
**'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).
:Rule will NOT check to see if the named layer exists or not


*'''Trainz Wiki Links:'''
*'''Trainz Wiki Links:'''
**'''[[How to Control Junctions in Sessions]]'''
**'''[[How to Use Layers#Layers in Driver Mode|How to Use Layers: Layers in Driver Mode]]


==='''Set Helper Icon Size Rule'''===
==='''Show/Hide Minimap Rule'''===


Sets the size of helper icons such as the junction lever arrows.
Shows the minimap window in Driver.


*'''<kuid:-25:791>'''
*'''<kuid:-25:794>'''


*'''Built-in Rule'''
*'''Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
  '''Junction Arrows Size ''<Click>''''' - to set scale ratio smaller than default, default is 100%
    '''''<Show/Hide>'' the driver Minimap Window''' - click to switch between '''Show''' and '''Hide'''.


==='''Set HTML Pages Rule'''===
*'''Related Rules:'''
**'''[[#Minimap Options Rule|Minimap Options Rule]]''' - sets the display options for the minimap.


Instructs the Display HTML Pages rule to perform specific operations. This rule has been superseded by the '''Message Popup Rule'''
==='''Show/Hide On-screen Help Rule'''===


*'''<kuid:-25:792>'''
Shows or hides On-screen help in Driver.


*'''Legacy Rule''' (replaced by '''Message Popup Rule''')
*'''<kuid:401543:2020>'''


*'''Built-in Rule'''
*'''Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''Operations to preform on the display HTML pages sequence browser'''
     '''On screen help (junction overlays, etc)''' - select one of three option buttons:-
    Select one of six option buttons:-
       '''( ) Show
       '''( ) to instruct the sequence browser to ''<select>''''' - to choose page operations
       '''( ) Hide
       '''( ) to instruct the sequence browser to open the page ''<select>''''' - enter the HTML page name
       '''( ) Leave Unchanged
       '''( ) to set browser parameters ''<select>''''' - choose one of:-
    '''On Screen Vehicle Names:''' - - select one of three option buttons:-
          '''to Enable/Disable closing of the browser window by the user'''
       '''( ) Show
          '''to Enable/Disable scrolling on the sequence browser window'''
       '''( ) Hide
          '''to Show/Hide the sequence browser window'''
       '''( ) Leave Unchanged
       '''( ) Set the following flag for the page named ''<select>''''' - enter the HTML page name
          '''[Check Box] Hide/Close window on 'done' action'''
          '''[Check Box] Window has no 'done' button'''
          '''[Check Box] Disable scrolling(not implemented yet)'''
          '''[Check Box] Spare setting 1'''
          '''[Check Box] Spare setting 2'''
          '''[Check Box] Spare setting 3'''
          '''[Check Box] Spare setting 4'''
          '''[Check Box] Spare setting 5'''
       '''( ) Use the page ''<select>''''' (enter HTML page name) '''from the HTML asset ''<select>''''' (select HTML asset)
       '''( ) Use the string table entry ''<select>''''' (enter Index) '''from the HTML asset ''<select>''''' (select HTML asset)


*'''Related Rules:'''
==='''Timed Limited Display HTML Rule (SP2 and later)'''===
**'''[[#Display HTML Pages Rule|Display HTML Pages Rule]]''' - displays HTML pages in a browser window.
**'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
**'''[[#Timed Limited Display HTML Rule (SP2 and later)|Timed Limited Display HTML Rule (SP2 and later)]]''' - displays a HTML page in a browser window for a set time.


==='''Set Junctions Rule'''===
Displays an HTML browser window for a limited time.


Sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control). '''''Warning:'' not compatible with Interlocking Tower Assets'''
*'''<kuid2:61392:2005:32>'''


*'''<kuid:-25:1065>'''
*'''DLS Rule''' by '''pguy'''
 
*'''Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
    '''''Add Junction''''' - click to select a junction from the session junction list
  '''HTML Asset Name : ''<[Click to select HTML asset]>''''' - click to select an HTML asset from those installed
    '''''Add All''''' - click to add ALL junctions in the session junction list
  '''Page filename : ''<value>''''' - click to enter the filename of the HTML page in the selected HTML asset. The ''.html'' filename extension is optional.
    '''''Delete All''''' - click to remove ALL entered junctions from the rule
  '''Play duration (SessVar or duration in seconds) : ''<value>''''' - enter a SessVar name or the number of seconds.
      '''Junction Options:''' - for each selected junction:-
  '''Browser left position (SessVar or position) : ''<value>''''' - enter a SessVar name or the number of pixels from the left screen edge.
          '''''<direction>''''' - click to select the junction direction
  '''Browser top position (SessVar or position) : ''<value>''''' - enter a SessVar name or the number of pixels from the top screen edge.
            '''Left'''
  '''Browser width (SessVar or position) : ''<value>''''' - enter a SessVar name or the width in pixels.
            '''Center'''
  '''Browser height (SessVar or position) : ''<value>''''' - enter a SessVar name or the browser height.
            '''Right'''
  '''[Check Box] ''<Alert is not reshowable on request/Alert is showable on request>''''' - check or click to allow or prevent the user viewing the page again.
            '''Don't change'''
 
          '''''<user control>''''' - click to select a user control option
*'''Notes:'''
            '''Locked''' - the junction setting cannot be changed by the user
:Seconds are Trainz clock time, not real time.
            '''Unlocked''' - the junction setting can be changed by the user
          '''''<AI control>''''' - click to select AI control
            '''Allows AI control''' - an AI train can switch the junction
            '''Blocks AI control''' - an AI train cannot switch the junction
          '''''Remove''''' - click to remove this junction from the rule list


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Junction Derailment Prevention Rule|Junction Derailment Prevention Rule]]''' - sets opposing junctions ahead of a train to prevent derailments
**'''[[#Close Message Popup Rule|Close Message Popup Rule]]''' - closes open message popups
**'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
**'''[[#Display HTML Pages Rule|Display HTML Pages Rule]]''' - displays HTML pages in a browser window.
**'''[[#Multiple Junction Alignment Check Rule|Multiple Junction Alignment Check Rule]]''' - executes child rules when junctions are aligned
**'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
**'''[[#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 HTML Page Rule|Set HTML Page Rule]]''' - sets parameters for the '''[[#Display HTML Pages Rule|Display HTML Pages Rule]]'''
==='''Wait on Waybill Screen/Main Screen Rule'''===


*'''Trainz Wiki Links:'''
Executes child rules when the Waybill window is opened or closed
**'''[[How to Control Junctions in Sessions]]'''


==='''Set Signal Extended Rule'''===
*'''<kuid:-25:957>'''


Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''
*'''Built-in Rule'''


*'''<kuid2:47662:20002:4>'''
*'''Parent Rule'''
 
*'''Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''''<Select signal>'' to ''<signal state>''''' - click to select a signal from the session list and click to select a state from the list -
     '''[Check Box] Trigger rule once''' - check to trigger the rule once only
      '''Automatic'''
    '''Wait for the Waybill window to be ''<opened/closed>''''' - select either '''opened''' or '''closed'''.
      '''Stop'''
      '''Stop then Continue'''
      '''Caution Left'''
      '''Caution Right'''
      '''Caution'''
      '''Advance Caution Left'''
      '''Advance Caution Right'''
      '''Advance Caution'''
      '''Proceed Left'''
      '''Proceed Right'''
      '''Proceed'''
      '''Slow'''
      '''Medium'''


*'''Notes:'''
'''[[#top|Back to Top]]'''
:The signal must support the state selected otherwise there will be no change in the signal
----
=='''Miscellaneous Rules'''==


*'''Related Rules:'''
Some of these rules have no user accessible functions but may be used by other rules. Others do not fit in any other category.
**'''[[#Trigger Multiple Signals Rule|Trigger Multiple Signals Rule]]''' - sets selected signals to DANGER (STOP) when selected triggers are activated
----
'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''


=='''Sh-Sz'''==
==='''ConsistDataHandler Rule'''===


==='''Show/Hide HUD Panel Rule'''===
Was used by the '''QuickDrive Rule''' to place consists onto a route. Now obsolete.


Shows or hides a HUD panel.
*'''<kuid:401543:1180>'''


*'''<kuid:-25:1047>'''
*'''Obsolete Rule''' (function is now built into '''TANE''')


*'''Built-in Rule'''
*'''Base Rule'''


  '''Properties:'''
  '''Properties:'''
     '''''<Show/Hide>'' the ''<click to select>'' HUD panel''' - select '''''Show''''' or '''''Hide''''' and then select the HUD panel
     '''None'''


*'''Related Rules:'''
==='''Custom Script Rule'''===
**'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
**'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
**'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
**'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers
**'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
**'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked


==='''Show/Hide Layer Rule'''===
No description


Shows or hides a layer from Driver.
*'''<kuid:447264:1526>'''
 
*'''<kuid2:401543:1170:1>'''


*'''Built-in Rule'''
*'''Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
   '''''<visibility>''''' - select one of two options
   '''None'''
      '''Show''' - select to make the layer visible
 
      '''Hide''' - select to make the layer invisible
==='''Generic TreeNode Debug Window Rule'''===
  '''''<click here to set>''''' - enter name of layer. Name is case sensitive.
 
No description.


*'''Known Bugs:'''
*'''<kuid:30501:1042>'''
:Layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded


*'''Known Issues:'''
*'''Base Rule'''
:Rule will NOT check to see if the named layer exists or not


*'''Trainz Wiki Links:'''
'''Properties:'''
**'''[[How to Use Layers#Layers in Driver Mode|How to Use Layers: Layers in Driver Mode]]
    '''None'''


==='''Show/Hide Minimap Rule'''===
==='''Session Debug Rule'''===


Shows the minimap window in Driver.
Executes the first child if ''Debug'' mode is selected. Otherwise executes the second child rule.


*'''<kuid:-25:794>'''
*'''<kuid:30501:100180>'''


*'''Built-in Rule'''
*'''Built-in Rule'''


'''Properties:'''
*'''Parent Rule'''  
    '''''<Show/Hide>'' the driver Minimap Window''' - click to switch between '''Show''' and '''Hide'''.


*'''Related Rules:'''
'''Properties:'''
**'''[[#Minimap Options Rule|Minimap Options Rule]]''' - sets the display options for the minimap.
    '''None'''


==='''Show/Hide On-screen Help Rule'''===
*'''Notes:'''  
: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.


Shows or hides On-screen help in Driver.
'''[[#top|Back to Top]]'''
----
=='''Navigation Rules'''==


*'''<kuid:401543:2020>'''
==='''Directional Trigger Check Rule'''===


*'''Built-in Rule'''
Executes child rules when a set train enters a set trigger in a set direction. Adds direction to the '''Trigger Check Rule'''.


'''Properties:'''
*'''<kuid2:532391:100003:1>'''
    '''On screen help (junction overlays, etc)''' - select one of three option buttons:-
      '''( ) Show
      '''( ) Hide
      '''( ) Leave Unchanged
    '''On Screen Vehicle Names:''' -  - select one of three option buttons:-
      '''( ) Show
      '''( ) Hide
      '''( ) Leave Unchanged


==='''Signal Passed At Danger Check Rule'''===
*'''DLS Rule''' by '''bobhahn'''
 
Executes child rules if a signal or stop mark is ''Passed at Danger (STOP)''.
 
*'''<kuid2:60850:89007:2>'''
 
*'''Built-in Rule'''
 
*'''Parent Rule'''


  '''Properties:'''
  '''Properties:'''
     '''[Check Box] Trigger only once'''
     '''[Check Box] Trigger only once '''
 
    '''[Check Box] Wait for child rules to complete even if no trains are present in rule trigger'''
*'''Trainz Wiki Links:'''
    '''[Check Box] Only activate when the entering vehicle of the train is heading ''<select direction>'' into the trigger''' - select one of two directions:-
**'''[[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]]
      '''''forward'''''
      '''''backward'''''
    '''Triggers List'''
      '''''<add trigger>''''' - select a trigger from the session list
      '''''<delete trigger>''''' - delete a selected trigger from the rule
    Select one of two option buttons:-
      '''( ) click to accept all trains'''
      '''( ) click to accept trains matching specific criteria'''
          Selecting the second option will produce the following selection controls:-
          '''Specific vehicle''' - identify the specific vehicle(s) that will trigger the rule
            '''''+''''' - click to add a ''specific'' vehicle from the session list
            '''''x''''' - click to remove the ''specific'' vehicle from the rule
          '''Vehicle types''''' - identify the ''type'' of vehicle(s) that will trigger the rule
            '''''+''''' - click to add a ''type'' of vehicle from the session list
            '''''x''''' - click to remove the ''type'' of vehicle from the rule
          '''Drivers''''' - identify the ''driver(s)'' that will trigger the rule
            '''''+''''' - click to add a ''driver'' from the session list
            '''''x''''' - click to remove a ''driver'' from the rule


==='''Simultaneous List Rule'''===
*'''Notes:'''
#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''.
#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.


Executes child rules simultaneously once this rule starts
*'''Related Rules:'''
**'''[[#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)


*'''<kuid:-25:1048>'''
*'''Trainz Wiki Links:'''
**'''[[How to Control Signals in Sessions#Application 2: Halt Before Clear|How to Control Signals in Sessions: Halt Before Clear]]'''
**'''[[Message Popup Rule Applications]]'''
**'''[[How to Use Navigation Point Rules (Applications)#Application 3: Wait for Loading to be Completed|How to Use Navigation Point Rules (Applications): Wait for Loading to be Completed]]'''
**'''[[How to Use Track Triggers]]'''
**'''[[How to Use Variables in Sessions (Examples)]]'''


*'''Built-in Rule'''
==='''Navigation Display Rule'''===


*'''Parent Rule'''
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.


'''Properties:'''
*'''<kuid2:401543:1161:1>'''
    '''Rule completes when ...''' - click to chose one of the following:-
      '''''one of the child rules has completed'''''
      '''''all child rules have reached a completed state'''''
      '''''all child rules have reached a "was completed" state'''''


*'''Related Rules:'''
*'''Base Rule'''
**'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order
**'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child on the second run, etc
**'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule
**'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously
 
*'''Trainz Wiki Links:'''
**'''[[Message Popup Rule Applications#Application 1: Event Counter and Message Selection|Message Popup Applications: Timed Message]]
**'''[[How to Use Parent and Child Rules]]'''
**'''[[How to Use Variables in Sessions (Examples)#Example 2: Event Counter and Message Selection|How to Use Variables in Sessions (Examples): Event Counter and Message Selection]]
**'''http://online.ts2009.com/mediaWiki/index.php/Simultaneous_List'''
 
==='''Speeding Check Rule'''===
 
Executes child rules if player controlled trains are over the local speed limit or over a set (custom) speed
 
*'''<kuid2:60850:89004:3>'''
 
*'''Built-in Rule'''
 
*'''Parent Rule'''


  '''Properties:'''
  '''Properties:'''
     Select one of two options to set a speed limit to be observed
     '''Unique set ID: ''<click here to set>''''' - enter a unique name for the navigation set. Name must be in lowercase and have no spaces.
      '''( ) Watch for trains travelling above the posted speed limit'''
    '''Train (optional): ''<click here to set>''''' - select a rolling stock asset from the session list shown.
          '''''<speed value>''''' - click to enter a new overspeed tolerance value
    Select one of three option buttons:-
          '''''<speed units>''''' - click to select one from the list:-
    '''( ) All points must be completed in sequence:'''
            '''''Km/h''''' - Kilometres per hour
      - the first uncompleted navigation point will be shown and must be completed next.
            '''''MPH''''' - Miles per hour
      - the next point (if any) will also be shown partly transparent.
            '''''mps''''' - metres per second
    '''( ) Points will be completed in sequence, but can be skipped:'''
      '''( ) Watch for trains travelling above a custom speed'''
      - navigation points can be skipped but must be completed in order.
          '''''<speed value>''''' - click to enter a new custom speed value
      - you cannot go back to complete a missed point.
          '''''<speed units>''''' - click to select one from the list:-
    '''( ) All points must be completed, but in any order:'''
            '''''Km/h''''' - Kilometres per hour
      - all uncompleted navigation points will be shown.
            '''''MPH''''' - Miles per hour
      - you may complete them in any order.
            '''''mps''''' - metres per second
  For each navigation point:
            '''Warning: This option is very performance intensive and should only be used in sessions with few trains'''
      '''''<Click here to set>''''' - select an item (trigger, trackmark, track object, rolling stock) from the session list to become the navigation point.
      '''''<Display text>''''' - enter a text message to display with the navigation point. You are limited to 25 characters.
      '''Icon ''<icon list>''''' - select an icon for the navigation point.
      '''''<Style>''''' - click to select one from three choices
        '''''Automatic''''' - the navigation point will be completed as soon as the consist reaches the point.
        '''''Manual''''' - the navigation point must be set as complete by using the '''Navigation point complete rule''' or the '''Navigation set clear rule'''.
            The '''Manual''' style option allows you to execute other rules (e.g. consist check, wait, etc) before completing the navigation point.
        '''''Require Stop''''' - the navigation point will be completed when the consist comes to a complete stop on the point.


==='''Startup Options Rule'''===
*'''Related Rules:'''
**'''[[#Navigation Set Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.
**'''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set has completed or is incomplete.
**'''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
**'''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.
**'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed


Specifies the starting options for the session. The weather settings will set the ''initial'' conditions, including the variability. To manually change the weather during play, use the '''Weather Rule'''.
*'''Trainz Wiki Links:'''
**'''[[How to Use Navigation Point Rules (Applications)]]'''
**'''[[How to Use Navigation Point Rules]]'''
 
==='''Navigation Point Complete Rule'''===
 
Manually completes a navigation point in a set


*'''<kuid:-16:10212>'''
*'''<kuid:401543:1167>'''


*'''Base Rule'''
*'''Base Rule'''


  '''Properties:'''
  '''Properties:'''
     '''Current control method is ''<select>''''' - select one from:-
     '''Mark navigation point ''<click here to set>''''' - enter the navigation point number to be completed
      '''''Easy Mode''''' - DCC (standard keyboard and mouse) control
     '''complete in set ''<click here to set>''''' - enter the unique name for the navigation set created using the '''Navigation Display Rule'''.
      '''''Ask User''''' - let the user decide
        Name must be in lowercase and have no spaces.
      '''''Realistic Mode''''' - Cab controls (on screen levers, throttles, buttons, etc)
    '''Set weather to ''<select mode>'' with ''<select frequency>'' changeability''' - select
      '''Weather mode:''' - select one of:-
          '''''Clear'''''
          '''''Cloudy'''''
          '''''Drizzle'''''
          '''''Rain'''''
          '''''Stormy'''''
          '''''Light Snow'''''
          '''''Medium Snow'''''
          '''''Heavy Snow'''''
      '''Changeability:''' - select one of:-
          '''''Off''''' - the weather will not change from the mode selected above
          '''''Periodic''''' - slow gradual changes to the weather
          '''''Extreme''''' - rapid and extreme changes to the weather
     '''Set time to ''<hours>'':''<minutes>'' with a rate of ''<select speed>''''' - set the starting time and the speed at which the Trainz clock will run
    '''Set derailment realism to ''<select reality level>''''' - select one of:-
      '''''None''''' - no train derailments will occur
      '''''Arcade''''' - train derailments will be exaggerated (beyond normal)
      '''''Realistic''''' - train derailments will occur as realistically as possible
    '''[Check Box] Show in game help''' - check to switch on help options
    '''Use ''<select measurement system>'' units in Driver''' - select one of:-
      '''''Metric''''' - kilometres, metres. This will override the default settings in a session
      '''''Imperial''''' - miles, feet. This will override the default settings in a session
      '''''Default''''' - uses the measurement system specified in the session


*'''Notes:'''
*'''Known Issues:'''
:Times are Trainz clock time, not real time
:The rule will '''NOT''' check to see if the named navigation set and point exists or not.


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Time and Rate Rule|Time and Rate Rule]]''' - sets the session start time and the rate at which time passes.
**'''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
**'''[[#Weather Rule|Weather Rule]]''' - changes weather conditions during Session play
**'''[[#Navigation Set Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.
**'''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set has completed or is incomplete.
**'''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
**'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed
 
*'''Trainz Wiki Links:'''
**'''[[How to Use Navigation Point Rules (Applications)]]'''
**'''[[How to Use Navigation Point Rules]]'''


==='''Station Visited Check Rule'''===
==='''Navigation Set Check Rule'''===


Executes child rules if specific trains call at set stations or industries
Executes child rules if a navigation set created with the '''Navigation Display Rule''' is complete (or incomplete).


*'''<kuid2:60850:89005:3>'''
*'''<kuid:401543:1165>'''


*'''Built-in Rule'''
*'''Base Rule'''


*'''Parent Rule'''
*'''Parent Rule'''


  '''Properties:'''
  '''Properties:'''
     '''Trigger: ''<select>''''' - click to select one of the following
     '''Checks if navigation point set ''<name>'':''' - enter the unique name for the navigation set created using the '''Navigation Display Rule'''.
      '''''Never''''' - stopping at the selected industries will never trigger the rule.
        Name must be in lowercase and have no spaces.
      '''''Once only''''' - the rule is triggered on the first visit only to any one of the selected industries
     '''is ''<Complete/Incomplete>''''' - click to select one
      '''''Once per industry''''' - the rule is triggered on the first visit to each industry with each individual product
 
      '''''Once per visit''''' - the rule is triggered on the first visit to each industry regardless of the product
*'''Known Issues:'''
      '''''Once per vehicle''''' - each vehicle can only trigger the rule once.  
:The rule will '''NOT''' check to see if the named navigation set exists or not.
     '''''<select industry>''''' - select industry or industries from session list
 
    Select one of two option buttons:-
*'''Related Rules:'''
      '''( ) click to accept all trains'''
**'''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
      '''( ) click to accept trains matching specific criteria'''
**'''[[#Navigation Set Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.
          Selecting the second option will produce the following selection controls:-         
**'''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
          '''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
**'''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.
            '''''+''''' - click to add a ''specific'' vehicle from the session list
**'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed
            '''''x''''' - click to remove the ''specific'' vehicle from the rule
 
          '''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule
*'''Trainz Wiki Links:'''
            '''''+''''' - click to add a ''type'' of vehicle from the session list
**'''[[How to Use Navigation Point Rules (Applications)]]'''
            '''''x''''' - click to remove the ''type'' of vehicle from the rule
**'''[[How to Use Navigation Point Rules]]'''
          '''Drivers''''' - identify the ''drivers'' that will trigger the rule
            '''''+''''' - click to add a ''driver'' from the session list
            '''''x''''' - click to remove a ''driver'' from the rule
----
'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''


=='''T'''==
==='''Navigation Set Clear Rule'''===
==='''Time and Rate Rule'''===


Sets the session start time and the rate at which time passes.
Clears a navigation set removing any uncompleted navigation points


*'''<kuid:-25:889>'''
*'''<kuid:401543:1164>'''


*'''Built-in Rule'''
*'''Base Rule'''


  '''Properties:'''
  '''Properties:'''
     '''Set time to ''<hours:minutes>''''' - enter the clock starting time as hours ('''0-23''') and minutes ('''0-59''')
     '''''<Click here to set>''''' - enter the unique name for the navigation set created using the '''Navigation Display Rule'''.
    '''with a rate of ''<1x>''''' - select a speed at which time will pass from '''1x''' (normal) to '''1440x''' (extremely fast)
        Name must be in lowercase and have no spaces.
 
*'''Known Issues:'''
:The rule will '''NOT''' check to see if the named navigation set exists or not.


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Startup Options Rule|Startup Options Rule]]''' - sets the startup options for a session including time and rate
**'''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
**'''[[#Timecheck Rule|Timecheck Rule]]''' - executes child rules at a set time.
**'''[[#Navigation Set Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.
**'''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set has completed or is incomplete.
**'''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.
**'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed


==='''Timecheck Rule'''===
*'''Trainz Wiki Links:'''
**'''[[How to Use Navigation Point Rules (Applications)]]'''
**'''[[How to Use Navigation Point Rules]]'''


Executes child rules at a set time.
==='''Navigation Set Hide/Show Rule'''===


*'''<kuid2:122381:10008:3>'''
Shows and hides navigation sets. You can have multiple sets visible and hidden at the same time.


*'''Built-in Rule'''
*'''<kuid:401543:1163>'''


*'''Parent Rule'''
*'''Base rule'''


  '''Properties:'''
  '''Properties:'''
     '''''<hh:mm:ss>''''' - enter execution time as hours (0-23), minutes (0-59) and seconds (0-59).
     '''''<visibility>''''' - click to select one
     '''[Check Box] Execution time is on the day after the start time''' - when checked delays execution until the following day.
      '''Hide''' - select to make the navigation set invisible
      '''Show''' - select to make the navigation set visible
     '''''<click here to set>''''' - enter the unique name for the navigation set created using the '''Navigation Display Rule'''.
        Name must be in lowercase and have no spaces.


*'''Known Issues:'''
*'''Known Issues:'''
:Do not use this rule as a child of a repeating rule such as the '''Simultaneous List Rule''' or the '''Ordered List Rule'''.
:The rule will '''NOT''' check to see if the named navigation set exists or not.
 
*'''Notes:'''
:Times and days are Trainz clock times not real time.


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Time and Rate Rule|Time and Rate Rule]]''' - sets the session start time and the rate at which time passes.
**'''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
**'''[[#Wait Rule|Wait Rule]]''' - executes child rules after waiting for a set number of seconds.
**'''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set has completed or is incomplete.
**'''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
**'''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.
**'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed


==='''Timed Limited Display HTML Rule (SP2 and later)'''===
*'''Trainz Wiki Links:'''
**'''[[How to Use Navigation Point Rules (Applications)]]'''
**'''[[How to Use Navigation Point Rules]]'''
 
==='''Schedule Rule'''===


Displays an HTML browser window for a limited time.
Allows a schedule of timed events to be applied to a train


*'''<kuid2:61392:2005:32>'''
*'''<kuid:-3:10185>'''


*'''DLS Rule''' by '''pguy'''
*'''Base Rule'''


  '''Properties:'''
  '''Properties:'''
  '''HTML Asset Name : ''<[Click to select HTML asset]>''''' - click to select an HTML asset from those installed
    '''Insert track mark ''<select>''''' - select a track mark from the Session List
  '''Page filename : ''<value>''''' - click to enter the filename of the HTML page in the selected HTML asset. The ''.html'' filename extension is optional.
    '''Arrival and Departure Time ''<Select>''''' - set time
  '''Play duration (SessVar or duration in seconds) : ''<value>''''' - enter a SessVar name or the number of seconds.
      '''''hh:mm:ss''''' - in hours/minutes/seconds
  '''Browser left position (SessVar or position) : ''<value>''''' - enter a SessVar name or the number of pixels from the left screen edge.
    '''Current Train ''<select>''''' - select from session list
  '''Browser top position (SessVar or position) : ''<value>''''' - enter a SessVar name or the number of pixels from the top screen edge.
    '''Insert destination ''<select>''''' - select from session list
  '''Browser width (SessVar or position) : ''<value>''''' - enter a SessVar name or the width in pixels.
  '''Browser height (SessVar or position) : ''<value>''''' - enter a SessVar name or the browser height.
  '''[Check Box] ''<Alert is not reshowable on request/Alert is showable on request>''''' - check or click to allow or prevent the user viewing the page again.


*'''Notes:'''
*'''Notes:'''
:Seconds are Trainz clock time, not real time.
:Times are Trainz clock times, not real time


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Close Message Popup Rule|Close Message Popup Rule]]''' - closes open message popups
**'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
**'''[[#Display HTML Pages Rule|Display HTML Pages Rule]]''' - displays HTML pages in a browser window.
**'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
**'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
**'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
**'''[[#Set HTML Page Rule|Set HTML Page Rule]]''' - sets parameters for the '''[[#Display HTML Pages Rule|Display HTML Pages Rule]]'''
**'''[[#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


==='''Trackside Check Rule'''===
==='''Trackside Check Rule'''===
Line 2,665: Line 2,680:


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#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


Line 2,702: Line 2,717:


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#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.
**'''[[#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'''


Line 2,711: Line 2,726:
**'''[[How to Use Variables in Sessions (Examples)]]
**'''[[How to Use Variables in Sessions (Examples)]]


==='''Trigger Multiple Signals Rule'''===
==='''Wait on Navigation Point Rule'''===


Sets selected signals to DANGER (STOP) when selected triggers are activated. Signals will be at AUTOMATIC when the triggers are not activated.
Executes child rules when a specific navigation point is completed
 
*'''<kuid:401543:1168>'''


*'''<kuid2:116387:26:1>'''
*'''Base Rule'''


*'''DLS Rule''' by '''maggs'''
*'''Parent Rule'''


  '''Properties:'''
  '''Properties:'''
     '''<add signal>''' - select a signal from the Session List. More than one signal can be added.
     '''navigation point ''<click here to set>''''' - enter the number of the navigation point to be completed
      '''<delete>''' - remove a signal from the rule.
    '''in set ''<click here to set>''''' - enter the unique name for the navigation set created using the '''Navigation Display Rule'''.
    '''<add trigger>''' - select a trigger from the Session List. More than one trigger can be added.
      Name must be in lowercase and have no spaces.
      '''<delete>''' - remove a trigger from the rule.
 
*'''Known Issues:'''
:The rule will '''NOT''' check to see if the named navigation set and point exists or not.


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Set Signal Extended Rule|Set Signal Extended Rule]]''' - sets a selected signal to a specific signal state
**'''[[#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.
'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''
**'''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set is complete or incomplete.
**'''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
**'''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.
 
*'''Trainz Wiki Links:'''
**'''[[Message Popup Rule Applications#Application 2: Navigation Point and Train Stopped Event Message|Message Popup Rule Applications: Navigation Point and Train Stopped Event Message]]
**'''[[How to Use Navigation Point Rules (Applications)]]'''
**'''[[How to Use Navigation Point Rules]]'''


=='''U, V'''==
==='''Wait on Train Stop/Start Rule'''===
==='''Variable Check Rule'''===


Executes child rules when a specific variable matches set conditions
Executes child rules when a train stops or starts moving


*'''<kuid:-25:1049>'''
*'''<kuid:-25:1069>'''


*'''Built-in Rule'''
*'''Built-in Rule'''
Line 2,743: Line 2,767:


  '''Properties:'''
  '''Properties:'''
     '''''<variable-name>''''' - enter a variable-name. Variable name is case sensitive.
     '''[Check Box] Trigger rule once'''
    Mathematical relationship, select one of:-
    '''Wait for a train that matches the following criteria to ''<select>''''' - select one of:-
       '''''is less than''''' - enter a '''''<value>''''' to test against
       '''''start moving'''''
       '''''is less than or equal to''''' - enter a '''''<value>''''' to test against
      '''''stop moving'''''
       '''''is equal to''''' - enter a '''''<value>''''' to test against
    Select one of two option buttons:-
      '''''is greater than or equal to''''' - enter a '''''<value>''''' to test against
       '''( ) click to accept all trains'''
      '''''is greater than''''' - enter a '''''<value>''''' to test against
       '''( ) click to accept trains matching specific criteria'''
      '''''is not equal to''''' - enter a '''''<value>''''' to test against
          Selecting the second option will produce the following selection controls:-
      '''''is between x and y''''' - enter a minimum '''''<x-value>''''' and a maximum '''''<y-value>'''''
          '''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
    Evaluation type. Select one from:-
            '''''+''''' - click to add a ''specific'' vehicle from the session list
      '''''<This condition will be evaluated only once ...>''''' - any changes to the variable that occur after
            '''''x''''' - click to remove the ''specific'' vehicle from the rule
              it has been checked will not change the result of this rule
          '''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule
      '''''<This condition will be evaluated once every second>''''' - the rule will be rerun and the variable
            '''''+''''' - click to add a ''type'' of vehicle from the session list
              rechecked every second
            '''''x''''' - click to remove the ''type'' of vehicle from the rule
 
          '''Drivers''''' - identify the ''drivers'' that will trigger the rule
*'''Related Rules:'''
            '''''+''''' - click to add a ''driver'' from the session list
**'''[[#Quick Session Variables Rule|Quick Session Variables Rule]]''' - allows the editing of session variables.
            '''''x''''' - click to remove a ''driver'' from the rule
**'''[[#Variable Modify Rule|Variable Modify Rule]]''' - changes the value of a specified variable.
**'''[[#Variable Modify Continuous Rule|Variable Modify Continuous Rule]]''' - continuously changes the value of a specified variable.
**'''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.
**'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.


*'''Trainz Wiki Links:'''
*'''Trainz Wiki Links:'''
**'''[[How to Use Variables in Sessions (Examples)]]
**'''[[Message Popup Rule Applications#Application 2: Navigation Point and Train Stopped Event Message|Message Popup Rule Applications: Navigation Point and Train Stopped Event Message]]'''


==='''Variable Modify Continuous Rule'''===
'''[[#top|Back to Top]]'''
----
=='''Resources Rules'''==
 
==='''DisplayIndustryStatus Rule (color modified)'''===


Adds, subtracts or sets a value to a specified variable every second.
Displays a summary of industry product levels when the "k" key is pressed.


*'''<kuid:-25:1051>'''
*'''<kuid:622415:100001>'''


*'''Built-in Rule'''
*'''DLS Rule''' by '''lockheed02''' and '''marzipan'''


  '''Properties:'''
  '''Properties:'''
  '''''<Add/Subtract/Change variable to>''''' - select one.
    '''None'''
      '''''<value>''''' - enter value to add, subtract or apply to ''<variable-name>''
 
      '''''<variable-name>''''' - enter variable-name. Variable-name is case sensitive.
*'''Notes:'''
: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.


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Quick Session Variables Rule|Quick Session Variables Rule]]''' - allows the editing of session variables.
**'''[[#ExTrainz Manager Rule - TANE SP2|ExTrainz Manager Rule - TANE SP2]]''' - displays information on consists, industries and products in Driver and Surveyor.
**'''[[#Variable Check Rule|Variable Check Rule]]''' - executes child rules according to the value of a specified variable.
**'''[[#Variable Modify Rule|Variable Modify Rule]]''' - changes the value of a specified variable.
**'''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.
**'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.


==='''Variable Modify Rule'''===
==='''ExTrainz Manager Rule - TANE SP2'''===


Change the value of a specified variable. This rule can also used to create a new variable and set its initial value by using the "Change variable" option.
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.


*'''<kuid:-25:1050>'''
*'''<kuid:160293:10029>'''


*'''Built-in Rule'''
*'''DLS Rule''' by '''trev999'''


  '''Properties:'''
  '''Properties:'''
     '''Change ''<Add to variable/Subtract from variable/Change variable>''''' - click to select one from:-
     '''Diagnostic mode is ''<On/Off>''''' - click to select ''On'' or ''Off''. When set ''On'' diagnostic messages will be added to the Trainz Log file.
      '''Add to variable'''
    '''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.
          '''Add ''<value>''''' to '''variable ''<variable-name>''''' - enter value to add to variable, enter variable-name. Variable-name is case sensitive.
    '''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.
          '''''<Do not undo the alteration if the rule is stopped/Undo the alteration if the rule is stopped>''''' - click to select one.
    '''Search only rolling stock already in session ''<Yes/No>''''' - click to select ''Yes'' or ''No''. When set to ''Yes'' only those rolling stock assets
      '''Subtract from variable'''
      installed in the session can be searched.
          '''Subtract ''<value>''''' from '''variable ''<variable-name>''''' - enter value to subtract from variable, enter variable-name.
    '''Graphic colours: ''<When Red, the industry does not require service/When Green, the industry does not require service>''''' - click to switch
            Variable-name is case sensitive.
      between the two colour options.
          '''''<Do not undo the alteration if the rule is stopped/Undo the alteration if the rule is stopped>''''' - click to select one.
    '''Industry page size: ''<value>''''' - enter the number of industries to be displayed in the Industry List window (maximum 250).
      '''Change variable'''
    '''The following industries are excluded: ''<Add an industry to be excluded>''''' - name can be complete (e.g. "Coal Mine 2")
          '''Change variable ''<variable-name>'' to ''<value>''''' - enter variable-name, enter new value.  
      which will exclude that specific industry from the management list, or partial (e.g. "Coal") which will exclude all
            Variable-name is case sensitive. This change cannot be undone if the rule is stopped.
      industries with the word "Coal" in their names. Entries are not case sensitive.
    '''[Check Box] (optional) Set the minimum value''' of '''''<variable-name>''''' to '''''<value>''''' - enter variable-name
      Once industries have been excluded, additional commands will appear for each excluded industry:-
      (this will already be set by the change option) and a value. Variable-name is case sensitive.
      '''''<delete> <industry name begins with/class name begins with> <name>''''' - click ''delete'' to remove this entry.
    '''[Check Box] (optional) Set the maximum value''' of '''''<variable-name>''''' to '''''<value>''''' - enter variable-name
          - click ''industry name begins with/class name begins with'' to select between the two (see ''notes'' below).
      (this will already be set by the change option) and a value. Variable-name is case sensitive.
          - click ''name'' to edit the name.
 
*'''Notes:'''
#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.
 
*'''Known Issues:'''
:This rule is NOT compatible with all industries.


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Quick Session Variables Rule|Quick Session Variables Rule]]''' - allows the editing of session variables.
**'''[[#DisplayIndustryStatus Rule (color modified)|DisplayIndustryStatus Rule (color modified)]]''' - displays information on industry product levels.
**'''[[#Variable Check Rule|Variable Check Rule]]''' - executes child rules according to the value of a specified variable.
**'''[[#Variable Modify Continuous Rule|Variable Modify Continuous Rule]]''' - continuously changes the value of a specified variable.
**'''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.
**'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.


*'''Trainz Wiki Links:'''
==='''Hide Product Overlays Rule'''===
**'''[[How to Use Variables in Sessions (Examples)]]
**'''http://online.ts2009.com/mediaWiki/index.php/Variable_Modify_Rule'''


==='''Variable Random Rule'''===
Hides the commodity or product bar graphs that appear on active industries


Assigns a random integer value to a variable.
*'''<kuid:400048:100970>'''


*'''<kuid:400260:100606>'''
*'''DLS Rule''' by '''callavsg'''
 
*'''DLS Rule''' by '''tram_'''


  '''Properties:'''
  '''Properties:'''
    '''Random variable ''<name>'' in ''minimum'' to ''maximum'' interval''' - enter name of variable. Variable-name is case sensitive.
  '''None'''
    '''The minimum possible value of ''variable_name'' is ''<value>''''' - enter the minimum value
    '''The maximum possible value of ''variable_name'' is ''<value>''''' - enter the maximum value


*'''Related Rules:'''
==='''Multiple Resource Check Rule'''===
**'''[[#Quick Session Variables Rule|Quick Session Variables Rule]]''' - allows the editing of session variables.
**'''[[#Randomize|Randomize]]''' - creates a different set of random numbers for each session run.
**'''[[#Variable Check Rule|Variable Check Rule]]''' - executes child rules according to the value of a specified variable.
**'''[[#Variable Modify Rule|Variable Modify Rule]]''' - changes the value of a specified variable.
**'''[[#Variable Modify Continuous Rule|Variable Modify Continuous Rule]]''' - continuously changes the value of a specified variable.
**'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.


*'''Trainz Wiki Links:'''
Executes child rules if industries or vehicles reach set commodity levels. This rule replaces the older '''Resource Check Rule'''  
**'''[[How to Use Variables in Sessions (Examples)]]


==='''Variable Show Rule'''===
*'''<kuid:-25:656>'''


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.
*'''Built-in Rule'''


*'''<kuid:-25:971>'''
*'''Parent Rule'''
 
*'''Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
  '''[Check Box] Add'''
    '''<Product Level>''' - click to select a product test from two choices:-
      '''''<variable-name>''''' - enter variable-name to add to HUD. Variable-name is case sensitive.
      '''''Reach/Exceed''''' - sets an upper limit for the resources being monitored.
      '''''<label>''''' - (optional) enter a short label to be displayed on the HUD in front of the variable value.
          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.
  '''[Check Box] Remove'''
          The initial level in the object must be below the set upper limit.
      '''''<variable-name>''''' - enter variable-name to remove from HUD. Variable-name is case sensitive.
      '''''Fall below''''' - sets a lower limit for the resources being monitored.
          For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon falls below a specified level.
          The initial level in the object must be above the set lower limit.
          To test when a resource level reaches zero (i.e. is empty) set the lower limit to a very low value but not zero as the level can never fall below zero.  
    '''''<value>''''' - enter required quantity value
    '''''<select>''''' - select a product from session list of products
    '''''<Add object>''''' - click to select a source or target object. Multiple objects and their queues can be added to the rule.
      ALL the entered products must reach/exceed or fall below the specified value for the rule to be triggered.  
      For each object:-
          '''''<Object>''''' - click to select session active industry or product enabled rail vehicle
          '''''<Queue>''''' - select product queue (there may be only one available)
          '''''<Remove>''''' - removes the object and its product queue from the rule
 
*'''Notes:'''
: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''.


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
**'''[[#Resource Check Rule|Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
**'''[[#Quick Session Variables Rule|Quick Session Variables Rule]]''' - allows the editing of session variables.
**'''[[#Resource Verify Rule (fixed)|Resource Verify Rule (fixed)]]''' - executes child rules when a set resource (commodity) level is reached
**'''[[#Variable Check Rule|Variable Check Rule]]''' - executes child rules according to the value of a specified variable.
**'''[[#Variable Modify Rule|Variable Modify Rule]]''' - changes the value of a specified variable.
**'''[[#Variable Modify Continuous Rule|Variable Modify Continuous Rule]]''' - continuously changes the value of a specified variable.
**'''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.


*'''Trainz Wiki Links:'''
*'''Trainz Wiki Links:'''
**'''[[How to Use Variables in Sessions (Examples)]]
**'''[[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]]'''
 
==='''Resource Check Rule'''===


==='''Vehicle Physics 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'''


Overrides the default vehicle physics properties for all vehicles or for those matching set criteria
*'''<kuid:-25:1067>'''


*'''<kuid:-25:1052>'''
*'''Legacy Rule''' (replaced by '''Multiple Resource Check Rule''')


*'''Built-in Rule'''
*'''Built-in Rule'''


'''Properties:''' 
*'''Parent Rule'''
    Select one of two option buttons:-
      '''( ) click to accept all trains'''
      '''( ) click to accept trains matching specific criteria'''
          Selecting the second option will produce the following selection controls:-
          '''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
            '''''+''''' - click to add a ''specific'' vehicle from the session list
            '''''x''''' - click to remove the ''specific'' vehicle from the rule
          '''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule
            '''''+''''' - click to add a ''type'' of vehicle from the session list
            '''''x''''' - click to remove the ''type'' of vehicle from the rule
          '''Drivers''''' - identify the ''drivers'' that will trigger the rule
            '''''+''''' - click to add a ''driver'' from the session list
            '''''x''''' - click to remove a ''driver'' from the rule
    '''Coupler Parameters:'''
      '''Couplers break at ''<value>'' kN expansion force''' - enter force value
      '''Couplers break at when coupling above ''<value>'' kph''' - enter speed value
      '''[Check Box] Show coupler breakage in HUD''' - check to display breakage in on-screen HUD
    '''Wheelslip Parameters:'''
      '''Maximum tractive effort adjusted by ''<value>'' %''' - enter adjustment as a %
      '''Traction is reduced to ''<value>'' % while wheelslipping''' - enter value as a %
      '''Traction boost is ''<value>'' % while sanding''' - enter value as a %
    '''Sway Parameters:'''
      '''Cab sway level is set to ''<value>'' %''' - enter value as a %
----
'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''
 
=='''W, X, Y, Z'''==
 
==='''Wait for Camera View Mode Rule'''===
 
Executes child rules when the camera view is changed to a selected view
 
*'''<kuid:-25:192>'''
 
*'''Built-in Rule'''
 
*'''Parent Rule'''


  '''Properties:'''
  '''Properties:'''
     '''[Check Box] Trigger rule once''' - check to set
     Select one of two option buttons:-
    '''Wait for the camera to change to the ''<click to select>''''' - select one camera view mode from:-
      '''( ) Watch industry queue'''
      '''Cab View'''
          '''Target Object ''<select>''''' - select an industry from the session list
      '''External View'''
          '''Queue ''<select>''''' - select a product queue from the selected industry
       '''Tracking View'''
          '''Product ''<select>''''' - select a product from the selected queue
      '''Free Roaming'''
          '''Amount ''<value>''''' - enter a quantity
    '''[Check Box] Wait for the camera to target vehicle ''<click to select>''''' - if checked, select a vehicle from the Session list
          Select one of two option buttons:-
            '''( ) Complete when designated queue equals or exceeds required amount'''
            '''( ) Complete when designated queue falls below required amount'''
       '''( ) Watch vehicle'''
          '''Target Object ''<select>''''' - select a rolling stock asset from the session list
          '''Queue ''<select>''''' - select a product queue from the selected rolling stock
          '''Product ''<select>''''' - select a product from the selected queue
          '''Amount ''<value>''''' - enter a quantity
          Select one of two option buttons:-
            '''( ) Complete when designated queue equals or exceeds required amount'''
            '''( ) Complete when designated queue falls below required amount'''
 
*'''Notes:'''
: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''.


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Cinematic Camera Rule|Cinematic Camera Rule]]''' - provides several different cinematic style cameras with animations
**'''[[#Multiple Resource Check Rule|Multiple Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
**'''[[#Focus Camera Rule|Focus Camera Rule]]''' - sets the initial camera view and starting vehicle for a session
**'''[[#Resource Verify Rule (fixed)|Resource Verify Rule (fixed)]]''' - executes child rules when a set resource (commodity) level is reached
**'''[[#Set Camera Rule|Set Camera Rule]]''' - sets the target object and properties of the camera


==='''Wait for Click on HUD Icon Rule'''===
*'''Trainz Wiki Links:'''
**'''http://online.ts2009.com/mediaWiki/index.php/Resource_Check_Rule'''


Executes child rules when the user clicks on a selected HUD icon
==='''Resource Verify Rule (fixed)'''===


*'''<kuid:-25:951> <kuid:-25:970>''' - two versions built-in with different kuids, both have the same properties
Executes child rules if a selected industry or vehicle reaches a set commodity level. The rule resets when all child rules have completed.


*'''Built-in Rule'''
*'''<kuid:160293:10060>'''
 
*'''DLS Rule''' by '''trev999


*'''Parent Rule'''
*'''Parent Rule'''


  '''Properties:'''
  '''Properties:'''
     '''[Check Box] Trigger Once'''
    Select one of two option buttons:-
    '''HUD Panel ''<Click>''''' - click choose from list:-
     '''( ) Watch industry queue'''
       '''Bottom Right Menu'''
      '''Target object ''<click to select>''''' - click to select an industry from the session list.
       '''Camera Controls'''
      '''Product ''<click to select>''''' - click to select an industry product.
       '''DCC Controls'''
       '''Amount ''<value>''''' - enter a quantity for the selected product.
     '''Icon ''<Click>''''' - click to choose from list. Selections depends on HUD Panel chosen
      Select one of two option buttons:-
       '''( ) Complete when designated queue equals or exceeds designated amount'''
       '''( ) Complete when designated queue falls below designated amount'''
     '''( ) Watch vehicle queue'''
      '''Target object ''<click to select>''''' - click to select a rolling stock vehicle from the session list.
      '''Product ''<click to select>''''' - click to select a commodity product.
      '''Amount ''<value>''''' - enter a quantity for the selected product.
      Select one of two option buttons:-
      '''( ) Complete when designated queue equals or exceeds designated amount'''
      '''( ) Complete when designated queue falls below designated amount'''
 
*'''Notes:'''
#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''.


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
**'''[[#Multiple Resource Check Rule|Multiple Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
**'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
**'''[[#Resource Check Rule|Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
**'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
**'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers
**'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
**'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.


==='''Wait for Derailment Rule'''===
'''[[#top|Back to Top]]'''
----
=='''Session Sequence Rules'''==


Executes child rules when a derailment occurs
==='''Ordered List Rule'''===
 
Executes child rules in order once this rule starts


*'''<kuid:-25:1053>'''
*'''<kuid:-25:171>'''


*'''Built-in Rule'''
*'''Built-in Rule'''
Line 2,972: Line 2,985:


  '''Properties:'''
  '''Properties:'''
     '''[Check Box] Trigger derailment watch once''' - check to execute the rule once only
     Select one of two option buttons:-
      '''( ) This process will repeat ''<value>'' time(s)''' - enter the number of times this rule is to be repeated
      '''( ) This process will repeat forever'''
 
*'''Known Issues:'''
:Some child rules will force a "wait" until certain conditions have been met (e.g. a mouse click or a set time has passed). These rules will delay the completion of any following child rules in the '''Ordered List Rule'''. If possible, place these rules last in the Ordered List.
::For example: The '''Message Popup Rule''' will wait until it is closed before allowing the next child rule to be executed.


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Clean Up Derailed Trains Rule|Clean Up Derailed Trains Rule]]''' - cleans up derailed train cars after a set time delay
**'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child on the second run, etc
**'''[[#Replace Missing Vehicles Rule|Replace Missing Vehicles Rule]]''' - creates a replacement train after a derailment
**'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule
**'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously
**'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously
 
*'''Trainz Wiki Links:'''
**'''http://online.ts2009.com/mediaWiki/index.php/Ordered_List'''
**'''[[How to Use Parent and Child Rules]]'''


==='''Wait for Driver On/Off Train Rule'''===
==='''Progressive List Rule'''===


Executes child rules when a driver gets on or off a train
Executes the first child rule on the first run, the second child on the second run, the third child on the third run, etc.


*'''<kuid:-25:953>'''
*'''<kuid:-25:754>'''


*'''Built-in Rule'''
*'''Built-in Rule'''
Line 2,989: Line 3,014:


  '''Properties:'''
  '''Properties:'''
  '''[Check Box] Trigger Rule Once''' - click to set''  
  '''After last child has been executed ...'''
  '''Wait for a driver character to get ''<On/Off>''''' a train that matches the following criteria''' - select '''On''' or '''Off'''
  '''''<successive runs will do nothing/the first child is chosen again>''''' - click to select one
  Select one of two option buttons:-
 
    '''( ) click to accept all trains'''
*'''Related Rules:'''
    '''( ) click to accept trains matching specific criteria'''
**'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order
        Selecting the second option will produce the following selection controls:-
**'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule
        '''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
**'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously
          '''''+''''' - click to add a ''specific'' vehicle from the session list
**'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously
          '''''x''''' - click to remove the ''specific'' vehicle from the rule
        '''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule
          '''''+''''' - click to add a ''type'' of vehicle from the session list
          '''''x''''' - click to remove the ''type'' of vehicle from the rule
        '''Drivers''''' - identify the ''drivers'' that will trigger the rule
          '''''+''''' - click to add a ''driver'' from the session list
          '''''x''''' - click to remove a ''driver'' from the rule


*'''Related Rules:'''
*'''Trainz Wiki Links:'''
**'''[[#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
**'''http://online.ts2009.com/mediaWiki/index.php/Progressive_List'''
**'''[[How to Use Parent and Child Rules]]'''


==='''Wait for Driver/Train to be Locally Owned Rule'''===
==='''Random List Rule'''===


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 ONE randomly selected child rule once only. The rule will not repeat to randomly select another child rule


*'''<kuid2:401543:1173:1>'''
*'''<kuid:-25:758>'''


*'''Built-in Rule'''
*'''Built-in Rule'''
Line 3,019: Line 3,038:


  '''Properties:'''
  '''Properties:'''
  '''Assets Ownership:''' - select one of two option buttons:-
    '''None'''
    '''( ) Wait for ownership of a specific Driver'''
    '''( ) Wait for ownership of Driver'''
  '''Driver or Vehicle ''<select>''''' - choose from session list


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#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
**'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order
**'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child rule on the second run, etc
**'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously
**'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously


==='''Wait on Navigation Point Rule'''===
*'''Trainz Wiki Links:'''
**'''[[How to Use Parent and Child Rules]]'''
**'''http://online.ts2009.com/mediaWiki/index.php/Random_List'''


Executes child rules when a specific navigation point is completed
==='''Reset List Rule'''===
 
Executes ALL child rules continuously in an ongoing infinite cycle


*'''<kuid:401543:1168>'''
*'''<kuid:-25:762>'''


*'''Base Rule'''
*'''Built-in Rule'''


*'''Parent Rule'''
*'''Parent Rule'''


  '''Properties:'''
  '''Properties:'''
     '''navigation point ''<click here to set>''''' - enter the number of the navigation point to be completed
     '''None'''
    '''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.
 
*'''Known Issues:'''
:The rule will '''NOT''' check to see if the named navigation set and point exists or not.


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
**'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order
**'''[[#Navigation Set Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.
**'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child rule on the second run, etc
**'''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set is complete or incomplete.
**'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule
**'''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
**'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously
**'''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.


*'''Trainz Wiki Links:'''
*'''Trainz Wiki Links:'''
**'''[[Message Popup Rule Applications#Application 2: Navigation Point and Train Stopped Event Message|Message Popup Rule Applications: Navigation Point and Train Stopped Event Message]]
**'''http://online.ts2009.com/mediaWiki/index.php/Reset_List'''
**'''[[How to Use Navigation Point Rules (Applications)]]'''
**'''[[How to Use Parent and Child Rules]]'''
**'''[[How to Use Navigation Point Rules]]'''


==='''Wait on Train Stop/Start Rule'''===
==='''Simultaneous List Rule'''===


Executes child rules when a train stops or starts moving
Executes child rules simultaneously once this rule starts


*'''<kuid:-25:1069>'''
*'''<kuid:-25:1048>'''


*'''Built-in Rule'''
*'''Built-in Rule'''
Line 3,068: Line 3,084:


  '''Properties:'''
  '''Properties:'''
     '''[Check Box] Trigger rule once'''  
     '''Rule completes when ...''' - click to chose one of the following:-
    '''Wait for a train that matches the following criteria to ''<select>''''' - select one of:-
       '''''one of the child rules has completed'''''
       '''''start moving'''''
       '''''all child rules have reached a completed state'''''
       '''''stop moving'''''
       '''''all child rules have reached a "was completed" state'''''
    Select one of two option buttons:-
 
       '''( ) click to accept all trains'''
*'''Related Rules:'''
      '''( ) click to accept trains matching specific criteria'''
**'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order
          Selecting the second option will produce the following selection controls:-
**'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child on the second run, etc
          '''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
**'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule
            '''''+''''' - click to add a ''specific'' vehicle from the session list
**'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously
            '''''x''''' - click to remove the ''specific'' vehicle from the rule
          '''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule
            '''''+''''' - click to add a ''type'' of vehicle from the session list
            '''''x''''' - click to remove the ''type'' of vehicle from the rule
          '''Drivers''''' - identify the ''drivers'' that will trigger the rule
            '''''+''''' - click to add a ''driver'' from the session list
            '''''x''''' - click to remove a ''driver'' from the rule


*'''Trainz Wiki Links:'''
*'''Trainz Wiki Links:'''
**'''[[Message Popup Rule Applications#Application 2: Navigation Point and Train Stopped Event Message|Message Popup Rule Applications: Navigation Point and Train Stopped Event Message]]'''
**'''[[Message Popup Rule Applications#Application 1: Event Counter and Message Selection|Message Popup Applications: Timed Message]]
**'''[[How to Use Parent and Child Rules]]'''
**'''[[How to Use Variables in Sessions (Examples)#Example 2: Event Counter and Message Selection|How to Use Variables in Sessions (Examples): Event Counter and Message Selection]]
**'''http://online.ts2009.com/mediaWiki/index.php/Simultaneous_List'''
 
'''[[#top|Back to Top]]'''
----
=='''Speed Rules'''==


==='''Wait on Waybill Screen/Main Screen Rule'''===
==='''ATP Speed Limiter Rule'''===


Executes child rules when the Waybill window is opened or closed
Limits allowable speed over set limit


*'''<kuid:-25:957>'''
*'''<kuid2:321959:1000:1>'''


*'''Built-in Rule'''
*'''Built-in Rule'''


*'''Parent Rule'''
'''Properties:'''
 
    '''Limits the speed to ''<value>'' mph over the set limit''' - enter speed value in mph
  '''Properties:'''
 
     '''[Check Box] Trigger rule once''' - check to trigger the rule once only
==='''Speeding Check Rule'''===
     '''Wait for the Waybill window to be ''<opened/closed>''''' - select either '''opened''' or '''closed'''.
 
 
Executes child rules if player controlled trains are over the local speed limit or over a set (custom) speed
==='''Wait Rule'''===
 
 
*'''<kuid2:60850:89004:3>'''
Executes child rules after waiting for set number of seconds
 
 
*'''Built-in Rule'''
*'''<kuid2:122381:10016:2>'''
 
 
*'''Parent Rule'''
*'''Built-in Rule'''
 
 
  '''Properties:'''
*'''Parent Rule'''
     Select one of two options to set a speed limit to be observed
 
      '''( ) Watch for trains travelling above the posted speed limit'''
  '''Properties:'''
          '''''<speed value>''''' - click to enter a new overspeed tolerance value
     '''''<click to set>''''' - enter the number of seconds for the wait delay
          '''''<speed units>''''' - click to select one from the list:-
 
            '''''Km/h''''' - Kilometres per hour
*'''Notes:'''  
            '''''MPH''''' - Miles per hour
:Seconds is in Trainz clock time, not real time
            '''''mps''''' - metres per second
 
      '''( ) Watch for trains travelling above a custom speed'''
*'''Related Rules:'''
          '''''<speed value>''''' - click to enter a new custom speed value
**'''[[#Timecheck Rule|Timecheck Rule]]''' - executes child rules at a set time.
          '''''<speed units>''''' - click to select one from the list:-
 
            '''''Km/h''''' - Kilometres per hour
*'''Trainz Wiki Links:'''
            '''''MPH''''' - Miles per hour
**'''[[Message Popup Rule Applications#Application 1: Timed Message|Message Popup Rule Applications: Timed Message]]'''
            '''''mps''''' - metres per second
**'''[[How to Use Navigation Point Rules (Applications)#Application 4: User Path Selection|How to Use Navigation Point Rules (Applications): User Path Selection]]
            '''Warning: This option is very performance intensive and should only be used in sessions with few trains'''
 
 
==='''Weather Rule'''===
==='''MaxPermittedSpeed Rule'''===
 
 
Changes the weather conditions during Session play.
Sets the maximum permitted speed of locomotives under AI control
 
 
*'''<kuid:-25:960>'''
*'''<kuid2:60850:89000:7>'''
 
 
*'''Built-in Rule'''
*'''Built-in Rule'''
 
 
  '''Properties:'''
'''Properties:'''
     '''Set weather to ''<select mode>'' with ''<select frequency>'' changeability''' - select
    '''None'''
 
*'''Notes:'''
:This rule cannot be configured from the Session Rules list. It must be configured in the '''config.txt''' file of each locomotive. Instructions with an example are shown in the rule Properties
 
'''[[#top|Back to Top]]'''
----
=='''Startup and Termination Rules'''==
 
==='''End Session Rule'''===
 
End the Session with a fade out.
 
*'''<kuid:-25:482>'''
 
*'''Built-in Rule'''
 
'''Properties:'''
    '''Fade out over ''<value>'' seconds''' - enter number of seconds for fade out.
 
*'''Notes:'''
:Seconds are Trainz clock time, not real time.
 
*'''Related Rules:'''
**'''[[#Session Complete Rule|Session Complete Rule]]''' - set the session to a percentage of completion
 
==='''Multiplayer Rule'''===
 
Enables the session to be taken online in a Multiplayer environment.
 
*'''<kuid:447264:1045>'''
 
*'''Built-in Rule'''
 
'''Properties:'''
    '''Suggested maximum number of players for this session ''<value>''''' - enter a number
    '''Maximum number of drivers per player ''<value>''''' - enter a number
    '''Players are permitted to claim drivers            [Check Box]''' - check to allow players to select a driver
    '''Players can see each other's driver orders        [Check Box]''' - check to allow players to view orders for other players
    '''Automatically target an available train on clients [Check Box]''' - automatically assign a driver to each player
 
==='''Randomize Rule'''===
 
Generates a different set of random numbers each time the session is run.
 
*'''<kuid:169301:100129>'''
 
*'''DLS Rule''' by '''Terry_Wagstaff'''
 
'''Properties:'''
    '''None'''
 
*'''Notes:'''
:Place this rule near the top of the Session Rules list and ensure that there is at least 5 seconds before the call to a Random function.
 
*'''Related Rules:'''
**'''[[#Variable Random|Variable Random]]''' - sets a variable to a random integer value.
 
==='''Session Complete Rule'''===
 
Set session to a percentage of completion.
 
*'''<kuid:447264:1011>'''
 
*'''Base Rule'''
 
'''Properties:'''
    '''Set session to percent complete ''<value>''''' - enter number as a percentage
     '''[Check Box] Separate achievements for completion''' - check to set
 
*'''Related Rules:'''
**'''[[#End Session Rule|End Session Rule]]''' - end the Session with a fade out.
 
==='''Startup Options Rule'''===
 
Specifies the starting options for the session. The weather settings will set the ''initial'' conditions, including the variability. To manually change the weather during play, use the '''Weather Rule'''.
 
*'''<kuid:-16:10212>'''
 
*'''Base Rule'''
 
'''Properties:'''
    '''Current control method is ''<select>''''' - select one from:-
      '''''Easy Mode''''' - DCC (standard keyboard and mouse) control
      '''''Ask User''''' - let the user decide
      '''''Realistic Mode''''' - Cab controls (on screen levers, throttles, buttons, etc)
    '''Set weather to ''<select mode>'' with ''<select frequency>'' changeability''' - select
      '''Weather mode:''' - select one of:-
          '''''Clear'''''
          '''''Cloudy'''''
          '''''Drizzle'''''
          '''''Rain'''''
          '''''Stormy'''''
          '''''Light Snow'''''
          '''''Medium Snow'''''
          '''''Heavy Snow'''''
      '''Changeability:''' - select one of:-
          '''''Off''''' - the weather will not change from the mode selected above
          '''''Periodic''''' - slow gradual changes to the weather
          '''''Extreme''''' - rapid and extreme changes to the weather
    '''Set time to ''<hours>'':''<minutes>'' with a rate of ''<select speed>''''' - set the starting time and the speed at which the Trainz clock will run
    '''Set derailment realism to ''<select reality level>''''' - select one of:-
      '''''None''''' - no train derailments will occur
      '''''Arcade''''' - train derailments will be exaggerated (beyond normal)
      '''''Realistic''''' - train derailments will occur as realistically as possible
    '''[Check Box] Show in game help''' - check to switch on help options
    '''Use ''<select measurement system>'' units in Driver''' - select one of:-
      '''''Metric''''' - kilometres, metres. This will override the default settings in a session
      '''''Imperial''''' - miles, feet. This will override the default settings in a session
      '''''Default''''' - uses the measurement system specified in the session
 
*'''Notes:'''
:Times are Trainz clock time, not real time
 
*'''Related Rules:'''
**'''[[#Time and Rate Rule|Time and Rate Rule]]''' - sets the session start time and the rate at which time passes.
**'''[[#Weather Rule|Weather Rule]]''' - changes weather conditions during Session play
 
'''[[#top|Back to Top]]'''
----
=='''Time Rules'''==
 
==='''Clock Rule'''===
 
Rule needed for animated clocks.
 
*'''<kuid2:62310:30041:2>'''
 
*'''Built-in Rule'''
 
'''Properties:'''
    '''None'''
 
*'''Notes:'''
:Apply this rule to your session to make use of the animated clocks. See the forum for code to include in your clock object to work with this rule.
 
==='''Time and Rate Rule'''===
 
Sets the session start time and the rate at which time passes.
 
*'''<kuid:-25:889>'''
 
*'''Built-in Rule'''
 
'''Properties:'''
    '''Set time to ''<hours:minutes>''''' - enter the clock starting time as hours ('''0-23''') and minutes ('''0-59''')
    '''with a rate of ''<1x>''''' - select a speed at which time will pass from '''1x''' (normal) to '''1440x''' (extremely fast)
 
*'''Related Rules:'''
**'''[[#Startup Options Rule|Startup Options Rule]]''' - sets the startup options for a session including time and rate
**'''[[#Timecheck Rule|Timecheck Rule]]''' - executes child rules at a set time.
 
==='''Timecheck Rule'''===
 
Executes child rules at a set time.
 
*'''<kuid2:122381:10008:3>'''
 
*'''Built-in Rule'''
 
*'''Parent Rule'''
 
'''Properties:'''
    '''''<hh:mm:ss>''''' - enter execution time as hours (0-23), minutes (0-59) and seconds (0-59).
    '''[Check Box] Execution time is on the day after the start time''' - when checked delays execution until the following day.
 
*'''Known Issues:'''
:Do not use this rule as a child of a repeating rule such as the '''Simultaneous List Rule''' or the '''Ordered List Rule'''.
 
*'''Notes:'''
:Times and days are Trainz clock times not real time.
 
*'''Related Rules:'''
**'''[[#Time and Rate Rule|Time and Rate Rule]]''' - sets the session start time and the rate at which time passes.
**'''[[#Wait Rule|Wait Rule]]''' - executes child rules after waiting for a set number of seconds.
 
==='''Wait Rule'''===
 
Executes child rules after waiting for set number of seconds
 
*'''<kuid2:122381:10016:2>'''
 
*'''Built-in Rule'''
 
*'''Parent Rule'''
 
  '''Properties:'''
     '''''<click to set>''''' - enter the number of seconds for the wait delay
 
*'''Notes:'''  
:Seconds is in Trainz clock time, not real time
 
*'''Related Rules:'''
**'''[[#Timecheck Rule|Timecheck Rule]]''' - executes child rules at a set time.
 
*'''Trainz Wiki Links:'''
**'''[[Message Popup Rule Applications#Application 1: Timed Message|Message Popup Rule Applications: Timed Message]]'''
**'''[[How to Use Navigation Point Rules (Applications)#Application 4: User Path Selection|How to Use Navigation Point Rules (Applications): User Path Selection]]
 
'''[[#top|Back to Top]]'''
----
=='''Variable Rules'''==
 
==='''Quick Session Variables Rule'''===
 
Allows the editing of session variables
 
*'''<kuid2:61392:5003:30>'''
 
*'''DLS Rule''' by '''pguy'''
 
'''Properties:'''
    '''''<local>''''' - click to edit local variables
      '''''<add new session variable>''''' - click to enter the name of new local variable
          for each variable:-
          '''''<variable-name>''''' - click to change variable name
          '''''<type>''''' - click to select one of:-
            '''string''' - text characters
            '''int''' - integer
            '''float''' - real (decimal) numbers
            '''bool''' - boolean (true/false)
            '''stringset''' - ''meaning not known at this time''
            '''stringlist''' - ''meaning not known at this time''
            '''tkmlist''' - trackmark list (no longer supported in TANE SP2)
            '''platformlist''' - platform list (no longer supported in TANE SP2)
            '''''del''''' - delete variable
            '''''edit''''' - edit variable
    '''''<trains>''''' - click to edit a train variable
      '''''<train selected>''''' - click to select a train from the session list. Initially none is selected
          '''''<select train>''''' - click to select a locomotive
          '''''<select vehicle>''''' - click to select a rail vehicle
          for the selected loco/vehicle:-
            '''''<Add new session variable>''''' - click to enter the name of a new variable
              for the entered variable:-
                  '''''<variable-name>''''' - click to change variable name
                  '''''<type>''''' - click to select type (see list above)
    '''''<objects>''''' - no longer supported in TANE SP2
    '''''<global>''''' - no longer supported in TANE SP2
 
*'''Known Issues:'''
:Rule creator, '''pguy''', has indicated that the future of this rule is uncertain as parts of it have been devalued in the latest release of TANE.
 
*'''Related Rules:'''
**'''[[#Variable Check Rule|Variable Check Rule]]''' - executes child rules according to the value of a specified variable.
**'''[[#Variable Modify Rule|Variable Modify Rule]]''' - changes the value of a specified variable.
**'''[[#Variable Modify Continuous Rule|Variable Modify Continuous Rule]]''' - continuously changes the value of a specified variable.
**'''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.
**'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
 
==='''Variable Check Rule'''===
 
Executes child rules when a specific variable matches set conditions
 
*'''<kuid:-25:1049>'''
 
*'''Built-in Rule'''
 
*'''Parent Rule'''
 
'''Properties:'''
    '''''<variable-name>''''' - enter a variable-name. Variable name is case sensitive.
    Mathematical relationship, select one of:-
      '''''is less than''''' - enter a '''''<value>''''' to test against
      '''''is less than or equal to''''' - enter a '''''<value>''''' to test against
      '''''is equal to''''' - enter a '''''<value>''''' to test against
      '''''is greater than or equal to''''' - enter a '''''<value>''''' to test against
      '''''is greater than''''' - enter a '''''<value>''''' to test against
      '''''is not equal to''''' - enter a '''''<value>''''' to test against
      '''''is between x and y''''' - enter a minimum '''''<x-value>''''' and a maximum '''''<y-value>'''''
    Evaluation type. Select one from:-
      '''''<This condition will be evaluated only once ...>''''' - any changes to the variable that occur after
              it has been checked will not change the result of this rule
      '''''<This condition will be evaluated once every second>''''' - the rule will be rerun and the variable
              rechecked every second
 
*'''Related Rules:'''
**'''[[#Quick Session Variables Rule|Quick Session Variables Rule]]''' - allows the editing of session variables.
**'''[[#Variable Modify Rule|Variable Modify Rule]]''' - changes the value of a specified variable.
**'''[[#Variable Modify Continuous Rule|Variable Modify Continuous Rule]]''' - continuously changes the value of a specified variable.
**'''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.
**'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
 
*'''Trainz Wiki Links:'''
**'''[[How to Use Variables in Sessions (Examples)]]
 
==='''Variable Modify Continuous Rule'''===
 
Adds, subtracts or sets a value to a specified variable every second.
 
*'''<kuid:-25:1051>'''
 
*'''Built-in Rule'''
 
'''Properties:'''
  '''''<Add/Subtract/Change variable to>''''' - select one.
      '''''<value>''''' - enter value to add, subtract or apply to ''<variable-name>''
      '''''<variable-name>''''' - enter variable-name. Variable-name is case sensitive.
 
*'''Related Rules:'''
**'''[[#Quick Session Variables Rule|Quick Session Variables Rule]]''' - allows the editing of session variables.
**'''[[#Variable Check Rule|Variable Check Rule]]''' - executes child rules according to the value of a specified variable.
**'''[[#Variable Modify Rule|Variable Modify Rule]]''' - changes the value of a specified variable.
**'''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.
**'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
 
==='''Variable Modify Rule'''===
 
Change the value of a specified variable. This rule can also used to create a new variable and set its initial value by using the "Change variable" option.
 
*'''<kuid:-25:1050>'''
 
*'''Built-in Rule'''
 
'''Properties:'''
    '''Change ''<Add to variable/Subtract from variable/Change variable>''''' - click to select one from:-
      '''Add to variable'''
          '''Add ''<value>''''' to '''variable ''<variable-name>''''' - enter value to add to variable, enter variable-name. Variable-name is case sensitive.
          '''''<Do not undo the alteration if the rule is stopped/Undo the alteration if the rule is stopped>''''' - click to select one.
      '''Subtract from variable'''
          '''Subtract ''<value>''''' from '''variable ''<variable-name>''''' - enter value to subtract from variable, enter variable-name.
            Variable-name is case sensitive.
          '''''<Do not undo the alteration if the rule is stopped/Undo the alteration if the rule is stopped>''''' - click to select one.
      '''Change variable'''
          '''Change variable ''<variable-name>'' to ''<value>''''' - enter variable-name, enter new value.
            Variable-name is case sensitive. This change cannot be undone if the rule is stopped.
    '''[Check Box] (optional) Set the minimum value''' of '''''<variable-name>''''' to '''''<value>''''' - enter variable-name
      (this will already be set by the change option) and a value. Variable-name is case sensitive.
    '''[Check Box] (optional) Set the maximum value''' of '''''<variable-name>''''' to '''''<value>''''' - enter variable-name
      (this will already be set by the change option) and a value. Variable-name is case sensitive.
 
*'''Related Rules:'''
**'''[[#Quick Session Variables Rule|Quick Session Variables Rule]]''' - allows the editing of session variables.
**'''[[#Variable Check Rule|Variable Check Rule]]''' - executes child rules according to the value of a specified variable.
**'''[[#Variable Modify Continuous Rule|Variable Modify Continuous Rule]]''' - continuously changes the value of a specified variable.
**'''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.
**'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
 
*'''Trainz Wiki Links:'''
**'''[[How to Use Variables in Sessions (Examples)]]
**'''http://online.ts2009.com/mediaWiki/index.php/Variable_Modify_Rule'''
 
==='''Variable Random Rule'''===
 
Assigns a random integer value to a variable.
 
*'''<kuid:400260:100606>'''
 
*'''DLS Rule''' by '''tram_'''
 
'''Properties:'''
    '''Random variable ''<name>'' in ''minimum'' to ''maximum'' interval''' - enter name of variable. Variable-name is case sensitive.
    '''The minimum possible value of ''variable_name'' is ''<value>''''' - enter the minimum value
    '''The maximum possible value of ''variable_name'' is ''<value>''''' - enter the maximum value
 
*'''Related Rules:'''
**'''[[#Quick Session Variables Rule|Quick Session Variables Rule]]''' - allows the editing of session variables.
**'''[[#Randomize|Randomize]]''' - creates a different set of random numbers for each session run.
**'''[[#Variable Check Rule|Variable Check Rule]]''' - executes child rules according to the value of a specified variable.
**'''[[#Variable Modify Rule|Variable Modify Rule]]''' - changes the value of a specified variable.
**'''[[#Variable Modify Continuous Rule|Variable Modify Continuous Rule]]''' - continuously changes the value of a specified variable.
**'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
 
*'''Trainz Wiki Links:'''
**'''[[How to Use Variables in Sessions (Examples)]]
 
==='''Variable Show Rule'''===
 
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.
 
*'''<kuid:-25:971>'''
 
*'''Built-in Rule'''
 
'''Properties:'''
  '''[Check Box] Add'''
      '''''<variable-name>''''' - enter variable-name to add to HUD. Variable-name is case sensitive.
      '''''<label>''''' - (optional) enter a short label to be displayed on the HUD in front of the variable value.
  '''[Check Box] Remove'''
      '''''<variable-name>''''' - enter variable-name to remove from HUD. Variable-name is case sensitive.
 
*'''Related Rules:'''
**'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
**'''[[#Quick Session Variables Rule|Quick Session Variables Rule]]''' - allows the editing of session variables.
**'''[[#Variable Check Rule|Variable Check Rule]]''' - executes child rules according to the value of a specified variable.
**'''[[#Variable Modify Rule|Variable Modify Rule]]''' - changes the value of a specified variable.
**'''[[#Variable Modify Continuous Rule|Variable Modify Continuous Rule]]''' - continuously changes the value of a specified variable.
**'''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.
 
*'''Trainz Wiki Links:'''
**'''[[How to Use Variables in Sessions (Examples)]]
 
'''[[#top|Back to Top]]'''
----
=='''Weather Rules'''==
==='''EIRS Weather Rule NE USA Rule'''===
 
Customize random weather rule relative to the North East Region of the United States.
 
*'''<kuid2:487222:1037:3>'''
 
*'''Built-in Rule'''
 
'''Properties:'''
    '''Season ''<select>''''' - select one of:-
      '''''Summer'''''
      '''''Fall'''''
      '''''Winter'''''
      '''''Spring'''''
    '''Random Changeability (minutes) ''<value>''''' - select one of:-
      '''''2/5/10/15/20/30/45/60''''' - minutes''
    '''Environment Settings ''<select>''''' - select one of:-
      '''''Disable/Enable'''''
 
*'''Notes:'''
:Minutes are Trainz clock times, not real times
 
*'''Related Rules:'''
**'''[[#Random Weather Rule v2|Random Weather Rule v2]]''' - randomly changes the weather according to entered parameters
**'''[[#Startup Options Rule|Startup Options Rule]]''' - sets the weather conditions at the start of a Session
**'''[[#Weather Rule|Weather Rule]]''' - changes the weather conditions during Session play
 
==='''Random Weather Rule v2'''===
 
Randomly changes the weather conditions between set values over a set duration.
 
*'''<kuid:169301:100132>'''
 
*'''DLS Rule''' by '''terry_wagstaff'''
 
'''Properties:'''
    '''Starting weather ''<select>'' - select one of:-
          '''''Clear weather, no clouds, rain or snow'''''
          '''''Cloudy weather, no rain'''''
          '''''Drizzle, light rain'''''
          '''''Rain'''''
          '''''Stormy weather that includes lightning and thunder'''''
          '''''Snowing lightly'''''
          '''''Medium snowfall'''''
          '''''Heavy snow'''''
    '''Best weather ''<select>'' - select one of:-
          '''''Clear weather, no clouds, rain or snow'''''
          '''''Cloudy weather, no rain'''''
          '''''Drizzle, light rain'''''
          '''''Rain'''''
          '''''Stormy weather that includes lightning and thunder'''''
          '''''Snowing lightly'''''
          '''''Medium snowfall'''''
          '''''Heavy snow'''''
    '''Worst weather ''<select>'' - select one of:-
          '''''Clear weather, no clouds, rain or snow'''''
          '''''Cloudy weather, no rain'''''
          '''''Drizzle, light rain'''''
          '''''Rain'''''
          '''''Stormy weather that includes lightning and thunder'''''
          '''''Snowing lightly'''''
          '''''Medium snowfall'''''
          '''''Heavy snow'''''
    '''Changing about every: ''<value>'' mins''' - enter number of minutes between weather changes
 
*'''Known issues:'''
:This rule, once started, will run continuously and will not terminate so do NOT use this rule as a child rule in an '''Ordered List Rule''' because any following child rules will never be executed.
 
*'''Related Rules:'''
**'''[[#EIRS Weather Rule NE USA Rule|EIRS Weather Rule NE USA Rule]]''' - customize random weather rule relative to the North East Region of the United States
**'''[[#Startup Options Rule|Startup Options Rule]]''' - sets the weather conditions at the start of a Session
 
==='''Weather Rule'''===
 
Changes the weather conditions during Session play.
 
*'''<kuid:-25:960>'''
 
*'''Built-in Rule'''
 
  '''Properties:'''
     '''Set weather to ''<select mode>'' with ''<select frequency>'' changeability''' - select
       '''Weather mode:''' - select one of:-
       '''Weather mode:''' - select one of:-
           '''''Clear'''''
           '''''Clear'''''
Line 3,154: Line 3,646:
**'''[[#Random Weather Rule v2|Random Weather Rule v2]]''' - randomly changes the weather according to entered parameters
**'''[[#Random Weather Rule v2|Random Weather Rule v2]]''' - randomly changes the weather according to entered parameters
**'''[[#Startup Options Rule|Startup Options Rule]]''' - sets the weather conditions at the start of a Session
**'''[[#Startup Options Rule|Startup Options Rule]]''' - sets the weather conditions at the start of a Session
'''[[#top|Back to Top]]'''
----
----
'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''

Revision as of 22:00, 15 June 2018

TRAINZ A New Era (TANE) SP2. List of Trainz Session Rules by Categories with Properties. All rules are the Copyright of N3V Games

This page is always under construction. As new rules appear they will be added to this list.

Only rules supplied with TANE or on the DLS are covered in this document.

Also available Session Rule List (Alphabetical) with Parameters

Description Key:

  • <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.
  • Base Rule and Built-in Rule is installed with TANE.
  • Parent Rule will execute child rules if it returns a true result.
  • Obsolete Rule is no longer required (explanation given).
  • Legacy Rule has been replaced by another rule (new rule will be identified).


Achievement Rules

Achievement Check Rule

Executes child rules when achievement conditions have been met

  • <kuid:401543:1190>
  • Built-in Rule
  • Parent Rule
Properties:
   <Not configured, click here to select an achievement asset> - click to select an Achievement Asset from those installed
      When an Achievement Asset has been selected, the following will appear:-
      Achievement KUID: <selected asset name> - click to change the selected Achievement Asset
      Achievement name: <not set> - click to select the achievement name from the selected asset
      Trigger if achievement: <select> - choose one of:-
         has been gained - the rule will be triggered when this achievement has been gained
         has not been gained - the rule will be triggered when this achievement has NOT been gained

Consist Check Rule

Executes child rules when a matching consist is found. The order of the vehicles in the consists is not important.

  • <kuid:-25:1068>
  • Built-in Rule
  • Parent Rule
Properties:
   [Check Box] 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. 
   Select one of two option buttons:-
   ( ) Rule disabled - select to disable the operation of this rule
   ( ) Complete whenever a train matching the description exists - When selected, enter the consist description:-
      Specific vehicle - identify the specific vehicle(s) that will trigger the rule
         + - click to add a specific vehicle from the session list
         x - click to remove the specific vehicle from the rule
      Vehicle types - identify the type of vehicle(s) that will trigger the rule
         + - click to add a type of vehicle from the session list
         x - click to remove the type of vehicle from the rule
      Drivers - identify the driver(s) that will trigger the rule
         + - click to add a driver from the session list
         x - click to remove a driver from the rule
  • Known Issues:
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.

Multiple Resource Check Rule

Executes child rules if industries or vehicles reach set commodity levels. This rule replaces the older Resource Check Rule

  • <kuid:-25:656>
  • Built-in Rule
  • Parent Rule
Properties:
   <Product Level> - click to select a product test from two choices:-
      Reach/Exceed - sets an upper limit for the resources being monitored. 
         For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon reaches or exceeds a specified level.
         The initial level in the object must be below the set upper limit.
      Fall below - sets a lower limit for the resources being monitored. 
         For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon falls below a specified level. 
         The initial level in the object must be above the set lower limit. 
         To test when a resource level reaches zero (i.e. is empty) set the lower limit to a very low value but not zero as the level can never fall below zero. 
   <value> - enter required quantity value
   <select> - select a product from session list of products
   <Add object> - click to select a source or target object. Multiple objects and their queues can be added to the rule. 
      ALL the entered products must reach/exceed or fall below the specified value for the rule to be triggered. 
      For each object:-
         <Object> - click to select session active industry or product enabled rail vehicle 
         <Queue> - select product queue (there may be only one available)
         <Remove> - removes the object and its product queue from the rule
  • Notes:
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.

Objective Add Rule

Sets up a game Objective with ID and display Name

  • <kuid:401543:2001>
  • Base Rule
Properties:
   Priority <Select> - select one of:-
      Above Normal
      Below Normal
      Normal
      Optional
      Urgent
   Completion Target Number <value> - to set Completion Target Number
   Icon <select> - to select Icon from list
   Display Name <enter> - to insert Name
   Unique Objective ID <enter> - enter a unique objective ID
   Custom Message <Text Box> - insert typed message in text area

Objective Check Rule

Executes child rules if an objective created with the Objective Add Rule is complete.

  • <kuid:401543:2003>
  • Base Rule
  • Parent Rule
Properties:
   Unique Objective ID <value> - enter the unique ID created with the Objective Add Rule 
   Mode <select> - select one of three:-
      Wait for completion
      Wait for failure
      Wait for progress

Objective Update Rule

Changes progress of an objective outcome created with the Objective Add Rule according to Property choices

  • <kuid:401543:2002>
  • Base Rule
Properties:
   Unique Objective ID <value> - enter the unique ID created with the Objective Add Rule 
   Mode <select> - select one from the following options
      Decrement progress
      Increment progress
      Reset Objective
      Set objects as complete
      Set objects as failed
      Set progress
      Set progress only if greater
   Amount <value> - click to enter a value

Ranked Session Begin Rule

Begins a ranked Session

  • <kuid:401543:2031>
  • Base Rule
Properties:
   Countdown Starting Value <value>
      hrs:
      min:
      sec:
   1 through 5 stars, points for each star <value> - enter number of points for each star rating
   Session timer mode: - select one of three option buttons:-
      ( ) Timer
      ( ) Countdown Starting value <value> - enter time hh:mm:ss
      ( ) None
  • Notes:
Times are Trainz clock time, not real time

Ranked Session Complete Rule

Completes the active ranked Session

  • <kuid:401543:2032>
  • Base Rule
Properties:
   Set the active ranked session as: - select one of two option buttons:-
      ( ) Complete
      ( ) Failed
   [Check Box] Customize the completion message <text> - enter a text message

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

  • <kuid:-25:1067>
  • Legacy Rule (replaced by Multiple Resource Check Rule)
  • Built-in Rule
  • Parent Rule
Properties:
   Select one of two option buttons:-
      ( ) Watch industry queue
         Target Object <select> - select an industry from the session list
         Queue <select> - select a product queue from the selected industry
         Product <select> - select a product from the selected queue
         Amount <value> - enter a quantity
         Select one of two option buttons:-
            ( ) Complete when designated queue equals or exceeds required amount
            ( ) Complete when designated queue falls below required amount
      ( ) Watch vehicle
         Target Object <select> - select a rolling stock asset from the session list
         Queue <select> - select a product queue from the selected rolling stock
         Product <select> - select a product from the selected queue
         Amount <value> - enter a quantity
         Select one of two option buttons:-
            ( ) Complete when designated queue equals or exceeds required amount
            ( ) Complete when designated queue falls below required amount
  • Notes:
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.

Resource Verify Rule (fixed)

Executes child rules if a selected industry or vehicle reaches a set commodity level. The rule resets when all child rules have completed.

  • <kuid:160293:10060>
  • DLS Rule by trev999
  • Parent Rule
Properties:
   Select one of two option buttons:-
   ( ) Watch industry queue
      Target object <click to select> - click to select an industry from the session list.
      Product <click to select> - click to select an industry product.
      Amount <value> - enter a quantity for the selected product.
      Select one of two option buttons:-
      ( ) Complete when designated queue equals or exceeds designated amount
      ( ) Complete when designated queue falls below designated amount
   ( ) Watch vehicle queue
      Target object <click to select> - click to select a rolling stock vehicle from the session list.
      Product <click to select> - click to select a commodity product.
      Amount <value> - enter a quantity for the selected product.
      Select one of two option buttons:-
      ( ) Complete when designated queue equals or exceeds designated amount
      ( ) Complete when designated queue falls below designated amount
  • Notes:
  1. This rule will only monitor a single commodity in a single industry or vehicle.
  2. 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.

Station Visited Check Rule

Executes child rules if specific trains call at set stations or industries

  • <kuid2:60850:89005:3>
  • Built-in Rule
  • Parent Rule
Properties:
   Trigger: <select> - click to select one of the following
      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 per industry - the rule is triggered on the first visit to each industry with each individual product
      Once per visit - the rule is triggered on the first visit to each industry regardless of the product
      Once per vehicle - each vehicle can only trigger the rule once. 
   <select industry> - select industry or industries from session list
   Select one of two option buttons:-
      ( ) click to accept all trains
      ( ) click to accept trains matching specific criteria
         Selecting the second option will produce the following selection controls:-          
         Specific vehicle - identify the specific vehicle or set of specific vehicles that will trigger the rule
            + - click to add a specific vehicle from the session list
            x - click to remove the specific vehicle from the rule
         Vehicle types - identify the type of vehicle or a set of vehicle types that will trigger the rule
            + - click to add a type of vehicle from the session list
            x - click to remove the type of vehicle from the rule
         Drivers - identify the drivers that will trigger the rule
            + - click to add a driver from the session list
            x - click to remove a driver from the rule

Back to Top

Camera Rules

Cinematic Camera Rule

Provides several different cinematic style cameras with animations. Best used at the start of a session. Use the Trackside Camera (tracking view) found in the Set Camera Rule during session play.

  • <kuid2:401543:1166:3>
  • Built-in Rule
Properties:
   [Check Box] Lock camera controls for the duration - if checked user cannot alter camera view
   [Check Box] Prevent train control for duration - if checked user cannot control train
   Camera target: <click to select> - click to select the object from the session list that will be the camera target
   Camera mode: - select one of three option buttons:-
      ( ) Stationary
      ( ) Circle targeted object
      ( ) Move from one point to another (zoom, pan, etc)
   Initial camera values:
      [Check Box] Pitch: <value> - check to select then click value to enter a pitch value
      [Check Box] Yaw:   <value> - check to select then click value to enter a yaw value
      [Check Box] Zoom:  <value> - check to select then click value to enter a zoom value
   Total time to animate:  <value> - enter an animation time in seconds
  • Notes:
Times are Trainz clock times, not real times

Focus Camera Rule

Sets the initial camera view and starting vehicle for a session.

  • <kuid2:122381:10014:1>
  • DLS Rule by mizi
Properties:
   Focus camera to: - select one of two option buttons
      ( ) Map object
      ( ) Vehicle
   Named <?????> - enter name of object or vehicle from session list
   Additionally:
      [Check Box] set view mode to - check to select one of four option buttons
         ( ) Internal view
         ( ) External view
         ( ) Tracking view
         ( ) Roaming view
      [Check Box] restrict user to manipulate the camera - check to set user limits on camera controls
         [Check Box] allow internal view
         [Check Box] allow external view
         [Check Box] allow tracking view
         [Check Box] allow roaming view
         [Check Box] allow change of view mode
         [Check Box] allow change vehicle in train
         [Check Box] allow change trains
         [Check Box] allow adjust camera viewpoint
      [Check Box] set camera angles - check to set the initial camera view point
         Yaw (90 = look at front of train): <value> degrees - enter yaw angle 
         Pitch (-90 = down, 90 = up): <value> degrees - enter pitch angle
         Distance from the focused object: <value> metres - enter distance from camera to object

Set Camera Rule

Sets the target object and properties of the camera.

  • <kuid:-25:179>
  • Built-in Rule
Properties:
   [Check Box] Set the target object of the camera to: - if checked, select one of three option buttons:-
      ( ) Vehicle <click to select> - select a vehicle from the Session list
      ( ) Junction <click to select> - select a junction from the Session list
      ( ) Map Object <click to select> - select a named map object from the Session list
   [Check Box] Change the camera view mode to <click to select> - if checked, select one camera view mode from
      Cab View
      External View
      Tracking View
      Free Roaming
   [Check Box] Set the camera flags to enable/disable user access to - if checked, select as many of the following check boxes as needed
      [Check Box] Internal view mode - check to enable, uncheck to disable
      [Check Box] External view mode - check to enable, uncheck to disable
      [Check Box] Tracking view mode - check to enable, uncheck to disable
      [Check Box] Roaming view mode - check to enable, uncheck to disable
      [Check Box] View switching - check to enable, uncheck to disable
      [Check Box] Vehicle view switching - check to enable, uncheck to disable
      [Check Box] Train view switching - check to enable, uncheck to disable
      [Check Box] Camera adjustments (pan, zoom, etc) - check to enable, uncheck to disable

Wait for Camera View Mode Rule

Executes child rules when the camera view is changed to a selected view

  • <kuid:-25:192>
  • Built-in Rule
  • Parent Rule
Properties:
   [Check Box] Trigger rule once - check to set
   Wait for the camera to change to the <click to select> - select one camera view mode from:-
      Cab View
      External View
      Tracking View
      Free Roaming
   [Check Box] Wait for the camera to target vehicle <click to select> - if checked, select a vehicle from the Session list

Back to Top

Danger, Derailment and Safety Rules

ATP Speed Limiter Rule

Limits allowable speed over set limit

  • <kuid2:321959:1000:1>
  • Built-in Rule
Properties:
   Limits the speed to <value> mph over the set limit - enter speed value in mph

Related Rules:
   AWS Configuration Rule - configures the Trainz implementation of the Automatic Warning System when approaching signals

AWS Configuration Rule

This rule configures the Trainz implementation of the Automatic Warning System when approaching signals

  • <kuid2:60850:89002:3>
  • Built-in Rule
Properties:
   Select one of three option buttons:-
      ( ) Active
      ( ) Passive
      ( ) Passive with HUD hidden
   [Check Box] Simulate AWS for unfitted cabs?
   [Check Box] Use modern sound set for unfitted cabs?

Clean Up Derailed Trains Rule

Cleans up derailed train cars after a set time delay

  • <kuid2:60850:89003:1>
  • Base Rule
Properties:
   Set delay to clean up derailed traincars to
      <h>: - click to enter the number of hours (0-23) to wait
      <mm>: - click to enter the number of minutes (0-59) to wait
      <ss>: - click to enter the number of seconds (0-59) to wait
  • Notes:
Time is Trainz clock time, not real time.

Coupler Breakage Check Rule

Executes child rules if there is a coupler breakage

  • <kuid2:447264:1017:1>
  • Built-in Rule
  • Parent Rule
Properties:
   None

Coupler Breakage HUD Rule

HUD displays warning about coupler stress and breakage

  • <kuid:-25:423>
  • Built-in Rule
Properties:
   Select one of two option buttons:-
      ( ) Show the Coupler Breakage Display
      ( ) Hide the Coupler Breakage Display

Junction Derailment Prevention Rule

Sets opposing (trailing) junctions ahead of a train to prevent derailments. Works with both AI and manually driven trains.

  • <kuid2:121843:100282:1>
  • DLS Rule by pitkin
Properties:
   None
  • Notes:
This rule will not overrule a junction already locked by another AI train or locked against AI control using the Set Junctions Rule.
  • Related Rules:
    • Lock All Junctions Rule - locks all junctions against user control
    • Set Cleared Junctions Rule - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.
    • Set Junctions Rule - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).

Replace Missing Vehicles Rule

Produces new trains to replace missing vehicles that have been removed from the session by the Clean Up Derailed Trains Rule

  • <kuid:447264:1214>
  • Built-in Rule
Properties:
   [Check Box] Respawn trains if they are abandoned for 10 minutes
   If checked:-
      Select one of two option buttons:-
         ( ) Respawn trains at their original locations
         ( ) Respawn trains from portals
            <+ Add a new portal> - click to enter the name of a portal, there can be more than one portal.
            Entered portal names that appear in red have not been found in the session

Safety System Engaged Check Rule

Executes child rules if safety systems are applied.

  • <kuid:447264:1216>
  • Built-in Rule
  • Parent Rule
Properties:
   [Check Box] Trigger only once

Safety System Isolated Check Rule

Executes child rules if safety systems are isolated (disengaged).

  • <kuid:447264:1217>
  • Built-in Rule
  • Parent Rule
Properties:
   [Check Box] Trigger only once

Set Coupler Masks Rule

Set the coupling/decoupling masks on the selected vehicles

  • <kuid:-25:980>
  • Built-in Rule
Properties:
   <Add vehicle> - click to select a vehicle from 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
      For each selected vehicle:-
      Coupling Mask
         Front and Back - choose for each
            Locked
            Unlocked
      Decoupling Mask
         Front and Back - choose for each
            Locked
            Unlocked
      <Remove> - click to remove this vehicle from the rule

Signal Passed At Danger Check Rule

Executes child rules if a signal or stop mark is Passed at Danger (STOP).

  • <kuid2:60850:89007:2>
  • Built-in Rule
  • Parent Rule
Properties:
   [Check Box] Trigger only once

Speeding Check Rule

Executes child rules if player controlled trains are over the local speed limit or over a set (custom) speed

  • <kuid2:60850:89004:3>
  • Built-in Rule
  • Parent Rule
Properties:
   Select one of two options to set a speed limit to be observed
      ( ) Watch for trains travelling above the posted speed limit
         <speed value> - click to enter a new overspeed tolerance value
         <speed units> - click to select one from the list:-
            Km/h - Kilometres per hour
            MPH - Miles per hour
            mps - metres per second
      ( ) Watch for trains travelling above a custom speed
         <speed value> - click to enter a new custom speed value
         <speed units> - click to select one from the list:-
            Km/h - Kilometres per hour
            MPH - Miles per hour
            mps - metres per second
            Warning: This option is very performance intensive and should only be used in sessions with few trains

Vehicle Physics Rule

Overrides the default vehicle physics properties for all vehicles or for those matching set criteria

  • <kuid:-25:1052>
  • Built-in Rule
Properties:  
   Select one of two option buttons:-
      ( ) click to accept all trains
      ( ) click to accept trains matching specific criteria
         Selecting the second option will produce the following selection controls:-
         Specific vehicle - identify the specific vehicle or set of specific vehicles that will trigger the rule
            + - click to add a specific vehicle from the session list
            x - click to remove the specific vehicle from the rule
         Vehicle types - identify the type of vehicle or a set of vehicle types that will trigger the rule
            + - click to add a type of vehicle from the session list
            x - click to remove the type of vehicle from the rule
         Drivers - identify the drivers that will trigger the rule
            + - click to add a driver from the session list
            x - click to remove a driver from the rule
   Coupler Parameters:
      Couplers break at <value> kN expansion force - enter force value
      Couplers break at when coupling above <value> kph - enter speed value
      [Check Box] Show coupler breakage in HUD - check to display breakage in on-screen HUD
   Wheelslip Parameters:
      Maximum tractive effort adjusted by <value> % - enter adjustment as a %
      Traction is reduced to <value> % while wheelslipping - enter value as a %
      Traction boost is <value> % while sanding - enter value as a %
   Sway Parameters:
      Cab sway level is set to <value> % - enter value as a %

Wait for Derailment Rule

Executes child rules when a derailment occurs

  • <kuid:-25:1053>
  • Built-in Rule
  • Parent Rule
Properties:
   [Check Box] Trigger derailment watch once - check to execute the rule once only

Back to Top

Driver Rules

AI Start Rule

Restarts all halted AI controlled trains. Drivers will continue with the commands in their driver command list.

  • <kuid2:400048:100981:1>
  • DLS Rule by callavsg
Properties:
   None

AI Stop Rule

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.

  • <kuid2:400048:100980:1>
  • DLS Rule by callavsg
Properties:
   None

Control Check Rule

Executes child rules if the train control method has been altered or a specific method has been selected.

  • <kuid:401543:1191>
  • Built-in Rule
  • Parent Rule
Properties:
 Execute child rules when: - select one of two option buttons:-
    ( ) DCC mode is Selected
    ( ) Cab mode is Selected
 Execute child rules: - select one of two option buttons:-
    ( ) Every time control method is set
    ( ) Once only

Control Type Rule

Sets the control method

  • <kuid:-16:2030>
  • Base Rule
Properties:
 Current control method is: <select> - click to select one of
    Easy Mode - DCC (standard keyboard and mouse) control
    Ask User - let the user decide
    Realistic Mode - Cab controls (on screen levers, throttles, buttons, etc)
  • Related Rules:

Disallow AI Rule

Cancels (deletes) all current and waiting AI commands for all drivers

  • <kuid:400048:100603>
  • DLS Rule by callavsg
Properties:
  None

Driver Command Check Rule

Executes child rules if the driver commands match a set list.

  • <kuid:-25:447>
  • Built-in Rule
  • Parent Rule
Properties:
 [Check Box] Trigger rule once - check to allow the rule to execute only once
 Driver character to watch the command list of <select> - select a driver name from the Session List
 Wait for driver character to have a command list that matches this:
    <add driver command> - add a driver command from the session list. More commands can be added. Commands can be deleted.
    <add all> - adds ALL driver commands in the session list. Individual commands can be removed.
    <delete all> - deletes all entered driver commands from the session rule

Driver Command Rule

Specifies which commands will be available for the drivers

  • <kuid:-3:10057>
  • Base Rule
Properties::
   For each installed Driver Command:-
   [Check Box] Name of Driver Command and Description (if available) - check to make that command available to the drivers
  • Notes:
Some Driver Commands that have been checked will not appear in the Command Lists for drivers if there is no target for their action. For example:
The Wait For Trigger command will not be available to any drivers if there are no triggers set.
The Call At command will not be available to any drivers if there are no industry active assets or passenger enabled stations.

Driver Main Menu Options Rule

Show/Hide the Driver Main Menu Bar

  • <kuid:-25:448>
  • Built-in Rule
Properties:
   <Show/Hide> the Driver Main Menu Bar - click Show or Hide to select

Driver Schedule Rule

Sets up a list of basic scheduled commands

  • <kuid2:82445:90001:9>
  • Built-in Rule
Properties: 
   Driver Schedule Assigned to name of driver <icon> - click icon to select a driver from those assigned in the Driver Setup Rule
   Next commands, will be executed  
      >> - click to enter driver commands from those specified in the Driver Command Rule
   Style: - select one of four option buttons:-
      ( ) Classic style: If there is a schedule do not emit a new schedule - any currently assigned set of driver commands will not be replaced
      ( ) Killer style: If there is a schedule clean it and emit a new one - replace any currently assigned driver commands with the new commands
      ( ) Cooperative style: If there is a schedule append the new one - add the new driver commands to the end of any existing commands
      ( ) Active style: Emit a new schedule, only if already a schedule running - only add the new commands if commands are currently running

Driver Setup Rule

Creates the list of drivers for this session and assign them their orders

  • <kuid:-16:2025>
  • Base Rule
Properties:
   <driver icon> - click to select a new driver from the list of installed and built in drivers
   <loco> - click to select a new locomotive from the session list and assign it to this driver. Locos displayed in red have not been found in the session list
   <driver name> - click to enter a new name for the selected driver
   <driver mode> - click to select one of:-
      Autodetect - the program will detect the driver mode to be used. For example, if driver commands have been entered for this driver
         then the AI driver mode will be selected
      First Human Player - the driver will wait until he/she has been selected by the player
      AI driver - the AI will be given control even if no commands are present
      Multiplayer Driver - the driver will be assigned to a multiplayer user
   <remove> - this driver will be removed from the rule
   >> - click to enter driver commands from those specified in the Driver Command Rule
    --> Scroll down to the bottom of the list of entered drivers for more options
 <Add another driver> - click to add another driver 
 [Check Box] Remove all existing Drivers first
 [Check Box] Generate new Drivers for empty Trains

Enable/Disable Driver Commands Rule

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

  • <kuid:-25:480>
  • Built-in Rule
Properties:
   <Enable/Disable> the following driver commands ... - click to select Enable or Disable
   For each driver command:-
   [Check Box] command name - check to enable or disable
   [Check Box] command name - check to enable or disable
   [Check Box] command name - check to enable or disable
   etc
   Select one of two option buttons:-
      ( ) click to accept all trains
      ( ) click to accept trains matching specific criteria
         Selecting the second option will produce the following selection controls:-
         Specific vehicle - identify the specific vehicle or set of specific vehicles that will trigger the rule
            + - click to add a specific vehicle from the session list
            x - click to remove the specific vehicle from the rule
         Vehicle types - identify the type of vehicle or a set of vehicle types that will trigger the rule
            + - click to add a type of vehicle from the session list
            x - click to remove the type of vehicle from the rule
         Drivers - identify the drivers that will trigger the rule
            + - click to add a driver from the session list
            x - click to remove a driver from the rule

JTG Correct Vehicle Lights

Corrects the brightness of vehicle headlights. Now obsolete.

  • <kuid2:478657:999103:1>
  • DLS Rule by jtg-trainz
  • Obsolete Rule (function is now built into TANE Driver Additional Tools Menu)
Properties:
   None

Quick Portal Manager Standard Edition Rule (SP2 and later)

Manages portals and adds flexible timetables.

  • <kuid2:61392:5011:45>
  • DLS Rule by pguy
Properties:
   Target date is day-of-week <dd/mm/yyyy> - day-of-week and date shown are for today's date. Click dd/mm/yyyy to change date.
   <Copy rule data to Clipboard> - click to copy the currently entered data to a special clipboard area used by the rules created by pguy. 
      This 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.
   [Check Box] This rule is enabled - check to activate (enable) the rule.
   [Check Box] 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.
   [Check Box] 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.

QuickDrive Rule

Changes the Session settings.

  • <kuid:401543:1184>
  • Base Rule
Properties:
  Open QuickDrive window when session is started          [Check Box] - check to set
  Set time to <hours:minutes> with a rate of <speed x> - set start time and rate at which time advances
  Enable gameplay Session Mode                            [Check Box] - check to set. Gameplay mode restricts the players options
  Enable in game help by default                          [Check Box] - check to allow help options to be displayed
  Set the default Control method to: - select one of two option buttons:-
     ( ) Easy Mode
     ( ) Realistic Mode
     [Check Box] Prevent player from changing this setting - check to set
  Realistic mode requires achievement: <text> in asset <asset name> - enter achievement name and select an asset from Aurans Achievements
  Set the default derailment realism to: - select one of three option buttons:-
     ( ) None
     ( ) Arcade
     ( ) Realistic
     [Check Box] Prevent player from changing this setting - check to set
  Set the default units to: - select one of three option buttons:-
     ( ) Imperial
     ( ) Metric
     ( ) Default

Wait for Driver On/Off Train Rule

Executes child rules when a driver gets on or off a train

  • <kuid:-25:953>
  • Built-in Rule
  • Parent Rule
Properties:
 [Check Box] Trigger Rule Once - click to set 
 Wait for a driver character to get <On/Off> a train that matches the following criteria - select On or Off
 Select one of two option buttons:-
    ( ) click to accept all trains
    ( ) click to accept trains matching specific criteria
       Selecting the second option will produce the following selection controls:-
       Specific vehicle - identify the specific vehicle or set of specific vehicles that will trigger the rule
          + - click to add a specific vehicle from the session list
          x - click to remove the specific vehicle from the rule
       Vehicle types - identify the type of vehicle or a set of vehicle types that will trigger the rule
          + - click to add a type of vehicle from the session list
          x - click to remove the type of vehicle from the rule
       Drivers - identify the drivers that will trigger the rule
          + - click to add a driver from the session list
          x - click to remove a driver from the rule

Wait for Driver/Train to be Locally Owned Rule

Executes child rules when a specific driver or vehicle is locally owned. If the driver/vehicle becomes unowned again the child rules are paused

  • <kuid2:401543:1173:1>
  • Built-in Rule
  • Parent Rule
Properties:
 Assets Ownership: - select one of two option buttons:-
    ( ) Wait for ownership of a specific Driver
    ( ) Wait for ownership of Driver
 Driver or Vehicle <select> - choose from session list

Back to Top

HUD (Heads Up Display) Rules

Cab Controls HUD Rule

Was used to provide the HUD controls for the cabin view. Now obsolete.

  • <kuid:-16:287428>
  • Base Rule
  • Obsolete Rule (function is now built into TANE)
Properties:
   None

Coupler Breakage HUD Rule

HUD displays warning about coupler stress and breakage

  • <kuid:-25:423>
  • Built-in Rule
Properties:
   Select one of two option buttons:-
      ( ) Show the Coupler Breakage Display
      ( ) Hide the Coupler Breakage Display

Display Custom HUD Rule

Show or hide the Custom Heads Up Display.

  • <kuid:-3:10206>
  • Base Rule
Properties:
   Show or Hide the Custom Heads up Display - select one of two option buttons:-
      ( ) Show the Custom Heads up Display
      ( ) Hide the Custom Heads up Display

Flash HUD Icon Rule

Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.

  • <kuid:-25:968>
  • Built-in Rule
Properties:
   Select one of two option buttons:-
   ( ) Flash the <click to select> icon on the <click to select> HUD panel for a period of <value> seconds
      TIP: Select the HUD panel first (the second <click to select> link).
      Available HUD panels are (select one):-
         Bottom Right Menu
         Camera Controls
         DCC Controls
         Driver Main Menu
      Available icons will depend on the HUD panel selected.
   ( ) <Start/Stop> flashing the <click to select> icon on the <click to select> HUD panel
      TIP: Select the HUD panel first (the second <click to select> link).
      Available HUD panels are (select one):-
         Bottom Right Menu
         Camera Controls
         DCC Controls
         Driver Main Menu
      Available icons will depend on the HUD panel selected.

mc Display Custom HUD V2 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)

  • <kuid2:61392:1072:10>
  • Legacy Rule (replaced by Quick CustomHUD Manager Rule (SP2 and later))
  • DLS Rule by pguy
Properties:
    Show or Hide the Custom Heads up Display - select one of two option buttons:-
    ( ) Show the Custom Heads up Display
    ( ) Hide the Custom Heads up Display

Quick CustomHud Manager 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)

  • <kuid2:61392:5020:47>
  • DLS Rule by pguy
Properties:
   <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.
   <Paste rule data from Clipboard> - if data is held in the special clipboard area, then click to paste that data into the selected HUD.
      This is NOT the standard OS clipboard.
   Current HUD Parameters
      HUD to select: <HUD name> - click to select a HUD from those available. One or two default HUDs will be supplied.
      new HUD - click to create a new HUD display with default properties. You will be required to enter a name for the new HUD
      clone HUD - click to create a new HUD using the properties of the currently selected HUD. You will be required to enter a name for the new HUD
      copy HUD - copies (overwrites) the currently selected HUD with the properties of another HUD. You will be required to enter the name of the HUD to be copied
   For new, cloned or copied HUDs, additional commands will be shown:
      rename HUD - rename the selected HUD. You will be required to enter a new name for the HUD
      delete HUD - delete the currently displayed HUD
   In Driver Mode an additional command will be shown:
      Assign hud to current train - click to assign the currently selected HUD to the currently selected driver
   [Check Box] hud is displayed (on) - check to display HUD in Driver Mode
   hud items nb entries max: <value> - enter the maximum number of items to be displayed in the HUD. Maximum is 30.
   hud view limit: <value> - enter the maximum look-ahead distance in metres for the HUD. Minimum value is 1000, maximum value is 10000.
   [Check Box] 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:
      [Check Box] HUD property - check to add this property to the HUD
  • Notes:
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.

Show/Hide HUD Panel Rule

Shows or hides a HUD panel.

  • <kuid:-25:1047>
  • Built-in Rule
Properties:
   <Show/Hide> the <click to select> HUD panel - select Show or Hide and then select the HUD panel

Variable Show Rule

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.

  • <kuid:-25:971>
  • Built-in Rule
Properties:
  [Check Box] Add
     <variable-name> - enter variable-name to add to HUD. Variable-name is case sensitive.
     <label> - (optional) enter a short label to be displayed on the HUD in front of the variable value.
  [Check Box] Remove
     <variable-name> - enter variable-name to remove from HUD. Variable-name is case sensitive.

Wait for Click on HUD Icon Rule

Executes child rules when the user clicks on a selected HUD icon

  • <kuid:-25:951> <kuid:-25:970> - two versions built-in with different kuids, both have the same properties
  • Built-in Rule
  • Parent Rule
Properties:
   [Check Box] Trigger Once
   HUD Panel <Click> - click choose from list:-
      Bottom Right Menu
      Camera Controls
      DCC Controls
   Icon <Click> - click to choose from list. Selections depends on HUD Panel chosen

Back to Top

Industry Rules

Advanced Industry Load Configuration Rule

Locks train controls when loading/unloading at an industry, overrides time settings for begin load and begin unload operations

  • <kuid:30501:100007>
  • Base Rule
Properties:
   Target object <select> - select industry object from session list
   [Check Box] Lock the train's controls during a stopped load/unload operation - check to disable driver controls while train is stopped and loading/unloading
   [Check Box] Override 'begin load' and 'begin unload' durations to <value> seconds - if checked enter number of seconds to override
  • Notes:
Times are Trainz clock time, not real time

Disable/Enable Industry Rule

Enables/Disables vehicle load/unload for industry

  • <kuid2:401543:1171:1>
  • Built-in Rule
Properties:
  Load/unload <Disable/Enable> - click to set to Disable or Enable
  Which Industry? <select> - click to set Industry from Session List
  Which Vehicles: - select one of two option buttons:-
     ( ) Apply to every vehicle in the session
     ( ) Apply only to a specific vehicles from Session List

DisplayIndustryStatus Rule (color modified)

Displays a summary of industry product levels when the "k" key is pressed.

  • <kuid:622415:100001>
  • DLS Rule by lockheed02 and marzipan
Properties:
   None
  • Notes:
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.

ExTrainz Manager Rule - TANE SP2

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.

  • <kuid:160293:10029>
  • DLS Rule by trev999
Properties:
   Diagnostic mode is <On/Off> - click to select On or Off. When set On diagnostic messages will be added to the Trainz Log file.
   Turn on message overlay <Yes/No> - click to select Yes or No. When set to Yes the message overlay (lower left of screen) will be active.
   Show rolling stock in Driver mode <Yes/No> - click to select Yes or No. When set to Yes rolling stock can be searched in Driver.
   Search only rolling stock already in session <Yes/No> - click to select Yes or No. When set to Yes only those rolling stock assets
      installed in the session can be searched.
   Graphic colours: <When Red, the industry does not require service/When Green, the industry does not require service> - click to switch 
      between the two colour options.
   Industry page size: <value> - enter the number of industries to be displayed in the Industry List window (maximum 250).
   The following industries are excluded: <Add an industry to be excluded> - name can be complete (e.g. "Coal Mine 2") 
      which will exclude that specific industry from the management list, or partial (e.g. "Coal") which will exclude all 
      industries with the word "Coal" in their names. Entries are not case sensitive.
      Once industries have been excluded, additional commands will appear for each excluded industry:-
      <delete> <industry name begins with/class name begins with> <name> - click delete to remove this entry. 
         - click industry name begins with/class name begins with to select between the two (see notes below).
         - click name to edit the name.
  • Notes:
  1. 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.
  2. 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.
  3. 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.
  • Known Issues:
This rule is NOT compatible with all industries.

Multiple Resource Check Rule

Executes child rules if industries or vehicles reach set commodity levels. This rule replaces the older Resource Check Rule

  • <kuid:-25:656>
  • Built-in Rule
  • Parent Rule
Properties:
   <Product Level> - click to select a product test from two choices:-
      Reach/Exceed - sets an upper limit for the resources being monitored. 
         For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon reaches or exceeds a specified level.
         The initial level in the object must be below the set upper limit.
      Fall below - sets a lower limit for the resources being monitored. 
         For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon falls below a specified level. 
         The initial level in the object must be above the set lower limit. 
         To test when a resource level reaches zero (i.e. is empty) set the lower limit to a very low value but not zero as the level can never fall below zero. 
   <value> - enter required quantity value
   <select> - select a product from session list of products
   <Add object> - click to select a source or target object. Multiple objects and their queues can be added to the rule. 
      ALL the entered products must reach/exceed or fall below the specified value for the rule to be triggered. 
      For each object:-
         <Object> - click to select session active industry or product enabled rail vehicle 
         <Queue> - select product queue (there may be only one available)
         <Remove> - removes the object and its product queue from the rule
  • Notes:
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.

Power Station Rule

Sets up a Power Station and its electricity consumers

  • <kuid:-25:746>
  • Base Rule
Properties:
   Power station <select> - select a Power Station from the session list.
   Consumers:
      <add object> - add power consumers from the session list

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

  • <kuid:-25:1067>
  • Legacy Rule (replaced by Multiple Resource Check Rule)
  • Built-in Rule
  • Parent Rule
Properties:
   Select one of two option buttons:-
      ( ) Watch industry queue
         Target Object <select> - select an industry from the session list
         Queue <select> - select a product queue from the selected industry
         Product <select> - select a product from the selected queue
         Amount <value> - enter a quantity
         Select one of two option buttons:-
            ( ) Complete when designated queue equals or exceeds required amount
            ( ) Complete when designated queue falls below required amount
      ( ) Watch vehicle
         Target Object <select> - select a rolling stock asset from the session list
         Queue <select> - select a product queue from the selected rolling stock
         Product <select> - select a product from the selected queue
         Amount <value> - enter a quantity
         Select one of two option buttons:-
            ( ) Complete when designated queue equals or exceeds required amount
            ( ) Complete when designated queue falls below required amount
  • Notes:
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.

Resource Verify Rule (fixed)

Executes child rules if a selected industry or vehicle reaches a set commodity level. The rule resets when all child rules have completed.

  • <kuid:160293:10060>
  • DLS Rule by trev999
  • Parent Rule
Properties:
   Select one of two option buttons:-
   ( ) Watch industry queue
      Target object <click to select> - click to select an industry from the session list.
      Product <click to select> - click to select an industry product.
      Amount <value> - enter a quantity for the selected product.
      Select one of two option buttons:-
      ( ) Complete when designated queue equals or exceeds designated amount
      ( ) Complete when designated queue falls below designated amount
   ( ) Watch vehicle queue
      Target object <click to select> - click to select a rolling stock vehicle from the session list.
      Product <click to select> - click to select a commodity product.
      Amount <value> - enter a quantity for the selected product.
      Select one of two option buttons:-
      ( ) Complete when designated queue equals or exceeds designated amount
      ( ) Complete when designated queue falls below designated amount
  • Notes:
  1. This rule will only monitor a single commodity in a single industry or vehicle.
  2. 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.

Station Visited Check Rule

Executes child rules if specific trains call at set stations or industries

  • <kuid2:60850:89005:3>
  • Built-in Rule
  • Parent Rule
Properties:
   Trigger: <select> - click to select one of the following
      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 per industry - the rule is triggered on the first visit to each industry with each individual product
      Once per visit - the rule is triggered on the first visit to each industry regardless of the product
      Once per vehicle - each vehicle can only trigger the rule once. 
   <select industry> - select industry or industries from session list
   Select one of two option buttons:-
      ( ) click to accept all trains
      ( ) click to accept trains matching specific criteria
         Selecting the second option will produce the following selection controls:-          
         Specific vehicle - identify the specific vehicle or set of specific vehicles that will trigger the rule
            + - click to add a specific vehicle from the session list
            x - click to remove the specific vehicle from the rule
         Vehicle types - identify the type of vehicle or a set of vehicle types that will trigger the rule
            + - click to add a type of vehicle from the session list
            x - click to remove the type of vehicle from the rule
         Drivers - identify the drivers that will trigger the rule
            + - click to add a driver from the session list
            x - click to remove a driver from the rule

Back to Top

Interlocking Tower, Junction and Signal Rules

Interlocking Tower Configure Path Rule

Alters settings on an interlocking tower path

  • <kuid:401543:3205>
  • Base Rule
Properties:
  Interlocking Tower <select> - to set Name and Objects

Interlocking Tower Path Selection UI Rule

Will automatically react to messages from Interlocking Towers and display a path selection dialog to the player. Disable by removing rule from session

  • <kuid:401543:3203>
  • Base Rule
Properties:
  [Checkbox] Show path activation message in Driver

Interlocking Tower Set Path Rule

Will set the state of an interlocking tower path for a train

  • <kuid:401543:3204>
  • Base Rule
Properties:
  Interlocking Tower <select> - to set Name and Objects

Interlocking Tower Enhanced Manager Rule (SP2 and later)

Provides more management and control options for interlocking towers.

  • <kuid2:61392:8130:41>
  • DLS Rule by pguy
Properties:
   <towers> - click to select interlocking towers from the session list
      <do full check again> - click to run an error check on all interlocking towers
      List of all available interlocking towers - for each tower:-
         <view details> - click to view and edit the tower properties
         <copy from> - click to copy properties from another tower selected from the session list
   <debug log> - click to set the debug log properties

Junction Derailment Prevention Rule

Sets opposing (trailing) junctions ahead of a train to prevent derailments. Works with both AI and manually driven trains.

  • <kuid2:121843:100282:1>
  • DLS Rule by pitkin
Properties:
   None
  • Notes:
This rule will not overrule a junction already locked by another AI train or locked against AI control using the Set Junctions Rule.
  • Related Rules:
    • Lock All Junctions Rule - locks all junctions against user control
    • Set Cleared Junctions Rule - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.
    • Set Junctions Rule - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).

Lock All Junctions Rule

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.

  • <kuid:400048:100971>
  • DLS Rule by callavsg
Properties:
   None
  • Notes:
Individual junctions can still be set, locked and unlocked by using the Set Junction Rule
  • Related Rules:
    • Set Cleared Junctions Rule - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.
    • Set Junctions Rule - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).

MissionCode Manager Rule (SP2 and later)

Enables the addition, editing and management of Mission Codes used to auto select paths in Interlocking Towers.

  • <kuid2:61392:8200:50>
  • DLS Rule by pguy

ENTRY UNDER CONSTRUCTION

MissionCode Stops and Timetable Manager Rule (SP2 and later)

Enables the creation, editing and management of stop zones and timetables for trains following a path defined using mission codes.

  • <kuid2:61392:8300:50>
  • DLS Rule by pguy

ENTRY UNDER CONSTRUCTION

Multiple Junction Alignment Check Rule

Executes child rules if specific junctions are set.

  • <kuid:-25:168>
  • Built-in Rule
  • Parent Rule
Properties:
   Wait until <selection> - select from:-
      any one - any of the junctions in the rule list (below) is set correctly
      all - ALL of the junctions in the rule list are set correctly
   <Add junction> - click to select a junction from the session list
   <Add all> - click to select ALL junctions in the session list
   <Delete all> - click to delete ALL selected junctions from the rule list
      For each selected junction:-
      <setting> - click to select one switch direction from:-
         Left
         Right
         Center
         Any
      <remove> - to delete this junction from the rule list
  • Related Rules:
    • Lock All Junctions Rule - locks all junctions against user control
    • Set Cleared Junctions Rule - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.
    • Set Junctions Rule - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).

Set Cleared Junctions Rule

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

  • <kuid2:131986:157661:1>
  • DLS Rule by atilabarut
Properties:
   Add Junction - click to select a junction from the session junction list
   Add All - click to add ALL junctions in the session junction list
   Delete All - click to remove ALL entered junctions from the rule
      Junction Options: - for each selected junction:-
         <direction> - click to select the junction direction
            Left
            Center
            Right
            Don't change
         <user control> - click to select a user control option
            Locked - the junction setting cannot be changed by the user
            Unlocked - the junction setting can be changed by the user
         <AI control> - click to select AI control
            Allows AI control - an AI train can switch the junction
            Blocks AI control - an AI train cannot switch the junction
         Remove - click to remove this junction from the rule list

Set Junctions Rule

Sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control). Warning: not compatible with Interlocking Tower Assets

  • <kuid:-25:1065>
  • Built-in Rule
Properties:
   Add Junction - click to select a junction from the session junction list
   Add All - click to add ALL junctions in the session junction list
   Delete All - click to remove ALL entered junctions from the rule
      Junction Options: - for each selected junction:-
         <direction> - click to select the junction direction
            Left
            Center
            Right
            Don't change
         <user control> - click to select a user control option
            Locked - the junction setting cannot be changed by the user
            Unlocked - the junction setting can be changed by the user
         <AI control> - click to select AI control
            Allows AI control - an AI train can switch the junction
            Blocks AI control - an AI train cannot switch the junction
         Remove - click to remove this junction from the rule list

Set Signal Extended Rule

Sets the state of a selected signal Warning: not compatible with Interlocking Tower Assets

  • <kuid2:47662:20002:4>
  • Built-in Rule
Properties:
   <Select signal> to <signal state> - click to select a signal from the session list and click to select a state from the list -
      Automatic
      Stop
      Stop then Continue
      Caution Left
      Caution Right
      Caution
      Advance Caution Left
      Advance Caution Right
      Advance Caution
      Proceed Left
      Proceed Right
      Proceed
      Slow
      Medium
  • Notes:
The signal must support the state selected otherwise there will be no change in the signal

Trigger Multiple Signals Rule

Sets selected signals to DANGER (STOP) when selected triggers are activated. Signals will be at AUTOMATIC when the triggers are not activated.

  • <kuid2:116387:26:1>
  • DLS Rule by maggs
Properties:
   <add signal> - select a signal from the Session List. More than one signal can be added.
      <delete> - remove a signal from the rule.
   <add trigger> - select a trigger from the Session List. More than one trigger can be added.
      <delete> - remove a trigger from the rule.

Back to Top

Message Rules

Close Message Popup Rule

Closes open message popups

  • <kuid:447264:1526>
  • Built-in Rule
Properties:
  None
  • Known Issues:
This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule
  • Related Rule:

DestSign Table Rule

Creates a list of destination names for a destination sign

  • <kuid2:206816:99004:2>
  • Built-in Rule
Properties:
  <add destination> - enter a destination name to be added to the destination sign roll
  <import destinations from texture-group> - select a list of destination names from session
  [Check Box] Enable industries/stations as destination - check to set
  [Check Box] Enable Track Marks as destinations - check to set
  [Check Box] Enable table of destinations - check to set

Display HTML Pages 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

  • <kuid:-25:442>
  • Legacy Rule (replaced by Message Popup Rule)
  • Base Rule
Properties:
   <Add Page> - adds the HTML page index.html from the selected HTML asset
      <index.html> - click to change the page name. The extension .html is optional
   <Add All> - adds all HTML pages from the session list (this appears to be disabled in TANE)
   <Delete All> - delete all HTML pages from this property list
   [Check Box] Prevent user from exiting browser until all pages viewed
   [Check Box] Disable closing of browser window by user
   [Check Box] Disable browser window scrolling
   [Check Box] Make browser window invisible
   [Check Box] Set position-Under Construction!!! - not implemented
   [Check Box] Set size-Under Construction!!! - not implemented
   Use the page <index.html> from asset <select> as the hidden button - the link buttons at the bottom of the page will be taken from the selected page in the selected HTML asset

Display Video Rule

Displays a page containing a video clip from a HTML asset in a browser window.

  • <kuid:-25:138>
  • Built-in Rule
Properties:
   Display page <index.html> of html asset <click to select> in a new browser window
      index.html - enter the filename of a HTML page in the selected HTML asset. The .html is optional in the filename.
      <click to select> - select the HTML asset from those installed.
  • Notes:
Video must be in a valid web format.

DisplayIndustryStatus Rule (color modified)

Displays a summary of industry product levels when the "k" key is pressed.

  • <kuid:622415:100001>
  • DLS Rule by lockheed02 and marzipan
Properties:
   None
  • Notes:
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.

ExTrainz Manager Rule - TANE SP2

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.

  • <kuid:160293:10029>
  • DLS Rule by trev999
Properties:
   Diagnostic mode is <On/Off> - click to select On or Off. When set On diagnostic messages will be added to the Trainz Log file.
   Turn on message overlay <Yes/No> - click to select Yes or No. When set to Yes the message overlay (lower left of screen) will be active.
   Show rolling stock in Driver mode <Yes/No> - click to select Yes or No. When set to Yes rolling stock can be searched in Driver.
   Search only rolling stock already in session <Yes/No> - click to select Yes or No. When set to Yes only those rolling stock assets
      installed in the session can be searched.
   Graphic colours: <When Red, the industry does not require service/When Green, the industry does not require service> - click to switch 
      between the two colour options.
   Industry page size: <value> - enter the number of industries to be displayed in the Industry List window (maximum 250).
   The following industries are excluded: <Add an industry to be excluded> - name can be complete (e.g. "Coal Mine 2") 
      which will exclude that specific industry from the management list, or partial (e.g. "Coal") which will exclude all 
      industries with the word "Coal" in their names. Entries are not case sensitive.
      Once industries have been excluded, additional commands will appear for each excluded industry:-
      <delete> <industry name begins with/class name begins with> <name> - click delete to remove this entry. 
         - click industry name begins with/class name begins with to select between the two (see notes below).
         - click name to edit the name.
  • Notes:
  1. 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.
  2. 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.
  3. 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.
  • Known Issues:
This rule is NOT compatible with all industries.

Fade In/Out Rule

Fade in or out within seconds, using specified color and opacity values.

  • <kuid2:190611:200000:2>
  • Built-in Rule
Properties:
   Red percentage:             <value> - enter the final % of red (0 = none, 100 = maximum)
   Green percentage:           <value> - enter the final % of green
   Blue percentage:            <value> - enter the final % of blue
   Alpha percentage (opacity): <value> - enter the final % of opacity (0 = invisible, 100 = solid)
   Fading duration:            <value> - enter the number of seconds required for the fade
   <help> - click to bring up help instructions
  • Notes:
Seconds are Trainz clock time, not real time.

Hide Product Overlays Rule

Hides the commodity or product bar graphs that appear on active industries

  • <kuid:400048:100970>
  • DLS Rule by callavsg
Properties:
  None

InputTable Rule

Creates a list of message names to be used for various purposes including passing data to Driver Commands

  • <kuid2:131986:1012:1>
  • Built-in Rule
Properties:
   <add> - click to add a new entry to the table
   Each new entry will require an input message
      <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:-
         turntable,name_of_turntable,number_of_connecting_roads - the first entry must be the word turntable in lower case.
            name_of_turntable is the name of the turntable, 
            number_of_connecting_roads is the number of tracks connecting to the turntable
      For the WaitUntilTime driver command the message must be formatted as:-
         time,hour,minute - the first entry must be the word time in lower case, 
            hour must be from 0 to 23, 
            minute must be from 0 to 59.
      For the WaitUntilSVariable driver command the message must be formatted as:-
         svar,svar_name,svar_condition,value - the first entry must be the word svar in lower case, 
            svar_name is the name of the session variable, 
            svar_condition is an equality (eg eq for equal, gt for greater than, etc)
            value is an integer value to be compared to the session variable.
   Each entry in the table will be followed by the commands:-
      cp - click to copy this entry to a new entry
      up - click to move this entry up one level
      dn - click to move this entry down one level
      rm - click to remove this entry from the table

Message Popup 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.

  • <kuid:-25:1003>
  • Built-in Rule
Properties:
   [Check Box] Pause game while message is displayed - stops the game until this message is closed
   [Check Box] Close previous popup windows - closes any Message Popups currently displayed before this message is shown
   Message location <Top Left/Top Right/Bottom Left/Bottom Right> - select one to position the browser window on the screen
   Message Source: - select one of three option buttons:-
      ( ) Custom text - the simplest and easiest option
         Icon <Click here to set> - (optional) shows a list of message icons. Select one to be displayed with the message
         Icon <Clear icon> - clears any currently displayed message icon
         Custom text box Enter text to be displayed. You will be limited to about 6 lines of text. 
             For longer messages or to include graphics, use the A predefined HTML page option.
         <HTML Wave> - (optional) select the name of the HTML asset from the list shown that contains the wave file to be played.
         <Wave Name> - (optional) enter the name of a wave (.wav) sound file to be played. 
             The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension ".wav" is optional
         [Check Box] Autoplay Wave: - plays the .wav sound file as soon as message is displayed. 
             If unchecked the sound will not be played.
      ( ) A predefined HTML page - requires a working knowledge of HTML
         <HTML Asset> - select the name of the HTML asset that contains the required HTML page from the list shown.
         <HTML Page> - enter the filename of the HTML page to be displayed. The page must be in the HTML asset identified above. 
             Filename is not case sensitive. Extension ".html" is optional.
         <HTML Wave> - (optional) select the name of the HTML file containing the wave file to be played. 
             The page must be in the HTML asset identified above. Filename is not case sensitive. Extension ".html" is optional.
         <Wave Name> - (optional) enter the name of a wave (.wav) sound file to be played. 
             The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension ".wav" is optional
         [Check Box] Autoplay Wave: - plays the .wav sound file as soon as message is displayed. 
           If unchecked sound will not be played.
      ( ) A predefined string-table entry from a HTML asset
         <HTML Asset> - select the name of the HTML asset from those installed that contains the required string-table.
         <String Table Token> - enter the "tag name" of the text in the string-table of the HTML assets config.txt file.
         <HTML Wave> - (optional) select the name of the HTML file containing the wave file to be played. 
             The page must be in the HTML asset identified above. Filename is not case sensitive. Extension ".html" is optional.
         <Wave Name> - (optional) enter the name of a wave (.wav) sound file to be played. 
             The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension ".wav" is optional
         [Check Box] Autoplay Wave: - plays the .wav sound file as soon as message is displayed. 
             If unchecked sound will not be played.
  • Known Issues:
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.

Minimap Options Rule

Sets the display options for the minimap.

  • <kuid:-25:636>
  • Built-in Rule
Properties: Default values - all checked
   [Check Box] Map Textures
   [Check Box] Gradients
   [Check Box] Junctions
   [Check Box] Signals
   [Check Box] Triggers
   [Check Box] Markers
   [Check Box] Trackside Labels
   [Check Box] Terrain Objects
   [Check Box] Industrial Names
   [Check Box] Named Objects
   [Check Box] Consists

Play Sound Rule

Plays a wav sound file.

  • <kuid:-25:1045>
  • Built-in Rule
Properties:
   Default HTML <Click> - click to to enter Sound File Name
   HTML Assets <Click> - click to select HTML asset
   Rule Completes <Click> -  to select one of:-
      sound has just started
      sound has finished playing
  • Related Rules:
    • Display Video Rule - displays a page containing a video clip from a HTML asset in a browser window

Session Metadata Rule

Sets session metadata in the config file. Info can be read by other systems and displayed to the player.

  • <kuid:401543:2036>
  • Base Rule
Properties:
   Type <Click> - click to select one of:-
      Simulation
      Challenge
   Length <value> - to enter number of minutes, default is 30 minutes
   Difficulty <Click> - click to select one of:-
      Normal - default
      Tutorial
      Easy
      Hard
      Expert
  • Notes:
Time is Trainz clock time, not real time

Set Helper Icon Size Rule

Sets the size of helper icons such as the junction lever arrows.

  • <kuid:-25:791>
  • Built-in Rule
Properties:
  Junction Arrows Size <Click> - to set scale ratio smaller than default, default is 100%

Set HTML Pages Rule

Instructs the Display HTML Pages rule to perform specific operations. This rule has been superseded by the Message Popup Rule

  • <kuid:-25:792>
  • Legacy Rule (replaced by Message Popup Rule)
  • Built-in Rule
Properties:
   Operations to preform on the display HTML pages sequence browser
   Select one of six option buttons:-
      ( ) 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 set browser parameters <select> - choose one of:-
         to Enable/Disable closing of the browser window by the user
         to Enable/Disable scrolling on the sequence browser window
         to Show/Hide the sequence browser window
      ( ) Set the following flag for the page named <select> - enter the HTML page name
         [Check Box] Hide/Close window on 'done' action
         [Check Box] Window has no 'done' button
         [Check Box] Disable scrolling(not implemented yet)
         [Check Box] Spare setting 1
         [Check Box] Spare setting 2
         [Check Box] Spare setting 3
         [Check Box] Spare setting 4
         [Check Box] Spare setting 5
      ( ) Use the page <select> (enter HTML page name) from the HTML asset <select> (select HTML asset)
      ( ) Use the string table entry <select> (enter Index) from the HTML asset <select> (select HTML asset)

Show/Hide Layer Rule

Shows or hides a layer from Driver.

  • <kuid2:401543:1170:1>
  • Built-in Rule
Properties:
  <visibility> - select one of two options
     Show - select to make the layer visible
     Hide - select to make the layer invisible
  <click here to set> - enter name of layer. Name is case sensitive.
  • Known Bugs:
Layers set to Hide when a game is saved will be Shown when the game is reloaded
  • Known Issues:
Rule will NOT check to see if the named layer exists or not

Show/Hide Minimap Rule

Shows the minimap window in Driver.

  • <kuid:-25:794>
  • Built-in Rule
Properties:
   <Show/Hide> the driver Minimap Window - click to switch between Show and Hide.

Show/Hide On-screen Help Rule

Shows or hides On-screen help in Driver.

  • <kuid:401543:2020>
  • Built-in Rule
Properties:
   On screen help (junction overlays, etc) - select one of three option buttons:-
      ( ) Show
      ( ) Hide
      ( ) Leave Unchanged
   On Screen Vehicle Names: -  - select one of three option buttons:-
      ( ) Show
      ( ) Hide
      ( ) Leave Unchanged

Timed Limited Display HTML Rule (SP2 and later)

Displays an HTML browser window for a limited time.

  • <kuid2:61392:2005:32>
  • DLS Rule by pguy
Properties:
  HTML Asset Name : <[Click to select HTML asset]> - click to select an HTML asset from those installed
  Page filename : <value> - click to enter the filename of the HTML page in the selected HTML asset. The .html filename extension is optional.
  Play duration (SessVar or duration in seconds) : <value> - enter a SessVar name or the number of seconds.
  Browser left position (SessVar or position) : <value> - enter a SessVar name or the number of pixels from the left screen edge.
  Browser top position (SessVar or position) : <value> - enter a SessVar name or the number of pixels from the top screen edge.
  Browser width (SessVar or position) : <value> - enter a SessVar name or the width in pixels.
  Browser height (SessVar or position) : <value> - enter a SessVar name or the browser height.
  [Check Box] <Alert is not reshowable on request/Alert is showable on request> - check or click to allow or prevent the user viewing the page again.
  • Notes:
Seconds are Trainz clock time, not real time.

Wait on Waybill Screen/Main Screen Rule

Executes child rules when the Waybill window is opened or closed

  • <kuid:-25:957>
  • Built-in Rule
  • Parent Rule
Properties:
   [Check Box] Trigger rule once - check to trigger the rule once only
   Wait for the Waybill window to be <opened/closed> - select either opened or closed.

Back to Top

Miscellaneous Rules

Some of these rules have no user accessible functions but may be used by other rules. Others do not fit in any other category.

ConsistDataHandler Rule

Was used by the QuickDrive Rule to place consists onto a route. Now obsolete.

  • <kuid:401543:1180>
  • Obsolete Rule (function is now built into TANE)
  • Base Rule
Properties:
   None

Custom Script Rule

No description

  • <kuid:447264:1526>
  • Built-in Rule
Properties:
  None

Generic TreeNode Debug Window Rule

No description.

  • <kuid:30501:1042>
  • Base Rule
Properties:
   None

Session Debug Rule

Executes the first child if Debug mode is selected. Otherwise executes the second child rule.

  • <kuid:30501:100180>
  • Built-in Rule
  • Parent Rule
Properties:
   None
  • Notes:
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.

Back to Top

Directional 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.

  • <kuid2:532391:100003:1>
  • DLS Rule by bobhahn
Properties:
   [Check Box] Trigger only once 
   [Check Box] Wait for child rules to complete even if no trains are present in rule trigger
   [Check Box] Only activate when the entering vehicle of the train is heading <select direction> into the trigger - select one of two directions:-
      forward
      backward
   Triggers List
      <add trigger> - select a trigger from the session list
      <delete trigger> - delete a selected trigger from the rule
   Select one of two option buttons:-
      ( ) click to accept all trains
      ( ) click to accept trains matching specific criteria
         Selecting the second option will produce the following selection controls:-
         Specific vehicle - identify the specific vehicle(s) that will trigger the rule
            + - click to add a specific vehicle from the session list
            x - click to remove the specific vehicle from the rule
         Vehicle types - identify the type of vehicle(s) that will trigger the rule
            + - click to add a type of vehicle from the session list
            x - click to remove the type of vehicle from the rule
         Drivers - identify the driver(s) that will trigger the rule
            + - click to add a driver from the session list
            x - click to remove a driver from the rule
  • Notes:
  1. This rule works best when used with the Directional Trigger track object available on the DLS.
  2. The Directional Trigger, when installed, will appear as a Signal not as a Trackmark.
  3. 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.
  • Related Rules:
    • Trackside Check Rule - executes child rules when activated by a train. Provides different options to the Trigger Check Rule
    • Trigger Check Rule - executes child rules when a set train enters a set trigger (non-directional)

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.

  • <kuid2:401543:1161:1>
  • Base Rule
Properties:
   Unique set ID: <click here to set> - enter a unique name for the navigation set. Name must be in lowercase and have no spaces.
   Train (optional): <click here to set> - select a rolling stock asset from the session list shown.
   Select one of three option buttons:-
   ( ) All points must be completed in sequence:
      - the first uncompleted navigation point will be shown and must be completed next.
      - the next point (if any) will also be shown partly transparent.
   ( ) Points will be completed in sequence, but can be skipped:
      - navigation points can be skipped but must be completed in order.
      - you cannot go back to complete a missed point.
   ( ) All points must be completed, but in any order:
      - all uncompleted navigation points will be shown.
      - you may complete them in any order.
  For each navigation point:
     <Click here to set> - select an item (trigger, trackmark, track object, rolling stock) from the session list to become the navigation point.
     <Display text> - enter a text message to display with the navigation point. You are limited to 25 characters.
     Icon <icon list> - select an icon for the navigation point.
     <Style> - click to select one from three choices
        Automatic - the navigation point will be completed as soon as the consist reaches the point.
        Manual - the navigation point must be set as complete by using the Navigation point complete rule or the Navigation set clear rule.
           The Manual style option allows you to execute other rules (e.g. consist check, wait, etc) before completing the navigation point.
        Require Stop - the navigation point will be completed when the consist comes to a complete stop on the point.

Manually completes a navigation point in a set

  • <kuid:401543:1167>
  • Base Rule
Properties:
   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.
        Name must be in lowercase and have no spaces.
  • Known Issues:
The rule will NOT check to see if the named navigation set and point exists or not.

Executes child rules if a navigation set created with the Navigation Display Rule is complete (or incomplete).

  • <kuid:401543:1165>
  • Base Rule
  • Parent Rule
Properties:
   Checks if navigation point set <name>: - enter the unique name for the navigation set created using the Navigation Display Rule.
        Name must be in lowercase and have no spaces.
   is <Complete/Incomplete> - click to select one
  • Known Issues:
The rule will NOT check to see if the named navigation set exists or not.

Clears a navigation set removing any uncompleted navigation points

  • <kuid:401543:1164>
  • Base Rule
Properties:
   <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.
  • Known Issues:
The rule will NOT check to see if the named navigation set exists or not.

Shows and hides navigation sets. You can have multiple sets visible and hidden at the same time.

  • <kuid:401543:1163>
  • Base rule
Properties:
   <visibility> - click to select one
      Hide - select to make the navigation set invisible
      Show - select to make the navigation set visible
   <click here to set> - enter the unique name for the navigation set created using the Navigation Display Rule.
        Name must be in lowercase and have no spaces.
  • Known Issues:
The rule will NOT check to see if the named navigation set exists or not.

Schedule Rule

Allows a schedule of timed events to be applied to a train

  • <kuid:-3:10185>
  • Base Rule
Properties:
   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
  • Notes:
Times are Trainz clock times, not real time

Trackside Check Rule

Executes child rules when a set train enters a set trigger. Similar to the Trigger Check Rule but provides different options.

  • <kuid2:46162:100207:1>
  • DLS Rule by Josefpav
  • Parent Rule
Properties:
   Applies to: - select one of three option buttons:-
      ( ) Junction
      ( ) Trigger
      ( ) Trackmark
   Trackside object name: <specify> - select object name from session list
   Wait for train to: - select one of three option buttons:-
      ( ) Enter
      ( ) Stop at
      ( ) Leave
   [Check Box] Auto reset this rule - check to execute the rule continuously
   Applies to train containing:
   <Add vehicle> - click to select a rail vehicle from the session list
   del - click to remove a selected vehicle from the rule

Trigger Check Rule

Executes child rules when a set train enters a set trigger. This rule replaces the older and less versatile Trigger Rule.

  • <kuid:-25:1071>
  • Built-in Rule
  • Parent Rule
Properties:
   [Check Box] Trigger only once 
   [Check Box] Wait for child rules to complete even if no trains are present in rule trigger
   [Check Box] Only activate when the entering vehicle of the train is heading <select direction> into the trigger - select one of two directions:-
      forward
      backward
   Triggers List
      <add trigger> - select a trigger from the session list
      <delete trigger> - delete a selected trigger from the rule
   Select one of two option buttons:-
      ( ) click to accept all trains
      ( ) click to accept trains matching specific criteria
         Selecting the second option will produce the following selection controls:-
         Specific vehicle - identify the specific vehicle(s) that will trigger the rule
            + - click to add a specific vehicle from the session list
            x - click to remove the specific vehicle from the rule
         Vehicle types - identify the type of vehicle(s) that will trigger the rule
            + - click to add a type of vehicle from the session list
            x - click to remove the type of vehicle from the rule
         Drivers - identify the driver(s) that will trigger the rule
            + - click to add a driver from the session list
            x - click to remove a driver from the rule

Wait on Navigation Point Rule

Executes child rules when a specific navigation point is completed

  • <kuid:401543:1168>
  • Base Rule
  • Parent Rule
Properties:
   navigation point <click here to set> - enter the number of the navigation point to be completed
   in set <click here to set> - enter the unique name for the navigation set created using the Navigation Display Rule.
      Name must be in lowercase and have no spaces.
  • Known Issues:
The rule will NOT check to see if the named navigation set and point exists or not.

Wait on Train Stop/Start Rule

Executes child rules when a train stops or starts moving

  • <kuid:-25:1069>
  • Built-in Rule
  • Parent Rule
Properties:
   [Check Box] Trigger rule once 
   Wait for a train that matches the following criteria to <select> - select one of:-
      start moving
      stop moving
   Select one of two option buttons:-
      ( ) click to accept all trains
      ( ) click to accept trains matching specific criteria
         Selecting the second option will produce the following selection controls:-
         Specific vehicle - identify the specific vehicle or set of specific vehicles that will trigger the rule
            + - click to add a specific vehicle from the session list
            x - click to remove the specific vehicle from the rule
         Vehicle types - identify the type of vehicle or a set of vehicle types that will trigger the rule
            + - click to add a type of vehicle from the session list
            x - click to remove the type of vehicle from the rule
         Drivers - identify the drivers that will trigger the rule
            + - click to add a driver from the session list
            x - click to remove a driver from the rule

Back to Top

Resources Rules

DisplayIndustryStatus Rule (color modified)

Displays a summary of industry product levels when the "k" key is pressed.

  • <kuid:622415:100001>
  • DLS Rule by lockheed02 and marzipan
Properties:
   None
  • Notes:
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.

ExTrainz Manager Rule - TANE SP2

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.

  • <kuid:160293:10029>
  • DLS Rule by trev999
Properties:
   Diagnostic mode is <On/Off> - click to select On or Off. When set On diagnostic messages will be added to the Trainz Log file.
   Turn on message overlay <Yes/No> - click to select Yes or No. When set to Yes the message overlay (lower left of screen) will be active.
   Show rolling stock in Driver mode <Yes/No> - click to select Yes or No. When set to Yes rolling stock can be searched in Driver.
   Search only rolling stock already in session <Yes/No> - click to select Yes or No. When set to Yes only those rolling stock assets
      installed in the session can be searched.
   Graphic colours: <When Red, the industry does not require service/When Green, the industry does not require service> - click to switch 
      between the two colour options.
   Industry page size: <value> - enter the number of industries to be displayed in the Industry List window (maximum 250).
   The following industries are excluded: <Add an industry to be excluded> - name can be complete (e.g. "Coal Mine 2") 
      which will exclude that specific industry from the management list, or partial (e.g. "Coal") which will exclude all 
      industries with the word "Coal" in their names. Entries are not case sensitive.
      Once industries have been excluded, additional commands will appear for each excluded industry:-
      <delete> <industry name begins with/class name begins with> <name> - click delete to remove this entry. 
         - click industry name begins with/class name begins with to select between the two (see notes below).
         - click name to edit the name.
  • Notes:
  1. 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.
  2. 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.
  3. 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.
  • Known Issues:
This rule is NOT compatible with all industries.

Hide Product Overlays Rule

Hides the commodity or product bar graphs that appear on active industries

  • <kuid:400048:100970>
  • DLS Rule by callavsg
Properties:
  None

Multiple Resource Check Rule

Executes child rules if industries or vehicles reach set commodity levels. This rule replaces the older Resource Check Rule

  • <kuid:-25:656>
  • Built-in Rule
  • Parent Rule
Properties:
   <Product Level> - click to select a product test from two choices:-
      Reach/Exceed - sets an upper limit for the resources being monitored. 
         For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon reaches or exceeds a specified level.
         The initial level in the object must be below the set upper limit.
      Fall below - sets a lower limit for the resources being monitored. 
         For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon falls below a specified level. 
         The initial level in the object must be above the set lower limit. 
         To test when a resource level reaches zero (i.e. is empty) set the lower limit to a very low value but not zero as the level can never fall below zero. 
   <value> - enter required quantity value
   <select> - select a product from session list of products
   <Add object> - click to select a source or target object. Multiple objects and their queues can be added to the rule. 
      ALL the entered products must reach/exceed or fall below the specified value for the rule to be triggered. 
      For each object:-
         <Object> - click to select session active industry or product enabled rail vehicle 
         <Queue> - select product queue (there may be only one available)
         <Remove> - removes the object and its product queue from the rule
  • Notes:
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.

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

  • <kuid:-25:1067>
  • Legacy Rule (replaced by Multiple Resource Check Rule)
  • Built-in Rule
  • Parent Rule
Properties:
   Select one of two option buttons:-
      ( ) Watch industry queue
         Target Object <select> - select an industry from the session list
         Queue <select> - select a product queue from the selected industry
         Product <select> - select a product from the selected queue
         Amount <value> - enter a quantity
         Select one of two option buttons:-
            ( ) Complete when designated queue equals or exceeds required amount
            ( ) Complete when designated queue falls below required amount
      ( ) Watch vehicle
         Target Object <select> - select a rolling stock asset from the session list
         Queue <select> - select a product queue from the selected rolling stock
         Product <select> - select a product from the selected queue
         Amount <value> - enter a quantity
         Select one of two option buttons:-
            ( ) Complete when designated queue equals or exceeds required amount
            ( ) Complete when designated queue falls below required amount
  • Notes:
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.

Resource Verify Rule (fixed)

Executes child rules if a selected industry or vehicle reaches a set commodity level. The rule resets when all child rules have completed.

  • <kuid:160293:10060>
  • DLS Rule by trev999
  • Parent Rule
Properties:
   Select one of two option buttons:-
   ( ) Watch industry queue
      Target object <click to select> - click to select an industry from the session list.
      Product <click to select> - click to select an industry product.
      Amount <value> - enter a quantity for the selected product.
      Select one of two option buttons:-
      ( ) Complete when designated queue equals or exceeds designated amount
      ( ) Complete when designated queue falls below designated amount
   ( ) Watch vehicle queue
      Target object <click to select> - click to select a rolling stock vehicle from the session list.
      Product <click to select> - click to select a commodity product.
      Amount <value> - enter a quantity for the selected product.
      Select one of two option buttons:-
      ( ) Complete when designated queue equals or exceeds designated amount
      ( ) Complete when designated queue falls below designated amount
  • Notes:
  1. This rule will only monitor a single commodity in a single industry or vehicle.
  2. 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.

Back to Top

Session Sequence Rules

Ordered List Rule

Executes child rules in order once this rule starts

  • <kuid:-25:171>
  • Built-in Rule
  • Parent Rule
Properties:
   Select one of two option buttons:-
     ( ) This process will repeat <value> time(s) - enter the number of times this rule is to be repeated
     ( ) This process will repeat forever
  • Known Issues:
Some child rules will force a "wait" until certain conditions have been met (e.g. a mouse click or a set time has passed). These rules will delay the completion of any following child rules in the Ordered List Rule. If possible, place these rules last in the Ordered List.
For example: The Message Popup Rule will wait until it is closed before allowing the next child rule to be executed.

Progressive List Rule

Executes the first child rule on the first run, the second child on the second run, the third child on the third run, etc.

  • <kuid:-25:754>
  • Built-in Rule
  • Parent Rule
Properties:
  After last child has been executed ...
  <successive runs will do nothing/the first child is chosen again> - click to select one

Random List Rule

Executes ONE randomly selected child rule once only. The rule will not repeat to randomly select another child rule

  • <kuid:-25:758>
  • Built-in Rule
  • Parent Rule
Properties:
   None

Reset List Rule

Executes ALL child rules continuously in an ongoing infinite cycle

  • <kuid:-25:762>
  • Built-in Rule
  • Parent Rule
Properties:
   None

Simultaneous List Rule

Executes child rules simultaneously once this rule starts

  • <kuid:-25:1048>
  • Built-in Rule
  • Parent Rule
Properties:
   Rule completes when ... - click to chose one of the following:-
      one of the child rules has completed
      all child rules have reached a completed state
      all child rules have reached a "was completed" state

Back to Top

Speed Rules

ATP Speed Limiter Rule

Limits allowable speed over set limit

  • <kuid2:321959:1000:1>
  • Built-in Rule
Properties:
   Limits the speed to <value> mph over the set limit - enter speed value in mph

Speeding Check Rule

Executes child rules if player controlled trains are over the local speed limit or over a set (custom) speed

  • <kuid2:60850:89004:3>
  • Built-in Rule
  • Parent Rule
Properties:
   Select one of two options to set a speed limit to be observed
      ( ) Watch for trains travelling above the posted speed limit
         <speed value> - click to enter a new overspeed tolerance value
         <speed units> - click to select one from the list:-
            Km/h - Kilometres per hour
            MPH - Miles per hour
            mps - metres per second
      ( ) Watch for trains travelling above a custom speed
         <speed value> - click to enter a new custom speed value
         <speed units> - click to select one from the list:-
            Km/h - Kilometres per hour
            MPH - Miles per hour
            mps - metres per second
            Warning: This option is very performance intensive and should only be used in sessions with few trains

MaxPermittedSpeed Rule

Sets the maximum permitted speed of locomotives under AI control

  • <kuid2:60850:89000:7>
  • Built-in Rule
Properties:
   None
  • Notes:
This rule cannot be configured from the Session Rules list. It must be configured in the config.txt file of each locomotive. Instructions with an example are shown in the rule Properties

Back to Top

Startup and Termination Rules

End Session Rule

End the Session with a fade out.

  • <kuid:-25:482>
  • Built-in Rule
Properties:
   Fade out over <value> seconds - enter number of seconds for fade out.
  • Notes:
Seconds are Trainz clock time, not real time.

Multiplayer Rule

Enables the session to be taken online in a Multiplayer environment.

  • <kuid:447264:1045>
  • Built-in Rule
Properties:
   Suggested maximum number of players for this session <value> - enter a number
   Maximum number of drivers per player <value> - enter a number
   Players are permitted to claim drivers             [Check Box] - check to allow players to select a driver
   Players can see each other's driver orders         [Check Box] - check to allow players to view orders for other players
   Automatically target an available train on clients [Check Box] - automatically assign a driver to each player

Randomize Rule

Generates a different set of random numbers each time the session is run.

  • <kuid:169301:100129>
  • DLS Rule by Terry_Wagstaff
Properties:
   None
  • Notes:
Place this rule near the top of the Session Rules list and ensure that there is at least 5 seconds before the call to a Random function.
  • Related Rules:

Session Complete Rule

Set session to a percentage of completion.

  • <kuid:447264:1011>
  • Base Rule
Properties:
   Set session to percent complete <value> - enter number as a percentage
   [Check Box] Separate achievements for completion - check to set

Startup Options Rule

Specifies the starting options for the session. The weather settings will set the initial conditions, including the variability. To manually change the weather during play, use the Weather Rule.

  • <kuid:-16:10212>
  • Base Rule
Properties:
   Current control method is <select> - select one from:-
      Easy Mode - DCC (standard keyboard and mouse) control
      Ask User - let the user decide
      Realistic Mode - Cab controls (on screen levers, throttles, buttons, etc)
   Set weather to <select mode> with <select frequency> changeability - select
      Weather mode: - select one of:-
         Clear
         Cloudy 
         Drizzle
         Rain
         Stormy
         Light Snow
         Medium Snow
         Heavy Snow
      Changeability: - select one of:-
         Off - the weather will not change from the mode selected above
         Periodic - slow gradual changes to the weather
         Extreme - rapid and extreme changes to the weather
   Set time to <hours>:<minutes> with a rate of <select speed> - set the starting time and the speed at which the Trainz clock will run
   Set derailment realism to <select reality level> - select one of:-
      None - no train derailments will occur
      Arcade - train derailments will be exaggerated (beyond normal)
      Realistic - train derailments will occur as realistically as possible
   [Check Box] Show in game help - check to switch on help options
   Use <select measurement system> units in Driver - select one of:-
      Metric - kilometres, metres. This will override the default settings in a session
      Imperial - miles, feet. This will override the default settings in a session
      Default - uses the measurement system specified in the session
  • Notes:
Times are Trainz clock time, not real time
  • Related Rules:

Back to Top

Time Rules

Clock Rule

Rule needed for animated clocks.

  • <kuid2:62310:30041:2>
  • Built-in Rule
Properties:
   None
  • Notes:
Apply this rule to your session to make use of the animated clocks. See the forum for code to include in your clock object to work with this rule.

Time and Rate Rule

Sets the session start time and the rate at which time passes.

  • <kuid:-25:889>
  • Built-in Rule
Properties:
   Set time to <hours:minutes> - enter the clock starting time as hours (0-23) and minutes (0-59)
   with a rate of <1x> - select a speed at which time will pass from 1x (normal) to 1440x (extremely fast)

Timecheck Rule

Executes child rules at a set time.

  • <kuid2:122381:10008:3>
  • Built-in Rule
  • Parent Rule
Properties:
   <hh:mm:ss> - enter execution time as hours (0-23), minutes (0-59) and seconds (0-59).
   [Check Box] Execution time is on the day after the start time - when checked delays execution until the following day.
  • Known Issues:
Do not use this rule as a child of a repeating rule such as the Simultaneous List Rule or the Ordered List Rule.
  • Notes:
Times and days are Trainz clock times not real time.
  • Related Rules:
    • Time and Rate Rule - sets the session start time and the rate at which time passes.
    • Wait Rule - executes child rules after waiting for a set number of seconds.

Wait Rule

Executes child rules after waiting for set number of seconds

  • <kuid2:122381:10016:2>
  • Built-in Rule
  • Parent Rule
Properties:
   <click to set> - enter the number of seconds for the wait delay
  • Notes:
Seconds is in Trainz clock time, not real time

Back to Top

Variable Rules

Quick Session Variables Rule

Allows the editing of session variables

  • <kuid2:61392:5003:30>
  • DLS Rule by pguy
Properties:
   <local> - click to edit local variables
      <add new session variable> - click to enter the name of new local variable
         for each variable:-
         <variable-name> - click to change variable name
         <type> - click to select one of:-
            string - text characters
            int - integer
            float - real (decimal) numbers
            bool - boolean (true/false)
            stringset - meaning not known at this time
            stringlist - meaning not known at this time
            tkmlist - trackmark list (no longer supported in TANE SP2)
            platformlist - platform list (no longer supported in TANE SP2)
            del - delete variable
            edit - edit variable
   <trains> - click to edit a train variable
      <train selected> - click to select a train from the session list. Initially none is selected
         <select train> - click to select a locomotive
         <select vehicle> - click to select a rail vehicle
         for the selected loco/vehicle:-
            <Add new session variable> - click to enter the name of a new variable
              for the entered variable:-
                 <variable-name> - click to change variable name
                 <type> - click to select type (see list above)
   <objects> - no longer supported in TANE SP2
   <global> - no longer supported in TANE SP2
  • Known Issues:
Rule creator, pguy, has indicated that the future of this rule is uncertain as parts of it have been devalued in the latest release of TANE.

Variable Check Rule

Executes child rules when a specific variable matches set conditions

  • <kuid:-25:1049>
  • Built-in Rule
  • Parent Rule
Properties:
   <variable-name> - enter a variable-name. Variable name is case sensitive.
   Mathematical relationship, select one of:-
      is less than - enter a <value> to test against
      is less than or equal to - enter a <value> to test against
      is equal to - enter a <value> to test against
      is greater than or equal to - enter a <value> to test against
      is greater than - enter a <value> to test against
      is not equal to - enter a <value> to test against
      is between x and y - enter a minimum <x-value> and a maximum <y-value>
   Evaluation type. Select one from:-
      <This condition will be evaluated only once ...> - any changes to the variable that occur after
              it has been checked will not change the result of this rule
      <This condition will be evaluated once every second> - the rule will be rerun and the variable 
              rechecked every second

Variable Modify Continuous Rule

Adds, subtracts or sets a value to a specified variable every second.

  • <kuid:-25:1051>
  • Built-in Rule
Properties:
  <Add/Subtract/Change variable to> - select one.
     <value> - enter value to add, subtract or apply to <variable-name>
     <variable-name> - enter variable-name. Variable-name is case sensitive.

Variable Modify Rule

Change the value of a specified variable. This rule can also used to create a new variable and set its initial value by using the "Change variable" option.

  • <kuid:-25:1050>
  • Built-in Rule
Properties:
   Change <Add to variable/Subtract from variable/Change variable> - click to select one from:-
      Add to variable
         Add <value> to variable <variable-name> - enter value to add to variable, enter variable-name. Variable-name is case sensitive.
         <Do not undo the alteration if the rule is stopped/Undo the alteration if the rule is stopped> - click to select one.
      Subtract from variable
         Subtract <value> from variable <variable-name> - enter value to subtract from variable, enter variable-name.
            Variable-name is case sensitive.
         <Do not undo the alteration if the rule is stopped/Undo the alteration if the rule is stopped> - click to select one.
      Change variable
         Change variable <variable-name> to <value> - enter variable-name, enter new value. 
            Variable-name is case sensitive. This change cannot be undone if the rule is stopped. 
   [Check Box] (optional) Set the minimum value of <variable-name> to <value> - enter variable-name
      (this will already be set by the change option) and a value. Variable-name is case sensitive.
   [Check Box] (optional) Set the maximum value of <variable-name> to <value> - enter variable-name
      (this will already be set by the change option) and a value. Variable-name is case sensitive.

Variable Random Rule

Assigns a random integer value to a variable.

  • <kuid:400260:100606>
  • DLS Rule by tram_
Properties:
   Random variable <name> in minimum to maximum interval - enter name of variable. Variable-name is case sensitive.
   The minimum possible value of variable_name is <value> - enter the minimum value
   The maximum possible value of variable_name is <value> - enter the maximum value

Variable Show Rule

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.

  • <kuid:-25:971>
  • Built-in Rule
Properties:
  [Check Box] Add
     <variable-name> - enter variable-name to add to HUD. Variable-name is case sensitive.
     <label> - (optional) enter a short label to be displayed on the HUD in front of the variable value.
  [Check Box] Remove
     <variable-name> - enter variable-name to remove from HUD. Variable-name is case sensitive.

Back to Top

Weather Rules

EIRS Weather Rule NE USA Rule

Customize random weather rule relative to the North East Region of the United States.

  • <kuid2:487222:1037:3>
  • Built-in Rule
Properties:
   Season <select> - select one of:-
      Summer
      Fall
      Winter
      Spring
   Random Changeability (minutes) <value> - select one of:-
      2/5/10/15/20/30/45/60 - minutes
   Environment Settings <select> - select one of:-
      Disable/Enable
  • Notes:
Minutes are Trainz clock times, not real times

Random Weather Rule v2

Randomly changes the weather conditions between set values over a set duration.

  • <kuid:169301:100132>
  • DLS Rule by terry_wagstaff
Properties:
   Starting weather <select> - select one of:-
         Clear weather, no clouds, rain or snow
         Cloudy weather, no rain 
         Drizzle, light rain
         Rain
         Stormy weather that includes lightning and thunder
         Snowing lightly
         Medium snowfall
         Heavy snow
   Best weather <select> - select one of:-
         Clear weather, no clouds, rain or snow
         Cloudy weather, no rain 
         Drizzle, light rain
         Rain
         Stormy weather that includes lightning and thunder
         Snowing lightly
         Medium snowfall
         Heavy snow
   Worst weather <select> - select one of:-
         Clear weather, no clouds, rain or snow
         Cloudy weather, no rain 
         Drizzle, light rain
         Rain
         Stormy weather that includes lightning and thunder
         Snowing lightly
         Medium snowfall
         Heavy snow
   Changing about every: <value> mins - enter number of minutes between weather changes
  • Known issues:
This rule, once started, will run continuously and will not terminate so do NOT use this rule as a child rule in an Ordered List Rule because any following child rules will never be executed.

Weather Rule

Changes the weather conditions during Session play.

  • <kuid:-25:960>
  • Built-in Rule
Properties:
   Set weather to <select mode> with <select frequency> changeability - select
      Weather mode: - select one of:-
         Clear
         Cloudy 
         Drizzle
         Rain
         Stormy
         Light Snow
         Medium Snow
         Heavy Snow
    Changeability: - select one of:-
         Off - the weather will not change from the mode selected above
         Periodic - slow gradual changes to the weather
         Extreme - rapid and extreme changes to the weather

Back to Top

Retrieved from "https://wiki.trainzsimulator.com/index.php?title=Session_Rule_List_with_Parameters&oldid=13539"