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
No edit summary
Line 1: Line 1:
'''TRAINZ A New Era (TANE) SP2. List of Trainz Session Rules by Categories with Properties. All rules are the Copyright of N3V Games'''
'''TRAINZ A New Era (TANE) SP2. List of Trainz Session Rules in Alphabetical Order 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 Rule List with Parameters|Session Rule List (Alphabetical) with Parameters]]'''
Also available '''[[Session Rules By Categories With Properties]]'''


----
----
'''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 17: Line 15:
*'''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]]'''


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


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


==='''Consist Check Rule'''===
==='''Advanced Industry Load Configuration 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:'''
     '''[Check Box] Enforce strict exclusive testing''' - check to only accept an exact match with no unspecified vehicles in the consist.
     '''Target object ''<select>''''' - select industry object from session list
      - leave unchecked to accept any consist that contains the specified vehicles.
    '''[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
    Select one of two option buttons:-
    '''[Check Box] Override 'begin load' and 'begin unload' durations to ''<value>'' seconds''' - if checked enter number of seconds to override
    '''( ) 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:'''
*'''Notes:'''
: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.
:Times are Trainz clock time, not real time


*'''Trainz Wiki Links:'''
==='''AI Start 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]]'''


==='''Multiple Resource Check Rule'''===
Restarts all halted AI controlled trains. Drivers will continue with the commands in their driver command list.


Executes child rules if industries or vehicles reach set commodity levels. This rule replaces the older '''Resource Check Rule'''  
*'''<kuid2:400048:100981:1>'''


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


*'''Parent Rule'''
==='''AI Stop Rule'''===


'''Properties:'''
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.
    '''<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:'''
*'''<kuid2:400048:100980:1>'''
: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:'''
*'''DLS Rule''' by '''callavsg'''
**'''[[#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


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


==='''Objective Add Rule'''===
==='''ATP Speed Limiter Rule'''===


Sets up a game Objective with ID and display Name
Limits allowable speed over set limit


*'''<kuid:401543:2001>'''
*'''<kuid2:321959:1000:1>'''


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


  '''Properties:'''
  '''Properties:'''
     '''Priority ''<Select>''''' - select one of:-
     '''Limits the speed to ''<value>'' mph over the set limit''' - enter speed value in mph
      '''''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:'''
==='''AWS Configuration Rule'''===
**'''[[#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'''===
This rule configures the Trainz implementation of the Automatic Warning System when approaching signals


Executes child rules if an objective created with the '''Objective Add Rule''' is complete.
*'''<kuid2:60850:89002:3>'''


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


*'''Base 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?'''
----
'''[[#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]]'''


*'''Parent Rule'''
=='''C'''==
 
==='''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:'''
  '''Properties:'''
     '''Unique Objective ID ''<value>''''' - enter the unique ID created with the '''Objective Add Rule'''
     '''None'''
    '''Mode ''<select>''''' - select one of three:-
      '''''Wait for completion'''''
      '''''Wait for failure'''''
      '''''Wait for progress'''''


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


==='''Objective Update Rule'''===
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.


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


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


  '''Properties:'''
  '''Properties:'''
     '''Unique Objective ID ''<value>''''' - enter the unique ID created with the '''Objective Add Rule'''
     '''[Check Box] Lock camera controls for the duration''' - if checked user cannot alter camera view
     '''Mode ''<select>''''' - select one from the following options
    '''[Check Box] Prevent train control for duration - if checked user cannot control train
      '''''Decrement progress'''''
     '''Camera target: ''<click to select>''''' - click to select the object from the session list that will be the camera target
       '''''Increment progress'''''
    '''Camera mode:''' - select one of three option buttons:-
      '''''Reset Objective'''''
      '''( ) Stationary'''
      '''''Set objects as complete'''''
       '''( ) Circle targeted object'''
       '''''Set objects as failed'''''
      '''( ) Move from one point to another (zoom, pan, etc)'''
      '''''Set progress'''''
    '''Initial camera values:'''
      '''''Set progress only if greater'''''
      '''[Check Box] Pitch: ''<value>''''' - check to select then click ''value'' to enter a pitch value
     '''Amount ''<value>''''' - click to enter a 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


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Objective Add Rule|Objective Add Rule]]''' - sets up a game objective
**'''[[#Focus Camera Rule|Focus Camera Rule]]''' - sets the initial camera view and starting vehicle for a session
**'''[[#Objective Check Rule|Objective Check Rule]]''' - executes child rules if an objective is completed
**'''[[#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


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


Begins a ranked Session
Cleans up derailed train cars after a set time delay


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


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


  '''Properties:'''
  '''Properties:'''
     '''Countdown Starting Value ''<value>'''''
     '''Set delay to clean up derailed traincars to'''
       '''''hrs:'''''
       '''''<h>'':''' - click to enter the number of hours (0-23) to wait
      '''''min:'''''
       '''''<mm>'':''' - click to enter the number of minutes (0-59) to wait
       '''''sec:'''''
       '''''<ss>'':''' - click to enter the number of seconds (0-59) to wait
    '''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:'''
*'''Notes:'''
:Times are Trainz clock time, not real time
:Time is Trainz clock time, not real time.


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Ranked Session Complete Rule|Ranked Session Complete Rule]]''' - completes the active ranked Session
**'''[[#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
 
*'''Trainz Wiki Links:'''
**'''http://online.ts2009.com/mediaWiki/index.php/Clean_up_Derailed_Trains_Rule'''


==='''Ranked Session Complete Rule'''===
==='''Clock Rule'''===


Completes the active ranked Session
Rule needed for animated clocks.


*'''<kuid:401543:2032>'''
*'''<kuid2:62310:30041:2>'''


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


  '''Properties:'''
  '''Properties:'''
     '''Set the active ranked session as:''' - select one of two option buttons:-
     '''None'''
      '''( ) Complete'''
      '''( ) Failed'''
    '''[Check Box] Customize the completion message ''<text>''''' - enter a text message


*'''Related Rules:'''
*'''Notes:'''  
**'''[[#Ranked Session Begin Rule|Ranked Session Begin Rule]]''' - begins a ranked Session
: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.


==='''Resource Check Rule'''===
==='''Close Message Popup 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'''
Closes open message popups


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


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


  '''Properties:'''
  '''Properties:'''
    Select one of two option buttons:-
  '''None'''
      '''( ) 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:'''
*'''Known Issues:'''
:This rule only checks for ''changing'' commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is ''full'' or ''empty''.
:This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule


*'''Related Rules:'''
*'''Related Rule:'''
**'''[[#Multiple Resource Check Rule|Multiple Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
**'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
**'''[[#Resource Verify Rule (fixed)|Resource Verify Rule (fixed)]]''' - executes child rules when a set resource (commodity) level is reached


*'''Trainz Wiki Links:'''
*'''Trainz Wiki Links:'''
**'''http://online.ts2009.com/mediaWiki/index.php/Resource_Check_Rule'''
**'''[[Message Popup Rule Applications]]'''
**'''[[Message Popup Example|Message Popup Examples]]'''


==='''Resource Verify Rule (fixed)'''===
==='''Consist Check Rule'''===


Executes child rules if a selected industry or vehicle reaches a set commodity level. The rule resets when all child rules have completed.
Executes child rules when a matching consist is found. The order of the vehicles in the consists is not important.  


*'''<kuid:160293:10060>'''
*'''<kuid:-25:1068>'''


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


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


  '''Properties:'''
  '''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:-
     Select one of two option buttons:-
     '''( ) Watch industry queue'''
     '''( ) Rule disabled''' - select to disable the operation of this rule
       '''Target object ''<click to select>''''' - click to select an industry from the session list.
    '''( ) Complete whenever a train matching the description exists''' - When selected, enter the consist description:-
      '''Product ''<click to select>''''' - click to select an industry product.
       '''Specific vehicle''' - identify the specific vehicle(s) that will trigger the rule
       '''Amount ''<value>''''' - enter a quantity for the selected product.
          '''''+''''' - click to add a ''specific'' vehicle from the session list
      Select one of two option buttons:-
          '''''x''''' - click to remove the ''specific'' vehicle from the rule
      '''( ) Complete when designated queue equals or exceeds designated amount'''
       '''Vehicle types''''' - identify the ''type'' of vehicle(s) that will trigger the rule
      '''( ) Complete when designated queue falls below designated amount'''
          '''''+''''' - click to add a ''type'' of vehicle from the session list
    '''( ) Watch vehicle queue'''
          '''''x''''' - click to remove the ''type'' of vehicle from the rule
      '''Target object ''<click to select>''''' - click to select a rolling stock vehicle from the session list.
       '''Drivers''''' - identify the ''driver(s)'' that will trigger the rule
       '''Product ''<click to select>''''' - click to select a commodity product.
          '''''+''''' - click to add a ''driver'' from the session list
      '''Amount ''<value>''''' - enter a quantity for the selected product.
          '''''x''''' - click to remove a ''driver'' from the rule
      Select one of two option buttons:-
      '''( ) Complete when designated queue equals or exceeds designated amount'''
      '''( ) Complete when designated queue falls below designated amount'''


*'''Notes:'''
*'''Known Issues:'''
#This rule will only monitor a single commodity in a single industry or vehicle.
: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.
#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:'''
*'''Trainz Wiki Links:'''
**'''[[#Multiple Resource Check Rule|Multiple Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
**'''http://online.ts2009.com/mediaWiki/index.php/Consist_Check_Rule'''
**'''[[#Resource Check Rule|Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
**'''[[How to Use Variables in Sessions (Examples)#Example 3: Counting Consist Checks|How to Use Variables in Sessions (Examples): Counting Consist Checks]]'''
 
==='''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'''


==='''Station Visited Check Rule'''===
==='''Control Check Rule'''===


Executes child rules if specific trains call at set stations or industries
Executes child rules if the train control method has been altered or a specific method has been selected.


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


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


  '''Properties:'''
  '''Properties:'''
    '''Trigger: ''<select>''''' - click to select one of the following
  '''Execute child rules when:''' - select one of two option buttons:-
      '''''Never''''' - stopping at the selected industries will never trigger the rule.
    '''( ) DCC mode is Selected'''
      '''''Once only''''' - the rule is triggered on the first visit only to any one of the selected industries
    '''( ) Cab mode is Selected'''
      '''''Once per industry''''' - the rule is triggered on the first visit to each industry with each individual product
  '''Execute child rules:''' - select one of two option buttons:-
      '''''Once per visit''''' - the rule is triggered on the first visit to each industry regardless of the product
    '''( ) Every time control method is set'''
      '''''Once per vehicle''''' - each vehicle can only trigger the rule once.
    '''( ) Once only'''
    '''''<select industry>''''' - select industry or industries from session list
 
    Select one of two option buttons:-
*'''Related Rules:'''
      '''( ) click to accept all trains'''
**'''[[#Control Type Rule|Control Type Rule]]''' - sets the control method
      '''( ) 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


'''[[#top|Back to Top]]'''
==='''Control Type Rule'''===
----
=='''Camera Rules'''==


==='''Cinematic Camera Rule'''===
Sets the control method


Provides several different cinematic style cameras with animations. Best used at the start of a session.
*'''<kuid:-16:2030>'''
Use the '''Trackside Camera''' (tracking view) found in the '''Set Camera Rule''' during session play.


*'''<kuid2:401543:1166:3>'''
*'''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)


'''Properties:'''
*'''Related Rules:'''
    '''[Check Box] Lock camera controls for the duration''' - if checked user cannot alter camera view
**'''[[#Control Check Rule|Control Check Rule]]''' - executes child rules if the train control method changes
    '''[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
==='''Coupler Breakage Check Rule'''===
    '''Camera mode:''' - select one of three option buttons:-
 
      '''( ) Stationary'''
Executes child rules if there is a coupler breakage
      '''( ) Circle targeted object'''
 
      '''( ) Move from one point to another (zoom, pan, etc)'''
*'''<kuid2:447264:1017:1>'''
    '''Initial camera values:'''
 
      '''[Check Box] Pitch: ''<value>''''' - check to select then click ''value'' to enter a pitch value
*'''Built-in Rule'''
      '''[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
*'''Parent Rule'''
    '''Total time to animate:  ''<value>''''' - enter an animation time in seconds


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


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Focus Camera Rule|Focus Camera Rule]]''' - sets the initial camera view and starting vehicle for a session
**'''[[#Coupler Breakage HUD Rule|Coupler Breakage HUD Rule]]''' - adds a coupler stress and breakage warning to the HUD
**'''[[#Set Camera Rule|Set Camera Rule]]''' - sets the target object and properties of the camera
**'''[[#Set Coupler Masks Rule|Set Coupler Masks Rule]]''' - sets the coupling/decoupling masks on selected vehicles
**'''[[#Wait for Camera View Mode Rule|Wait for Camera View Mode Rule]]''' - executes child rules when the camera view is changed


==='''Focus Camera Rule'''===
==='''Coupler Breakage HUD Rule'''===


Sets the initial camera view and starting vehicle for a session.
HUD displays warning about coupler stress and breakage


*'''<kuid2:122381:10014:1>'''
*'''<kuid:-25:423>'''


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


  '''Properties:'''
  '''Properties:'''
     '''Focus camera to:''' - select one of two option buttons
     Select one of two option buttons:-
      '''( ) Map object'''
       '''( ) Show the Coupler Breakage Display'''
      '''( ) Vehicle'''
       '''( ) Hide the Coupler Breakage Display'''
    '''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:'''
*'''Related Rules:'''
**'''[[#Cinematic Camera Rule|Cinematic Camera Rule]]''' - provides several different cinematic style cameras with animations
**'''[[#Coupler Breakage Check Rule|Coupler Breakage Check Rule]]''' - executes child rules if a coupler breaks
**'''[[#Set Camera Rule|Set Camera Rule]]]''' - sets the target object and properties of the camera
**'''[[#Set Coupler Masks Rule|Set Coupler Masks Rule]]''' - sets the coupling/decoupling masks on selected vehicles
**'''[[#Wait for Camera View Mode Rule|Wait for Camera View Mode Rule]]''' - executes child rules when the camera view is changed


==='''Set Camera Rule'''===
==='''Custom Script Rule'''===


Sets the target object and properties of the camera.
No description


*'''<kuid:-25:179>'''
*'''<kuid:447264:1526>'''


*'''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:-
  '''None'''
      '''( ) Vehicle ''<click to select>''''' - select a vehicle from the Session list
----
      '''( ) Junction ''<click to select>''''' - select a junction from 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]]'''
      '''( ) 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:'''
=='''D'''==
**'''[[#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


==='''Wait for Camera View Mode Rule'''===
==='''DestSign Table Rule'''===


Executes child rules when the camera view is changed to a selected view
Creates a list of destination names for a destination sign


*'''<kuid:-25:192>'''
*'''<kuid2:206816:99004:2>'''


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


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


'''Properties:'''
==='''Directional Trigger Check Rule'''===
    '''[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:'''
Executes child rules when a set train enters a set trigger in a set direction. Adds direction to the '''Trigger Check 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
**'''[[#Set Camera Rule|Set Camera Rule]]''' - sets the target object and properties of the camera


'''[[#top|Back to Top]]'''
*'''<kuid2:532391:100003:1>'''
----
=='''Danger, Derailment and Safety Rules'''==


==='''ATP Speed Limiter Rule'''===
*'''DLS Rule''' by '''bobhahn'''
 
Limits allowable speed over set limit
 
*'''<kuid2:321959:1000:1>'''
 
*'''Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''Limits the speed to ''<value>'' mph over the set limit''' - enter speed value in mph
     '''[Check Box] Trigger only once '''
 
    '''[Check Box] Wait for child rules to complete even if no trains are present in rule trigger'''
'''Related Rules:'''
    '''[Check Box] Only activate when the entering vehicle of the train is heading ''<select direction>'' into the trigger''' - select one of two directions:-
     '''[[#AWS Configuration Rule|AWS Configuration Rule]]''' - configures the Trainz implementation of the Automatic Warning System when approaching signals
      '''''forward'''''
 
      '''''backward'''''
==='''AWS Configuration Rule'''===
     '''Triggers List'''
 
      '''''<add trigger>''''' - select a trigger from the session list
This rule configures the Trainz implementation of the Automatic Warning System when approaching signals
      '''''<delete trigger>''''' - delete a selected trigger from the rule
 
    Select one of two option buttons:-
*'''<kuid2:60850:89002:3>'''
      '''( ) 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


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


'''Properties:'''
*'''Related Rules:'''
    Select one of three option buttons:-
**'''[[#Trackside Check Rule|Trackside Check Rule]]''' - executes child rules when activated by a train. Provides different options to the '''Trigger Check Rule'''
      '''( ) Active'''
**'''[[#Trigger Check Rule|Trigger Check Rule]]''' - executes child rules when a set train enters a set trigger (non-directional)
      '''( ) 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'''===
*'''Trainz Wiki Links:'''
**'''[[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)]]'''


Cleans up derailed train cars after a set time delay
==='''Disable/Enable Industry Rule'''===


*'''<kuid2:60850:89003:1>'''
Enables/Disables vehicle load/unload for industry


*'''Base Rule'''
*'''<kuid2:401543:1171:1>'''
 
*'''Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
    '''Set delay to clean up derailed traincars to'''
  '''Load/unload ''<Disable/Enable>''''' - click to set to '''Disable''' or '''Enable'''
      '''''<h>'':''' - click to enter the number of hours (0-23) to wait
  '''Which Industry? ''<select>''''' - click to set Industry from Session List
      '''''<mm>'':''' - click to enter the number of minutes (0-59) to wait
  '''Which Vehicles:''' - select one of two option buttons:-
      '''''<ss>'':''' - click to enter the number of seconds (0-59) to wait
      '''( ) Apply to every vehicle in the session'''
      '''( ) Apply only to a specific vehicles from Session List'''


*'''Notes:'''
==='''Disallow AI Rule'''===
:Time is Trainz clock time, not real time.


*'''Related Rules:'''
Cancels (deletes) all current and waiting AI commands for all drivers
**'''[[#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


*'''Trainz Wiki Links:'''
*'''<kuid:400048:100603>'''
**'''http://online.ts2009.com/mediaWiki/index.php/Clean_up_Derailed_Trains_Rule'''


==='''Coupler Breakage Check Rule'''===
*'''DLS Rule''' by '''callavsg'''


Executes child rules if there is a coupler breakage
'''Properties:'''
  '''None'''


*'''<kuid2:447264:1017:1>'''
*'''Related Rules:'''
**'''[[#AI Start Rule|AI Start Rule]]''' - restarts all halted AI drivers
**'''[[#AI Stop Rule|AI Stop Rule]]''' - halts all AI drivers


*'''Built-in Rule'''
==='''Display Custom HUD Rule'''===


*'''Parent Rule'''
Show or hide the Custom Heads Up Display.


'''Properties:'''
*'''<kuid:-3:10206>'''
    '''None'''


*'''Related Rules:'''
*'''Base Rule'''
**'''[[#Coupler Breakage HUD Rule|Coupler Breakage HUD Rule]]''' - adds a coupler stress and breakage warning to the HUD
**'''[[#Set Coupler Masks Rule|Set Coupler Masks Rule]]''' - sets the coupling/decoupling masks on selected vehicles
 
==='''Coupler Breakage HUD Rule'''===
 
HUD displays warning about coupler stress and breakage
 
*'''<kuid:-25:423>'''
 
*'''Built-in Rule'''


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


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Coupler Breakage Check Rule|Coupler Breakage Check Rule]]''' - executes child rules if a coupler breaks
**'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
**'''[[#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)|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


==='''Junction Derailment Prevention Rule'''===
*'''Trainz Wiki Links:'''
**'''http://online.ts2009.com/mediaWiki/index.php/Display_Custom_HUD_Rule'''


Sets opposing (trailing) junctions ahead of a train to prevent derailments.  Works with both AI and manually driven trains.
==='''Display HTML Pages Rule'''===


*'''<kuid2:121843:100282:1>'''
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'''  


*'''DLS Rule''' by '''pitkin'''
*'''<kuid:-25:442>'''


'''Properties:'''
*'''Legacy Rule''' (replaced by '''Message Popup Rule''')
    '''None'''


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


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
**'''[[#Close Message Popup Rule|Close Message Popup Rule]]''' - closes a displayed pop-up browser window.
**'''[[#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.
**'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
**'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).
**'''[[#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.


==='''Replace Missing Vehicles Rule'''===
==='''Display Video Rule'''===


Produces new trains to replace missing vehicles that have been removed from the session by the '''Clean Up Derailed Trains Rule'''
Displays a page containing a video clip from a HTML asset in a browser window.


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


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


  '''Properties:'''
  '''Properties:'''
     '''[Check Box] Respawn trains if they are abandoned for 10 minutes'''
     '''Display page ''<index.html>'' of html asset ''<click to select>'' in a new browser window
    If checked:-
       '''''index.html''''' - enter the filename of a HTML page in the selected HTML asset. The ''.html'' is optional in the filename.
       Select one of two option buttons:-
      '''''<click to select>''''' - select the HTML asset from those installed.
          '''( ) Respawn trains at their original locations'''
 
          '''( ) Respawn trains from portals'''
*'''Notes:'''
            '''''<+ Add a new portal>''''' - click to enter the name of a portal, there can be more than one portal.
:Video must be in a valid web format.
            Entered portal names that appear in red have not been found in the session


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Clean Up Derailed Trains Rule|Clean Up Derailed Trains Rule]]''' - cleans up derailed train cars after a set time delay
**'''[[#Play Sound Rule|Play Sound Rule]]''' - plays a wav sound file
**'''[[#Wait for Derailment Rule|Wait for Derailment Rule]]''' - executes child rules when a derailment occurs


==='''Safety System Engaged Check Rule'''===
==='''DisplayIndustryStatus Rule (color modified)'''===


Executes child rules if safety systems are applied.
Displays a summary of industry product levels when the "k" key is pressed.


*'''<kuid:447264:1216>'''
*'''<kuid:622415:100001>'''


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


*'''Parent Rule'''
'''Properties:'''
    '''None'''


'''Properties:'''
*'''Notes:'''
    '''[Check Box] Trigger only once'''
: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:'''
**'''[[#Safety System Isolated Check Rule|Safety System Isolated Check Rule]]''' - executes child rules if safety systems have been isolated
**'''[[#ExTrainz Manager Rule - TANE SP2|ExTrainz Manager Rule - TANE SP2]]''' - displays information on consists, industries and products in Driver and Surveyor.


==='''Safety System Isolated Check Rule'''===
==='''Driver Command Check Rule'''===


Executes child rules if safety systems are isolated (disengaged).
Executes child rules if the driver commands match a set list.


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


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


  '''Properties:'''
  '''Properties:'''
    '''[Check Box] Trigger only once'''
  '''[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


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Safety System Engaged Check Rule|Safety System Engaged Check Rule]]''' - executes child rules if safety systems have been engaged
**'''[[#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
==='''Set Coupler Masks 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
**'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train


Set the coupling/decoupling  masks on the selected vehicles
*'''Trainz Wiki Links:'''
**'''http://online.ts2009.com/mediaWiki/index.php/Driver_Command_Rule'''


*'''<kuid:-25:980>'''
==='''Driver Command Rule'''===


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


'''Properties:'''
*'''<kuid:-3:10057>'''
    '''''<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


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


==='''Signal Passed At Danger Check 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


Executes child rules if a signal or stop mark is ''Passed at Danger (STOP)''.
*'''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.


*'''<kuid2:60850:89007:2>'''
*'''Related Rules:'''
**'''[[#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'''
*'''Parent Rule'''


  '''Properties:'''
  '''Properties:'''
     '''[Check Box] Trigger only once'''
     '''''<Show/Hide>'' the Driver Main Menu Bar''' - click '''Show''' or '''Hide''' to select


*'''Trainz Wiki Links:'''
==='''Driver Schedule Rule'''===
**'''[[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]]


==='''Speeding Check Rule'''===
Sets up a list of basic scheduled commands


Executes child rules if player controlled trains are over the local speed limit or over a set (custom) speed
*'''<kuid2:82445:90001:9>'''
 
*'''<kuid2:60850:89004:3>'''


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


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


'''Properties:'''
*'''Related Rules:'''
    Select one of two options to set a speed limit to be observed
**'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
      '''( ) Watch for trains travelling above the posted speed limit'''
**'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
          '''''<speed value>''''' - click to enter a new overspeed tolerance value
**'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
          '''''<speed units>''''' - click to select one from the list:-
**'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
            '''''Km/h''''' - Kilometres per hour
**'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
            '''''MPH''''' - Miles per hour
 
            '''''mps''''' - metres per second
*'''Trainz Wiki Links:'''
      '''( ) Watch for trains travelling above a custom speed'''
**'''[[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]]
          '''''<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'''===
==='''Driver Setup Rule'''===


Overrides the default vehicle physics properties for all vehicles or for those matching set criteria
Creates the list of drivers for this session and assign them their orders


*'''<kuid:-25:1052>'''
*'''<kuid:-16:2025>'''


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


  '''Properties:'''
  '''Properties:'''
     Select one of two option buttons:-
     '''''<driver icon>''''' - click to select a new driver from the list of installed and built in drivers
      '''( ) click to accept all trains'''
    '''''<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
      '''( ) click to accept trains matching specific criteria'''
    '''''<driver name>''''' - click to enter a new name for the selected driver
          Selecting the second option will produce the following selection controls:-
    '''''<driver mode>''''' - click to select one of:-
          '''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
      '''''Autodetect''''' - the program will detect the driver mode to be used. For example, if driver commands have been entered for this driver
            '''''+''''' - click to add a ''specific'' vehicle from the session list
           then the '''AI driver''' mode will be selected
            '''''x''''' - click to remove the ''specific'' vehicle from the rule
      '''''First Human Player''''' - the driver will wait until he/she has been selected by the player
          '''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule
      '''''AI driver''''' - the AI will be given control even if no commands are present
            '''''+''''' - click to add a ''type'' of vehicle from the session list
       '''''Multiplayer Driver''''' - the driver will be assigned to a multiplayer user
            '''''x''''' - click to remove the ''type'' of vehicle from the rule
    '''''<remove>''''' - this driver will be removed from the rule
           '''Drivers''''' - identify the ''drivers'' that will trigger the rule
     '''''>>''''' - click to enter driver commands from those specified in the '''Driver Command Rule'''
            '''''+''''' - click to add a ''driver'' from the session list
    --> Scroll down to the bottom of the list of entered drivers for more options
            '''''x''''' - click to remove a ''driver'' from the rule
  '''''<Add another driver>''''' - click to add another driver
    '''Coupler Parameters:'''
  '''[Check Box] Remove all existing Drivers first'''
       '''Couplers break at ''<value>'' kN expansion force''' - enter force value
  '''[Check Box] Generate new Drivers for empty Trains'''
      '''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'''===
*'''Related Rules:'''
 
**'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
Executes child rules when a derailment occurs
**'''[[#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
 
*'''Trainz Wiki Links:'''
**'''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]]'''


*'''<kuid:-25:1053>'''
=='''E, F, G'''==
 
==='''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'''
*'''Built-in Rule'''


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


'''Properties:'''
*'''Notes:'''
    '''[Check Box] Trigger derailment watch once''' - check to execute the rule once only
:Minutes are Trainz clock times, not real times


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Clean Up Derailed Trains Rule|Clean Up Derailed Trains Rule]]''' - cleans up derailed train cars after a set time delay
**'''[[#Random Weather Rule v2|Random Weather Rule v2]]''' - randomly changes the weather according to entered parameters
**'''[[#Replace Missing Vehicles Rule|Replace Missing Vehicles Rule]]''' - creates a replacement train after a derailment
**'''[[#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


'''[[#top|Back to Top]]'''
==='''Enable/Disable Driver Commands Rule'''===
----
=='''Driver Rules'''==


==='''AI Start 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


Restarts all halted AI controlled trains. Drivers will continue with the commands in their driver command list.
*'''<kuid:-25:480>'''


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


*'''DLS Rule''' by '''callavsg'''
'''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


'''Properties:'''
    '''None'''
*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#AI Stop Rule|AI Stop Rule]]''' - halts all AI drivers
**'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
**'''[[#Disallow AI Rule|Disallow AI Rule]]''' - cancels all AI driver commands
**'''[[#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


==='''AI Stop Rule'''===
*'''Trainz Wiki Links:'''
**'''http://online.ts2009.com/mediaWiki/index.php/Enable/Disable_Driver_Commands_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.
==='''End Session Rule'''===


*'''<kuid2:400048:100980:1>'''
End the Session with a fade out.


*'''DLS Rule''' by '''callavsg'''
*'''<kuid:-25:482>'''
 
'''Properties:'''
    '''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
 
==='''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'''
*'''Built-in Rule'''


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


'''Properties:'''
*'''Notes:'''
  '''Execute child rules when:''' - select one of two option buttons:-
:Seconds are Trainz clock time, not real time.
    '''( ) 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'''


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Control Type Rule|Control Type Rule]]''' - sets the control method
**'''[[#Session Complete Rule|Session Complete Rule]]''' - set the session to a percentage of completion


==='''Control Type Rule'''===
==='''ExTrainz Manager Rule - TANE SP2'''===


Sets the control method
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:-16:2030>'''
*'''<kuid:160293:10029>'''


*'''Base Rule'''
*'''DLS Rule''' by '''trev999'''


  '''Properties:'''
  '''Properties:'''
  '''Current control method is: ''<select>''''' - click to select one of
    '''Diagnostic mode is ''<On/Off>''''' - click to select ''On'' or ''Off''. When set ''On'' diagnostic messages will be added to the Trainz Log file.
    '''''Easy Mode''''' - DCC (standard keyboard and mouse) control
    '''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.
    '''''Ask User''''' - let the user decide
    '''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.
    '''''Realistic Mode''''' - Cab controls (on screen levers, throttles, buttons, etc)
    '''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:'''
#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:'''
**'''[[#Control Check Rule|Control Check Rule]]''' - executes child rules if the train control method changes
**'''[[#DisplayIndustryStatus Rule (color modified)|DisplayIndustryStatus Rule (color modified)]]''' - displays information on industry product levels.


==='''Disallow AI Rule'''===
==='''Fade In/Out Rule'''===


Cancels (deletes) all current and waiting AI commands for all drivers
Fade in or out within seconds, using specified color and opacity values.


*'''<kuid:400048:100603>'''
*'''<kuid2:190611:200000:2>'''


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


  '''Properties:'''
  '''Properties:'''
  '''None'''
    '''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


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


==='''Driver Command Check Rule'''===
==='''Flash HUD Icon Rule'''===


Executes child rules if the driver commands match a set list.
Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.


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


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


  '''Properties:'''
  '''Properties:'''
  '''[Check Box] Trigger rule once''' - check to allow the rule to execute only once
    Select one of two option buttons:-
  '''Driver character to watch the command list of ''<select>''' - select a driver name from the Session List''
    '''( ) Flash the ''<click to select>'' icon on the ''<click to select>'' HUD panel for a period of ''<value>'' seconds'''
  '''Wait for driver character to have a command list that matches this:'''
      TIP: Select the HUD panel first (the second ''<click to select>'' link).
    '''''<add driver command>''''' - add a driver command from the session list. More commands can be added. Commands can be deleted.
      Available HUD panels are (select one):-
    '''''<add all>''''' - adds ALL driver commands in the session list. Individual commands can be removed.
          '''Bottom Right Menu'''
    '''''<delete all>''''' - deletes all entered driver commands from the session rule
          '''Camera Controls'''
 
          '''DCC Controls'''
*'''Related Rules:'''
          '''Driver Main Menu'''
**'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
      Available icons will depend on the HUD panel selected.
**'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
    '''( ) ''<Start/Stop>'' flashing the ''<click to select>'' icon on the ''<click to select>'' HUD panel'''
**'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
      TIP: Select the HUD panel first (the second ''<click to select>'' link).
**'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
      Available HUD panels are (select one):-
**'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
          '''Bottom Right Menu'''
          '''Camera Controls'''
          '''DCC Controls'''
          '''Driver Main Menu'''
      Available icons will depend on the HUD panel selected.


*'''Trainz Wiki Links:'''
*'''Related Rules:'''
**'''http://online.ts2009.com/mediaWiki/index.php/Driver_Command_Rule'''
**'''[[#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


==='''Driver Command Rule'''===
==='''Focus Camera Rule'''===


Specifies which commands will be available for the drivers
Sets the initial camera view and starting vehicle for a session.


*'''<kuid:-3:10057>'''
*'''<kuid2:122381:10014:1>'''


*'''Base Rule'''
*'''DLS Rule''' by '''mizi'''


  '''Properties:''':
  '''Properties:'''
     For each installed Driver Command:-
    '''Focus camera to:''' - select one of two option buttons
     '''[Check Box] ''Name of Driver Command'' and ''Description (if available)''''' - check to make that command available to the drivers
      '''( ) Map object'''
 
      '''( ) Vehicle'''
*'''Notes:'''
     '''Named ''<?????>''''' - enter name of object or vehicle from session list
: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:
     '''Additionally:'''
::The ''Wait For Trigger'' command will not be available to any drivers if there are no triggers set.
      '''[Check Box] set view mode to''' - check to select one of four option buttons
::The ''Call At'' command will not be available to any drivers if there are no industry active assets or passenger enabled stations.
          '''( ) 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:'''
**'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
**'''[[#Cinematic Camera Rule|Cinematic Camera Rule]]''' - provides several different cinematic style cameras with animations
**'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
**'''[[#Set Camera Rule|Set Camera Rule]]]''' - sets the target object and properties of the camera
**'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
**'''[[#Wait for Camera View Mode Rule|Wait for Camera View Mode Rule]]''' - executes child rules when the camera view is changed
**'''[[#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'''===
==='''Generic TreeNode Debug Window Rule'''===


Show/Hide the Driver Main Menu Bar
No description.


*'''<kuid:-25:448>'''
*'''<kuid:30501:1042>'''


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


  '''Properties:'''
  '''Properties:'''
     '''''<Show/Hide>'' the Driver Main Menu Bar''' - click '''Show''' or '''Hide''' to select
     '''None'''
----
'''[[#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 Schedule Rule'''===
=='''H, I, J'''==


Sets up a list of basic scheduled commands
==='''Hide Product Overlays Rule'''===


*'''<kuid2:82445:90001:9>'''
Hides the commodity or product bar graphs that appear on active industries


*'''Built-in Rule'''
*'''<kuid:400048:100970>'''


'''Properties:'''
*'''DLS Rule''' by '''callavsg'''
    '''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:'''
'''Properties:'''
**'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
  '''None'''
**'''[[#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:'''
==='''InputTable Rule'''===
**'''[[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'''===
Creates a list of message names to be used for various purposes including passing data to '''Driver Commands'''


Creates the list of drivers for this session and assign them their orders
*'''<kuid2:131986:1012:1>'''


*'''<kuid:-16:2025>'''
*'''Built-in Rule'''
 
*'''Base Rule'''


  '''Properties:'''
  '''Properties:'''
     '''''<driver icon>''''' - click to select a new driver from the list of installed and built in drivers
     '''''<add>''''' - click to add a new entry to the table
     '''''<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
     Each new entry will require an input message
    '''''<driver name>''''' - click to enter a new name for the selected driver
      '''''<short message>''''' - enter a message. The message must be in a format that is specific for each purpose
    '''''<driver mode>''''' - click to select one of:-
      For the '''MoveTurntable''' driver command the message must be formatted as:-
       '''''Autodetect''''' - the program will detect the driver mode to be used. For example, if driver commands have been entered for this driver
          '''turntable,name_of_turntable,number_of_connecting_roads''' - the first entry must be the word ''turntable'' in lower case.
          then the '''AI driver''' mode will be selected
            ''name_of_turntable'' is the name of the turntable,
       '''''First Human Player''''' - the driver will wait until he/she has been selected by the player
            ''number_of_connecting_roads'' is the number of tracks connecting to the turntable
      '''''AI driver''''' - the AI will be given control even if no commands are present
       For the '''WaitUntilTime''' driver command the message must be formatted as:-
       '''''Multiplayer Driver''''' - the driver will be assigned to a multiplayer user
          '''time,hour,minute''' - the first entry must be the word ''time'' in lower case,  
    '''''<remove>''''' - this driver will be removed from the rule
            ''hour'' must be from 0 to 23,
    '''''>>''''' - click to enter driver commands from those specified in the '''Driver Command Rule'''
            ''minute'' must be from 0 to 59.
    --> Scroll down to the bottom of the list of entered drivers for more options
       For the '''WaitUntilSVariable''' driver command the message must be formatted as:-
  '''''<Add another driver>''''' - click to add another driver
          '''svar,svar_name,svar_condition,value''' - the first entry must be the word ''svar'' in lower case,
  '''[Check Box] Remove all existing Drivers first'''
            ''svar_name'' is the name of the session variable,
  '''[Check Box] Generate new Drivers for empty Trains'''
            ''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'''===


*'''Related Rules:'''
Alters settings on an interlocking tower path
**'''[[#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
*'''<kuid:401543:3205>'''
**'''[[#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
*'''Base Rule'''  
**'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
 
'''Properties:'''
  '''Interlocking Tower ''<select>''''' - to set Name and Objects


*'''Trainz Wiki Links:'''
*'''Related Rules:'''
**'''http://online.ts2009.com/mediaWiki/index.php/Driver_Setup_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.
**'''[[#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.


==='''Enable/Disable Driver Commands Rule'''===
==='''Interlocking Tower Path Selection UI 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
Will automatically react to messages from Interlocking Towers and display a path selection dialog to the player. Disable by removing rule from session


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


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


  '''Properties:'''
  '''Properties:'''
    '''<Enable/Disable>'' the following driver commands ...''' - click to select '''Enable''' or '''Disable'''
  '''[Checkbox] Show path activation message in Driver'''
    For each driver command:-
 
    '''[Check Box] ''command name''''' - check to enable or disable
*'''Related Rules:'''
    '''[Check Box] ''command name''''' - check to enable or disable
**'''[[#Interlocking Tower Configure Path Rule|Interlocking Tower Configure Path Rule]]''' - alters the settings on an interlocking tower path
    '''[Check Box] ''command name''''' - check to enable or disable
**'''[[#Interlocking Tower Set Path Rule|Interlocking Tower Set Path Rule]]''' - sets the state of an interlocking tower path for a train
    etc
**'''[[#Interlocking Tower Enhanced Manager Rule (SP2 and later)|Interlocking Tower Enhanced Manager Rule (SP2 and later)]]''' - more management and control options for interlocking towers.
    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:'''
==='''Interlocking Tower Set Path Rule'''===
**'''[[#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


*'''Trainz Wiki Links:'''
Will set the state of an interlocking tower path for a train
**'''http://online.ts2009.com/mediaWiki/index.php/Enable/Disable_Driver_Commands_Rule'''


==='''JTG Correct Vehicle Lights'''===
*'''<kuid:401543:3204>'''


Corrects the brightness of vehicle headlights. Now obsolete.
*'''Base Rule'''


*'''<kuid2:478657:999103:1>'''
'''Properties:'''
  '''Interlocking Tower ''<select>''''' - to set Name and Objects


*'''DLS Rule''' by '''jtg-trainz'''
*'''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.


*''' Obsolete Rule''' (function is now built into TANE Driver Additional Tools Menu)
==='''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:'''
  '''Properties:'''
     '''None'''
     '''''<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
 
*'''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 Set Path Rule|Interlocking Tower Set Path Rule]]''' - sets the state of an interlocking tower path for a train
 
*'''Trainz Wiki Links:'''
**'''http://online.ts2009.com/mediaWiki/index.php/Enhanced_Interlocking_Tower_Manager_Rule'''
 
==='''JTG Correct Vehicle Lights'''===


==='''Quick Portal Manager Standard Edition Rule (SP2 and later)'''===
Corrects the brightness of vehicle headlights. Now obsolete.


Manages portals and adds flexible timetables.
*'''<kuid2:478657:999103:1>'''


*'''<kuid2:61392:5011:45>'''
*'''DLS Rule''' by '''jtg-trainz'''


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


  '''Properties:'''
  '''Properties:'''
     '''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.
     '''None'''
    '''''<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.
==='''Junction Derailment Prevention Rule'''===
    '''''<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.
Sets opposing (trailing) junctions ahead of a train to prevent derailments. Works with both AI and manually driven trains.
    '''[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:'''
*'''<kuid2:121843:100282:1>'''
**'''[[#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


*'''Trainz Wiki Links:'''
*'''DLS Rule''' by '''pitkin'''
**'''http://online.ts2009.com/mediaWiki/index.php/Quick_Portal_Manager'''


==='''QuickDrive Rule'''===
'''Properties:'''
    '''None'''


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


*'''<kuid:401543:1184>'''
*'''Related Rules:'''
**'''[[#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]]'''


*'''Base Rule'''
=='''K, L, M'''==


'''Properties:'''
==='''Lock All Junctions Rule'''===
  '''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'''


*'''Trainz Wiki Links:'''
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.
**'''http://online.ts2009.com/mediaWiki/index.php/QuickDrive_Rule'''


==='''Wait for Driver On/Off Train Rule'''===
*'''<kuid:400048:100971>'''


Executes child rules when a driver gets on or off a train
*'''DLS Rule''' by '''callavsg'''


*'''<kuid:-25:953>'''
'''Properties:'''
    '''None'''


*'''Built-in Rule'''
*'''Notes:'''
 
:Individual junctions can still be set, locked and unlocked by using the '''Set Junction 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


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


==='''Wait for Driver/Train to be Locally Owned Rule'''===
==='''MaxPermittedSpeed 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 the maximum permitted speed of locomotives under AI control


*'''<kuid2:401543:1173:1>'''
*'''<kuid2:60850:89000:7>'''


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


*'''Parent Rule'''
'''Properties:'''
    '''None'''


'''Properties:'''
*'''Notes:'''
  '''Assets Ownership:''' - select one of two option buttons:-
: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
    '''( ) Wait for ownership of a specific Driver'''
    '''( ) Wait for ownership of Driver'''
  '''Driver or Vehicle ''<select>''''' - choose from session list


*'''Related Rules:'''
==='''mc Display Custom HUD V2 Rule (SP2 and later)'''===
**'''[[#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


'''[[#top|Back to Top]]'''
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)'''
----
=='''HUD (Heads Up Display) Rules'''==


==='''Cab Controls HUD Rule'''===
*'''<kuid2:61392:1072:10>'''


Was used to provide the HUD controls for the cabin view. Now obsolete.
*'''Legacy Rule''' (replaced by '''Quick CustomHUD Manager Rule (SP2 and later)''')


*'''<kuid:-16:287428>'''
*'''DLS Rule''' by '''pguy'''


*'''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'''


*'''Obsolete Rule''' (function is now built into TANE)
*'''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.
**'''[[#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


'''Properties:'''
==='''Message Popup Rule'''===
    '''None'''


==='''Coupler Breakage HUD 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.


HUD displays warning about coupler stress and breakage
*'''<kuid:-25:1003>'''
 
*'''<kuid:-25:423>'''


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


  '''Properties:'''
  '''Properties:'''
     Select one of two option buttons:-
     '''[Check Box] Pause game while message is displayed''' - stops the game until this message is closed
       '''( ) Show the Coupler Breakage Display'''
    '''[Check Box] Close previous popup windows''' - closes any Message Popups currently displayed before this message is shown
       '''( ) Hide the Coupler Breakage Display'''
    '''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.


*'''Related Rules:'''
*'''Known Issues:'''
**'''[[#Coupler Breakage Check Rule|Coupler Breakage Check Rule]]''' - executes child rules if a coupler breaks
: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.
**'''[[#Set Coupler Masks Rule|Set Coupler Masks Rule]]''' - sets the coupling/decoupling masks on selected vehicles
 
==='''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'''


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
**'''[[#Close Message Popup Rule|Close Message Popup Rule]]''' - closes a displayed pop-up browser window.
**'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
**'''[[#Display HTML Pages Rule|Display HTML Pages Rule]]''' - display listed HTML files in order as a navigable sequence of pages.
**'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers
**'''[[#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.
**'''[[#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:'''
*'''Trainz Wiki Links:'''
**'''http://online.ts2009.com/mediaWiki/index.php/Display_Custom_HUD_Rule'''
**'''[[How to Create a HTML Asset]]'''
**'''[[Message Popup Rule Applications|Message Popup Applications]]'''
**'''[[Message Popup Example|Message Popup Examples]]'''


==='''Flash HUD Icon Rule'''===
==='''Minimap Options Rule'''===


Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.
Sets the display options for the minimap.


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


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


  '''Properties:'''
  '''Properties:''' ''Default values - all checked''
    Select one of two option buttons:-
    '''[Check Box] Map Textures'''
    '''( ) Flash the ''<click to select>'' icon on the ''<click to select>'' HUD panel for a period of ''<value>'' seconds'''
    '''[Check Box] Gradients'''
      TIP: Select the HUD panel first (the second ''<click to select>'' link).
    '''[Check Box] Junctions'''
      Available HUD panels are (select one):-
    '''[Check Box] Signals'''
          '''Bottom Right Menu'''
    '''[Check Box] Triggers'''
          '''Camera Controls'''
    '''[Check Box] Markers'''
          '''DCC Controls'''
     '''[Check Box] Trackside Labels'''
          '''Driver Main Menu'''
    '''[Check Box] Terrain Objects'''
      Available icons will depend on the HUD panel selected.
    '''[Check Box] Industrial Names'''
     '''( ) ''<Start/Stop>'' flashing the ''<click to select>'' icon on the ''<click to select>'' HUD panel'''
    '''[Check Box] Named Objects'''
      TIP: Select the HUD panel first (the second ''<click to select>'' link).
    '''[Check Box] Consists'''
      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:'''
*'''Related Rules:'''
**'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
**'''[[#Show/Hide Minimap Rule|Show/Hide Minimap Rule]]''' - shows the minimap window in Driver.
**'''[[#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


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


Shows or hides a graphical HUD which includes junction direction for the junction ahead. This rule has been superseded by the '''Quick CustomHUD Manager Rule (SP2 and later)'''
Enables the addition, editing and management of Mission Codes used to auto select paths in '''Interlocking Towers'''.


*'''<kuid2:61392:1072:10>'''
*'''<kuid2:61392:8200:50>'''
 
*'''DLS Rule''' by '''pguy'''
 
ENTRY UNDER CONSTRUCTION
 
*'''Trainz Wiki Links:'''
**'''http://online.ts2009.com/mediaWiki/index.php/MissionCodes_Manager'''
 
==='''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.


*'''Legacy Rule''' (replaced by '''Quick CustomHUD Manager Rule (SP2 and later)''')
*'''<kuid2:61392:8300:50>'''


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


'''Properties:'''
ENTRY UNDER CONSTRUCTION
    '''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'''


*'''Related Rules:'''
*'''Trainz Wiki Links:'''
**'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
**'''http://online.ts2009.com/mediaWiki/index.php/Mission_Code_Stops_and_TimeTables_Manager'''
**'''[[#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


==='''Quick CustomHud Manager Rule (SP2 and later)'''===
==='''Multiplayer 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)'''
Enables the session to be taken online in a Multiplayer environment.


*'''<kuid2:61392:5020:47>'''
*'''<kuid:447264:1045>'''


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


  '''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'''.
     '''Suggested maximum number of players for this session ''<value>''''' - enter a number
      This is NOT the standard OS clipboard.
     '''Maximum number of drivers per player ''<value>''''' - enter a number
     '''''<Paste rule data from Clipboard>''''' - if data is held in the special clipboard area, then click to paste that data into the selected HUD.
    '''Players are permitted to claim drivers            [Check Box]''' - check to allow players to select a driver
      This is NOT the standard OS clipboard.
     '''Players can see each other's driver orders        [Check Box]''' - check to allow players to view orders for other players
    '''Current HUD Parameters'''
     '''Automatically target an available train on clients [Check Box]''' - automatically assign a driver to each player
      '''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:'''
==='''Multiple Junction Alignment Check Rule'''===
: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:'''
Executes child rules if specific junctions are set.
**'''[[#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


==='''Show/Hide HUD Panel Rule'''===
*'''<kuid:-25:168>'''


Shows or hides a HUD panel.
*'''Built-in Rule'''


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


  '''Properties:'''
  '''Properties:'''
     '''''<Show/Hide>'' the ''<click to select>'' HUD panel''' - select '''''Show''''' or '''''Hide''''' and then select the HUD panel
     '''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:'''
*'''Related Rules:'''
**'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
**'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
**'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
**'''[[#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.
**'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
**'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).
**'''[[#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.
*'''Trainz Wiki Links:'''
**'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked
**'''[[How to Control Junctions in Sessions]]'''


==='''Variable Show Rule'''===
==='''Multiple Resource Check 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.
Executes child rules if industries or vehicles reach set commodity levels. This rule replaces the older '''Resource Check Rule'''


*'''<kuid:-25:971>'''
*'''<kuid:-25:656>'''


*'''Built-in Rule'''
*'''Built-in Rule'''
*'''Parent 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]]'''
----
'''[[#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]]'''


==='''Wait for Click on HUD Icon Rule'''===
=='''N, O'''==


Executes child rules when the user clicks on a selected HUD icon
==='''Navigation Display Rule'''===


*'''<kuid:-25:951> <kuid:-25:970>''' - two versions built-in with different kuids, both have the same properties
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.


*'''Built-in Rule'''
*'''<kuid2:401543:1161:1>'''


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


  '''Properties:'''
  '''Properties:'''
     '''[Check Box] Trigger Once'''
     '''Unique set ID: ''<click here to set>''''' - enter a unique name for the navigation set. Name must be in lowercase and have no spaces.
     '''HUD Panel ''<Click>''''' - click choose from list:-
     '''Train (optional): ''<click here to set>''''' - select a rolling stock asset from the session list shown.
       '''Bottom Right Menu'''
    Select one of three option buttons:-
       '''Camera Controls'''
    '''( ) All points must be completed in sequence:'''
       '''DCC Controls'''
       - the first uncompleted navigation point will be shown and must be completed next.
    '''Icon ''<Click>''''' - click to choose from list. Selections depends on HUD Panel chosen
      - 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:'''
**'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
**'''[[#Navigation Set Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.
**'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
**'''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set has completed or is incomplete.
**'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
**'''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
**'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers
**'''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.
**'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
**'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed
**'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.


'''[[#top|Back to Top]]'''
*'''Trainz Wiki Links:'''
----
**'''[[How to Use Navigation Point Rules (Applications)]]'''
=='''Industry Rules'''==
**'''[[How to Use Navigation Point Rules]]'''


==='''Advanced Industry Load Configuration Rule'''===
==='''Navigation Point Complete Rule'''===


Locks train controls when loading/unloading at an industry, overrides time settings for begin load and begin unload operations
Manually completes a navigation point in a set


*'''<kuid:30501:100007>'''
*'''<kuid:401543:1167>'''


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


  '''Properties:'''
  '''Properties:'''
     '''Target object ''<select>''''' - select industry object from session list
     '''Mark navigation point ''<click here to set>''''' - enter the navigation point number to be completed
     '''[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
     '''complete in set ''<click here to set>''''' - enter the unique name for the navigation set created using the '''Navigation Display Rule'''.
    '''[Check Box] Override 'begin load' and 'begin unload' durations to ''<value>'' seconds''' - if checked enter number of seconds to override
        Name must be in lowercase and have no spaces.


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


==='''Disable/Enable Industry Rule'''===
*'''Related Rules:'''
**'''[[#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 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


Enables/Disables vehicle load/unload for industry
*'''Trainz Wiki Links:'''
**'''[[How to Use Navigation Point Rules (Applications)]]'''
**'''[[How to Use Navigation Point Rules]]'''


*'''<kuid2:401543:1171:1>'''
==='''Navigation Set Check Rule'''===


*'''Built-in Rule'''
Executes child rules if a navigation set created with the '''Navigation Display Rule''' is complete (or incomplete).


'''Properties:'''
*'''<kuid:401543:1165>'''
  '''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)'''===
*'''Base Rule'''


Displays a summary of industry product levels when the "k" key is pressed.
*'''Parent Rule'''
 
*'''<kuid:622415:100001>'''
 
*'''DLS Rule''' by '''lockheed02''' and '''marzipan'''


  '''Properties:'''
  '''Properties:'''
     '''None'''
     '''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


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


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


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


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.
==='''Navigation Set Clear Rule'''===
 
Clears a navigation set removing any uncompleted navigation points


*'''<kuid:160293:10029>'''
*'''<kuid:401543:1164>'''


*'''DLS Rule''' by '''trev999'''
*'''Base 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.
     '''''<Click here to set>''''' - enter the unique name for the navigation set created using the '''Navigation Display Rule'''.
    '''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.
        Name must be in lowercase and have no spaces.
    '''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:'''
#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:'''
*'''Known Issues:'''
:This rule is NOT compatible with all industries.
:The rule will '''NOT''' check to see if the named navigation set exists or not.


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#DisplayIndustryStatus Rule (color modified)|DisplayIndustryStatus Rule (color modified)]]''' - displays information on industry product levels.
**'''[[#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


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


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


*'''<kuid:-25:656>'''
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:'''
     '''<Product Level>''' - click to select a product test from two choices:-
     '''''<visibility>''''' - click to select one
       '''''Reach/Exceed''''' - sets an upper limit for the resources being monitored.
       '''Hide''' - select to make the navigation set invisible
          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.
       '''Show''' - select to make the navigation set visible
          The initial level in the object must be below the set upper limit.
     '''''<click here to set>''''' - enter the unique name for the navigation set created using the '''Navigation Display Rule'''.
       '''''Fall below''''' - sets a lower limit for the resources being monitored.
        Name must be in lowercase and have no spaces.
          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:'''
*'''Known Issues:'''
:This rule only checks for ''changing'' commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is ''full'' or ''empty''.
:The rule will '''NOT''' check to see if the named navigation set exists or not.


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Resource Check Rule|Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
**'''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
**'''[[#Resource Verify Rule (fixed)|Resource Verify Rule (fixed)]]''' - executes child rules when a set resource (commodity) level is reached
**'''[[#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:'''
*'''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]]'''
**'''[[How to Use Navigation Point Rules (Applications)]]'''
**'''[[How to Use Navigation Point Rules]]'''


==='''Power Station Rule'''===
==='''Objective Add Rule'''===


Sets up a Power Station and its electricity consumers
Sets up a game Objective with ID and display Name


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


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


  '''Properties:'''
  '''Properties:'''
     '''Power station ''<select>''''' - select a Power Station from the session list.
     '''Priority ''<Select>''''' - select one of:-
     '''Consumers:'''
      '''''Above Normal'''''
      '''''<add object>''''' - add power consumers from the session list
      '''''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


==='''Resource Check 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


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'''
==='''Objective Check Rule'''===


*'''<kuid:-25:1067>'''
Executes child rules if an objective created with the '''Objective Add Rule''' is complete.


*'''Legacy Rule''' (replaced by '''Multiple Resource Check Rule''')
*'''<kuid:401543:2003>'''


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


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


  '''Properties:'''
  '''Properties:'''
     Select one of two option buttons:-
     '''Unique Objective ID ''<value>''''' - enter the unique ID created with the '''Objective Add Rule'''  
      '''( ) Watch industry queue'''
    '''Mode ''<select>''''' - select one of three:-
          '''Target Object ''<select>''''' - select an industry from the session list
      '''''Wait for completion'''''
          '''Queue ''<select>''''' - select a product queue from the selected industry
       '''''Wait for failure'''''
          '''Product ''<select>''''' - select a product from the selected queue
      '''''Wait for progress'''''
          '''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''.


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


*'''Trainz Wiki Links:'''
==='''Objective Update Rule'''===
**'''http://online.ts2009.com/mediaWiki/index.php/Resource_Check_Rule'''


==='''Resource Verify Rule (fixed)'''===
Changes progress of an objective outcome created with the '''Objective Add Rule''' according to Property choices


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:2002>'''


*'''<kuid:160293:10060>'''
*'''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
 
*'''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
 
==='''Ordered List Rule'''===
 
Executes child rules in order once this rule starts
 
*'''<kuid:-25:171>'''


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


*'''Parent Rule'''
*'''Parent Rule'''
Line 1,558: Line 1,525:
  '''Properties:'''
  '''Properties:'''
     Select one of two option buttons:-
     Select one of two option buttons:-
    '''( ) Watch industry queue'''
      '''( ) This process will repeat ''<value>'' time(s)''' - enter the number of times this rule is to be repeated
      '''Target object ''<click to select>''''' - click to select an industry from the session list.
      '''( ) This process will repeat forever'''
      '''Product ''<click to select>''''' - click to select an industry product.
 
      '''Amount ''<value>''''' - enter a quantity for the selected product.
*'''Known Issues:'''
      Select one of two option buttons:-
: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.
      '''( ) Complete when designated queue equals or exceeds designated amount'''
::For example: The '''Message Popup Rule''' will wait until it is closed before allowing the next child rule to be executed.
      '''( ) Complete when designated queue falls below designated amount'''
 
    '''( ) Watch vehicle queue'''
*'''Related Rules:'''
      '''Target object ''<click to select>''''' - click to select a rolling stock vehicle from the session list.
**'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child on the second run, etc
      '''Product ''<click to select>''''' - click to select a commodity product.
**'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule
      '''Amount ''<value>''''' - enter a quantity for the selected product.
**'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously
      Select one of two option buttons:-
**'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously
      '''( ) Complete when designated queue equals or exceeds designated amount'''
      '''( ) Complete when designated queue falls below designated amount'''


*'''Notes:'''
*'''Trainz Wiki Links:'''
#This rule will only monitor a single commodity in a single industry or vehicle.
**'''http://online.ts2009.com/mediaWiki/index.php/Ordered_List'''
#This rule only checks for ''changing'' commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is ''full'' or ''empty''.
**'''[[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]]'''


*'''Related Rules:'''
=='''P, Q'''==
**'''[[#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'''===
==='''Play Sound Rule'''===


Executes child rules if specific trains call at set stations or industries
Plays a wav sound file.


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


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


  '''Properties:'''
  '''Properties:'''
     '''Trigger: ''<select>''''' - click to select one of the following
     '''Default HTML ''<Click>''''' - click to to enter Sound File Name
      '''''Never''''' - stopping at the selected industries will never trigger the rule.
    '''HTML Assets ''<Click>''''' - click to select HTML asset
      '''''Once only''''' - the rule is triggered on the first visit only to any one of the selected industries
     '''Rule Completes ''<Click>''''' - to select one of:-
      '''''Once per industry''''' - the rule is triggered on the first visit to each industry with each individual product
       '''sound has just started'''
      '''''Once per visit''''' - the rule is triggered on the first visit to each industry regardless of the product
       '''sound has finished playing'''
      '''''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


'''[[#top|Back to Top]]'''
*'''Related Rules:'''
----
**'''[[#Display Video Rule|Display Video Rule]]''' - displays a page containing a video clip from a HTML asset in a browser window
=='''Interlocking Tower, Junction and Signal Rules'''==


==='''Interlocking Tower Configure Path Rule'''===
==='''Power Station Rule'''===


Alters settings on an interlocking tower path
Sets up a Power Station and its electricity consumers


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


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


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


*'''Related Rules:'''
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 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'''===
*'''<kuid:-25:754>'''


Will automatically react to messages from Interlocking Towers and display a path selection dialog to the player. Disable by removing rule from session
*'''Built-in Rule'''


*'''<kuid:401543:3203>'''
*'''Parent Rule'''
 
*'''Base Rule'''


  '''Properties:'''
  '''Properties:'''
   '''[Checkbox] Show path activation message in Driver'''
   '''After last child has been executed ...'''
  '''''<successive runs will do nothing/the first child is chosen again>''''' - click to select one


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Interlocking Tower Configure Path Rule|Interlocking Tower Configure Path Rule]]''' - alters the settings on an interlocking tower path
**'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order
**'''[[#Interlocking Tower Set Path Rule|Interlocking Tower Set Path Rule]]''' - sets the state of an interlocking tower path for a train
**'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule
**'''[[#Interlocking Tower Enhanced Manager Rule (SP2 and later)|Interlocking Tower Enhanced Manager Rule (SP2 and later)]]''' - more management and control options for interlocking towers.
**'''[[#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/Progressive_List'''
**'''[[How to Use Parent and Child Rules]]'''


==='''Interlocking Tower Set Path Rule'''===
==='''Quick CustomHud Manager Rule (SP2 and later)'''===


Will set the state of an interlocking tower path for a train
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)'''


*'''<kuid:401543:3204>'''
*'''<kuid2:61392:5020:47>'''


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


  '''Properties:'''
  '''Properties:'''
  '''Interlocking Tower ''<select>''''' - to set Name and Objects
    '''''<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.
*'''Related Rules:'''
    '''''<Paste rule data from Clipboard>''''' - if data is held in the special clipboard area, then click to paste that data into the selected HUD.
**'''[[#Interlocking Tower Configure Path Rule|Interlocking Tower Configure Path Rule]]''' - alters the settings on an interlocking tower path
      This is NOT the standard OS clipboard.
**'''[[#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.
    '''Current HUD Parameters'''
**'''[[#Interlocking Tower Enhanced Manager Rule (SP2 and later)|Interlocking Tower Enhanced Manager Rule (SP2 and later)]]''' - more management and control options for interlocking towers.
      '''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.
 
*'''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


==='''Interlocking Tower Enhanced Manager Rule (SP2 and later)'''===
==='''Quick Portal Manager Standard Edition Rule (SP2 and later)'''===


Provides more management and control options for interlocking towers.
Manages portals and adds flexible timetables.  


*'''<kuid2:61392:8130:41>'''
*'''<kuid2:61392:5011:45>'''


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


  '''Properties:'''
  '''Properties:'''
     '''''<towers>''''' - click to select interlocking towers from the session list
     '''Target date is ''day-of-week'' ''&<nowiki />lt;dd/mm/yyyy&<nowiki />gt;''''' - ''day-of-week'' and ''date'' shown are for today's date. Click '''''dd/mm/yyyy''''' to change date.
       '''''<do full check again>''''' - click to run an error check on all interlocking towers
    '''''<Copy rule data to Clipboard>''''' - click to copy the currently entered data to a special clipboard area used by the rules created by '''pguy'''.
       '''List of all available interlocking towers''' - for each tower:-
       This is NOT the standard OS clipboard.
          '''''<view details>''''' - click to view and edit the tower properties
    '''''<Paste rule data from Clipboard>''''' - if data is held in the special clipboard area, then click to paste that data into the rule.
          '''''<copy from>''''' - click to copy properties from another tower selected from the session list
       This is NOT the standard OS clipboard.
     '''''<debug log>''''' - click to set the debug log properties
    '''[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.
*'''Related Rules:'''
    '''[Check Box] Disable locomotives/vehicles enhanced mode''' - check to save vehicle properties when a train is removed by a portal.
**'''[[#Interlocking Tower Configure Path Rule|Interlocking Tower Configure Path Rule]]''' - alters the settings on an interlocking tower path
      These properties will be restored if the same train is emitted by a portal. If checked then a new command will appear:
**'''[[#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.
      '''''<for all vehicles/for only locomotives/for only tagged vehicles>''''' - click to select one.
**'''[[#Interlocking Tower Set Path Rule|Interlocking Tower Set Path Rule]]''' - sets the state of an interlocking tower path for a train
     '''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.
*'''Trainz Wiki Links:'''
    '''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.
**'''http://online.ts2009.com/mediaWiki/index.php/Enhanced_Interlocking_Tower_Manager_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
==='''Junction Derailment Prevention Rule'''===
    For each schedule:-
 
      '''''<hh:mm>''''' - click to set the time when a train will be emitted from the portal. Times use the 24hr clock.
Sets opposing (trailing) junctions ahead of a train to prevent derailments. Works with both AI and manually driven trains.
      '''''<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)'''.
*'''<kuid2:121843:100282:1>'''
      '''''<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.


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


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


*'''Notes:'''
==='''Quick Session Variables Rule'''===
: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:'''
Allows the editing of session variables
**'''[[#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).


==='''Lock All Junctions Rule'''===
*'''<kuid2:61392:5003:30>'''


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.
*'''DLS Rule''' by '''pguy'''


*'''<kuid:400048:100971>'''
'''Properties:'''
 
    '''''<local>''''' - click to edit local variables
*'''DLS Rule''' by '''callavsg'''
      '''''<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


'''Properties:'''
*'''Known Issues:'''  
    '''None'''
: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.
 
*'''Notes:'''
:Individual junctions can still be set, locked and unlocked by using the '''Set Junction Rule'''


*'''Related Rules:'''
*'''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.
**'''[[#Variable Check Rule|Variable Check Rule]]''' - executes child rules according to 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 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.


==='''MissionCode Manager Rule (SP2 and later)'''===
==='''QuickDrive Rule'''===


Enables the addition, editing and management of Mission Codes used to auto select paths in '''Interlocking Towers'''.  
Changes the Session settings.


*'''<kuid2:61392:8200:50>'''
*'''<kuid:401543:1184>'''


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


ENTRY UNDER CONSTRUCTION
'''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'''


*'''Trainz Wiki Links:'''
*'''Trainz Wiki Links:'''
**'''http://online.ts2009.com/mediaWiki/index.php/MissionCodes_Manager'''
**'''http://online.ts2009.com/mediaWiki/index.php/QuickDrive_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]]'''


==='''MissionCode Stops and Timetable Manager Rule (SP2 and later)'''===
=='''R'''==


Enables the creation, editing and management of stop zones and timetables for trains following a path defined using mission codes.
==='''Random List Rule'''===


*'''<kuid2:61392:8300:50>'''
Executes ONE randomly selected child rule once only. The rule will not repeat to randomly select another child rule


*'''DLS Rule''' by '''pguy'''
*'''<kuid:-25:758>'''
 
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'''
*'''Built-in Rule'''
Line 1,763: Line 1,784:


  '''Properties:'''
  '''Properties:'''
     '''Wait until ''<selection>''''' - select from:-
     '''None'''
      '''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:'''
*'''Related Rules:'''
**'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
**'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order
**'''[[#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.
**'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child rule on the second run, etc
**'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).
**'''[[#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:'''
*'''Trainz Wiki Links:'''
**'''[[How to Control Junctions in Sessions]]'''
**'''[[How to Use Parent and Child Rules]]'''
**'''http://online.ts2009.com/mediaWiki/index.php/Random_List'''


==='''Set Cleared Junctions Rule'''===
==='''Random Weather Rule v2'''===


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'''
Randomly changes the weather conditions between set values over a set duration.


*'''<kuid2:131986:157661:1>'''
*'''<kuid:169301:100132>'''


*'''DLS Rule''' by '''atilabarut'''
*'''DLS Rule''' by '''terry_wagstaff'''


  '''Properties:'''
  '''Properties:'''
     '''''Add Junction''''' - click to select a junction from the session junction list
     '''Starting weather ''<select>'' - select one of:-
    '''''Add All''''' - click to add ALL junctions in the session junction list
          '''''Clear weather, no clouds, rain or snow'''''
    '''''Delete All''''' - click to remove ALL entered junctions from the rule
          '''''Cloudy weather, no rain'''''
      '''Junction Options:''' - for each selected junction:-
          '''''Drizzle, light rain'''''
           '''''<direction>''''' - click to select the junction direction
          '''''Rain'''''
            '''Left'''
          '''''Stormy weather that includes lightning and thunder'''''
            '''Center'''
          '''''Snowing lightly'''''
            '''Right'''
          '''''Medium snowfall'''''
            '''Don't change'''
          '''''Heavy snow'''''
           '''''<user control>''''' - click to select a user control option
    '''Best weather ''<select>'' - select one of:-
            '''Locked''' - the junction setting cannot be changed by the user
           '''''Clear weather, no clouds, rain or snow'''''
            '''Unlocked''' - the junction setting can be changed by the user
          '''''Cloudy weather, no rain'''''
           '''''<AI control>''''' - click to select AI control
          '''''Drizzle, light rain'''''
            '''Allows AI control''' - an AI train can switch the junction
          '''''Rain'''''
            '''Blocks AI control''' - an AI train cannot switch the junction
          '''''Stormy weather that includes lightning and thunder'''''
           '''''Remove''''' - click to remove this junction from the rule list
          '''''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:'''
*'''Related Rules:'''
**'''[[#Junction Derailment Prevention Rule|Junction Derailment Prevention Rule]]''' - sets opposing junctions ahead of a train to prevent derailments
**'''[[#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
**'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
**'''[[#Startup Options Rule|Startup Options Rule]]''' - sets the weather conditions at the start of a Session
**'''[[#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:'''
==='''Randomize Rule'''===
**'''[[How to Control Junctions in Sessions]]'''


==='''Set Junctions Rule'''===
Generates a different set of random numbers each time the session is run.


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


*'''<kuid:-25:1065>'''
*'''DLS Rule''' by '''Terry_Wagstaff'''


*'''Built-in Rule'''
'''Properties:'''
    '''None'''


'''Properties:'''
*'''Notes:'''
    '''''Add Junction''''' - click to select a junction from the session junction list
: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.
    '''''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


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Junction Derailment Prevention Rule|Junction Derailment Prevention Rule]]''' - sets opposing junctions ahead of a train to prevent derailments
**'''[[#Variable Random|Variable Random]]''' - sets a variable to a random integer value.
**'''[[#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:'''
==='''Ranked Session Begin Rule'''===
**'''[[How to Control Junctions in Sessions]]'''


==='''Set Signal Extended Rule'''===
Begins a ranked Session


Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''
*'''<kuid:401543:2031>'''


*'''<kuid2:47662:20002:4>'''
*'''Base 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 -
     '''Countdown Starting Value ''<value>'''''
       '''Automatic'''
       '''''hrs:'''''
      '''Stop'''
       '''''min:'''''
       '''Stop then Continue'''
       '''''sec:'''''
      '''Caution Left'''
    '''1 through 5 stars, points for each star ''<value>''''' - enter number of points for each star rating
       '''Caution Right'''
    '''Session timer mode:''' - select one of three option buttons:-
      '''Caution'''
       '''( ) Timer'''
      '''Advance Caution Left'''
       '''( ) Countdown Starting value ''<value>''''' - enter time ''hh:mm:ss''
      '''Advance Caution Right'''
       '''( ) None'''
      '''Advance Caution'''
       '''Proceed Left'''
       '''Proceed Right'''
      '''Proceed'''
      '''Slow'''
       '''Medium'''


*'''Notes:'''
*'''Notes:'''
:The signal must support the state selected otherwise there will be no change in the signal
:Times are Trainz clock time, not real time


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Trigger Multiple Signals Rule|Trigger Multiple Signals Rule]]''' - sets selected signals to DANGER (STOP) when selected triggers are activated
**'''[[#Ranked Session Complete Rule|Ranked Session Complete Rule]]''' - completes the active ranked Session


==='''Trigger Multiple Signals Rule'''===
==='''Ranked Session Complete Rule'''===


Sets selected signals to DANGER (STOP) when selected triggers are activated. Signals will be at AUTOMATIC when the triggers are not activated.
Completes the active ranked Session


*'''<kuid2:116387:26:1>'''
*'''<kuid:401543:2032>'''


*'''DLS Rule''' by '''maggs'''
*'''Base Rule'''


  '''Properties:'''
  '''Properties:'''
     '''<add signal>''' - select a signal from the Session List. More than one signal can be added.
     '''Set the active ranked session as:''' - select one of two option buttons:-
       '''<delete>''' - remove a signal from the rule.
       '''( ) Complete'''
    '''<add trigger>''' - select a trigger from the Session List. More than one trigger can be added.
      '''( ) Failed'''
      '''<delete>''' - remove a trigger from the rule.
    '''[Check Box] Customize the completion message ''<text>''''' - enter a text message


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Set Signal Extended Rule|Set Signal Extended Rule]]''' - sets a selected signal to a specific signal state
**'''[[#Ranked Session Begin Rule|Ranked Session Begin Rule]]''' - begins a ranked Session


'''[[#top|Back to Top]]'''
==='''Replace Missing Vehicles Rule'''===
----
=='''Message Rules'''==


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


Closes open message popups
*'''<kuid:447264:1214>'''
 
*'''<kuid:447264:1526>'''


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


  '''Properties:'''
  '''Properties:'''
  '''None'''
    '''[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


*'''Known Issues:'''
*'''Related Rules:'''
:This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule
**'''[[#Clean Up Derailed Trains Rule|Clean Up Derailed Trains Rule]]''' - cleans up derailed train cars after a set time delay
**'''[[#Wait for Derailment Rule|Wait for Derailment Rule]]''' - executes child rules when a derailment occurs


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


*'''Trainz Wiki Links:'''
Executes ALL child rules continuously in an ongoing infinite cycle
**'''[[Message Popup Rule Applications]]'''
**'''[[Message Popup Example|Message Popup Examples]]'''


==='''DestSign Table Rule'''===
*'''<kuid:-25:762>'''


Creates a list of destination names for a destination sign
*'''Built-in Rule'''


*'''<kuid2:206816:99004:2>'''
*'''Parent Rule'''
 
*'''Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
  '''''<add destination>''''' - enter a destination name to be added to the destination sign roll
    '''None'''
  '''''<import destinations from texture-group>''''' - select a list of destination names from session
 
  '''[Check Box] Enable industries/stations as destination''' - check to set
*'''Related Rules:'''
  '''[Check Box] Enable Track Marks as destinations''' - check to set
**'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order
  '''[Check Box] Enable table of destinations''' - check to set
**'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child rule on the second run, etc
**'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule
**'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously
 
*'''Trainz Wiki Links:'''
**'''http://online.ts2009.com/mediaWiki/index.php/Reset_List'''
**'''[[How to Use Parent and Child Rules]]'''
 
==='''Resource Check Rule'''===


==='''Display HTML Pages 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'''


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:1067>'''


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


*'''Legacy Rule''' (replaced by '''Message Popup Rule''')
*'''Built-in Rule'''


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


  '''Properties:'''
  '''Properties:'''
     '''''<Add Page>''''' - adds the HTML page ''index.html'' from the selected HTML asset
     Select one of two option buttons:-
      '''''<index.html>''''' - click to change the page name. The extension ''.html'' is optional
      '''( ) Watch industry queue'''
    '''''<Add All>''''' - adds all HTML pages from the session list '''(this appears to be disabled in TANE)'''
          '''Target Object ''<select>''''' - select an industry from the session list
    '''''<Delete All>''''' - delete all HTML pages from this property list
          '''Queue ''<select>''''' - select a product queue from the selected industry
    '''[Check Box] Prevent user from exiting browser until all pages viewed'''
          '''Product ''<select>''''' - select a product from the selected queue
    '''[Check Box] Disable closing of browser window by user'''
          '''Amount ''<value>''''' - enter a quantity
    '''[Check Box] Disable browser window scrolling'''
          Select one of two option buttons:-
    '''[Check Box] Make browser window invisible'''
            '''( ) Complete when designated queue equals or exceeds required amount'''
    '''[Check Box] Set position-Under Construction!!!''' - not implemented
            '''( ) Complete when designated queue falls below required amount'''
    '''[Check Box] Set size-Under Construction!!!''' - not implemented
      '''( ) Watch vehicle'''
    '''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
          '''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:'''
**'''[[#Close Message Popup Rule|Close Message Popup Rule]]''' - closes a displayed pop-up browser window.
**'''[[#Multiple Resource Check Rule|Multiple Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
**'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
**'''[[#Resource Verify Rule (fixed)|Resource Verify Rule (fixed)]]''' - executes child rules when a set resource (commodity) level is reached
**'''[[#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.
*'''Trainz Wiki Links:'''
**'''http://online.ts2009.com/mediaWiki/index.php/Resource_Check_Rule'''


==='''Display Video Rule'''===
==='''Resource Verify Rule (fixed)'''===


Displays a page containing a video clip from a HTML asset in a browser window.
Executes child rules if a selected industry or vehicle reaches a set commodity level. The rule resets when all child rules have completed.


*'''<kuid:-25:138>'''
*'''<kuid:160293:10060>'''


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


  '''Properties:'''
*'''Parent Rule'''
     '''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.
  '''Properties:'''
       '''''<click to select>''''' - select the HTML asset from those installed.
    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:'''  
*'''Notes:'''
:Video must be in a valid web format.
#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:'''
**'''[[#Play Sound Rule|Play Sound Rule]]''' - plays a wav sound file
**'''[[#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]]'''


==='''DisplayIndustryStatus Rule (color modified)'''===
=='''S-Se'''==


Displays a summary of industry product levels when the "k" key is pressed.
==='''Safety System Engaged Check Rule'''===


*'''<kuid:622415:100001>'''
Executes child rules if safety systems are applied.


*'''DLS Rule''' by '''lockheed02''' and '''marzipan'''
*'''<kuid:447264:1216>'''
 
*'''Built-in Rule'''
 
*'''Parent Rule'''


  '''Properties:'''
  '''Properties:'''
     '''None'''
     '''[Check Box] Trigger only once'''
 
*'''Related Rules:'''
**'''[[#Safety System Isolated Check Rule|Safety System Isolated Check Rule]]''' - executes child rules if safety systems have been isolated
 
==='''Safety System Isolated Check Rule'''===
 
Executes child rules if safety systems are isolated (disengaged).
 
*'''<kuid:447264:1217>'''
 
*'''Built-in Rule'''
 
*'''Parent Rule'''


*'''Notes:'''
'''Properties:'''
: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.
    '''[Check Box] Trigger only once'''


*'''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.
**'''[[#Safety System Engaged Check Rule|Safety System Engaged Check Rule]]''' - executes child rules if safety systems have been engaged


==='''ExTrainz Manager Rule - TANE SP2'''===
==='''Schedule 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.
Allows a schedule of timed events to be applied to a train


*'''<kuid:160293:10029>'''
*'''<kuid:-3:10185>'''


*'''DLS Rule''' by '''trev999'''
*'''Base 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.
     '''Insert track mark ''<select>''''' - select a track mark from the Session List
    '''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.
     '''Arrival and Departure Time ''<Select>''''' - set time
     '''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.
      '''''hh:mm:ss''''' - in hours/minutes/seconds
    '''Search only rolling stock already in session ''<Yes/No>''''' - click to select ''Yes'' or ''No''. When set to ''Yes'' only those rolling stock assets
     '''Current Train ''<select>''''' - select from session list
      installed in the session can be searched.
    '''Insert destination ''<select>''''' - select from session list
    '''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:'''
*'''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.
:Times are Trainz clock times, not real time
#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:'''
**'''[[#DisplayIndustryStatus Rule (color modified)|DisplayIndustryStatus Rule (color modified)]]''' - displays information on industry product levels.
**'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
**'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
**'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
**'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
**'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers


==='''Fade In/Out Rule'''===
==='''Session Complete Rule'''===


Fade in or out within seconds, using specified color and opacity values.
Set session to a percentage of completion.


*'''<kuid2:190611:200000:2>'''
*'''<kuid:447264:1011>'''


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


  '''Properties:'''
  '''Properties:'''
     '''Red percentage:            ''<value>''''' - enter the final % of red (0 = none, 100 = maximum)
     '''Set session to percent complete ''<value>''''' - enter number as a percentage
     '''Green percentage:          ''<value>''''' - enter the final % of green
     '''[Check Box] Separate achievements for completion''' - check to set
    '''Blue percentage:            ''<value>''''' - enter the final % of blue
 
    '''Alpha percentage (opacity): ''<value>''''' - enter the final % of opacity (0 = invisible, 100 = solid)
*'''Related Rules:'''
    '''Fading duration:            ''<value>''''' - enter the number of seconds required for the fade
**'''[[#End Session Rule|End Session Rule]]''' - end the Session with a fade out.
    '''''<help>''''' - click to bring up help instructions


*'''Notes:'''
==='''Session Debug Rule'''===
:Seconds are Trainz clock time, not real time.


==='''Hide Product Overlays Rule'''===
Executes the first child if ''Debug'' mode is selected. Otherwise executes the second child rule.


Hides the commodity or product bar graphs that appear on active industries
*'''<kuid:30501:100180>'''


*'''<kuid:400048:100970>'''
*'''Built-in Rule'''


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


  '''Properties:'''
  '''Properties:'''
  '''None'''
    '''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.


==='''InputTable Rule'''===
==='''Session Metadata Rule'''===


Creates a list of message names to be used for various purposes including passing data to '''Driver Commands'''
Sets session metadata in the config file. Info can be read by other systems and displayed to the player.


*'''<kuid2:131986:1012:1>'''
*'''<kuid:401543:2036>'''


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


  '''Properties:'''
  '''Properties:'''
     '''''<add>''''' - click to add a new entry to the table
     '''Type ''<Click>''''' - click to select one of:-
    Each new entry will require an input message
       '''Simulation'''
       '''''<short message>''''' - enter a message. The message must be in a format that is specific for each purpose
       '''Challenge'''
       For the '''MoveTurntable''' driver command the message must be formatted as:-
    '''Length ''<value>''''' - to enter number of minutes, default is 30 minutes
          '''turntable,name_of_turntable,number_of_connecting_roads''' - the first entry must be the word ''turntable'' in lower case.
    '''Difficulty ''<Click>''''' - click to select one of:-
            ''name_of_turntable'' is the name of the turntable,  
      '''Normal''' - default
            ''number_of_connecting_roads'' is the number of tracks connecting to the turntable
      '''Tutorial'''
      For the '''WaitUntilTime''' driver command the message must be formatted as:-
       '''Easy'''
          '''time,hour,minute''' - the first entry must be the word ''time'' in lower case,
       '''Hard'''
            ''hour'' must be from 0 to 23,
       '''Expert'''
            ''minute'' must be from 0 to 59.
 
      For the '''WaitUntilSVariable''' driver command the message must be formatted as:-
*'''Notes:'''  
          '''svar,svar_name,svar_condition,value''' - the first entry must be the word ''svar'' in lower case,
:Time is Trainz clock time, not real time
            ''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'''===
==='''Set Camera 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.
Sets the target object and properties of the camera.


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


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


  '''Properties:'''
  '''Properties:'''
     '''[Check Box] Pause game while message is displayed''' - stops the game until this message is closed
     '''[Check Box] Set the target object of the camera to:''' - if checked, select one of three option buttons:-
    '''[Check Box] Close previous popup windows''' - closes any Message Popups currently displayed before this message is shown
      '''( ) Vehicle ''<click to select>''''' - select a vehicle from the Session list
    '''Message location ''<Top Left/Top Right/Bottom Left/Bottom Right>''''' - select one to position the browser window on the screen
      '''( ) Junction ''<click to select>''''' - select a junction from the Session list
    '''Message Source:''' - select one of three option buttons:-
      '''( ) Map Object ''<click to select>''''' - select a named map object from the Session list
      '''( ) Custom text''' - the simplest and easiest option
    '''[Check Box] Change the camera view mode to ''<click to select>''''' - if checked, select one camera view mode from
          '''Icon ''<Click here to set>''''' - (optional) shows a list of message icons. Select one to be displayed with the message
      '''Cab View'''
          '''Icon ''<Clear icon>''''' - clears any currently displayed message icon
      '''External View'''
          '''Custom text box''' Enter text to be displayed. You will be limited to about 6 lines of text.
      '''Tracking View'''
              For longer messages or to include graphics, use the '''A predefined HTML page''' option.
      '''Free Roaming'''
          '''''<HTML Wave>''''' - (optional) select the name of the HTML asset from the list shown that contains the wave file to be played.
    '''[Check Box] Set the camera flags to enable/disable user access to''' - if checked, select as many of the following check boxes as needed
          '''''<Wave Name>''''' - (optional) enter the name of a wave (.wav) sound file to be played.
      '''[Check Box] Internal view mode''' - check to enable, uncheck to disable
              The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension ".wav" is optional
       '''[Check Box] External view mode''' - check to enable, uncheck to disable
          '''[Check Box] Autoplay Wave:''' - plays the .wav sound file as soon as message is displayed.
      '''[Check Box] Tracking view mode''' - check to enable, uncheck to disable
              If unchecked the sound will not be played.
      '''[Check Box] Roaming view mode''' - check to enable, uncheck to disable
       '''( ) A predefined HTML page''' - requires a working knowledge of HTML
      '''[Check Box] View switching''' - check to enable, uncheck to disable
          '''''<HTML Asset>''''' - select the name of the HTML asset that contains the required HTML page from the list shown.
      '''[Check Box] Vehicle view switching''' - check to enable, uncheck to disable
          '''''<HTML Page>''''' - enter the filename of the HTML page to be displayed. The page must be in the HTML asset identified above.
      '''[Check Box] Train view switching''' - check to enable, uncheck to disable
              Filename is not case sensitive. Extension ".html" is optional.
       '''[Check Box] Camera adjustments (pan, zoom, etc)''' - check to enable, uncheck to disable
          '''''<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.
*'''Related Rules:'''
          '''''<Wave Name>''''' - (optional) enter the name of a wave (.wav) sound file to be played.
**'''[[#Cinematic Camera Rule|Cinematic Camera Rule]]''' - provides several different cinematic style cameras with animations
              The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension ".wav" is optional
**'''[[#Focus Camera Rule|Focus Camera Rule]]''' - sets the initial camera view and starting vehicle for a session
          '''[Check Box] Autoplay Wave:''' - plays the .wav sound file as soon as message is displayed.
**'''[[#Wait for Camera View Mode Rule|Wait for Camera View Mode Rule]]''' - executes child rules when the camera view is changed
            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:'''
==='''Set Coupler Masks Rule'''===
: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:'''
Set the coupling/decoupling  masks on the selected vehicles
**'''[[#Close Message Popup Rule|Close Message Popup Rule]]''' - closes a displayed pop-up browser window.
**'''[[#Display HTML Pages Rule|Display HTML Pages Rule]]''' - display listed HTML files in order as a navigable sequence of pages.
**'''[[#Timed Limited Display HTML Rule (SP2 and later)|Timed Limited Display HTML Rule (SP2 and later)]]''' - displays a HTML page in a browser window for a set time.


*'''Trainz Wiki Links:'''
*'''<kuid:-25:980>'''
**'''[[How to Create a HTML Asset]]'''
**'''[[Message Popup Rule Applications|Message Popup Applications]]'''
**'''[[Message Popup Example|Message Popup Examples]]'''
 
==='''Minimap Options Rule'''===
 
Sets the display options for the minimap.
 
*'''<kuid:-25:636>'''


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


  '''Properties:''' ''Default values - all checked''
  '''Properties:'''
     '''[Check Box] Map Textures'''
    '''''<Add vehicle>''''' - click to select a vehicle from the session list
     '''[Check Box] Gradients'''
     '''''<Add All>''''' - click to add all vehicles in the session list
    '''[Check Box] Junctions'''
     '''''<Delete All>''''' - click to remove all added vehicles from this rule
    '''[Check Box] Signals'''
      For each selected vehicle:-
    '''[Check Box] Triggers'''
      '''Coupling Mask'''
    '''[Check Box] Markers'''
          '''Front''' and '''Back''' - choose for each
    '''[Check Box] Trackside Labels'''
            '''''Locked'''''
    '''[Check Box] Terrain Objects'''
            '''''Unlocked'''''
    '''[Check Box] Industrial Names'''
      '''Decoupling Mask'''
    '''[Check Box] Named Objects'''
          '''Front''' and '''Back''' - choose for each
    '''[Check Box] Consists'''
            '''''Locked'''''
            '''''Unlocked'''''
      '''''<Remove>''''' - click to remove this vehicle from the rule


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Show/Hide Minimap Rule|Show/Hide Minimap Rule]]''' - shows the minimap window in Driver.
**'''[[#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


==='''Play Sound Rule'''===
==='''Set Cleared Junctions Rule'''===


Plays a wav sound file.
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:-25:1045>'''
*'''<kuid2:131986:157661:1>'''


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


  '''Properties:'''
  '''Properties:'''
     '''Default HTML ''<Click>''''' - click to to enter Sound File Name
     '''''Add Junction''''' - click to select a junction from the session junction list
    '''HTML Assets ''<Click>''''' - click to select HTML asset
    '''''Add All''''' - click to add ALL junctions in the session junction list
    '''Rule Completes ''<Click>''''' - to select one of:-
    '''''Delete All''''' - click to remove ALL entered junctions from the rule
      '''sound has just started'''
      '''Junction Options:''' - for each selected junction:-
      '''sound has finished playing'''
          '''''<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:'''
*'''Related Rules:'''
**'''[[#Display Video Rule|Display Video Rule]]''' - displays a page containing a video clip from a HTML asset in a browser window
**'''[[#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:'''
**'''[[How to Control Junctions in Sessions]]'''


==='''Session Metadata Rule'''===
==='''Set Helper Icon Size Rule'''===


Sets session metadata in the config file. Info can be read by other systems and displayed to the player.
Sets the size of helper icons such as the junction lever arrows.


*'''<kuid:401543:2036>'''
*'''<kuid:-25:791>'''


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


  '''Properties:'''
  '''Properties:'''
    '''Type ''<Click>''''' - click to select one of:-
   '''Junction Arrows Size ''<Click>''''' - to set scale ratio smaller than default, default is 100%
      '''Simulation'''
 
      '''Challenge'''
==='''Set HTML Pages Rule'''===
    '''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'''
Instructs the Display HTML Pages rule to perform specific operations. This rule has been superseded by the '''Message Popup Rule'''


Line 2,273: Line 2,277:
**'''[[#Timed Limited Display HTML Rule (SP2 and later)|Timed Limited Display HTML Rule (SP2 and later)]]''' - displays a HTML page in a browser window for a set time.
**'''[[#Timed Limited Display HTML Rule (SP2 and later)|Timed Limited Display HTML Rule (SP2 and later)]]''' - displays a HTML page in a browser window for a set time.


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


Shows or hides a layer from Driver.
Sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control). '''''Warning:'' not compatible with Interlocking Tower Assets'''


*'''<kuid2:401543:1170:1>'''
*'''<kuid:-25:1065>'''


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


  '''Properties:'''
  '''Properties:'''
  '''''<visibility>''''' - select one of two options
    '''''Add Junction''''' - click to select a junction from the session junction list
      '''Show''' - select to make the layer visible
    '''''Add All''''' - click to add ALL junctions in the session junction list
      '''Hide''' - select to make the layer invisible
    '''''Delete All''''' - click to remove ALL entered junctions from the rule
  '''''<click here to set>''''' - enter name of layer. Name is case sensitive.
      '''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


*'''Known Bugs:'''
*'''Related Rules:'''
:Layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded
**'''[[#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
*'''Known Issues:'''
**'''[[#Multiple Junction Alignment Check Rule|Multiple Junction Alignment Check Rule]]''' - executes child rules when junctions are aligned
:Rule will NOT check to see if the named layer exists or not
**'''[[#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 Layers#Layers in Driver Mode|How to Use Layers: Layers in Driver Mode]]
**'''[[How to Control Junctions in Sessions]]'''


==='''Show/Hide Minimap Rule'''===
==='''Set Signal Extended Rule'''===


Shows the minimap window in Driver.
Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''


*'''<kuid:-25:794>'''
*'''<kuid2:47662:20002:4>'''


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


  '''Properties:'''
  '''Properties:'''
     '''''<Show/Hide>'' the driver Minimap Window''' - click to switch between '''Show''' and '''Hide'''.
     '''''<Select signal>'' to ''<signal state>''''' - click to select a signal from the session list and click to select a state from the list -
 
      '''Automatic'''
*'''Related Rules:'''
      '''Stop'''
**'''[[#Minimap Options Rule|Minimap Options Rule]]''' - sets the display options for the minimap.
      '''Stop then Continue'''
      '''Caution Left'''
      '''Caution Right'''
      '''Caution'''
      '''Advance Caution Left'''
      '''Advance Caution Right'''
      '''Advance Caution'''
      '''Proceed Left'''
      '''Proceed Right'''
      '''Proceed'''
      '''Slow'''
      '''Medium'''


==='''Show/Hide On-screen Help Rule'''===
*'''Notes:'''
:The signal must support the state selected otherwise there will be no change in the signal


Shows or hides On-screen help in Driver.
*'''Related Rules:'''
**'''[[#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]]'''


*'''<kuid:401543:2020>'''
=='''Sh-Sz'''==


*'''Built-in Rule'''
==='''Show/Hide HUD Panel Rule'''===


'''Properties:'''
Shows or hides a HUD panel.
    '''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)'''===
*'''<kuid:-25:1047>'''


Displays an HTML browser window for a limited time.
*'''Built-in Rule'''


*'''<kuid2:61392:2005:32>'''
'''Properties:'''
    '''''<Show/Hide>'' the ''<click to select>'' HUD panel''' - select '''''Show''''' or '''''Hide''''' and then select the HUD panel


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


'''Properties:'''
==='''Show/Hide Layer Rule'''===
  '''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:'''
Shows or hides a layer from Driver.
:Seconds are Trainz clock time, not real time.


*'''Related Rules:'''
*'''<kuid2:401543:1170:1>'''
**'''[[#Close Message Popup Rule|Close Message Popup Rule]]''' - closes open message popups
**'''[[#Display HTML Pages Rule|Display HTML Pages Rule]]''' - displays HTML pages in a browser window.
**'''[[#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|Display HTML Pages Rule]]'''
==='''Wait on Waybill Screen/Main Screen Rule'''===
 
Executes child rules when the Waybill window is opened or closed
 
*'''<kuid:-25:957>'''


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


  '''Properties:'''
  '''Properties:'''
    '''[Check Box] Trigger rule once''' - check to trigger the rule once only
  '''''<visibility>''''' - select one of two options
    '''Wait for the Waybill window to be ''<opened/closed>''''' - select either '''opened''' or '''closed'''.
      '''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.


'''[[#top|Back to Top]]'''
*'''Known Bugs:'''
----
:Layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded
=='''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.
*'''Known Issues:'''
:Rule will NOT check to see if the named layer exists or not


==='''ConsistDataHandler Rule'''===
*'''Trainz Wiki Links:'''
**'''[[How to Use Layers#Layers in Driver Mode|How to Use Layers: Layers in Driver Mode]]


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


*'''<kuid:401543:1180>'''
Shows the minimap window in Driver.


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


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


  '''Properties:'''
  '''Properties:'''
     '''None'''
     '''''<Show/Hide>'' the driver Minimap Window''' - click to switch between '''Show''' and '''Hide'''.
 
*'''Related Rules:'''
**'''[[#Minimap Options Rule|Minimap Options Rule]]''' - sets the display options for the minimap.


==='''Custom Script Rule'''===
==='''Show/Hide On-screen Help Rule'''===


No description
Shows or hides On-screen help in Driver.


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


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


  '''Properties:'''
  '''Properties:'''
  '''None'''
    '''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


==='''Generic TreeNode Debug Window Rule'''===
==='''Signal Passed At Danger Check Rule'''===
 
Executes child rules if a signal or stop mark is ''Passed at Danger (STOP)''.


No description.
*'''<kuid2:60850:89007:2>'''


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


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


  '''Properties:'''
  '''Properties:'''
     '''None'''
     '''[Check Box] Trigger only once'''
 
*'''Trainz Wiki Links:'''
**'''[[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]]


==='''Session Debug Rule'''===
==='''Simultaneous List Rule'''===


Executes the first child if ''Debug'' mode is selected. Otherwise executes the second child rule.
Executes child rules simultaneously once this rule starts


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


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


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


  '''Properties:'''
  '''Properties:'''
     '''None'''
     '''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'''''


*'''Notes:'''  
*'''Related Rules:'''
: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.
**'''[[#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
'''[[#top|Back to Top]]'''
**'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule
----
**'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously
=='''Navigation Rules'''==


==='''Directional Trigger Check Rule'''===
*'''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 when a set train enters a set trigger in a set direction. Adds direction to the '''Trigger 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>'''


*'''<kuid2:532391:100003:1>'''
*'''Built-in Rule'''


*'''DLS Rule''' by '''bobhahn'''
*'''Parent Rule'''


  '''Properties:'''
  '''Properties:'''
     '''[Check Box] Trigger only once '''
     Select one of two options to set a speed limit to be observed
    '''[Check Box] Wait for child rules to complete even if no trains are present in rule trigger'''
       '''( ) Watch for trains travelling above the posted speed limit'''
    '''[Check Box] Only activate when the entering vehicle of the train is heading ''<select direction>'' into the trigger''' - select one of two directions:-
          '''''<speed value>''''' - click to enter a new overspeed tolerance value
       '''''forward'''''
          '''''<speed units>''''' - click to select one from the list:-
      '''''backward'''''
            '''''Km/h''''' - Kilometres per hour
    '''Triggers List'''
             '''''MPH''''' - Miles per hour
      '''''<add trigger>''''' - select a trigger from the session list
             '''''mps''''' - metres per second
      '''''<delete trigger>''''' - delete a selected trigger from the rule
      '''( ) Watch for trains travelling above a custom speed'''
    Select one of two option buttons:-
          '''''<speed value>''''' - click to enter a new custom speed value
      '''( ) click to accept all trains'''
          '''''<speed units>''''' - click to select one from the list:-
      '''( ) click to accept trains matching specific criteria'''
            '''''Km/h''''' - Kilometres per hour
          Selecting the second option will produce the following selection controls:-
             '''''MPH''''' - Miles per hour
          '''Specific vehicle''' - identify the specific vehicle(s) that will trigger the rule
             '''''mps''''' - metres per second
             '''''+''''' - click to add a ''specific'' vehicle from the session list
            '''Warning: This option is very performance intensive and should only be used in sessions with few trains'''
             '''''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:'''
==='''Startup Options Rule'''===
#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.


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


*'''Trainz Wiki Links:'''
*'''<kuid:-16:10212>'''
**'''[[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)]]'''
 
==='''Navigation Display 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.
 
*'''<kuid2:401543:1161:1>'''


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


  '''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.
     '''Current control method is ''<select>''''' - select one from:-
    '''Train (optional): ''<click here to set>''''' - select a rolling stock asset from the session list shown.
      '''''Easy Mode''''' - DCC (standard keyboard and mouse) control
    Select one of three option buttons:-
      '''''Ask User''''' - let the user decide
    '''( ) All points must be completed in sequence:'''
      '''''Realistic Mode''''' - Cab controls (on screen levers, throttles, buttons, etc)
      - the first uncompleted navigation point will be shown and must be completed next.
    '''Set weather to ''<select mode>'' with ''<select frequency>'' changeability''' - select
      - the next point (if any) will also be shown partly transparent.
      '''Weather mode:''' - select one of:-
    '''( ) Points will be completed in sequence, but can be skipped:'''
          '''''Clear'''''
      - navigation points can be skipped but must be completed in order.
          '''''Cloudy'''''
      - you cannot go back to complete a missed point.
          '''''Drizzle'''''
    '''( ) All points must be completed, but in any order:'''
          '''''Rain'''''
      - all uncompleted navigation points will be shown.
          '''''Stormy'''''
       - you may complete them in any order.
          '''''Light Snow'''''
  For each navigation point:
          '''''Medium Snow'''''
      '''''<Click here to set>''''' - select an item (trigger, trackmark, track object, rolling stock) from the session list to become the navigation point.
          '''''Heavy Snow'''''
      '''''<Display text>''''' - enter a text message to display with the navigation point. You are limited to 25 characters.
       '''Changeability:''' - select one of:-
      '''Icon ''<icon list>''''' - select an icon for the navigation point.
          '''''Off''''' - the weather will not change from the mode selected above
      '''''<Style>''''' - click to select one from three choices
          '''''Periodic''''' - slow gradual changes to the weather
        '''''Automatic''''' - the navigation point will be completed as soon as the consist reaches the point.
          '''''Extreme''''' - rapid and extreme changes to the weather
        '''''Manual''''' - the navigation point must be set as complete by using the '''Navigation point complete rule''' or the '''Navigation set clear rule'''.
    '''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
            The '''Manual''' style option allows you to execute other rules (e.g. consist check, wait, etc) before completing the navigation point.
    '''Set derailment realism to ''<select reality level>''''' - select one of:-
        '''''Require Stop''''' - the navigation point will be completed when the consist comes to a complete stop on the point.
      '''''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:'''
*'''Related Rules:'''
**'''[[#Navigation Set Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.
**'''[[#Time and Rate Rule|Time and Rate Rule]]''' - sets the session start time and the rate at which time passes.
**'''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set has completed or is incomplete.
**'''[[#Weather Rule|Weather Rule]]''' - changes weather conditions during Session play
**'''[[#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:'''
==='''Station Visited Check Rule'''===
**'''[[How to Use Navigation Point Rules (Applications)]]'''
**'''[[How to Use Navigation Point Rules]]'''


==='''Navigation Point Complete Rule'''===
Executes child rules if specific trains call at set stations or industries


Manually completes a navigation point in a set
*'''<kuid2:60850:89005:3>'''


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


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


  '''Properties:'''
  '''Properties:'''
     '''Mark navigation point ''<click here to set>''''' - enter the navigation point number to be completed
     '''Trigger: ''<select>''''' - click to select one of the following
     '''complete in set ''<click here to set>''''' - 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
 
      '''''Once per industry''''' - the rule is triggered on the first visit to each industry with each individual product
*'''Known Issues:'''
      '''''Once per visit''''' - the rule is triggered on the first visit to each industry regardless of the product
:The rule will '''NOT''' check to see if the named navigation set and point exists or not.
      '''''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
----
'''[[#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]]'''


*'''Related Rules:'''
=='''T'''==
**'''[[#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.
==='''Time and Rate Rule'''===
**'''[[#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:'''
Sets the session start time and the rate at which time passes.
**'''[[How to Use Navigation Point Rules (Applications)]]'''
**'''[[How to Use Navigation Point Rules]]'''


==='''Navigation Set Check Rule'''===
*'''<kuid:-25:889>'''


Executes child rules if a navigation set created with the '''Navigation Display Rule''' is complete (or incomplete).
*'''Built-in Rule'''


*'''<kuid:401543:1165>'''
'''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)


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


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


*'''Known Issues:'''
*'''Known Issues:'''
:The rule will '''NOT''' check to see if the named navigation set exists or not.
: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:'''
*'''Related Rules:'''
**'''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
**'''[[#Time and Rate Rule|Time and Rate Rule]]''' - sets the session start time and the rate at which time passes.
**'''[[#Navigation Set Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.
**'''[[#Wait Rule|Wait Rule]]''' - executes child rules after waiting for a set number of seconds.
**'''[[#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:'''
==='''Timed Limited Display HTML Rule (SP2 and later)'''===
**'''[[How to Use Navigation Point Rules (Applications)]]'''
**'''[[How to Use Navigation Point Rules]]'''


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


Clears a navigation set removing any uncompleted navigation points
*'''<kuid2:61392:2005:32>'''


*'''<kuid:401543:1164>'''
*'''DLS Rule''' by '''pguy'''


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


'''Properties:'''
*'''Notes:'''
    '''''<Click here to set>''''' - enter the unique name for the navigation set created using the '''Navigation Display Rule'''.
:Seconds are Trainz clock time, not real time.
        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:'''
**'''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
**'''[[#Close Message Popup Rule|Close Message Popup Rule]]''' - closes open message popups
**'''[[#Navigation Set Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.
**'''[[#Display HTML Pages Rule|Display HTML Pages Rule]]''' - displays HTML pages in a browser window.
**'''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set has completed or is incomplete.
**'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
**'''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.
**'''[[#Set HTML Page Rule|Set HTML Page Rule]]''' - sets parameters for the '''[[#Display HTML Pages Rule|Display HTML Pages Rule]]'''
**'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed


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


==='''Navigation Set Hide/Show Rule'''===
Executes child rules when a set train enters a set trigger. Similar to the '''Trigger Check Rule''' but provides different options.


Shows and hides navigation sets. You can have multiple sets visible and hidden at the same time.
*'''<kuid2:46162:100207:1>'''


*'''<kuid:401543:1163>'''
*'''DLS Rule''' by '''Josefpav'''


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


  '''Properties:'''
  '''Properties:'''
     '''''<visibility>''''' - click to select one
     '''Applies to:''' - select one of three option buttons:-
       '''Hide''' - select to make the navigation set invisible
      '''( ) Junction'''
       '''Show''' - select to make the navigation set visible
       '''( ) Trigger'''
     '''''<click here to set>''''' - enter the unique name for the navigation set created using the '''Navigation Display Rule'''.
       '''( ) Trackmark'''
        Name must be in lowercase and have no spaces.
     '''Trackside object name: ''<specify>''''' - select object name from session list
 
    '''Wait for train to:''' - select one of three option buttons:-
*'''Known Issues:'''
      '''( ) Enter'''
:The rule will '''NOT''' check to see if the named navigation set exists or not.
      '''( ) 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


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
**'''[[#Directional Trigger Check Rule|Directional Trigger Check Rule]]''' - executes child rules when activated by a train moving in a set direction.
**'''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set has completed or is incomplete.
**'''[[#Trigger Check Rule|Trigger Check Rule]]''' - executes child rules when activated by a train
**'''[[#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:'''
==='''Trigger Check Rule'''===
**'''[[How to Use Navigation Point Rules (Applications)]]'''
**'''[[How to Use Navigation Point Rules]]'''


==='''Schedule Rule'''===
Executes child rules when a set train enters a set trigger. This rule replaces the older and less versatile '''Trigger Rule'''.


Allows a schedule of timed events to be applied to a train
*'''<kuid:-25:1071>'''


*'''<kuid:-3:10185>'''
*'''Built-in Rule'''


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


  '''Properties:'''
  '''Properties:'''
     '''Insert track mark ''<select>''''' - select a track mark from the Session List
     '''[Check Box] Trigger only once '''
    '''Arrival and Departure Time ''<Select>''''' - set time
    '''[Check Box] Wait for child rules to complete even if no trains are present in rule trigger'''
       '''''hh:mm:ss''''' - in hours/minutes/seconds
    '''[Check Box] Only activate when the entering vehicle of the train is heading ''<select direction>'' into the trigger''' - select one of two directions:-
    '''Current Train ''<select>''''' - select from session list
      '''''forward'''''
    '''Insert destination ''<select>''''' - select from session list
      '''''backward'''''
 
    '''Triggers List'''
*'''Notes:'''
      '''''<add trigger>''''' - select a trigger from the session list
:Times are Trainz clock times, not real time
      '''''<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


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
**'''[[#Directional Trigger Check Rule|Directional Trigger Check Rule]]''' - executes child rules when activated by a train moving in a set direction.
**'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
**'''[[#Trackside Check Rule|Trackside Check Rule]]''' - executes child rules when activated by a train. Provides different options to the '''Trigger Check Rule'''
**'''[[#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


==='''Trackside Check Rule'''===
*'''Trainz Wiki Links:'''
**'''[[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)]]


Executes child rules when a set train enters a set trigger. Similar to the '''Trigger Check Rule''' but provides different options.
==='''Trigger Multiple Signals Rule'''===


*'''<kuid2:46162:100207:1>'''
Sets selected signals to DANGER (STOP) when selected triggers are activated. Signals will be at AUTOMATIC when the triggers are not activated.


*'''DLS Rule''' by '''Josefpav'''
*'''<kuid2:116387:26:1>'''


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


  '''Properties:'''
  '''Properties:'''
     '''Applies to:''' - select one of three option buttons:-
     '''<add signal>''' - select a signal from the Session List. More than one signal can be added.
      '''( ) Junction'''
       '''<delete>''' - remove a signal from the rule.
       '''( ) Trigger'''
     '''<add trigger>''' - select a trigger from the Session List. More than one trigger can be added.
      '''( ) Trackmark'''
      '''<delete>''' - remove a trigger from the rule.
    '''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


*'''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.
**'''[[#Set Signal Extended Rule|Set Signal Extended Rule]]''' - sets a selected signal to a specific signal state
**'''[[#Trigger Check Rule|Trigger Check Rule]]''' - executes child rules when activated by a train
----
'''[[#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]]'''


==='''Trigger Check Rule'''===
=='''U, V'''==
==='''Variable Check Rule'''===


Executes child rules when a set train enters a set trigger. This rule replaces the older and less versatile '''Trigger Rule'''.
Executes child rules when a specific variable matches set conditions


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


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


  '''Properties:'''
  '''Properties:'''
     '''[Check Box] Trigger only once '''
     '''''<variable-name>''''' - enter a variable-name. Variable name is case sensitive.
    '''[Check Box] Wait for child rules to complete even if no trains are present in rule trigger'''
    Mathematical relationship, select one of:-
    '''[Check Box] Only activate when the entering vehicle of the train is heading ''<select direction>'' into the trigger''' - select one of two directions:-
       '''''is less than''''' - enter a '''''<value>''''' to test against
       '''''forward'''''
       '''''is less than or equal to''''' - enter a '''''<value>''''' to test against
      '''''backward'''''
       '''''is equal to''''' - enter a '''''<value>''''' to test against
    '''Triggers List'''
      '''''is greater than or equal to''''' - enter a '''''<value>''''' to test against
       '''''<add trigger>''''' - select a trigger from the session list
      '''''is greater than''''' - enter a '''''<value>''''' to test against
      '''''<delete trigger>''''' - delete a selected trigger from the rule
      '''''is not equal to''''' - enter a '''''<value>''''' to test against
    Select one of two option buttons:-
      '''''is between x and y''''' - enter a minimum '''''<x-value>''''' and a maximum '''''<y-value>'''''
       '''( ) click to accept all trains'''
    Evaluation type. Select one from:-
      '''( ) click to accept trains matching specific criteria'''
      '''''<This condition will be evaluated only once ...>''''' - any changes to the variable that occur after
          Selecting the second option will produce the following selection controls:-
              it has been checked will not change the result of this rule
          '''Specific vehicle''' - identify the specific vehicle(s) 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 ''specific'' vehicle from the session list
              rechecked every second
            '''''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


*'''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.
**'''[[#Quick Session Variables Rule|Quick Session Variables Rule]]''' - allows the editing of session variables.
**'''[[#Trackside Check Rule|Trackside Check Rule]]''' - executes child rules when activated by a train. Provides different options to the '''Trigger Check 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:'''
**'''[[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)]]
**'''[[How to Use Variables in Sessions (Examples)]]


==='''Wait on Navigation Point Rule'''===
==='''Variable Modify Continuous Rule'''===


Executes child rules when a specific navigation point is completed
Adds, subtracts or sets a value to a specified variable every second.


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


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


  '''Properties:'''
  '''Properties:'''
    '''navigation point ''<click here to set>''''' - enter the number of the navigation point to be completed
  '''''<Add/Subtract/Change variable to>''''' - select one.
    '''in set ''<click here to set>''''' - enter the unique name for the navigation set created using the '''Navigation Display Rule'''.
      '''''<value>''''' - enter value to add, subtract or apply to ''<variable-name>''
      Name must be in lowercase and have no spaces.
      '''''<variable-name>''''' - enter variable-name. Variable-name is case sensitive.
 
*'''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.
**'''[[#Quick Session Variables Rule|Quick Session Variables Rule]]''' - allows the editing of session variables.
**'''[[#Navigation Set Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.
**'''[[#Variable Check Rule|Variable Check Rule]]''' - executes child rules according to the value of a specified variable.
**'''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set is complete or incomplete.
**'''[[#Variable Modify Rule|Variable Modify Rule]]''' - changes the value of a specified variable.
**'''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
**'''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.
**'''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.
**'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.


*'''Trainz Wiki Links:'''
==='''Variable Modify Rule'''===
**'''[[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]]'''


==='''Wait on Train Stop/Start 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.


Executes child rules when a train stops or starts moving
*'''<kuid:-25:1050>'''
 
*'''<kuid:-25:1069>'''


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


  '''Properties:'''
  '''Properties:'''
     '''[Check Box] Trigger rule once'''
     '''Change ''<Add to variable/Subtract from variable/Change variable>''''' - click to select one from:-
    '''Wait for a train that matches the following criteria to ''<select>''''' - select one of:-
       '''Add to variable'''
       '''''start moving'''''
          '''Add ''<value>''''' to '''variable ''<variable-name>''''' - enter value to add to variable, enter variable-name. Variable-name is case sensitive.
      '''''stop moving'''''
          '''''<Do not undo the alteration if the rule is stopped/Undo the alteration if the rule is stopped>''''' - click to select one.
    Select one of two option buttons:-
       '''Subtract from variable'''
      '''( ) click to accept all trains'''
           '''Subtract ''<value>''''' from '''variable ''<variable-name>''''' - enter value to subtract from variable, enter variable-name.
       '''( ) click to accept trains matching specific criteria'''
             Variable-name is case sensitive.
          Selecting the second option will produce the following selection controls:-
          '''''<Do not undo the alteration if the rule is stopped/Undo the alteration if the rule is stopped>''''' - click to select one.
           '''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
      '''Change variable'''
            '''''+''''' - click to add a ''specific'' vehicle from the session list
           '''Change variable ''<variable-name>'' to ''<value>''''' - enter variable-name, enter new value.
             '''''x''''' - click to remove the ''specific'' vehicle from the rule
            Variable-name is case sensitive. This change cannot be undone if the rule is stopped.
           '''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule
    '''[Check Box] (optional) Set the minimum value''' of '''''<variable-name>''''' to '''''<value>''''' - enter variable-name
            '''''+''''' - click to add a ''type'' of vehicle from the session list
      (this will already be set by the change option) and a value. Variable-name is case sensitive.
            '''''x''''' - click to remove the ''type'' of vehicle from the rule
    '''[Check Box] (optional) Set the maximum value''' of '''''<variable-name>''''' to '''''<value>''''' - enter variable-name
          '''Drivers''''' - identify the ''drivers'' that will trigger the rule
      (this will already be set by the change option) and a value. Variable-name is case sensitive.
            '''''+''''' - click to add a ''driver'' from the session list
 
            '''''x''''' - click to remove a ''driver'' from the rule
*'''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:'''
*'''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 Variables in Sessions (Examples)]]
**'''http://online.ts2009.com/mediaWiki/index.php/Variable_Modify_Rule'''


'''[[#top|Back to Top]]'''
==='''Variable Random Rule'''===
----
=='''Resources Rules'''==


==='''DisplayIndustryStatus Rule (color modified)'''===
Assigns a random integer value to a variable.


Displays a summary of industry product levels when the "k" key is pressed.
*'''<kuid:400260:100606>'''


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


  '''Properties:'''
  '''Properties:'''
     '''None'''
     '''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
*'''Notes:'''
    '''The maximum possible value of ''variable_name'' is ''<value>''''' - enter the maximum value
: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:'''
**'''[[#ExTrainz Manager Rule - TANE SP2|ExTrainz Manager Rule - TANE SP2]]''' - displays information on consists, industries and products in Driver and Surveyor.
**'''[[#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.
==='''ExTrainz Manager Rule - TANE SP2'''===
**'''[[#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.


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


*'''<kuid:160293:10029>'''
==='''Variable Show Rule'''===


*'''DLS Rule''' by '''trev999'''
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.


'''Properties:'''
*'''<kuid:-25:971>'''
    '''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:'''
*'''Built-in Rule'''
#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:'''
'''Properties:'''
:This rule is NOT compatible with all industries.
  '''[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:'''
*'''Related Rules:'''
**'''[[#DisplayIndustryStatus Rule (color modified)|DisplayIndustryStatus Rule (color modified)]]''' - displays information on industry product levels.
**'''[[#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.


==='''Hide Product Overlays Rule'''===
*'''Trainz Wiki Links:'''
**'''[[How to Use Variables in Sessions (Examples)]]


Hides the commodity or product bar graphs that appear on active industries
==='''Vehicle Physics Rule'''===


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


*'''DLS Rule''' by '''callavsg'''
*'''<kuid:-25:1052>'''
 
'''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'''
*'''Built-in Rule'''


*'''Parent Rule'''
'''Properties:'''
 
    Select one of two option buttons:-
'''Properties:'''
      '''( ) click to accept all trains'''
    '''<Product Level>''' - click to select a product test from two choices:-
      '''( ) click to accept trains matching specific criteria'''
      '''''Reach/Exceed''''' - sets an upper limit for the resources being monitored.
          Selecting the second option will produce the following selection controls:-
           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.
          '''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
          The initial level in the object must be below the set upper limit.
            '''''+''''' - click to add a ''specific'' vehicle from the session list
      '''''Fall below''''' - sets a lower limit for the resources being monitored.
            '''''x''''' - click to remove the ''specific'' vehicle from the rule
          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.
           '''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule
           The initial level in the object must be above the set lower limit.
            '''''+''''' - click to add a ''type'' of vehicle from the session list
          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.
            '''''x''''' - click to remove the ''type'' of vehicle from the rule
     '''''<value>''''' - enter required quantity value
           '''Drivers''''' - identify the ''drivers'' that will trigger the rule
    '''''<select>''''' - select a product from session list of products
            '''''+''''' - click to add a ''driver'' from the session list
     '''''<Add object>''''' - click to select a source or target object. Multiple objects and their queues can be added to the rule.
            '''''x''''' - click to remove a ''driver'' from the rule
       ALL the entered products must reach/exceed or fall below the specified value for the rule to be triggered.
     '''Coupler Parameters:'''
       For each object:-
      '''Couplers break at ''<value>'' kN expansion force''' - enter force value
          '''''<Object>''''' - click to select session active industry or product enabled rail vehicle
      '''Couplers break at when coupling above ''<value>'' kph''' - enter speed value
          '''''<Queue>''''' - select product queue (there may be only one available)
      '''[Check Box] Show coupler breakage in HUD''' - check to display breakage in on-screen HUD
          '''''<Remove>''''' - removes the object and its product queue from the rule
     '''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'''==


*'''Notes:'''
==='''Wait for Camera View Mode 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:'''
Executes child rules when the camera view is changed to a selected view
**'''[[#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
*'''<kuid:-25:192>'''
 
*'''Built-in Rule'''
 
*'''Parent Rule'''


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


==='''Resource Check Rule'''===
*'''Related Rules:'''
**'''[[#Cinematic Camera Rule|Cinematic Camera Rule]]''' - provides several different cinematic style cameras with animations
**'''[[#Focus Camera Rule|Focus Camera Rule]]''' - sets the initial camera view and starting vehicle for a session
**'''[[#Set Camera Rule|Set Camera Rule]]''' - sets the target object and properties of the camera


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'''
==='''Wait for Click on HUD Icon Rule'''===


*'''<kuid:-25:1067>'''
Executes child rules when the user clicks on a selected HUD icon


*'''Legacy Rule''' (replaced by '''Multiple Resource Check Rule''')
*'''<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 2,907: Line 2,946:


  '''Properties:'''
  '''Properties:'''
     Select one of two option buttons:-
     '''[Check Box] Trigger Once'''
      '''( ) Watch industry queue'''
    '''HUD Panel ''<Click>''''' - click choose from list:-
          '''Target Object ''<select>''''' - select an industry from the session list
      '''Bottom Right Menu'''
          '''Queue ''<select>''''' - select a product queue from the selected industry
      '''Camera Controls'''
          '''Product ''<select>''''' - select a product from the selected queue
       '''DCC Controls'''
          '''Amount ''<value>''''' - enter a quantity
    '''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 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:'''
**'''[[#Multiple Resource Check Rule|Multiple Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
**'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
**'''[[#Resource Verify Rule (fixed)|Resource Verify Rule (fixed)]]''' - executes child rules when a set resource (commodity) level is reached
**'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
**'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
**'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers
**'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
**'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.


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


==='''Resource Verify Rule (fixed)'''===
Executes child rules when a derailment occurs


Executes child rules if a selected industry or vehicle reaches a set commodity level. The rule resets when all child rules have completed.
*'''<kuid:-25:1053>'''


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


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


  '''Properties:'''
  '''Properties:'''
    Select one of two option buttons:-
     '''[Check Box] Trigger derailment watch once''' - check to execute the rule once only
     '''( ) 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:'''
*'''Related Rules:'''
**'''[[#Multiple Resource Check Rule|Multiple Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
**'''[[#Clean Up Derailed Trains Rule|Clean Up Derailed Trains Rule]]''' - cleans up derailed train cars after a set time delay
**'''[[#Resource Check Rule|Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
**'''[[#Replace Missing Vehicles Rule|Replace Missing Vehicles Rule]]''' - creates a replacement train after a derailment


'''[[#top|Back to Top]]'''
==='''Wait for Driver On/Off Train Rule'''===
----
=='''Session Sequence Rules'''==


==='''Ordered List Rule'''===
Executes child rules when a driver gets on or off a train


Executes child rules in order once this rule starts
*'''<kuid:-25:953>'''
 
*'''<kuid:-25:171>'''


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


  '''Properties:'''
  '''Properties:'''
    Select one of two option buttons:-
  '''[Check Box] Trigger Rule Once''' - click to set''
      '''( ) This process will repeat ''<value>'' time(s)''' - enter the number of times this rule is to be repeated
  '''Wait for a driver character to get ''<On/Off>''''' a train that matches the following criteria''' - select '''On''' or '''Off'''
      '''( ) This process will repeat forever'''
  Select one of two option buttons:-
 
    '''( ) click to accept all trains'''
*'''Known Issues:'''
    '''( ) click to accept trains matching specific criteria'''
: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.
        Selecting the second option will produce the following selection controls:-
::For example: The '''Message Popup Rule''' will wait until it is closed before allowing the next child rule to be executed.
        '''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:'''
**'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child on the second run, etc
**'''[[#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
**'''[[#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:'''
==='''Wait for Driver/Train to be Locally Owned Rule'''===
**'''http://online.ts2009.com/mediaWiki/index.php/Ordered_List'''
**'''[[How to Use Parent and Child Rules]]'''


==='''Progressive 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 the first child rule on the first run, the second child on the second run, the third child on the third run, etc.
*'''<kuid2:401543:1173:1>'''
 
*'''<kuid:-25:754>'''


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


  '''Properties:'''
  '''Properties:'''
  '''After last child has been executed ...'''
  '''Assets Ownership:''' - select one of two option buttons:-
  '''''<successive runs will do nothing/the first child is chosen again>''''' - click to select one
    '''( ) Wait for ownership of a specific Driver'''
    '''( ) Wait for ownership of Driver'''
  '''Driver or Vehicle ''<select>''''' - choose from session list


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order
**'''[[#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
**'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule
 
**'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously
==='''Wait on Navigation Point Rule'''===
**'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously


*'''Trainz Wiki Links:'''
Executes child rules when a specific navigation point is completed
**'''http://online.ts2009.com/mediaWiki/index.php/Progressive_List'''
**'''[[How to Use Parent and Child Rules]]'''


==='''Random List Rule'''===
*'''<kuid:401543:1168>'''


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


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


  '''Properties:'''
  '''Properties:'''
     '''None'''
     '''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.


*'''Related Rules:'''
*'''Related Rules:'''
**'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order
**'''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
**'''[[#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 Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.
**'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously
**'''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set is complete or incomplete.
**'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously
**'''[[#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:'''
*'''Trainz Wiki Links:'''
**'''[[How to Use Parent and Child Rules]]'''
**'''[[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/Random_List'''
**'''[[How to Use Navigation Point Rules (Applications)]]'''
**'''[[How to Use Navigation Point Rules]]'''


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


Executes ALL child rules continuously in an ongoing infinite cycle
Executes child rules when a train stops or starts moving


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


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


  '''Properties:'''
  '''Properties:'''
     '''None'''
     '''[Check Box] Trigger rule once'''
 
    '''Wait for a train that matches the following criteria to ''<select>''''' - select one of:-
*'''Related Rules:'''
      '''''start moving'''''
**'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order
      '''''stop moving'''''
**'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child rule on the second run, etc
    Select one of two option buttons:-
**'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule
      '''( ) click to accept all trains'''
**'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously
      '''( ) 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


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


==='''Simultaneous List Rule'''===
==='''Wait on Waybill Screen/Main Screen Rule'''===


Executes child rules simultaneously once this rule starts
Executes child rules when the Waybill window is opened or closed


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


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


  '''Properties:'''
  '''Properties:'''
     '''Rule completes when ...''' - click to chose one of the following:-
     '''[Check Box] Trigger rule once''' - check to trigger the rule once only
      '''''one of the child rules has completed'''''
    '''Wait for the Waybill window to be ''<opened/closed>''''' - select either '''opened''' or '''closed'''.
      '''''all child rules have reached a completed state'''''
      '''''all child rules have reached a "was completed" state'''''


*'''Related Rules:'''
==='''Wait 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:'''
Executes child rules after waiting for set number of seconds
**'''[[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]]'''
*'''<kuid2:122381:10016:2>'''
----
=='''Speed Rules'''==


==='''ATP Speed Limiter Rule'''===
*'''Built-in Rule'''


Limits allowable speed over set limit
*'''Parent Rule'''
 
*'''<kuid2:321959:1000:1>'''
 
*'''Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''Limits the speed to ''<value>'' mph over the set limit''' - enter speed value in mph
     '''''<click to set>''''' - enter the number of seconds for the wait delay


==='''Speeding Check Rule'''===
*'''Notes:'''  
:Seconds is in Trainz clock time, not real time


Executes child rules if player controlled trains are over the local speed limit or over a set (custom) speed
*'''Related Rules:'''
**'''[[#Timecheck Rule|Timecheck Rule]]''' - executes child rules at a set time.


*'''<kuid2:60850:89004:3>'''
*'''Trainz Wiki Links:'''
 
**'''[[Message Popup Rule Applications#Application 1: Timed Message|Message Popup Rule Applications: Timed Message]]'''
*'''Built-in Rule'''
**'''[[How to Use Navigation Point Rules (Applications)#Application 4: User Path Selection|How to Use Navigation Point Rules (Applications): User Path Selection]]
 
*'''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
 
'''[[#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'''===
==='''Weather Rule'''===
Line 3,646: Line 3,154:
**'''[[#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 02:05, 16 June 2018

TRAINZ A New Era (TANE) SP2. List of Trainz Session Rules in Alphabetical Order 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 Rules By Categories With Properties

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).

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

A, B

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

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

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

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

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?

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

C

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

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

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.

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.

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:

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.

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

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:

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

Custom Script Rule

No description

  • <kuid:447264:1526>
  • Built-in Rule
Properties:
  None

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

D

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

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)

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

Disallow AI Rule

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

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

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

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.

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

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

E, F, G

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

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

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.

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.

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.

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

Generic TreeNode Debug Window Rule

No description.

  • <kuid:30501:1042>
  • Base Rule
Properties:
   None

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

H, I, J

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

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

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

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).

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

K, L, M

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).

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

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

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

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

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

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).

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.

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

N, O

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.

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

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.

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

P, Q

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

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

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

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.

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.

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.

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

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

R

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

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.

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:

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

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

Reset List Rule

Executes ALL child rules continuously in an ongoing infinite cycle

  • <kuid:-25:762>
  • Built-in Rule
  • Parent Rule
Properties:
   None

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 | A, B | C | D | E, F, G | H, I, J | K, L, M | N, O | P, Q | R | S-Se | Sh-Sz | T | U, V | W, X, Y, Z

S-Se

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

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

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

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.

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 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

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

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 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)

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

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

Sh-Sz

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

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

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

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

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

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:

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 | A, B | C | D | E, F, G | H, I, J | K, L, M | N, O | P, Q | R | S-Se | Sh-Sz | T | U, V | W, X, Y, Z

T

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.

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.

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

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 | A, B | C | D | E, F, G | H, I, J | K, L, M | N, O | P, Q | R | S-Se | Sh-Sz | T | U, V | W, X, Y, Z

U, V

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.

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 %

Back to Top | A, B | C | D | E, F, G | H, I, J | K, L, M | N, O | P, Q | R | S-Se | Sh-Sz | T | U, V | 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:
   [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

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

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

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

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

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.

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

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 | A, B | C | D | E, F, G | H, I, J | K, L, M | N, O | P, Q | R | S-Se | Sh-Sz | T | U, V | W, X, Y, Z

Retrieved from "https://wiki.trainzsimulator.com/index.php?title=Session_Rule_List_with_Parameters&oldid=13540"