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
Correction
Line 1: Line 1:
'''This page is under construction'''
'''This page is under construction'''


TRAINZ A New Era SP2-List of Trainz Session Rules by Categories with Properties. '''All rules are the Copyright of N3V Games'''
TRAINZ A New Era SP2. List of Trainz Session Rules in Alphabetical Order with Properties. '''All rules are the Copyright of N3V Games'''


See also '''[[#Session Rule List (Alphabetical) with Parameters|Session Rule List (Alphabetical) with Parameters]]'''
See also '''[[#Session Rules By Categories With Properties|Session Rules By Categories With Properties]]'''


'''kuid numbers''' are for the current versions of each rule at the time of writing. These numbers can change as rules are updated.
'''kuid numbers''' are for the current versions of each rule at the time of writing. These numbers can change as rules are updated.


=='''Achievement Rules'''==
'''[[#A, B, C|A, B, C]]''' |  '''[[#D, E|D, E]]''' |  '''[[#F, G|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|S]]''' |  '''[[#T, U, V|T, U, V]]''' |  '''[[#W, X, Y, Z|W, X, Y, Z]]'''
 
=='''A, B, C'''==


==='''Achievement Check Rule'''===
==='''Achievement Check Rule'''===
Line 36: Line 38:
  '''Note:''' Times are Trainz clock time, not real time
  '''Note:''' Times are Trainz clock time, not real time


==='''Arrival and Departure Score [TANE] Rule'''===
==='''ATP Speed Limiter Rule'''===


Awards points for arriving and departing stations at the correct times and penalties for lateness. Use a rule such as [[#Trackside Check Rule|Trackside Check Rule]] to detect the arrival of the train at a timed station and immediately follow it with this rule as a child rule with the parameters set for the particular station. 
Limits allowable speed over set limit


'''<kuid:169301:100138> DLS Rule''' by '''terry_wagstaff'''
'''<kuid2:321959:1000:1> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''For station ''<to be set>''''' - select station name from session list
     '''Limits the speed to ''<value>'' mph over the set limit''' - enter speed value in mph
'''Check arrival time ''<Yes/No>''''' - click to select '''Yes''' or '''No'''
'''Related Rules:'''
  '''Due to arrive - ''<hh:mm>''''' - set scheduled arrival time in clock hours and minutes
    '''[[#AWS Configuration Rule|AWS Configuration Rule]]''' - configures the Trainz implementation of the Automatic Warning System when approaching signals
  '''Bonus for early arrival: ''<points>''''' - enter points
 
  '''Score for being on time: ''<points>''''' - enter points
==='''AWS Configuration Rule'''===
  '''Penalty for late arrival: ''<points> per second''''' - enter points to be deducted per second
'''Check departure time ''<Yes/No>''''' - click to select '''Yes''' or '''No'''
  '''Minimum wait: ''<seconds>''''' - enter number of seconds for minimum wait time at platform
  '''Maximum wait: ''<seconds>''''' - enter number of seconds for maximum wait time at platform
  '''Due to depart - ''<hh:mm>''''' - set scheduled departure time in clock hours and minutes
  '''Penalty for early departure of moving before guards signal: ''<points>''''' - enter points
  '''Score for departing on time: ''<points>''''' - enter points
  '''Penalty for late departure: ''<points> per second''''' - enter points to be deducted per second
  '''Sound guards whistle ''<Yes/No>''''' - click to select '''Yes''' or '''No'''
'''Notes:''' Times are Trainz clock times, not real times.
    The variable "Ranking Points" is modified by this rule. 
 
==='''Consist Check Rule'''===


Waits for a consist to exist that matches a description then executes any following child rules. The order of the vehicles in the consist is not important.
This rule configures the Trainz implementation of the Automatic Warning System when approaching signals


'''<kuid:-25:1068> Built-in Rule'''
'''<kuid2:60850:89002:3> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
    '''[Check Box] Enforce strict exclusive testing''' - check to only accept an exact match with no unspecified vehicles in the consist.
     Select one of three option buttons:-
      - leave unchecked to accept any consist that contains the specified vehicles.
      '''( ) Active'''
     Select one of two option buttons:-
       '''( ) Passive'''
    '''( ) Rule disabled''' - select to disable the operation of this rule
       '''( ) Passive with HUD hidden'''
    '''( ) Complete whenever a train matching the description exists''' - When selected, enter the consist description:-
    '''[Check Box] Simulate AWS for unfitted cabs?'''
       '''Specific vehicle''' - identify the specific vehicle(s) that will trigger the rule
    '''[Check Box] Use modern sound set for unfitted cabs?'''
          '''''+''''' - click to add a ''specific'' vehicle from the session list
'''Related Rules:'''
          '''''x''''' - click to remove the ''specific'' vehicle from the rule
    '''[[#ATP Speed Limiter Rule|ATP Speed Limiter Rule]]''' - limits allowable speed over set limit
       '''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
'''Note:''' This rule will continue to check all consists all the time even after it has been triggered.


==='''Multiple Resource Check Rule'''===
==='''Cinematic Camera Rule'''===


If specified resources in a selected industries or vehicles reaches set levels, then executes any following child rules. This rule replaces the older '''[[#Resource Check Rule|Resource Check 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|Set Camera Rule]]''' during session play.


'''<kuid:-25:656> Built-in Rule'''
'''<kuid2:401543:1166:3> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''<Product Level>''' - click to select a product test from two choices:-
     '''[Check Box] Lock camera controls for the duration''' - if checked user cannot alter camera view
      '''''Reach/Exceed''''' - sets an upper limit for the resources being monitored.
    '''[Check Box] Prevent train control for duration - if checked user cannot control train
          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.
    '''Camera target: ''<click to select>''''' - click to select the object from the session list that will be the camera target
          The initial level in the object must be below the set upper limit.
    '''Camera mode:''' - select one of three option buttons:-
       '''''Fall below''''' - sets a lower limit for the resources being monitored.
       '''( ) Stationary'''
          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.
      '''( ) Circle targeted object'''
          The initial level in the object must be above the set lower limit.
      '''( ) Move from one point to another (zoom, pan, etc)'''
          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.
     '''Initial camera values:'''
     '''''<value>''''' - enter required quantity value
      '''[Check Box] Pitch: ''<value>''''' - check to select then click ''value'' to enter a pitch value
    '''''<select>''''' - select a product from session list of products
      '''[Check Box] Yaw:  ''<value>''''' - check to select then click ''value'' to enter a yaw value
    '''''<Add object>''''' - click to select a source or target object. Multiple objects and their queues can be added to the rule.
      '''[Check Box] Zoom:  ''<value>''''' - check to select then click ''value'' to enter a zoom value
      ALL the entered products must reach/exceed or fall below the specified value for the rule to be triggered.
    '''Total time to animate:  ''<value>''''' - enter an animation time in seconds
      For each object:-
'''Note:''' Times are Trainz clock times, not real times
          '''''<Object>''''' - click to select session active industry or product enabled rail vehicle
'''Related Rules:'''
          '''''<Queue>''''' - select product queue (there may be only one available)
    '''[[#Focus Camera Rule|Focus Camera Rule]]''' - sets the initial camera view and starting vehicle for a session
          '''''<Remove>''''' - removes the object and its product queue from the rule
    '''[[#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]]''' - waits for the camera to be changed to the designated view, then executes any following child rules


==='''Objective Add Rule'''===
==='''Clean Up Derailed Trains Rule'''===


Sets up a game Objective with ID and display Name
Cleans up derailed train cars after a set time delay


'''<kuid:401543:2001> Base Rule'''
'''<kuid2:60850:89003:1> Base Rule'''


  '''Properties:'''
  '''Properties:'''
     '''Priority ''<Select>''''' - select one of:-
     '''Set delay to clean up derailed traincars to'''
      '''''Above Normal'''''
       '''''<h>'':''' - click to enter the number of hours (0-23) to wait
      '''''Below Normal'''''
      '''''<mm>'':''' - click to enter the number of minutes (0-59) to wait
       '''''Normal'''''
      '''''<ss>'':''' - click to enter the number of seconds (0-59) to wait
      '''''Optional'''''
'''Note:''' Time is Trainz clock time, not real time.
      '''''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:'''
  '''Related Rules:'''
     '''[[#Objective Check Rule|Objective Check Rule]]''' - checks if an objective is complete
     '''[[#Replace Missing Vehicles Rule|Replace Missing Vehicles Rule]]''' - creates a replacement train after a derailment
     '''[[#Objective Update Rule|Objective Update Rule]]''' - changes the progress of a game objective
     '''[[#Wait for Derailment Rule|Wait for Derailment Rule]]''' - executes child rules if a derailment occurs


==='''Objective Check Rule'''===
==='''Clock Rule'''===


Checks if an objective created with the '''[[#Objective Add Rule|Objective Add Rule]]''' is complete, then executes any following child rules
Rule needed for animated clocks.


'''<kuid:401543:2003> Base Rule'''
'''<kuid2:62310:30041:2> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
    '''Unique Objective ID ''<value>''''' - enter the unique ID created with the '''Objective Add Rule'''
'''Note:''' 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.
    '''Mode ''<select>''''' - select one of three option buttons:-
      '''''Wait for completion'''''
      '''''Wait for failure'''''
      '''''Wait for progress'''''
'''Related Rules:'''
    '''[[#Objective Add Rule|Objective Add Rule]]''' - sets up a game objective
    '''[[#Objective Update Rule|Objective Update Rule]]''' - changes the progress of a game objective


==='''Objective Update Rule'''===
==='''Close Message Popup Rule'''===


Changes progress of an objective outcome created with the '''[[#Objective Add Rule|Objective Add Rule]]''' according to Property choices
Closes open message popups


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


  '''Properties:'''
  '''Properties:'''
     '''Unique Objective ID ''<value>''''' - enter the unique ID created with the '''Objective Add Rule'''  
     '''None'''
    '''Mode ''<select>''''' - select one from the following options
'''Known Issues:'''
      '''''Decrement progress'''''
  This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule
      '''''Increment progress'''''
  '''Related Rule:'''
      '''''Reset Objective'''''
     '''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
      '''''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]]''' - checks if an objective is complete


==='''Power Station Rule'''===
==='''Consist Check Rule'''===


Sets up a Power Station and its electricity consumers
Waits for a consist to exist that matches a description then executes any following child rules. The order of the vehicles in the consist is not important.


'''<kuid:-25:746> Base Rule'''
'''<kuid:-25:1068> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''Power station ''<select>''''' - select a Power Station from the session list.
     '''[Check Box] Enforce strict exclusive testing''' - check to only accept an exact match with no unspecified vehicles in the consist.
    '''Consumers:'''
      - leave unchecked to accept any consist that contains the specified vehicles.
       '''''<add object>''''' - add power consumers from the session list
    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
'''Note:''' This rule will continue to check all consists for a match even after it has been triggered.
    To disable this feature add another copy of the rule with the '''Rule disabled''' option selected as one of its child rules.
==='''Control Check Rule'''===


==='''Ranked Session Begin Rule'''===
Checks if the control method changes, then executes any following child rules


Begins a ranked Session
'''<kuid:401543:1191> Built-in Rule'''
 
'''<kuid:401543:2031> Base Rule'''


  '''Properties:'''
  '''Properties:'''
    '''Countdown Starting Value ''<value>'''''
  '''Execute child rules when:''' - select one of two option buttons:-
      '''''hrs:'''''
    '''( ) DCC mode is Selected'''
      '''''min:'''''
    '''( ) Cab mode is Selected'''
      '''''sec:'''''
  '''Execute child rules:''' - select one of two option buttons:-
    '''1 through 5 stars, points for each star ''<value>''''' - enter number of points for each star rating
    '''( ) Every time control method is set'''
    '''Session timer mode:''' - select one of three option buttons:-
    '''( ) Once only'''
      '''( ) Timer'''
      '''( ) Countdown Starting value ''<value>''''' - enter time ''hh:mm:ss''
      '''( ) None'''
'''Note:''' Times are Trainz clock time, not real time
  '''Related Rules:'''
  '''Related Rules:'''
     '''[[#Ranked Session Complete Rule|Ranked Session Complete Rule]]''' - completes the active ranked Session
     '''[[#Control Type Rule|Control Type Rule]]''' - sets the control method


==='''Ranked Session Complete Rule'''===
==='''Control Type Rule'''===


Completes the active ranked Session
Sets the control method


'''<kuid:401543:2032> Base Rule'''
'''<kuid:-16:2030> Base Rule'''


  '''Properties:'''
  '''Properties:'''
    '''Set the active ranked session as:''' - select one of two option buttons:-
  '''Current control method is: ''<select>''''' - click to select one of
      '''( ) Complete'''
    '''Easy Mode'''
      '''( ) Failed'''
    '''Ask User'''
    '''[Check Box] Customize the completion message ''<text>''''' - enter a text message
    '''Realistic Mode'''
  '''Related Rules:'''
  '''Related Rules:'''
     '''[[#Ranked Session Begin Rule|Ranked Session Begin Rule]]''' - begins a ranked Session
     '''[[#Control Check Rule|Control Check Rule]]''' - checks if the control method changes, then executes any following child rules


==='''Resource Check Rule'''===
==='''Coupler Breakage Check Rule'''===


Check the progress of the amount of a resource and target object, then executes any following child rules. This rule has been superseded by the '''[[#Multiple Resource Check Rule|Multiple Resource Check Rule]]'''
Checks for breaking couplers and, if found, executes any following child rules.


'''<kuid:-25:1067> Built-in Rule'''
'''<kuid2:447264:1017:1> Built-in 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'''
  '''Related Rules:'''
  '''Related Rules:'''
     '''[[#Multiple Resource Check Rule|Multiple Resource Check Rule]]''' - checks specified resources in a selected industries or vehicles reaches set levels, then executes any following child rules.
     '''[[#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


==='''Station Visited Check Rule'''===
==='''Coupler Breakage HUD Rule'''===


Waits for a designated train or any train to call at one of the designated stations or industries, then executes any following child rules
HUD displays warning about coupler stress and breakage


'''<kuid2:60850:89005:3> Built-in Rule'''
'''<kuid:-25:423> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
    '''Trigger: ''<select>''''' - click to select one of the following
     Select one of two option buttons:-
      '''''Never''''' - stopping at the selected industries will never trigger the rule.
       '''( ) Show the Coupler Breakage Display'''
      '''''Once only''''' - the rule is triggered on the first visit only to any one of the selected industries
       '''( ) Hide the Coupler Breakage Display'''
      '''''Once per industry''''' - the rule is triggered on the first visit to each industry with each individual product
'''Related Rules:'''
      '''''Once per visit''''' - the rule is triggered on the first visit to each industry regardless of the product
    '''[[#Coupler Breakage Check Rule|Coupler Breakage Check Rule]]''' - executes child rules when a breakage occurs
      '''''Once per vehicle''''' - each vehicle can only trigger the rule once.
    '''[[#Set Coupler Masks Rule|Set Coupler Masks Rule]]''' - sets the coupling/decoupling masks on selected vehicles
    '''''<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]]'''
==='''CPC: Emit Train on Trigger Rule'''===


=='''Camera Rules'''==
Emits a train from a Portal or an Unportal after a triggered event.


==='''Cinematic Camera Rule'''===
'''<kuid2:117746:1044:12> DLS Rule''' by '''sforget'''


Provides several different cinematic style cameras with animations. Best used at the start of a session.
'''Properties:'''
Use the '''Trackside Camera''' (tracking view) found in the '''[[#Set Camera Rule|Set Camera Rule]]''' during session play.
    '''Portal index from CPC ''<value>''''' - click to enter (Un)Portal Index
    '''Use UnPortal ''<select>''''' - click to select ''Yes'' or ''No''
    '''Delay from Trigger to Emit ''<seconds>''''' - click to set number of seconds
    '''Add Trigger ''<select>''''' - click to add Trigger from Session List
'''Note:''' Times are Trainz clock time, not real time
 
==='''Custom Script Rule'''===
 
No description


'''<kuid2:401543:1166:3> Built-in Rule'''
'''<kuid:447264:1526> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''[Check Box] Lock camera controls for the duration''' - if checked user cannot alter camera view
     '''None'''
    '''[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
'''[[#top|Back to Top]]''' |  '''[[#A, B, C|A, B, C]]''' |  '''[[#D, E|D, E]]''' |  '''[[#F, G|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|S]]''' |  '''[[#T, U, V|T, U, V]]''' |  '''[[#W, X, Y, Z|W, X, Y, Z]]'''
    '''Camera mode:''' - select one of three option buttons:-
 
      '''( ) Stationary'''
=='''D, E'''==
      '''( ) Circle targeted object'''
 
      '''( ) Move from one point to another (zoom, pan, etc)'''
==='''DestSign Table Rule'''===
    '''Initial camera values:'''
 
      '''[Check Box] Pitch: ''<value>''''' - check to select then click ''value'' to enter a pitch value
Creates a list of destination names for a destination sign
      '''[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
'''<kuid2:206816:99004:2> Built-in Rule'''
    '''Total time to animate:  ''<value>''''' - enter an animation time in seconds
 
'''Note:''' Times are Trainz clock times, not real times
'''Properties:'''
'''Related Rules:'''
  '''''<add destination>''''' - enter a destination name to be added to the destination sign roll
    '''[[#Focus Camera Rule|Focus Camera Rule]]''' - sets the initial camera view and starting vehicle for a session
  '''''<import destinations from texture-group>''''' - select a list of destination names from session
    '''[[#Set Camera Rule|Set Camera Rule]]''' - sets the target object and properties of the camera
  '''[Check Box] Enable industries/stations as destination''' - check to set
    '''[[#Wait for Camera View Mode Rule|Wait for Camera View Mode Rule]]''' - waits for the camera to be changed to the designated view, then executes any following child rules
  '''[Check Box] Enable Track Marks as destinations''' - check to set
  '''[Check Box] Enable table of destinations''' - check to set
==='''Focus Camera Rule'''===
 
==='''Disable/Enable Industry Rule'''===


Sets the initial camera view and starting vehicle for a session.
Disables vehicle load/unload for industry


'''<kuid2:122381:10014:1> DLS Rule''' by '''mizi'''
'''<kuid2:401543:1171:1> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
    '''Focus camera to:''' - select one of two option buttons
  '''Load/unload ''<Disable/Enable>''''' - click to set to '''Disable''' or '''Enable'''
      '''( ) Map object'''
  '''Which Industry? ''<select>''''' - click to set Industry from Session List
      '''( ) Vehicle'''
  '''Which Vehicles:''' - select one of two option buttons:-
    '''Named ''<?????>''''' - enter name of object or vehicle from session list
      '''( ) Apply to every vehicle in the session'''
    '''Additionally:'''
      '''( ) Apply only to a specific vehicles from Session List'''
      '''[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:'''
    '''[[#Cinematic Camera Rule|Cinematic Camera Rule]]''' - provides several different cinematic style cameras with animations
'''[[#Set Camera Rule|Set Camera Rule]]]''' - sets the target object and properties of the camera
'''[[#Wait for Camera View Mode Rule|Wait for Camera View Mode Rule]]''' - waits for the camera to be changed to the designated view, then executes any following child rules


==='''Set Camera Rule'''===
==='''Display Custom HUD Rule'''===


Sets the target object and properties of the camera.
Show or hide the Custom Heads Up Display.


'''<kuid:-25:179> Built-in Rule'''
'''<kuid:-3:10206> Base Rule'''


  '''Properties:'''
  '''Properties:'''
    '''[Check Box] Set the target object of the camera to:''' - if checked, select one of three option buttons:-
  '''Show or Hide the Custom Heads up Display''' - select one of two option buttons:-
      '''( ) Vehicle ''<click to select>''''' - select a vehicle from the Session list
    '''( ) Show the Custom Heads up Display'''
      '''( ) Junction ''<click to select>''''' - select a junction from the Session list
    '''( ) Hide the Custom Heads up Display'''
      '''( ) Map Object ''<click to select>''''' - select a named map object from the Session list
    '''[Check Box] Change the camera view mode to ''<click to select>''''' - if checked, select one camera view mode from
      '''Cab View'''
      '''External View'''
      '''Tracking View'''
      '''Free Roaming'''
    '''[Check Box] Set the camera flags to enable/disable user access to''' - if checked, select as many of the following check boxes as needed
      '''[Check Box] Internal view mode''' - check to enable, uncheck to disable
      '''[Check Box] External view mode''' - check to enable, uncheck to disable
      '''[Check Box] Tracking view mode''' - check to enable, uncheck to disable
      '''[Check Box] Roaming view mode''' - check to enable, uncheck to disable
      '''[Check Box] View switching''' - check to enable, uncheck to disable
      '''[Check Box] Vehicle view switching''' - check to enable, uncheck to disable
      '''[Check Box] Train view switching''' - check to enable, uncheck to disable
      '''[Check Box] Camera adjustments (pan, zoom, etc)''' - check to enable, uncheck to disable
  '''Related Rules:'''
  '''Related Rules:'''
     '''[[#Cinematic Camera Rule|Cinematic Camera Rule]]''' - provides several different cinematic style cameras with animations
     '''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
     '''[[#Focus Camera Rule|Focus Camera Rule]]''' - sets the initial camera view and starting vehicle for a session
    '''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
'''[[#Wait for Camera View Mode Rule|Wait for Camera View Mode Rule]]''' - waits for the camera to be changed to the designated view, then executes any following child rules
     '''[[#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]]''' - waits for a click on the HUD Icon, then executes any following child rules.
==='''Display HTML Pages Rule'''===


==='''Wait for Camera View Mode 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|Message Popup Rule]]'''  


Waits for the camera to be changed to the designated view, then executes any following child rules
'''<kuid:-25:442> Base Rule'''
 
'''<kuid:-25:192> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''[Check Box] Trigger rule once''' - check to set
     '''''<Add Page>''''' - adds the HTML page ''index.html'' from the selected HTML asset
     '''Wait for the camera to change to the ''<click to select>''''' - select one camera view mode from:-
      '''''<index.html>''''' - click to change the page name. The extension ''.html'' is optional
      '''Cab View'''
     '''''<Add All>''''' - adds all HTML pages from the session list '''(this appears to be disabled in TANE)'''
      '''External View'''
    '''''<Delete All>''''' - delete all HTML pages from this property list
      '''Tracking View'''
    '''[Check Box] Prevent user from exiting browser until all pages viewed'''
      '''Free Roaming'''
    '''[Check Box] Disable closing of browser window by user'''
     '''[Check Box] Wait for the camera to target vehicle ''<click to select>''''' - if checked, select a vehicle from the Session list
    '''[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:'''
     '''[[#Cinematic Camera Rule|Cinematic Camera Rule]]''' - provides several different cinematic style cameras with animations
     '''[[#Close Message Popup Rule|Close Message Popup Rule]]''' - closes a displayed pop-up browser window.
     '''[[#Focus Camera Rule|Focus Camera Rule]]''' - sets the initial camera view and starting vehicle for a session
     '''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
'''[[#Set Camera Rule|Set Camera Rule]]]''' - sets the target object and properties of the camera
    '''[[#Set HTML Page Rule|Set HTML Page Rule]]''' - sets parameters for the '''[[#Display HTML Pages Rule|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.


'''[[#top|Back to Top]]'''
==='''Display Video Rule'''===


=='''Danger and Safety Rules'''==
Displays a page containing a video clip from a HTML asset in a browser window.


==='''ATP Speed Limiter Rule'''===
'''<kuid:-25:138> Built-in Rule'''
 
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
     '''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.
'''Note:''' video must be in a valid web format.
  '''Related Rules:'''
  '''Related Rules:'''
     '''[[#AWS Configuration Rule|AWS Configuration Rule]]''' - configures the Trainz implementation of the Automatic Warning System when approaching signals
     '''[[#Play Sound Rule|Play Sound Rule]]] - plays a wav sound file


==='''AWS Configuration Rule'''===
==='''Driver Command Check Rule'''===


This rule configures the Trainz implementation of the Automatic Warning System when approaching signals
Verifies the driver commands of a driver character, then executes any following child rules


'''<kuid2:60850:89002:3> Built-in Rule'''
'''<kuid:-25:447> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
    Select one of three option buttons:-
  '''[Check Box] Trigger rule once''' - check to allow the rule to execute only once
      '''( ) Active'''
  '''Driver character to watch the command list of ''<select>''' - select a driver name from the Session List''
      '''( ) Passive'''
  '''Wait for driver character to have a command list that matches this:'''
      '''( ) Passive with HUD hidden'''
    '''''<add driver command>''''' - add a driver command from the session list. More commands can be added. Commands can be deleted.
    '''[Check Box] Simulate AWS for unfitted cabs?'''
    '''''<add all>''''' - adds ALL driver commands in the session list. Individual commands can be removed.
    '''[Check Box] Use modern sound set for unfitted cabs?'''
    '''''<delete all>''''' - deletes all entered driver commands from the session rule
  '''Related Rules:'''
  '''Related Rules:'''
     '''[[#ATP Speed Limiter Rule|ATP Speed Limiter Rule]]''' - limits allowable speed over set limit
     '''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
    '''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers


==='''Clean Up Derailed Trains Rule'''===
==='''Driver Command Rule'''===


Cleans up derailed train cars after a set time delay
Specifies which commands will be available for the drivers


'''<kuid2:60850:89003:1> Base Rule'''
'''<kuid:-3:10057> Base Rule'''


  '''Properties:'''
  '''Properties''':
     '''Set delay to clean up derailed traincars to'''
     For each installed Driver Command:-
      '''''<h>'':''' - click to enter the number of hours (0-23) to wait
    '''[Check Box] ''Name of Diver Command'' and ''Description (if available)''''' - check to make that command available to the driver
      '''''<mm>'':''' - click to enter the number of minutes (0-59) to wait
      '''''<ss>'':''' - click to enter the number of seconds (0-59) to wait
'''Note:''' Time is Trainz clock time, not real time.
  '''Related Rules:'''
  '''Related Rules:'''
     '''[[#Replace Missing Vehicles Rule|Replace Missing Vehicles Rule]]''' - creates a replacement train after a derailment
     '''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - checks the driver commands then executes any following child rules
     '''[[#Wait for Derailment Rule|Wait for Derailment Rule]]''' - executes child rules if a derailment occurs
     '''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers


==='''Coupler Breakage Check Rule'''===
==='''Driver Main Menu Options Rule'''===


Checks for breaking couplers and, if found, executes any following child rules.
Show/Hide the Driver Main Menu Bar


'''<kuid2:447264:1017:1> Built-in Rule'''
'''<kuid:-25:448> Built-in Rule'''


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


HUD displays warning about coupler stress and breakage
Sets up a list of basic scheduled commands


'''<kuid:-25:423> Built-in Rule'''
'''<kuid2:82445:90001:9> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''  
     Select one of two option buttons:-
     '''Driver Schedule Assigned to ''name of driver <icon>''''' - click '''icon''' to select a driver from those assigned in the '''Driver Setup Rule'''
       '''( ) Show the Coupler Breakage Display'''
    '''Next commands, will be executed''' 
       '''( ) Hide the Coupler Breakage Display'''
       '''''>>''''' - click to enter driver commands from those specified in the '''Driver Command Rule'''
'''Related Rules:'''
    '''Style:''' - select one of four option buttons:-
    '''[[#Coupler Breakage Check Rule|Coupler Breakage Check Rule]]''' - executes child rules when a breakage occurs
       '''( ) Classic style: If there is a schedule do not emit a new schedule''' - any currently assigned set of driver commands will not be replaced
    '''[[#Set Coupler Masks Rule|Set Coupler Masks Rule]]''' - sets the coupling/decoupling masks on selected vehicles
      '''( ) 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


==='''Junction Derailment Prevention Rule'''===
==='''Driver Setup Rule'''===


'''<kuid2:121843:100282:1> DLS Rule''' by '''pitkin'''
Creates the list of drivers for this session and assign them their orders


Sets opposing junctions ahead of a train to prevent derailments.  Works with both AI and manually driven trains.
'''<kuid:-16:2025> Base Rule'''


  '''Properties:'''
  '''Properties:'''
     '''None'''
     '''''<driver icon>''''' - click to select a new driver from the list of installed and built in drivers
'''Note:''' Will not overrule a junction already locked by another AI train or locked against AI control using the '''[[#Set Junctions Rule|Set Junctions Rule]]'''.
    '''''<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
'''Related Rules:'''
    '''''<driver name>''''' - click to enter a new name for the selected driver
    '''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets the selected junctions to a specific state (switch direction, locked/unlocked, allow/prevent AI control).
    '''''<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'''


==='''Replace Missing Vehicles Rule'''===
==='''EIRS Weather Rule NE USA Rule'''===


Produces new trains to replace missing vehicles that have been removed from the session by the '''[[#Clean Up Derailed Trains Rule|Clean Up Derailed Trains Rule]]'''
Customize random weather rule relative to the North East Region of the United States.


'''<kuid:447264:1214> Built-in Rule'''
'''<kuid2:487222:1037:3> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''[Check Box] Respawn trains if they are abandoned for 10 minutes'''
     '''Season ''<select>''''' - select one of:-
    If checked:-
       '''''Summer'''''
       Select one of two option buttons:-
      '''''Fall'''''
          '''( ) Respawn trains at their original locations'''
      '''''Winter'''''
          '''( ) Respawn trains from portals'''
      '''''Spring'''''
            '''''<+ Add a new portal>''''' - click to enter the name of a portal, there can be more than one portal.
    '''Random Changeability (minutes) ''<value>''''' - select one of:-
            Entered portal names that appear in red have not been found in the session
      '''''2/5/10/15/20/30/45/60''''' - minutes''
    '''Environment Settings ''<select>''''' - select one of:-
      '''''Disable/Enable'''''
'''Note:''' 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
     '''[[#Startup Options Rule|Startup Options Rule]]''' - sets the weather conditions at the start of a Session
     '''[[#Wait for Derailment Rule|Wait for Derailment Rule]]''' - executes child rules if a derailment occurs
     '''[[#Weather Rule|Weather Rule]]''' - changes the weather conditions during Session play


==='''Safety System Engaged Check Rule'''===
==='''Enable/Disable Driver Commands Rule'''===


Checks for safety systems making penalty applications on users and, if found, then executes any following child rules.
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:447264:1216> Built-in Rule'''
'''<kuid:-25:480> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''[Check Box] Trigger only once'''
    '''<Enable/Disable>'' the following driver commands ...''' - click to select '''Enable''' or '''Disable'''
  '''Related Rules:'''
    For each driver command:-
     '''[[#Safety System Isolated Check Rule|Safety System Isolated Check Rule]]''' - executes child rules if safety systems have been isolated by user
     '''[Check Box] ''command name''''' - check to enable or disable
    '''[Check Box] ''command name''''' - check to enable or disable
    '''[Check Box] ''command name''''' - check to enable or disable
    etc
    Select one of two option buttons:-
      '''( ) click to accept all trains'''
      '''( ) click to accept trains matching specific criteria'''
          Selecting the second option will produce the following selection controls:-
          '''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
            '''''+''''' - click to add a ''specific'' vehicle from the session list
            '''''x''''' - click to remove the ''specific'' vehicle from the rule
          '''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule
            '''''+''''' - click to add a ''type'' of vehicle from the session list
            '''''x''''' - click to remove the ''type'' of vehicle from the rule
          '''Drivers''''' - identify the ''drivers'' that will trigger the rule
            '''''+''''' - click to add a ''driver'' from the session list
            '''''x''''' - click to remove a ''driver'' from the rule
  '''Related Rules:'''
     '''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
    '''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - checks the driver commands then executes any following child rules


==='''Safety System Isolated Check Rule'''===
==='''End Session Rule'''===  


Checks for safety systems being isolated by users and, if found, then executes any following child rules.
End the Session with a fade out.


'''<kuid:447264:1217> Built-in Rule'''
'''<kuid:-25:482> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''[Check Box] Trigger only once'''
     '''Fade out over ''<value>'' seconds''' - enter number of seconds for fade out.
'''Note:''' Seconds are Trainz clock time, not real time.
  '''Related Rules:'''
  '''Related Rules:'''
     '''[[#Safety System Engaged Check Rule|Safety System Engaged Check Rule]]''' - executes child rules if safety systems have been engaged by user
     '''[[#Session Complete Rule|Session Complete Rule]]''' - set the session to a percentage of completion


==='''Set Coupler Masks Rule'''===
'''[[#top|Back to Top]]''' |  '''[[#A, B, C|A, B, C]]''' |  '''[[#D, E|D, E]]''' |  '''[[#F, G|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|S]]''' |  '''[[#T, U, V|T, U, V]]''' |  '''[[#W, X, Y, Z|W, X, Y, Z]]'''


Set the coupling/decoupling  masks on the selected vehicles
=='''F, G'''==


'''<kuid:-25:980> Built-in Rule'''
==='''Fade in/out Rule'''===


'''Properties:'''
Fade in or out within seconds, using specified color and opacity values.
    '''''<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:'''
    '''[[#Coupler Breakage Check Rule|Coupler Breakage Check Rule]]''' - executes child rules when a breakage occurs
    '''[[#Coupler Breakage HUD Rule|Coupler Breakage HUD Rule]]''' - adds a coupler stress and breakage warning to the HUD
     
==='''Signal Passed At Danger Check Rule'''===


Checks for Drivers passing signals at danger (stop) and, if found, then executes any following child rules.
'''<kuid2:190611:200000:2> Built-in Rule'''
 
'''<kuid2:60850:89007:2> Built-in Rule


  '''Properties:'''
  '''Properties:'''
     '''[Check Box] Trigger only once'''
     '''Red percentage:            ''<value>''''' - enter the final % of red (0 = none, 100 = maximum)
 
    '''Green percentage:          ''<value>''''' - enter the final % of green
==='''Speeding Check Rule'''===
    '''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
 
==='''Flash HUD Icon Rule'''===


If player controlled trains are over the local speed limit or over a set (custom) speed, then executes any following child rules
Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.


'''<kuid2:60850:89004:3> Built-in Rule
'''<kuid:-25:968> Built-in Rule


  '''Properties:'''
  '''Properties:'''
     Select one of two options to set a speed limit to be observed
     Select one of two option buttons:-
      '''( ) Watch for trains travelling above the posted speed limit'''
    '''( ) Flash the ''<click to select>'' icon on the ''<click to select>'' HUD panel for a period of ''<value>'' seconds'''
          '''''<speed value>''''' - click to enter a new overspeed tolerance value
      TIP: Select the HUD panel first (the second ''<click to select>'' link).
          '''''<speed units>''''' - click to select one from the list:-
      Available HUD panels are (select one):-
            '''''Km/h''''' - Kilometres per hour
          '''Bottom Right Menu'''
            '''''MPH''''' - Miles per hour
          '''Camera Controls'''
            '''''mps''''' - metres per second
          '''DCC Controls'''
       '''( ) Watch for trains travelling above a custom speed'''
          '''Driver Main Menu'''
          '''''<speed value>''''' - click to enter a new custom speed value
       Available icons will depend on the HUD panel selected.
           '''''<speed units>''''' - click to select one from the list:-
    '''( ) ''<Start/Stop>'' flashing the ''<click to select>'' icon on the ''<click to select>'' HUD panel'''
            '''''Km/h''''' - Kilometres per hour
      TIP: Select the HUD panel first (the second ''<click to select>'' link).
            '''''MPH''''' - Miles per hour
      Available HUD panels are (select one):-
            '''''mps''''' - metres per second
           '''Bottom Right Menu'''
            '''Warning: This option is very performance intensive and should only be used in sessions with few trains'''
          '''Camera Controls'''
          '''DCC Controls'''
          '''Driver Main Menu'''
      Available icons will depend on the HUD panel selected.
'''Related Rules:'''
    '''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - show or hide the Custom Heads Up Display.
    '''[[#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]]''' - waits for a click on the HUD Icon, then executes any following child rules.


==='''Vehicle Physics Rule'''===
==='''Focus Camera Rule'''===


Overrides the default vehicle physics properties for all vehicles or for those matching set criteria
Sets the initial camera view and starting vehicle for a session.


'''<kuid:-25:1052> Built-in Rule
'''<kuid2:122381:10014:1> DLS Rule''' by '''mizi'''


  '''Properties:'''
  '''Properties:'''
     Select one of two option buttons:-
     '''Focus camera to:''' - select one of two option buttons
       '''( ) click to accept all trains'''
       '''( ) Map object'''
       '''( ) click to accept trains matching specific criteria'''
       '''( ) Vehicle'''
          Selecting the second option will produce the following selection controls:-
    '''Named ''<?????>''''' - enter name of object or vehicle from session list
          '''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
    '''Additionally:'''
            '''''+''''' - click to add a ''specific'' vehicle from the session list
      '''[Check Box] set view mode to''' - check to select one of four option buttons
            '''''x''''' - click to remove the ''specific'' vehicle from the rule
           '''( ) Internal view'''
           '''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule
          '''( ) External view'''
            '''''+''''' - click to add a ''type'' of vehicle from the session list
          '''( ) Tracking view'''
            '''''x''''' - click to remove the ''type'' of vehicle from the rule
          '''( ) Roaming view'''
           '''Drivers''''' - identify the ''drivers'' that will trigger the rule
      '''[Check Box] restrict user to manipulate the camera''' - check to set user limits on camera controls
            '''''+''''' - click to add a ''driver'' from the session list
          '''[Check Box] allow internal view'''
            '''''x''''' - click to remove a ''driver'' from the rule
           '''[Check Box] allow external view'''
    '''Coupler Parameters:'''
          '''[Check Box] allow tracking view'''
       '''Couplers break at ''<value>'' kN expansion force''' - enter force value
          '''[Check Box] allow roaming view'''
      '''Couplers break at when coupling above ''<value>'' kph''' - enter speed value
          '''[Check Box] allow change of view mode'''
      '''[Check Box] Show coupler breakage in HUD''' - check to display breakage in on-screen HUD
          '''[Check Box] allow change vehicle in train'''
    '''Wheelslip Parameters:'''
          '''[Check Box] allow change trains'''
      '''Maximum tractive effort adjusted by ''<value>'' %''' - enter adjustment as a %
          '''[Check Box] allow adjust camera viewpoint'''
      '''Traction is reduced to ''<value>'' % while wheelslipping''' - enter value as a %
       '''[Check Box] set camera angles''' - check to set the initial camera view point
      '''Traction boost is ''<value>'' % while sanding''' - enter value as a %
          '''Yaw (90 = look at front of train): ''<value>'' degrees''' - enter yaw angle
     '''Sway Parameters:'''
          '''Pitch (-90 = down, 90 = up): ''<value>'' degrees''' - enter pitch angle
      '''Cab sway level is set to ''<value>'' %''' - enter value as a %
          '''Distance from the focused object: ''<value>'' metres''' - enter distance from camera to object
'''Related Rules:'''
==='''Wait for Derailment Rule'''===
    '''[[#Cinematic Camera Rule|Cinematic Camera Rule]]''' - provides several different cinematic style cameras with animations
     '''[[#Set Camera Rule|Set Camera Rule]]''' - sets the target object and properties of the camera
    '''[[#Wait for Camera View Mode Rule|Wait for Camera View Mode Rule]]''' - waits for the camera to be changed to the designated view, then executes any following child rules
 
==='''Generic TreeNode Debug Window Rule'''===


Waits for a derailment to occur, then executes any following child rules
No description.


'''<kuid:-25:1053> Built-in Rule
'''<kuid:30501:1042> Base Rule'''


  '''Properties:'''
  '''Properties:'''
    '''[Check Box] Trigger derailment watch once''' - check to execute the rule once only
'''Note:''' I have been unable to find any references to this rule in Trainz except for the fact that it exists as a session rule.
  '''Related Rules:'''
  '''Related Rules:'''
     '''[[#Clean UP Derailed Trains Rule|Clean UP Derailed Trains Rule]]''' - cleans up derailed train cars after a set time delay
     '''[[#Session Debug Rule|Session Debug Rule]]''' - executes the first child if debug mode is selected, otherwise the second child rule is executed
    '''[[#Replace Missing Vehicles Rule|Replace Missing Vehicles Rule]]''' - creates a replacement train after a derailment


'''[[#top|Back to Top]]'''
'''[[#top|Back to Top]]''' |  '''[[#A, B, C|A, B, C]]''' |  '''[[#D, E|D, E]]''' |  '''[[#F, G|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|S]]''' |  '''[[#T, U, V|T, U, V]]''' |  '''[[#W, X, Y, Z|W, X, Y, Z]]'''


=='''Driver Rules'''==
=='''H, I, J'''==


==='''Control Check Rule'''===
==='''InputTable Rule'''===


Checks if the control method changes, then executes any following child rules
Creates a list of message names to be used for various purposes.


'''<kuid:401543:1191> Built-in Rule'''
'''<kuid2:131986:1012:1> Built-in'''


  '''Properties:'''
  '''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'''
'''Related Rules:'''
    '''[[#Control Type Rule|Control Type Rule]]''' - sets the control method


==='''Control Type Rule'''===
==='''Interlocking Tower Configure Path'''===


Sets the control method
Alters settings on an interlocking tower path


'''<kuid:-16:2030> Base Rule'''
'''<kuid:401543:3205> Base Rule'''  


  '''Properties:'''
  '''Properties:'''
  '''Current control method is: ''<select>''''' - click to select one of
  '''Interlocking Tower ''<select>''''' - to set Name and Objects
    '''Easy Mode'''
    '''Ask User'''
    '''Realistic Mode'''
  '''Related Rules:'''
  '''Related Rules:'''
     '''[[#Control Check Rule|Control Check Rule]]''' - checks if the control method changes, then executes any following child rules
     '''[[#Interlocking Tower Path Selection UI|Interlocking Tower Path Selection UI]]''' - 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.


==='''CPC: Emit Train on Trigger Rule'''===
==='''Interlocking Tower Enhanced Manager Rule (SP2 and later)'''===


Emits a train from a Portal or an Unportal after a triggered event.
Provides more management and control options for interlocking towers.


'''<kuid2:117746:1044:12> DLS Rule''' by '''sforget'''
'''<kuid2:61392:8130:40> DLS Rule''' by '''pguy'''


  '''Properties:'''
  '''Properties:'''
    '''Portal index from CPC ''<value>''''' - click to enter (Un)Portal Index
'''Related Rules:'''
     '''Use UnPortal ''<select>''''' - click to select ''Yes'' or ''No''
     '''[[#Interlocking Tower Configure Path|Interlocking Tower Configure Path]]''' - alters the settings on an interlocking tower path
     '''Delay from Trigger to Emit ''<seconds>''''' - click to set number of seconds
     '''[[#Interlocking Tower Path Selection UI|Interlocking Tower Path Selection UI]]''' - automatically reacts to messages from Interlocking Towers and displays a path selection dialog to the player.
     '''Add Trigger ''<select>''''' - click to add Trigger from Session List
     '''[[#Interlocking Tower Set Path Rule|Interlocking Tower Set Path Rule]]''' - sets the state of an interlocking tower path for a train
'''Note:''' Times are Trainz clock time, not real time


==='''Disable/Enable Industry Rule'''===
==='''Interlocking Tower Path Selection UI'''===


Disables vehicle load/unload for industry
Will automatically react to messages from Interlocking Towers and display a path selection dialog to the player. Disable by removing rule from session


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


  '''Properties:'''
  '''Properties:'''
   '''Load/unload ''<Disable/Enable>''''' - click to set to '''Disable''' or '''Enable'''
   '''[Checkbox] Show path activation message in Driver'''
  '''Which Industry? ''<select>''''' - click to set Industry from Session List
'''Related Rules:'''
  '''Which Vehicles:''' - select one of two option buttons:-
    '''[[#Interlocking Tower Configure Path|Interlocking Tower Configure Path]]''' - alters the settings on an interlocking tower path
      '''( ) Apply to every vehicle in the session'''
    '''[[#Interlocking Tower Set Path Rule|Interlocking Tower Set Path Rule]]''' - sets the state of an interlocking tower path for a train
      '''( ) Apply only to a specific vehicles from Session List'''
    '''[[#Interlocking Tower Enhanced Manager Rule (SP2 and later)|Interlocking Tower Enhanced Manager Rule (SP2 and later)]]''' - more management and control options for interlocking towers.


==='''Driver Command Rule'''===
==='''Interlocking Tower Set Path Rule'''===


Specifies which commands will be available for the drivers
Will set the state of an interlocking tower path for a train


'''<kuid:-3:10057> Base Rule'''
'''<kuid:401543:3204> Base Rule'''


  '''Properties:''':
  '''Properties:'''
    For each installed Driver Command:-
  '''Interlocking Tower ''<select>''''' - to set Name and Objects
    '''[Check Box] ''Name of Diver Command'' and ''Description (if available)''''' - check to make that command available to the driver
  '''Related Rules:'''
  '''Related Rules:'''
     '''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - checks the driver commands then executes any following child rules
     '''[[#Interlocking Tower Configure Path|Interlocking Tower Configure Path]]''' - alters the settings on an interlocking tower path
     '''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
    '''[[#Interlocking Tower Path Selection UI|Interlocking Tower Path Selection UI]]''' - 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.


==='''Driver Command Check Rule'''===
==='''Junction Derailment Prevention Rule'''===


Verifies the driver commands of a driver character, then executes any following child rules
'''<kuid2:121843:100282:1> DLS Rule''' by '''pitkin'''


'''<kuid:-25:447> Built-in Rule'''
Sets opposing junctions ahead of a train to prevent derailments.  Works with both AI and manually driven trains.


  '''Properties:'''
  '''Properties:'''
  '''[Check Box] Trigger rule once''' - check to allow the rule to execute only once
    '''None'''
  '''Driver character to watch the command list of ''<select>''' - select a driver name from the Session List''
'''Note:''' Will not overrule a junction already locked by another AI train or locked against AI control using the '''[[#Set Junctions Rule|Set Junctions Rule]]'''.
  '''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:'''
     '''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
     '''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets the selected junctions to a specific state (switch direction, locked/unlocked, allow/prevent AI control).
    '''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers


==='''Driver Main Menu Options Rule'''===
'''[[#top|Back to Top]]''' |  '''[[#A, B, C|A, B, C]]''' |  '''[[#D, E|D, E]]''' |  '''[[#F, G|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|S]]''' |  '''[[#T, U, V|T, U, V]]''' |  '''[[#W, X, Y, Z|W, X, Y, Z]]'''


Show/Hide the Driver Main Menu Bar
=='''K, L, M'''==


'''<kuid:-25:448> Built-in Rule'''
==='''MaxPermittedSpeed Rule'''===


'''Properties:'''
Controls AI behavior. When active AI Trains only go as fast as permitted
  '''''<Show/Hide>'' the Driver Main Menu Bar''' - click '''Show''' or '''Hide''' to select


==='''Driver Schedule Rule'''===
'''<kuid2:60850:89000:7> Built-in Rule'''


Sets up a list of basic scheduled commands
'''Note:''' 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


'''<kuid2:82445:90001:9> Built-in Rule'''
==='''Message Popup Rule'''===


'''Properties:'''
Displays a pop-up browser window and waits for it to be closed. Closure can be manual (by the user) or by another rule.
    '''Driver Schedule Assigned to ''name of driver <icon>''''' - click '''icon''' to select a driver from those assigned in the '''Driver Setup Rule'''
    '''Next commands, will be executed''' 
      '''''>>''''' - click to enter driver commands from those specified in the '''Driver Command Rule'''
    '''Style:''' - select one of four option buttons:-
      '''( ) Classic style: If there is a schedule do not emit a new schedule''' - any currently assigned set of driver commands will not be replaced
      '''( ) Killer style: If there is a schedule clean it and emit a new one''' - replace any currently assigned driver commands with the new commands
      '''( ) Cooperative style: If there is a schedule append the new one''' - add the new driver commands to the end of any existing commands
      '''( ) Active style: Emit a new schedule, only if already a schedule running''' - only add the new commands if commands are currently running


==='''Driver Setup Rule'''===
'''<kuid:-25:1003> Built-in Rule'''
 
Creates the list of drivers for this session and assign them their orders
 
'''<kuid:-16:2025> Base Rule'''


  '''Properties:'''
  '''Properties:'''
     '''''<driver icon>''''' - click to select a new driver from the list of installed and built in drivers
     '''[Check Box] Pause game while message is displayed''' - stops the game until this message is closed
     '''''<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
    '''[Check Box] Close previous popup windows''' - closes any Message Popups currently displayed before this message is shown
     '''''<driver name>''''' - click to enter a new name for the selected driver
     '''Message location ''<Top Left/Top Right/Bottom Left/Bottom Right>''''' - select one to position the browser window on the screen
    '''''<driver mode>''''' - click to select one of:-
     '''Message Source:''' - select one of three option buttons:-
      '''''Autodetect''''' - the program will detect the driver mode to be used. For example, if driver commands have been entered for this driver
      '''( ) Custom text''' - the simplest and easiest option
          then the '''AI driver''' mode will be selected
          '''Icon ''<Click here to set>''''' - shows a list of message icons. Select one to be displayed with the message
       '''''First Human Player''''' - the driver will wait until he/she has been selected by the player
          '''Icon ''<Clear icon>''''' - clears any currently displayed message icon
      '''''AI driver''''' - the AI will be given control even if no commands are present
          '''Custom text box''' Enter text to be displayed. You will be limited to about 6 lines of text.  
      '''''Multiplayer Driver''''' - the driver will be assigned to a multiplayer user
            For longer messages or to include graphics, use the '''A predefined HTML page''' option.
    '''''<remove>''''' - this driver will be removed from the rule
       '''( ) A predefined HTML page''' - requires a working knowledge of HTML
    '''''>>''''' - click to enter driver commands from those specified in the '''Driver Command Rule'''
          '''''<HTML Asset>''''' - select the name of the HTML asset that contains the required HTML page from the list shown.
    --> Scroll down to the bottom of the list of entered drivers for more options
          '''''<HTML Page>''''' - enter the filename of the HTML page to be displayed. The page must be in the HTML asset identified above.
  '''''<Add another driver>''''' - click to add another driver
              Filename is not case sensitive. Extension ".html" is optional.
  '''[Check Box] Remove all existing Drivers first'''
          '''''<HTML Wave>''''' - (optional) select the name of the HTML file containing the wave file to be played.
  '''[Check Box] Generate new Drivers for empty Trains'''
              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>''''' - <function unknown at present>
          '''''<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 Rule:'''
    '''[[#Close Message Popup Rule|Close Message Popup Rule]]''' - closes a displayed pop-up browser window.


==='''Enable/Disable Driver Commands Rule'''===
==='''Minimap Options 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
Sets the display options for the minimap.


'''<kuid:-25:480> Built-in Rule'''
'''<kuid:-25:636> Built-in Rule'''


  '''Properties:'''
  '''Properties:''' ''Default values - all checked''
    '''<Enable/Disable>'' the following driver commands ...''' - click to select '''Enable''' or '''Disable'''
     '''[Check Box] Map Textures'''
    For each driver command:-
     '''[Check Box] Gradients'''
     '''[Check Box] ''command name''''' - check to enable or disable
     '''[Check Box] Junctions'''
     '''[Check Box] ''command name''''' - check to enable or disable
     '''[Check Box] Signals'''
     '''[Check Box] ''command name''''' - check to enable or disable
    '''[Check Box] Triggers'''
    etc
    '''[Check Box] Markers'''
     Select one of two option buttons:-
    '''[Check Box] Trackside Labels'''
      '''( ) click to accept all trains'''
    '''[Check Box] Terrain Objects'''
      '''( ) click to accept trains matching specific criteria'''
    '''[Check Box] Industrial Names'''
          Selecting the second option will produce the following selection controls:-
    '''[Check Box] Named Objects'''
          '''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
    '''[Check Box] Consists'''
            '''''+''''' - click to add a ''specific'' vehicle from the session list
            '''''x''''' - click to remove the ''specific'' vehicle from the rule
          '''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule
            '''''+''''' - click to add a ''type'' of vehicle from the session list
            '''''x''''' - click to remove the ''type'' of vehicle from the rule
          '''Drivers''''' - identify the ''drivers'' that will trigger the rule
            '''''+''''' - click to add a ''driver'' from the session list
            '''''x''''' - click to remove a ''driver'' from the rule
  '''Related Rules:'''
  '''Related Rules:'''
     '''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
     '''[[#Show/Hide Minimap Rule|Show/Hide Minimap Rule]]''' - shows the minimap window in Driver.
    '''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - checks the driver commands then executes any following child rules


==='''MaxPermittedSpeed Rule'''===
==='''Multiplayer Rule'''===


Controls AI behavior. When active AI Trains only go as fast as permitted
Enables the session to be taken online in a Multiplayer environment.


'''<kuid2:60850:89000:7> Built-in Rule'''
'''<kuid:447264:1045> Built-in Rule'''


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


==='''QuickDrive Rule'''===
==='''Multiple Junction Alignment Check Rule'''===


Change the Session settings and add consists in Driver
Checks junctions are set or in alignment, then executes any following child rules.


'''<kuid:401543:1184> Base Rule'''
'''<kuid:-25:168> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
  '''Open QuickDrive window when session is started          [Check Box]''' - check to set
    '''Wait until ''<selection>''''' - select from:-
  '''Set time to ''<hours:minutes>'' with a rate of ''<speed x>''''' - set start time and rate at which time advances
      '''any one''' - any of the junctions in the rule list (below) is set correctly
  '''Enable gameplay Session Mode                            [Check Box]''' - check to set. Gameplay mode restricts the players options
      '''all''' - ALL of the junctions in the rule list are set correctly
  '''Enable in game help by default                          [Check Box]''' - check to allow help options to be displayed
    '''''<Add junction>''''' - click to select a junction from the session list
  '''Set the default Control method to:''' - select one of two option buttons:-
    '''''<Add all>''''' - click to select ALL junctions in the session list
      '''( ) Easy Mode'''
    '''''<Delete all>''''' - click to delete ALL selected junctions from the rule list
      '''( ) Realistic Mode'''
      For each selected junction:-
      '''[Check Box] Prevent player from changing this setting''' - check to set
      '''''<setting>''''' - click to select one switch direction from:-
  '''Realistic mode requires achievement: ''<text>'' in asset ''<asset name>''''' - enter achievement name and select an asset from Aurans Achievements
          '''Left'''
  '''Set the default derailment realism to:''' - select one of three option buttons:-
          '''Right'''
      '''( ) None'''
          '''Center'''
      '''( ) Arcade'''
          '''Any'''
      '''( ) Realistic'''
      '''''<remove>''''' - to delete this junction from the rule list''
      '''[Check Box] Prevent player from changing this setting''' - check to set
'''Related Rules:'''
  '''Set the default units to:''' - select one of three option buttons:-
    '''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets junctions to specific directions, locks and unlocks junctions, allows or denies AI control.
      '''( ) Imperial'''
      '''( ) Metric'''
      '''( ) Default'''


==='''Wait for Driver On/Off Train Rule'''===
==='''Multiple Resource Check Rule'''===


Waits for a Driver to get off of a train, then executes any following child rules
If specified resources in a selected industries or vehicles reaches set levels, then executes any following child rules. This rule replaces the older '''[[#Resource Check Rule|Resource Check Rule]]'''


'''<kuid:-25:953> Built-in Rule'''
'''<kuid:-25:656> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
  '''[Check Box] Trigger Rule Once''' - click to set''
    '''<Product Level>''' - click to select a product test from two choices:-
  '''Wait for a driver character to get ''<On/Off>''''' a train that matches the following criteria''' - select '''On''' or '''Off'''
      '''''Reach/Exceed''''' - sets an upper limit for the resources being monitored.
  Select one of two option buttons:-
          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.
    '''( ) click to accept all trains'''
          The initial level in the object must be below the set upper limit.
    '''( ) click to accept trains matching specific criteria'''
      '''''Fall below''''' - sets a lower 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 falls below 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 above the set lower limit.
          '''''+''''' - click to add a ''specific'' 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 ''specific'' vehicle from the rule
    '''''<value>''''' - enter required quantity value
        '''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule
    '''''<select>''''' - select a product from session list of products
          '''''+''''' - click to add a ''type'' of vehicle 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 the ''type'' of vehicle from the rule
      ALL the entered products must reach/exceed or fall below the specified value for the rule to be triggered.
        '''Drivers''''' - identify the ''drivers'' that will trigger the rule
      For each object:-
          '''''+''''' - click to add a ''driver'' from the session list
          '''''<Object>''''' - click to select session active industry or product enabled rail vehicle  
          '''''x''''' - click to remove a ''driver'' from the rule
          '''''<Queue>''''' - select product queue (there may be only one available)
          '''''<Remove>''''' - removes the object and its product queue from the rule


==='''Wait for Driver/Train to be Locally Owned Rule'''===
'''[[#top|Back to Top]]''' |  '''[[#A, B, C|A, B, C]]''' |  '''[[#D, E|D, E]]''' |  '''[[#F, G|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|S]]''' |  '''[[#T, U, V|T, U, V]]''' |  '''[[#W, X, Y, Z|W, X, Y, Z]]'''


Waits for a specific driver or train car to be locally owned, then executes any following child rules. If the driver/train car becomes unowned again the child rules are paused
=='''N, O'''==


'''<kuid2:401543:1173:1> Built-in Rule'''
==='''Navigation Display Rule'''===


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


'''[[#top|Back to Top]]'''
'''<kuid2:401543:1161:1> Base Rule'''
 
=='''Message Rules'''==
 
==='''Close Message Popup Rule'''===
 
Closes open message popups
 
'''<kuid:447264:1526> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
  None
    '''Unique set ID: ''<click here to set>''''' - enter a unique name for the navigation set. Name must be in lowercase and have no spaces.
'''Known Issues:'''
    '''Train (optional): ''<click here to set>''''' - select a rolling stock asset from the session list shown.
   This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule
    Select one of three option buttons:-
  '''Related Rule:'''
    '''( ) All points must be completed in sequence:'''
     '''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
      - the first uncompleted navigation point will be shown and must be completed next.
 
      - the next point (if any) will also be shown but at a lower opacity.
==='''Custom Script Rule'''===
    '''( ) Points will be completed in sequence, but can be skipped:'''
 
      - navigation points can be skipped but must be completed in order.
No description
      - you cannot go back to complete a missed point.
 
    '''( ) All points must be completed, but in any order:'''
'''<kuid:447264:1526> Built-in Rule'''
      - 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:'''
     '''[[#Navigation Set Hide/Show rule|Navigation Set Hide/Show rule]]''' - makes a navigation set visible/invisible.
    '''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - checks if a navigation set is complete or incomplete.
    '''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
    '''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.
    '''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' -  checks if a specific navigation point in a set has been completed.


'''Properties:'''
==='''Navigation Point Complete Rule'''===
  None.


==='''Display Custom HUD Rule'''===
Manually completes a navigation point in a set


Show or hide the Custom Heads Up Display.
'''<kuid:401543:1167> Base Rule'''
 
'''<kuid:-3:10206> Base Rule'''


  '''Properties:'''
  '''Properties:'''
  '''Show or Hide the Custom Heads up Display''' - select one of two option buttons:-
    '''Mark navigation point ''<click here to set>''''' - enter the navigation point number to be completed
    '''( ) Show the Custom Heads up Display'''
    '''complete in set ''<click here to set>''''' - enter the unique name for the navigation set created using the '''[[#Navigation Display Rule|Navigation Display Rule]]'''.
    '''( ) Hide the Custom Heads up Display'''
        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:'''
     '''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
     '''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
     '''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
     '''[[#Navigation Set Hide/Show rule|Navigation Set Hide/Show rule]]''' - makes a navigation set visible/invisible.
     '''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
    '''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - checks if a navigation set is complete or incomplete.
     '''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - waits for a click on the HUD Icon, then executes any following child rules.
     '''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
     '''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - checks if a specific navigation point in a set has been completed.
==='''Display HTML Pages Rule'''===
 
==='''Navigation Set 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|Message Popup Rule]]'''
Checks if a navigation set is complete or incomplete, then executes any following child rules


'''<kuid:-25:442> Base Rule'''
'''<kuid:401543:1165> Base Rule'''


  '''Properties:'''
  '''Properties:'''
     '''''<Add Page>''''' - adds the HTML page ''index.html'' from the selected HTML asset
     '''Checks if navigation point set ''<name>'':''' - enter the unique name for the navigation set created using the '''[[#Navigation Display Rule|Navigation Display Rule]]'''.
      '''''<index.html>''''' - click to change the page name. The extension ''.html'' is optional
        Name must be in lowercase and have no spaces.
    '''''<Add All>''''' - adds all HTML pages from the session list '''(this appears to be disabled in TANE)'''
     '''is ''<Complete/Incomplete>''''' - click to select one
     '''''<Delete All>''''' - delete all HTML pages from this property list
'''Known Issues:'''
    '''[Check Box] Prevent user from exiting browser until all pages viewed'''
     The rule will '''NOT''' check to see if the named navigation set exists or not.
     '''[Check Box] Disable closing of browser window by user'''
    '''[Check Box] Disable browser window scrolling'''
    '''[Check Box] Make browser window invisible'''
    '''[Check Box] Set position-Under Construction!!!''' - not implemented
    '''[Check Box] Set size-Under Construction!!!''' - not implemented
    '''Use the page ''<index.html>'' from asset ''<select>'' as the hidden button''' - the link buttons at the bottom of the page will be taken from the selected page in the selected HTML asset
  '''Related Rules:'''
  '''Related Rules:'''
     '''[[#Close Message Popup Rule|Close Message Popup Rule]]''' - closes a displayed pop-up browser window.
     '''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
     '''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
     '''[[#Navigation Set Hide/Show rule|Navigation Set Hide/Show rule]]''' - makes a navigation set visible/invisible.
     '''[[#Set HTML Page Rule|Set HTML Page Rule]]''' - sets parameters for the '''[[#Display HTML Pages Rule|Display HTML Pages Rule]]'''
     '''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
     '''[[#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.
    '''[[#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]]''' - checks if a specific navigation point in a set has been completed.


==='''Display Video Rule'''===
==='''Navigation Set Clear Rule'''===


Displays a page containing a video clip from a HTML asset in a browser window.
Clears a navigation set removing any uncompleted navigation points


'''<kuid:-25:138> Built-in Rule'''
'''<kuid:401543:1164> Base Rule'''


  '''Properties:'''
  '''Properties:'''
     '''Display page ''<index.html>'' of html asset ''<click to select>'' in a new browser window
     '''''<Click here to set>''''' - enter the unique name for the navigation set created using the '''[[#Navigation Display Rule|Navigation Display Rule]]'''.
      '''''index.html''''' - enter the filename of a HTML page in the selected HTML asset. The ''.html'' is optional in the filename.
        Name must be in lowercase and have no spaces.
      '''''<click to select>''''' - select the HTML asset from those installed.
'''Known Issues:'''
'''Note:''' video must be in a valid web format.
    The rule will '''NOT''' check to see if the named navigation set exists or not.
'''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]]''' - checks if a navigation set is complete or 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]]''' -  checks if a specific navigation point in a set has been completed.


==='''Fade in/out Rule'''===
==='''Navigation Set Hide/Show'''===


Fade in or out within seconds, using specified color and opacity values.
Shows and hides navigation sets. You can have multiple sets visible and hidden at the same time.


'''<kuid2:190611:200000:2> Built-in Rule'''
'''<kuid:401543:1163> Base rule'''


  '''Properties:'''
  '''Properties:'''
     '''Red percentage:            ''<value>''''' - enter the final % of red (0 = none, 100 = maximum)
     '''''<visibility>''''' - click to select one
     '''Green percentage:          ''<value>''''' - enter the final % of green
      '''Hide''' - select to make the navigation set invisible
    '''Blue percentage:           ''<value>''''' - enter the final % of blue
      '''Show''' - select to make the navigation set visible
    '''Alpha percentage (opacity): ''<value>''''' - enter the final % of opacity (0 = invisible, 100 = solid)
     '''''<click here to set>''''' - enter the unique name for the navigation set created using the '''[[#Navigation Display Rule|Navigation Display Rule]]'''.
     '''Fading duration:            ''<value>''''' - enter the number of seconds required for the fade
        Name must be in lowercase and have no spaces.
     '''''<help>''''' - click to bring up help instructions
'''Known Issues:'''
 
    The rule will '''NOT''' check to see if the named navigation set exists or not.
==='''Flash HUD Icon Rule'''===
'''Related Rules:'''
    '''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
     '''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - checks if a navigation set is complete or incomplete.
    '''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
     '''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.
    '''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - checks if a specific navigation point in a set has been completed.
 
==='''Objective Add Rule'''===


Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.
Sets up a game Objective with ID and display Name


'''<kuid:-25:968> Built-in Rule
'''<kuid:401543:2001> Base Rule'''


  '''Properties:'''
  '''Properties:'''
     Select one of two option buttons:-
     '''Priority ''<Select>''''' - select one of:-
    '''( ) Flash the ''<click to select>'' icon on the ''<click to select>'' HUD panel for a period of ''<value>'' seconds'''
      '''''Above Normal'''''
       TIP: Select the HUD panel first (the second ''<click to select>'' link).
      '''''Below Normal'''''
      Available HUD panels are (select one):-
       '''''Normal'''''
          '''Bottom Right Menu'''
      '''''Optional'''''
          '''Camera Controls'''
      '''''Urgent'''''
          '''DCC Controls'''
     '''Completion Target Number ''<value>''''' - to set Completion Target Number
          '''Driver Main Menu'''
    '''Icon ''<select>''''' - to select Icon from list
      Available icons will depend on the HUD panel selected.
    '''Display Name ''<enter>''''' - to insert Name
     '''( ) ''<Start/Stop>'' flashing the ''<click to select>'' icon on the ''<click to select>'' HUD panel'''
    '''Unique Objective ID ''<enter>''''' - enter a unique objective ID
      TIP: Select the HUD panel first (the second ''<click to select>'' link).
    '''Custom Message ''<Text Box>''''' - insert typed message in text area
      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]]''' - show or hide the Custom Heads Up Display.
     '''[[#Objective Check Rule|Objective Check Rule]]''' - checks if an objective is complete
    '''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
     '''[[#Objective Update Rule|Objective Update Rule]]''' - changes the progress of a game objective
     '''[[#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]]''' - waits for a click on the HUD Icon, then executes any following child rules.


==='''InputTable Rule'''===
==='''Objective Check Rule'''===


Creates a list of message names to be used for various purposes.
Checks if an objective created with the '''[[#Objective Add Rule|Objective Add Rule]]''' is complete, then executes any following child rules


'''<kuid2:131986:1012:1> Built-in'''
'''<kuid:401543:2003> Base Rule'''


  '''Properties:'''
  '''Properties:'''
    '''Unique Objective ID ''<value>''''' - enter the unique ID created with the '''Objective Add Rule'''
    '''Mode ''<select>''''' - select one of three option buttons:-
      '''''Wait for completion'''''
      '''''Wait for failure'''''
      '''''Wait for progress'''''
'''Related Rules:'''
    '''[[#Objective Add Rule|Objective Add Rule]]''' - sets up a game objective
    '''[[#Objective Update Rule|Objective Update Rule]]''' - changes the progress of a game objective


==='''Message Popup Rule'''===
==='''Objective Update 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.
Changes progress of an objective outcome created with the '''[[#Objective Add Rule|Objective Add Rule]]''' according to Property choices


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


  '''Properties:'''
  '''Properties:'''
     '''[Check Box] Pause game while message is displayed''' - stops the game until this message is switched off
     '''Unique Objective ID ''<value>''''' - enter the unique ID created with the '''Objective Add Rule'''  
    '''[Check Box] Close previous popup windows''' - closes any Message Popups currently displayed
    '''Mode ''<select>''''' - select one from the following options
    '''Message location ''<Top Left/Top Right/Bottom Left/Bottom Right>''''' - select one to position the browser window on the screen
      '''''Decrement progress'''''
    '''Message Source:''' - select one of three option buttons:-
      '''''Increment progress'''''
      '''( ) Custom text''' - the simplest and easiest option
       '''''Reset Objective'''''
          '''Icon ''<Click here to set>''''' - shows a list of message icons. Select one to be displayed with the message
      '''''Set objects as complete'''''
          '''Icon ''<Clear icon>''''' - clears any currently displayed message icon
      '''''Set objects as failed'''''
          '''Custom text box''' Enter text to be displayed. You will be limited to about 6 lines of text.
      '''''Set progress'''''
            For longer messages or to include graphics, use the '''A predefined HTML page''' option.
       '''''Set progress only if greater'''''
       '''( ) A predefined HTML page''' - requires a working knowledge of HTML
    '''Amount ''<value>''''' - click to enter a value
          '''''<HTML Asset>''''' - select the name of the HTML asset that contains the required HTML page from the list shown.
'''Related Rules:'''
          '''''<HTML Page>''''' - enter the filename of the HTML page to be displayed. The page must be in the HTML asset identified above.
    '''[[#Objective Add Rule|Objective Add Rule]]''' - sets up a game objective
              Filename is not case sensitive. Extension ".html" is optional.
     '''[[#Objective Check Rule|Objective Check Rule]]''' - checks if an objective is complete
          '''''<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>''''' - <function unknown at present>
          '''''<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 Rule:'''
     '''[[#Close Message Popup Rule|Close Message Popup Rule]]''' - closes a displayed pop-up browser window.


==='''Minimap Options Rule'''===
==='''Ordered List Rule'''===


Sets the display options for the minimap.
Child rules will be executed in order once this rule starts


'''<kuid:-25:636> Built-in Rule'''
'''<kuid:-25:171> Built-in Rule'''


  '''Properties:''' ''Default values - all checked''
  '''Properties:'''
     '''[Check Box] Map Textures'''
  Select one of two option buttons:-
     '''[Check Box] Gradients'''
  '''( ) This process will repeat ''<value>'' time(s)''' - enter the number of times this rule is to be repeated
     '''[Check Box] Junctions'''
  '''( ) This process will repeat forever'''
     '''[Check Box] Signals'''
'''Related Rules:'''
    '''[Check Box] Triggers'''
     '''[[#Progressive List Rule|Progressive List Rule]]''' - first child rule will be executed on the first run of this rule, the second child executed on the second run, etc
    '''[Check Box] Markers'''
     '''[[#Random List Rule|Random List Rule]]''' - one of the child rules will be randomly selected and executed
    '''[Check Box] Trackside Labels'''
     '''[[#Reset List Rule|Reset List Rule]]''' - Resets and starts all child rules
    '''[Check Box] Terrain Objects'''
     '''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - all child rules are executed simultaneously
    '''[Check Box] Industrial Names'''
 
    '''[Check Box] Named Objects'''
'''[[#top|Back to Top]]''' |  '''[[#A, B, C|A, B, C]]''' |  '''[[#D, E|D, E]]''' |  '''[[#F, G|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|S]]''' | '''[[#T, U, V|T, U, V]]''' |  '''[[#W, X, Y, Z|W, X, Y, Z]]'''
    '''[Check Box] Consists'''
 
  '''Related Rules:'''
=='''P, Q'''==
    '''[[#Show/Hide Minimap Rule|Show/Hide Minimap Rule]]''' - shows the minimap window in Driver.


==='''Play Sound Rule'''===
==='''Play Sound Rule'''===
Line 1,042: Line 964:
       '''sound has just started'''
       '''sound has just started'''
       '''sound has finished playing'''
       '''sound has finished playing'''
'''Related Rules:'''
    '''[[#Display Video Rule|Display Video Rule]]] - displays a page containing a video clip from a HTML asset in a browser window


==='''Session Metadata Rule'''===
==='''Power Station Rule'''===


Sets session metadata in the config file. Info can be read by other systems and displayed to the player.
Sets up a Power Station and its electricity consumers


'''<kuid:401543:2036> Base Rule'''
'''<kuid:-25:746> Base Rule'''


  '''Properties:'''
  '''Properties:'''
     '''Type ''<Click>''''' - click to select one of:-
     '''Power station ''<select>''''' - select a Power Station from the session list.
      '''Simulation'''
    '''Consumers:'''
       '''Challenge'''
       '''''<add object>''''' - add power consumers from the session list
    '''Length ''<value>''''' - to enter number of minutes, default is 30 minutes
 
    '''Difficulty ''<Click>''''' - click to select one of:-
==='''Progressive List Rule'''===
      '''Normal''' - default
      '''Tutorial'''
      '''Easy'''
      '''Hard'''
      '''Expert'''
'''Note:''' Time is Trainz clock time, not real time


==='''Set Helper Icon Size Rule'''===
The first child rule will be executed on the first run of this rule, the second child executed on the second run, etc.


Sets the size of helper icons such as the junction lever arrows.
'''<kuid:-25:754> Built-in Rule'''
 
'''<kuid:-25:791> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
   '''Junction Arrows Size ''<Click>''''' - to set scale ratio smaller than default, default is 100%
   '''After last child has been executed ...'''
  '''''<successive runs will do nothing/the first child is chosen again>''''' - click to select one
'''Related Rules:'''
    '''[[#Ordered List Rule|Ordered List Rule]]''' - child rules will be executed in order
    '''[[#Random List Rule|Random List Rule]]''' - one of the child rules will be randomly selected and executed
    '''[[#Reset List Rule|Reset List Rule]]''' - Resets and starts all child rules
    '''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - all child rules are executed simultaneously


==='''Set HTML Pages Rule'''===
==='''Quick Session Variables Rule'''===


Instructs the Display HTML Pages rule to perform specific operations. This rule has been superseded by the '''[[#Message Popup Rule|Message Popup Rule]]'''
Allows the editing of any session variables


'''<kuid:-25:792> Built-in'''
'''<kuid2:61392:5003:30> DLS Rule''' by '''pguy'''


  '''Properties:'''
  '''Properties:'''
     '''Operations to preform on the display HTML pages sequence browser'''
     '''''<local>''''' - click to edit local variables
    Select one of six option buttons:-
       '''''<add new session variable>''''' - click to enter the name of new local variable
       '''( ) to instruct the sequence browser to ''<select>''''' - to choose page operations
          for each variable:-
      '''( ) to instruct the sequence browser to open the page ''<select>''''' - enter the HTML page name
          '''''<variable-name>''''' - click to change variable name
      '''( ) to set browser parameters ''<select>''''' - choose one of:-
          '''''<type>''''' - click to select one of:-
          '''to Enable/Disable closing of the browser window by the user'''
            '''string''' - text characters
          '''to Enable/Disable scrolling on the sequence browser window'''
            '''int''' - integer
          '''to Show/Hide the sequence browser window'''
            '''float''' - real (decimal) numbers
      '''( ) Set the following flag for the page named ''<select>''''' - enter the HTML page name
            '''bool''' - boolean (true/false)
          '''[Check Box] Hide/Close window on 'done' action'''
            '''stringset''' - ''meaning not known at this time''
          '''[Check Box] Window has no 'done' button'''
            '''stringlist''' - ''meaning not known at this time''
          '''[Check Box] Disable scrolling(not implemented yet)'''
            '''tkmlist''' - trackmark list (no longer supported in TANE SP2)
          '''[Check Box] Spare setting 1'''
            '''platformlist''' - platform list (no longer supported in TANE SP2)
          '''[Check Box] Spare setting 2'''
            '''''del''''' - delete variable
           '''[Check Box] Spare setting 3'''
            '''''edit''''' - edit variable
           '''[Check Box] Spare setting 4'''
    '''''<trains>''''' - click to edit a train variable
           '''[Check Box] Spare setting 5'''
      '''''<train selected>''''' - click to select a train from the session list. Initially none is selected
      '''( ) Use the page ''<select>''''' (enter HTML page name) '''from the HTML asset ''<select>''''' (select HTML asset)
           '''''<select train>''''' - click to select a locomotive
      '''( ) Use the string table entry ''<select>''''' (enter Index) '''from the HTML asset ''<select>''''' (select HTML asset)
           '''''<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 SP2
        '''''<global>''''' - no longer supported in SP2
'''Note:''' Rule creator, '''pguy''' has indicated that the future of this rule is uncertain as parts of it have been devalued in the latest release of TANE.
  '''Related Rules:'''
  '''Related Rules:'''
     '''[[#Display HTML Pages Rule|Display HTML Pages Rule]]''' - displays HTML pages in a browser window.
'''[[#Variable Check Rule}Variable Check Rule]] - tests the value of a specified variable.
     '''[[#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.
    '''[[#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.
==='''QuickDrive Rule'''===


==='''Show/Hide HUD Panel Rule'''===
Change the Session settings and add consists in Driver


Shows or hides a HUD panel.
'''<kuid:401543:1184> Base Rule'''
 
'''<kuid:-25:1047> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
    '''''<Show/Hide>'' the ''<click to select>'' HUD panel''' - select '''''Show''''' or '''''Hide''''' and then select the HUD panel
  '''Open QuickDrive window when session is started          [Check Box]''' - check to set
'''Related Rules:'''
  '''Set time to ''<hours:minutes>'' with a rate of ''<speed x>''''' - set start time and rate at which time advances
    '''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - show or hide the Custom Heads Up Display.
  '''Enable gameplay Session Mode                            [Check Box]''' - check to set. Gameplay mode restricts the players options
    '''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
  '''Enable in game help by default                          [Check Box]''' - check to allow help options to be displayed
    '''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
  '''Set the default Control method to:''' - select one of two option buttons:-
    '''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - waits for a click on the HUD Icon, then executes any following child rules.
      '''( ) 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'''
 
'''[[#top|Back to Top]]''' |  '''[[#A, B, C|A, B, C]]''' |  '''[[#D, E|D, E]]''' |  '''[[#F, G|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|S]]''' |  '''[[#T, U, V|T, U, V]]''' |  '''[[#W, X, Y, Z|W, X, Y, Z]]'''
 
=='''R'''==


==='''Show/Hide Layer Rule'''===
==='''Random List Rule'''===


Shows or hides a layer from Driver.
One of the child rules will be randomly selected and executed. The rule will not repeat to randomly select another child rule


'''<kuid2:401543:1170:1> Built-in'''
'''<kuid:-25:758> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
  '''''<visibility>''''' - select one of two options
    '''None'''
      '''Show''' - select to make the layer visible
'''Related Rules:'''
      '''Hide''' - select to make the layer invisible
    '''[[#Ordered List Rule|Ordered List Rule]]''' - child rules will be executed in order
  '''''<click here to set>''''' - enter name of layer. Name is case sensitive.
    '''[[#Progressive List Rule|Progressive List Rule]]''' - first child rule will be executed on the first run of this rule, the second child executed on the second run, etc
'''Known Bugs:'''
    '''[[#Reset List Rule|Reset List Rule]]''' - Resets and starts all child rules
  TANE (all versions) - layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded
    '''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - all child rules are executed simultaneously
   
==='''Randomize Rule'''===


==='''Show/Hide Minimap Rule'''===
Generates a different set of random numbers each time the session is run.


Shows the minimap window in Driver.
'''<kuid:169301:100129> DLS Rule''' by '''Terry_Wagstaff'''
 
'''<kuid:-25:794> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''''<Show/Hide>'' the driver Minimap Window''' - click to switch between '''Show''' and '''Hide'''.
     '''None'''
'''Note:''' 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:'''
  '''Related Rules:'''
     '''[[#Minimap Options Rule|Minimap Options Rule]]''' - sets the display options for the minimap.
     '''[[#Variable Random|Variable Random]]''' - sets a variable to a random value.


==='''Show/Hide On-screen Help Rule'''===
==='''Ranked Session Begin Rule'''===


Shows or hides On-screen help in Driver.
Begins a ranked Session


'''<kuid:401543:2020> Built-in Rule'''
'''<kuid:401543:2031> Base Rule'''


  '''Properties:'''
  '''Properties:'''
     '''On screen help (junction overlays, etc)''' - select one of three option buttons:-
     '''Countdown Starting Value ''<value>'''''
       '''( ) Show
      '''''hrs:'''''
       '''( ) Hide
       '''''min:'''''
      '''( ) Leave Unchanged
       '''''sec:'''''
     '''On Screen Vehicle Names:''' -  - select one of three option buttons:-
    '''1 through 5 stars, points for each star ''<value>''''' - enter number of points for each star rating
       '''( ) Show
     '''Session timer mode:''' - select one of three option buttons:-
       '''( ) Hide
       '''( ) Timer'''
       '''( ) Leave Unchanged
       '''( ) Countdown Starting value ''<value>''''' - enter time ''hh:mm:ss''
       '''( ) None'''
'''Note:''' Times are Trainz clock time, not real time
'''Related Rules:'''
    '''[[#Ranked Session Complete Rule|Ranked Session Complete Rule]]''' - completes the active ranked Session


==='''Timed limited display HTML Rule (SP2 and later)'''===
==='''Ranked Session Complete Rule'''===


Displays an HTML browser window for a limited time.
Completes the active ranked Session


'''<kuid2:61392:2005:32> DLS Rule''' by '''pguy'''
'''<kuid:401543:2032> Base Rule'''


  '''Properties:'''
  '''Properties:'''
  '''HTML Asset Name : ''<[Click to select HTML asset]>''''' - click to select an HTML asset from those installed
    '''Set the active ranked session as:''' - select one of two option buttons:-
  '''Page filename : ''<value>''''' - click to enter the filename of the HTML page in the selected HTML asset. The ''.html'' filename extension is optional.
      '''( ) Complete'''
  '''Play duration (SessVar or duration in seconds) : ''<value>''''' - enter a SessVar name or the number of seconds.
      '''( ) Failed'''
  '''Browser left position (SessVar or position) : ''<value>''''' - enter a SessVar name or the number of pixels from the left screen edge.
    '''[Check Box] Customize the completion message ''<text>''''' - enter a text message
  '''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.
'''Note:''' Seconds are Trainz clock time, not real time.
  '''Related Rules:'''
  '''Related Rules:'''
     '''[[#Close Message Popup Rule|Close Message Popup Rule]]''' - closes open message popups
     '''[[#Ranked Session Begin Rule|Ranked Session Begin Rule]]''' - begins a ranked Session
    '''[[#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.
==='''Replace Missing Vehicles Rule'''===
    '''[[#Set HTML Page Rule|Set HTML Page Rule]]''' - sets parameters for the '''[[#Display HTML Pages Rule|Display HTML Pages Rule]]'''
==='''Wait for Click on HUD Icon Rule'''===


Waits for a click on the HUD Icon, then executes any following child rules
Produces new trains to replace missing vehicles that have been removed from the session by the '''[[#Clean Up Derailed Trains Rule|Clean Up Derailed Trains Rule]]'''


'''<kuid:-25:951> <kuid:-25:970> Built-in''' - two versions built-in with different kuids, both have the same properties
'''<kuid:447264:1214> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''[Check Box] Trigger Once'''
     '''[Check Box] Respawn trains if they are abandoned for 10 minutes'''
     '''HUD Panel ''<Click>''''' - click choose from list:-
     If checked:-
       '''Bottom Right Menu'''
       Select one of two option buttons:-
      '''Camera Controls'''
          '''( ) Respawn trains at their original locations'''
      '''DCC Controls'''
          '''( ) Respawn trains from portals'''
    '''Icon ''<Click>''''' - click to choose from list. Selections depends on HUD Panel chosen
            '''''<+ Add a new portal>''''' - click to enter the name of a portal, there can be more than one portal.
            Entered portal names that appear in red have not been found in the session
  '''Related Rules:'''
  '''Related Rules:'''
     '''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - show or hide the Custom Heads Up Display.
     '''[[#Clean Up Derailed Trains Rule|Clean Up Derailed Trains Rule]]''' - cleans up derailed train cars after a set time delay
    '''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
     '''[[#Wait for Derailment Rule|Wait for Derailment Rule]]''' - executes child rules if a derailment occurs
     '''[[#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.
==='''Reset List Rule'''===
==='''Wait on Waybill Screen/Main Screen Rule'''===


Waits for the Waybill window to be opened or closed, then executes any following child rules
Resets and starts all child rules in an ongoing infinite cycle


'''<kuid:-25:957> Built-in Rule'''
'''<kuid:-25:762> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''[Check Box] Trigger rule once''' - check to trigger the rule once only
     '''None'''
    '''Wait for the Waybill window to be ''<opened/closed>''''' - select either '''opened''' or '''closed'''.
'''Related Rules:'''
    '''[[#Ordered List Rule|Ordered List Rule]]''' - child rules will be executed in order
    '''[[#Progressive List Rule|Progressive List Rule]]''' - first child rule will be executed on the first run of this rule, the second child executed on the second run, etc
    '''[[#Random List Rule|Random List Rule]]''' - one of the child rules will be randomly selected and executed


'''[[#top|Back to Top]]'''
==='''Resource Check Rule'''===


=='''Navigation Rules'''==
Check the progress of the amount of a resource and target object, then executes any following child rules. This rule has been superseded by the '''[[#Multiple Resource Check Rule|Multiple Resource Check Rule]]'''


==='''DestSign Table Rule'''===
'''<kuid:-25:1067> Built-in Rule'''


Creates a list of destination names for a destination sign
'''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'''
'''Related Rules:'''
    '''[[#Multiple Resource Check Rule|Multiple Resource Check Rule]]''' - checks specified resources in a selected industries or vehicles reaches set levels, then executes any following child rules.


'''<kuid2:206816:99004:2> Built-in Rule'''
'''[[#top|Back to Top]]''' |  '''[[#A, B, C|A, B, C]]''' |  '''[[#D, E|D, E]]''' |  '''[[#F, G|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|S]]''' |  '''[[#T, U, V|T, U, V]]''' |  '''[[#W, X, Y, Z|W, X, Y, Z]]'''


'''Properties:'''
=='''S'''==
  '''''<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


==='''Interlocking Tower Configure Path'''===
==='''Safety System Engaged Check Rule'''===


Alters settings on an interlocking tower path
Checks for safety systems making penalty applications on users and, if found, then executes any following child rules.


'''<kuid:401543:3205> Base Rule'''  
'''<kuid:447264:1216> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
  '''Interlocking Tower ''<select>''''' - to set Name and Objects
    '''[Check Box] Trigger only once'''
  '''Related Rules:'''
  '''Related Rules:'''
     '''[[#Interlocking Tower Path Selection UI|Interlocking Tower Path Selection UI]]''' - automatically reacts to messages from Interlocking Towers and displays a path selection dialog to the player.
     '''[[#Safety System Isolated Check Rule|Safety System Isolated Check Rule]]''' - executes child rules if safety systems have been isolated by user
    '''[[#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'''===
==='''Safety System Isolated Check Rule'''===


Will automatically react to messages from Interlocking Towers and display a path selection dialog to the player. Disable by removing rule from session
Checks for safety systems being isolated by users and, if found, then executes any following child rules.


'''<kuid:401543:3203> Base Rule'''
'''<kuid:447264:1217> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
  '''[Checkbox] Show path activation message in Driver'''
    '''[Check Box] Trigger only once'''
  '''Related Rules:'''
  '''Related Rules:'''
     '''[[#Interlocking Tower Configure Path|Interlocking Tower Configure Path]]''' - alters the settings on an interlocking tower path
     '''[[#Safety System Engaged Check Rule|Safety System Engaged Check Rule]]''' - executes child rules if safety systems have been engaged by user
    '''[[#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 Set Path Rule'''===
==='''Schedule Rule'''===


Will set the state of an interlocking tower path for a train
Allows a schedule of timed events to be applied to a train


'''<kuid:401543:3204> Base Rule'''
'''<kuid:-3:10185> Base Rule'''


  '''Properties:'''
  '''Properties:'''
  '''Interlocking Tower ''<select>''''' - to set Name and Objects
    '''Insert track mark ''<select>''''' - select a track mark from the Session List
'''Related Rules:'''
    '''Arrival and Departure Time ''<Select>''''' - set time
     '''[[#Interlocking Tower Configure Path|Interlocking Tower Configure Path]]''' - alters the settings on an interlocking tower path
      '''''hh:mm:ss''''' - in hours/minutes/seconds
     '''[[#Interlocking Tower Path Selection UI|Interlocking Tower Path Selection UI]]''' - automatically reacts to messages from Interlocking Towers and displays a path selection dialog to the player.
     '''Current Train ''<select>''''' - select from session list
    '''[[#Interlocking Tower Enhanced Manager Rule (SP2 and later)|Interlocking Tower Enhanced Manager Rule (SP2 and later)]]''' - more management and control options for interlocking towers.
     '''Insert destination ''<select>''''' - select from session list
'''Note:''' Times are Trainz clock times, not real time


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


Provides more management and control options for interlocking towers.
Set session to a percentage of completion.


'''<kuid2:61392:8130:40> DLS Rule''' by '''pguy'''
'''<kuid:447264:1011> Base Rule'''


  '''Properties:'''
  '''Properties:'''
    '''Set session to percent complete ''<value>''''' - enter number as a percentage
    '''[Check Box] Separate achievements for completion''' - check to set
  '''Related Rules:'''
  '''Related Rules:'''
     '''[[#Interlocking Tower Configure Path|Interlocking Tower Configure Path]]''' - alters the settings on an interlocking tower path
     '''[[#End Session Rule|End Session Rule]]''' - end the Session with a fade out.
    '''[[#Interlocking Tower Path Selection UI|Interlocking Tower Path Selection UI]]''' - 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


==='''Multiple Junction Alignment Check Rule'''===
==='''Session Debug Rule'''===


Checks junctions are set or in alignment, then executes any following child rules.
Executes the first child if ''Debug'' mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.


'''<kuid:-25:168> Built-in Rule'''
'''<kuid:30501:100180> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''Wait until ''<selection>''''' - select from:-
     '''None'''
      '''any one''' - any of the junctions in the rule list (below) is set correctly
'''Note:''' When a session starts with this rule enabled, the player will be given the choice of running the session in '''''Debug''''' or '''''Normal''''' mode.
      '''all''' - ALL of the junctions in the rule list are set correctly
     Selecting ''Debug'' will execute the first child rule. Selecting ''Normal'' will execute the second child rule.
    '''''<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:'''
     '''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets junctions to specific directions, locks and unlocks junctions, allows or denies AI control.
     '''[[#Generic TreeNode Debug Window Rule|Generic TreeNode Debug Window Rule]]''' - no description


==='''Navigation Display Rule'''===
==='''Session Metadata 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.
Sets session metadata in the config file. Info can be read by other systems and displayed to the player.


'''<kuid2:401543:1161:1> Base Rule'''
'''<kuid:401543:2036> 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.
     '''Type ''<Click>''''' - click to select one of:-
    '''Train (optional): ''<click here to set>''''' - select a rolling stock asset from the session list shown.
      '''Simulation'''
    Select one of three option buttons:-
       '''Challenge'''
    '''( ) All points must be completed in sequence:'''
     '''Length ''<value>''''' - to enter number of minutes, default is 30 minutes
       - the first uncompleted navigation point will be shown and must be completed next.
    '''Difficulty ''<Click>''''' - click to select one of:-
      - the next point (if any) will also be shown but at a lower opacity.
      '''Normal''' - default
    '''( ) Points will be completed in sequence, but can be skipped:'''
      '''Tutorial'''
      - navigation points can be skipped but must be completed in order.
      '''Easy'''
      - you cannot go back to complete a missed point.
      '''Hard'''
     '''( ) All points must be completed, but in any order:'''
      '''Expert'''
      - all uncompleted navigation points will be shown.
  '''Note:''' Time is Trainz clock time, not real time
      - 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:'''
    '''[[#Navigation Set Hide/Show rule|Navigation Set Hide/Show rule]]''' - makes a navigation set visible/invisible.
    '''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - checks if a navigation set is complete or incomplete.
    '''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
    '''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.
    '''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' -  checks if a specific navigation point in a set has been completed.


==='''Navigation Point Complete Rule'''===
==='''Set Camera Rule'''===


Manually completes a navigation point in a set
Sets the target object and properties of the camera.


'''<kuid:401543:1167> Base Rule'''
'''<kuid:-25:179> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''Mark navigation point ''<click here to set>''''' - enter the navigation point number to be completed
     '''[Check Box] Set the target object of the camera to:''' - if checked, select one of three option buttons:-
    '''complete in set ''<click here to set>''''' - enter the unique name for the navigation set created using the '''[[#Navigation Display Rule|Navigation Display Rule]]'''.
      '''( ) Vehicle ''<click to select>''''' - select a vehicle from the Session list
        Name must be in lowercase and have no spaces.
      '''( ) Junction ''<click to select>''''' - select a junction from the Session list
'''Known Issues:'''
      '''( ) Map Object ''<click to select>''''' - select a named map object from the Session list
     The rule will '''NOT''' check to see if the named navigation set and point exists or not.
    '''[Check Box] Change the camera view mode to ''<click to select>''''' - if checked, select one camera view mode from
'''Related Rules:'''
      '''Cab View'''
    '''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
      '''External View'''
    '''[[#Navigation Set Hide/Show rule|Navigation Set Hide/Show rule]]''' - makes a navigation set visible/invisible.
      '''Tracking View'''
     '''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - checks if a navigation set is complete or incomplete.
      '''Free Roaming'''
     '''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
     '''[Check Box] Set the camera flags to enable/disable user access to''' - if checked, select as many of the following check boxes as needed
     '''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - checks if a specific navigation point in a set has been completed.
      '''[Check Box] Internal view mode''' - check to enable, uncheck to disable
 
      '''[Check Box] External view mode''' - check to enable, uncheck to disable
==='''Navigation Set Check Rule'''===
      '''[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:'''
     '''[[#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]]''' - waits for the camera to be changed to the designated view, then executes any following child rules
 
==='''Set Coupler Masks Rule'''===


Checks if a navigation set is complete or incomplete, then executes any following child rules
Set the coupling/decoupling  masks on the selected vehicles


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


  '''Properties:'''
  '''Properties:'''
     '''Checks if navigation point set ''<name>'':''' - enter the unique name for the navigation set created using the '''[[#Navigation Display Rule|Navigation Display Rule]]'''.
     '''''<Add vehicle>''''' - click to select a vehicle from the session list
        Name must be in lowercase and have no spaces.
    '''''<Add All>''''' - click to add all vehicles in the session list
     '''is ''<Complete/Incomplete>''''' - click to select one
     '''''<Delete All>''''' - click to remove all added vehicles from this rule
'''Known Issues:'''
      For each selected vehicle:-
    The rule will '''NOT''' check to see if the named navigation set exists or not.
      '''Coupling Mask'''
'''Related Rules:'''
          '''Front''' and '''Back''' - choose for each
    '''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
            '''''Locked'''''
    '''[[#Navigation Set Hide/Show rule|Navigation Set Hide/Show rule]]''' - makes a navigation set visible/invisible.
            '''''Unlocked'''''
    '''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
      '''Decoupling Mask'''
     '''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.
          '''Front''' and '''Back''' - choose for each
     '''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - checks if a specific navigation point in a set has been completed.
            '''''Locked'''''
            '''''Unlocked'''''
      '''''<Remove>''''' - click to remove this vehicle from the rule
'''Related Rules:'''
     '''[[#Coupler Breakage Check Rule|Coupler Breakage Check Rule]]''' - executes child rules when a breakage occurs
     '''[[#Coupler Breakage HUD Rule|Coupler Breakage HUD Rule]]''' - adds a coupler stress and breakage warning to the HUD


==='''Navigation Set Clear Rule'''===
==='''Set Helper Icon Size Rule'''===


Clears a navigation set removing any uncompleted navigation points
Sets the size of helper icons such as the junction lever arrows.


'''<kuid:401543:1164> Base Rule'''
'''<kuid:-25:791> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
    '''''<Click here to set>''''' - enter the unique name for the navigation set created using the '''[[#Navigation Display Rule|Navigation Display Rule]]'''.
  '''Junction Arrows Size ''<Click>''''' - to set scale ratio smaller than default, default is 100%
        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:'''
    '''[[#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]]''' - checks if a navigation set is complete or 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]]''' -  checks if a specific navigation point in a set has been completed.


==='''Navigation Set Hide/Show'''===
==='''Set HTML Pages Rule'''===


Shows and hides navigation sets. You can have multiple sets visible and hidden at the same time.
Instructs the Display HTML Pages rule to perform specific operations. This rule has been superseded by the '''[[#Message Popup Rule|Message Popup Rule]]'''


'''<kuid:401543:1163> Base rule'''
'''<kuid:-25:792> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''''<visibility>''''' - click to select one
     '''Operations to preform on the display HTML pages sequence browser'''
       '''Hide''' - select to make the navigation set invisible
    Select one of six option buttons:-
      '''Show''' - select to make the navigation set visible
      '''( ) to instruct the sequence browser to ''<select>''''' - to choose page operations
    '''''<click here to set>''''' - enter the unique name for the navigation set created using the '''[[#Navigation Display Rule|Navigation Display Rule]]'''.
      '''( ) to instruct the sequence browser to open the page ''<select>''''' - enter the HTML page name
        Name must be in lowercase and have no spaces.
       '''( ) to set browser parameters ''<select>''''' - choose one of:-
'''Known Issues:'''
          '''to Enable/Disable closing of the browser window by the user'''
    The rule will '''NOT''' check to see if the named navigation set exists or not.
          '''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)
  '''Related Rules:'''
  '''Related Rules:'''
     '''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
     '''[[#Display HTML Pages Rule|Display HTML Pages Rule]]''' - displays HTML pages in a browser window.
     '''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - checks if a navigation set is complete or incomplete.
     '''[[#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.
    '''[[#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]]''' - checks if a specific navigation point in a set has been completed.
 
==='''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
'''Note:''' Times are Trainz clock times, not real time


==='''Set Junctions Rule'''===
==='''Set Junctions Rule'''===
Line 1,475: Line 1,411:
  '''Note:''' The signal must support the state selected otherwise there will be no change in the signal
  '''Note:''' The signal must support the state selected otherwise there will be no change in the signal


==='''Trackside Check Rule'''===
==='''Show/Hide HUD Panel Rule'''===


Similar to the '''[[#Trigger Check Rule|Trigger Check Rule]]''' but provides other options. If the rule is satisfied then it will execute any following child rules
Shows or hides a HUD panel.


'''<kuid2:46162:100207:1> DLS Rule''' by '''Josefpav'''
'''<kuid:-25:1047> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''Applies to:''' - select one of three option buttons:-
     '''''<Show/Hide>'' the ''<click to select>'' HUD panel''' - select '''''Show''''' or '''''Hide''''' and then select the HUD panel
      '''( ) Junction'''
'''Related Rules:'''
      '''( ) Trigger'''
     '''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - show or hide the Custom Heads Up Display.
      '''( ) Trackmark'''
     '''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
    '''Trackside object name: ''<specify>''''' - select object name from session list
     '''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
    '''Wait for train to:''' - select one of three option buttons:-
     '''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - waits for a click on the HUD Icon, then executes any following child rules.
      '''( ) 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:'''
     '''[[#Trigger Check Rule|Trigger Check Rule]]''' - waits for a specific train or any train to enter one of the designated triggers, then executes any following child rules.


==='''Trigger Check Rule'''===
==='''Show/Hide Layer Rule'''===


Waits for a specific train or any train to enter one of the designated triggers, then executes any following child rules. This rule replaces the older and less versatile "Trigger Rule".
Shows or hides a layer from Driver.


'''<kuid:-25:1071> Built-in Rule'''
'''<kuid2:401543:1170:1> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
    '''[Check Box] Trigger only once '''
  '''''<visibility>''''' - select one of two options
    '''[Check Box] Wait for child rules to complete even if no trains are present in rule trigger'''
      '''Show''' - select to make the layer visible
    '''[Check Box] Only activate when the entering vehicle of the train is heading ''<select direction>'' into the trigger''' - select one of two directions:-
      '''Hide''' - select to make the layer invisible
      '''''forward'''''
  '''''<click here to set>''''' - enter name of layer. Name is case sensitive.
      '''''backward'''''
'''Known Bugs:'''
    '''Triggers List'''
Layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded
      '''''<add trigger>''''' - select a trigger from the session list
  '''Known Issues:'''
      '''''<delete trigger>''''' - delete a selected trigger from the rule
Rule will NOT check to see if the named layer exists or not
    Select one of two option buttons:-
 
      '''( ) click to accept all trains'''
==='''Show/Hide Minimap Rule'''===
      '''( ) 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:'''
    '''[[#Trackside Check Rule|Trackside Check Rule]]''' - similar but provides other options.
 
==='''Wait on Navigation Point Rule'''===


Waits for a navigation point to be completed, then executes any following child rules
Shows the minimap window in Driver.


'''<kuid:401543:1168> Base Rule'''
'''<kuid:-25:794> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''navigation point ''<click here to set>''''' - enter the number of the navigation point to be completed
     '''''<Show/Hide>'' the driver Minimap Window''' - click to switch between '''Show''' and '''Hide'''.
    '''in set ''<click here to set>''''' - enter the unique name for the navigation set created using the '''[[#Navigation Display Rule|Navigation Display Rule]]'''.
      Name must be in lowercase and have no spaces.
'''Known Issues:'''
    The rule will '''NOT''' check to see if the named navigation set and point exists or not.
  '''Related Rules:'''
  '''Related Rules:'''
     '''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
     '''[[#Minimap Options Rule|Minimap Options Rule]]''' - sets the display options for the minimap.
    '''[[#Navigation Set Hide/Show rule|Navigation Set Hide/Show rule]]''' - makes a navigation set visible/invisible.
    '''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - checks if a navigation set is complete or incomplete.
    '''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
    '''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.


==='''Wait on Train Stop/Start Rule'''===
==='''Show/Hide On-screen Help Rule'''===


Wait for a train to stop or start, then executes any following child rules
Shows or hides On-screen help in Driver.


'''<kuid:-25:1069> Built-in Rule'''
'''<kuid:401543:2020> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''[Check Box] Trigger rule once'''
     '''On screen help (junction overlays, etc)''' - select one of three option buttons:-
    '''Wait for a train that matches the following criteria to ''<select>''''' - select one of:-
       '''( ) Show
      '''''start moving'''''
       '''( ) Hide
      '''''stop moving'''''
      '''( ) Leave Unchanged
    Select one of two option buttons:-
    '''On Screen Vehicle Names:''' - - select one of three option buttons:-
       '''( ) click to accept all trains'''
      '''( ) Show
       '''( ) click to accept trains matching specific criteria'''
      '''( ) Hide
          Selecting the second option will produce the following selection controls:-
      '''( ) Leave Unchanged
          '''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]]'''
==='''Signal Passed At Danger Check Rule'''===


=='''Session Debug Rules'''==
Checks for Drivers passing signals at danger (stop) and, if found, then executes any following child rules.


==='''Generic TreeNode Debug Window Rule'''===
'''<kuid2:60850:89007:2> Built-in Rule


No description.
'''Properties:'''
    '''[Check Box] Trigger only once'''


'''<kuid:30501:1042> Base Rule'''
==='''Simultaneous List Rule'''===


'''Properties:'''
Child rules are executed simultaneously once this rule starts
'''Note:''' I have been unable to find any references to this rule in Trainz except for the fact that it exists as a session rule.
'''Related Rules:'''
    '''[[#Session Debug Rule|Session Debug Rule]]''' - executes the first child if debug mode is selected, otherwise the second child rule is executed


==='''Session Debug Rule'''===
'''<kuid:-25:1048> Built-in Rule'''
 
Executes the first child if ''Debug'' mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.
 
'''<kuid:30501:100180> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''None'''
     '''Rule completes when ...''' - click to chose one of the following:-
'''Note:''' When a session starts with this rule enabled, the player will be given the choice of running the session in '''''Debug''''' or '''''Normal''''' mode.
      '''''one of the child rules has completed'''''
    Selecting ''Debug'' will execute the first child rule. Selecting ''Normal'' will execute the second child rule.
      '''''all child rules have reached a completed state'''''
      '''''all child rules have reached a "was completed" state'''''
  '''Related Rules:'''
  '''Related Rules:'''
     '''[[#Generic TreeNode Debug Window Rule|Generic TreeNode Debug Window Rule]]''' - no description
     '''[[#Ordered List Rule|Ordered List Rule]]''' - child rules will be executed in order
    '''[[#Progressive List Rule|Progressive List Rule]]''' - first child rule will be executed on the first run of this rule, the second child executed on the second run, etc
    '''[[#Random List Rule|Random List Rule]]''' - one of the child rules will be randomly selected and executed
    '''[[#Reset List Rule|Reset List Rule]]''' - Resets and starts all child rules


'''[[#top|Back to Top]]'''
==='''Speeding Check Rule'''===


=='''Session Sequence Rules'''==
If player controlled trains are over the local speed limit or over a set (custom) speed, then executes any following child rules


==='''Ordered List Rule'''===
'''<kuid2:60850:89004:3> Built-in Rule
 
Child rules will be executed in order once this rule starts
 
'''<kuid:-25:171> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
  Select one of two option buttons:-
    Select one of two options to set a speed limit to be observed
  '''( ) This process will repeat ''<value>'' time(s)''' - enter the number of times this rule is to be repeated
      '''( ) Watch for trains travelling above the posted speed limit'''
  '''( ) This process will repeat forever'''
          '''''<speed value>''''' - click to enter a new overspeed tolerance value
'''Related Rules:'''
          '''''<speed units>''''' - click to select one from the list:-
    '''[[#Progressive List Rule|Progressive List Rule]]''' - first child rule will be executed on the first run of this rule, the second child executed on the second run, etc
            '''''Km/h''''' - Kilometres per hour
    '''[[#Random List Rule|Random List Rule]]''' - one of the child rules will be randomly selected and executed
            '''''MPH''''' - Miles per hour
    '''[[#Reset List Rule|Reset List Rule]]''' - Resets and starts all child rules
            '''''mps''''' - metres per second
    '''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - all child rules are executed simultaneously
      '''( ) 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'''


==='''Progressive List Rule'''===
==='''Startup Options Rule'''===


The first child rule will be executed on the first run of this rule, the second child executed on the second run, etc.
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|Weather Rule]]'''.


'''<kuid:-25:754> Built-in Rule'''
'''<kuid:-16:10212> Base Rule'''


  '''Properties:'''
  '''Properties:'''
  '''After last child has been executed ...'''
    '''Current control method is ''<select>''''' - select one from:-
  '''''<successive runs will do nothing/the first child is chosen again>''''' - click to select one
      '''''Easy Mode''''' - standard keyboard control
'''Related Rules:'''
      '''''Ask User''''' - let the user decide
    '''[[#Ordered List Rule|Ordered List Rule]]''' - child rules will be executed in order
      '''''Realistic Mode''''' - on screen levers, throttles, buttons, etc
     '''[[#Random List Rule|Random List Rule]]''' - one of the child rules will be randomly selected and executed
    '''Set weather to ''<select mode>'' with ''<select frequency>'' changeability''' - select
    '''[[#Reset List Rule|Reset List Rule]]''' - Resets and starts all child rules
      '''Weather mode:''' - select one of:-
     '''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - all child rules are executed simultaneously
          '''''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
'''Note:''' Times are Trainz clock time, not real time
'''Related Rules:'''
     '''[[#Weather Rule|Weather Rule]]''' - changes weather conditions during Session play


==='''Random List Rule'''===
==='''Station Visited Check Rule'''===


One of the child rules will be randomly selected and executed. The rule will not repeat to randomly select another child rule
Waits for a designated train or any train to call at one of the designated stations or industries, then executes any following child rules


'''<kuid:-25:758> Built-in Rule'''
'''<kuid2:60850:89005:3> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''None'''
     '''Trigger: ''<select>''''' - click to select one of the following
'''Related Rules:'''
      '''''Never''''' - stopping at the selected industries will never trigger the rule.
    '''[[#Ordered List Rule|Ordered List Rule]]''' - child rules will be executed in order
      '''''Once only''''' - the rule is triggered on the first visit only to any one of the selected industries
    '''[[#Progressive List Rule|Progressive List Rule]]''' - first child rule will be executed on the first run of this rule, the second child executed on the second run, etc
      '''''Once per industry''''' - the rule is triggered on the first visit to each industry with each individual product
    '''[[#Reset List Rule|Reset List Rule]]''' - Resets and starts all child rules
      '''''Once per visit''''' - the rule is triggered on the first visit to each industry regardless of the product
    '''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - all child rules are executed simultaneously
      '''''Once per vehicle''''' - each vehicle can only trigger the rule once.
    '''''<select industry>''''' - select industry or industries from session list
==='''Reset List Rule'''===
    Select one of two option buttons:-
 
      '''( ) click to accept all trains'''
Resets and starts all child rules in an ongoing infinite cycle
      '''( ) click to accept trains matching specific criteria'''
 
          Selecting the second option will produce the following selection controls:-         
'''<kuid:-25:762> Built-in Rule'''
          '''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
            '''''+''''' - click to add a ''specific'' vehicle from the session list
            '''''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, C|A, B, C]]''' |  '''[[#D, E|D, E]]''' |  '''[[#F, G|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|S]]''' |  '''[[#T, U, V|T, U, V]]''' |  '''[[#W, X, Y, Z|W, X, Y, Z]]'''
 
=='''T, U, V'''==
==='''Timecheck Rule'''===
 
Executes child rules at a set time.
 
'''<kuid2:122381:10008:3> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''None'''
     '''''<hh:mm:ss>''''' - enter execution time as hours (0-23), minutes (0-59) and seconds (0-59).
'''Related Rules:'''
     '''[Check Box] Execution time is on the day after the start time''' - when checked delays execution until the following day.
    '''[[#Ordered List Rule|Ordered List Rule]]''' - child rules will be executed in order
'''Note:''' Times and days are Trainz clock times not real time.
     '''[[#Progressive List Rule|Progressive List Rule]]''' - first child rule will be executed on the first run of this rule, the second child executed on the second run, etc
    '''[[#Random List Rule|Random List Rule]]''' - one of the child rules will be randomly selected and executed


==='''Simultaneous List Rule'''===
==='''Timed Limited Display HTML Rule (SP2 and later)'''===


Child rules are executed simultaneously once this rule starts
Displays an HTML browser window for a limited time.


'''<kuid:-25:1048> Built-in Rule'''
'''<kuid2:61392:2005:32> DLS Rule''' by '''pguy'''


  '''Properties:'''
  '''Properties:'''
    '''Rule completes when ...''' - click to chose one of the following:-
  '''HTML Asset Name : ''<[Click to select HTML asset]>''''' - click to select an HTML asset from those installed
      '''''one of the child rules has completed'''''
  '''Page filename : ''<value>''''' - click to enter the filename of the HTML page in the selected HTML asset. The ''.html'' filename extension is optional.
      '''''all child rules have reached a completed state'''''
  '''Play duration (SessVar or duration in seconds) : ''<value>''''' - enter a SessVar name or the number of seconds.
      '''''all child rules have reached a "was completed" state'''''
  '''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.
'''Note:''' Seconds are Trainz clock time, not real time.
  '''Related Rules:'''
  '''Related Rules:'''
     '''[[#Ordered List Rule|Ordered List Rule]]''' - child rules will be executed in order
     '''[[#Close Message Popup Rule|Close Message Popup Rule]]''' - closes open message popups
     '''[[#Progressive List Rule|Progressive List Rule]]''' - first child rule will be executed on the first run of this rule, the second child executed on the second run, etc
     '''[[#Display HTML Pages Rule|Display HTML Pages Rule]]''' - displays HTML pages in a browser window.
     '''[[#Random List Rule|Random List Rule]]''' - one of the child rules will be randomly selected and executed
     '''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
     '''[[#Reset List Rule|Reset List Rule]]''' - Resets and starts all child rules
     '''[[#Set HTML Page Rule|Set HTML Page Rule]]''' - sets parameters for the '''[[#Display HTML Pages Rule|Display HTML Pages Rule]]'''
==='''Trackside Check Rule'''===


'''[[#top|Back to Top]]'''
Similar to the '''[[#Trigger Check Rule|Trigger Check Rule]]''' but provides other options. If the rule is satisfied then it will execute any following child rules


=='''Startup and Termination Rules'''==
'''<kuid2:46162:100207:1> DLS Rule''' by '''Josefpav'''
 
==='''End Session Rule'''===
 
End the Session with a fade out.
 
'''<kuid:-25:482> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''Fade out over ''<value>'' seconds''' - enter number of seconds for fade out.
     '''Applies to:''' - select one of three option buttons:-
'''Note:''' Seconds are Trainz clock time, not real time.
      '''( ) 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
  '''Related Rules:'''
  '''Related Rules:'''
     '''[[#Session Complete Rule|Session Complete Rule]]''' - set the session to a percentage of completion
     '''[[#Trigger Check Rule|Trigger Check Rule]]''' - waits for a specific train or any train to enter one of the designated triggers, then executes any following child rules.


==='''Multiplayer Rule'''===
==='''Trigger Check Rule'''===


Enables the session to be taken online in a Multiplayer environment.
Waits for a specific train or any train to enter one of the designated triggers, then executes any following child rules. This rule replaces the older and less versatile "Trigger Rule".


'''<kuid:447264:1045> Built-in Rule'''
'''<kuid:-25:1071> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''Suggested maximum number of players for this session ''<value>''''' - enter a number
     '''[Check Box] Trigger only once '''
    '''Maximum number of drivers per player ''<value>''''' - enter a number
    '''[Check Box] Wait for child rules to complete even if no trains are present in rule trigger'''
     '''Players are permitted to claim drivers            [Check Box]''' - check to allow players to select a driver
    '''[Check Box] Only activate when the entering vehicle of the train is heading ''<select direction>'' into the trigger''' - select one of two directions:-
    '''Players can see each other's driver orders        [Check Box]''' - check to allow players to view orders for other players
      '''''forward'''''
     '''Automatically target an available train on clients [Check Box]''' - automatically assign a driver to each player
      '''''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
'''Related Rules:'''
     '''[[#Trackside Check Rule|Trackside Check Rule]]''' - similar but provides other options.
 
==='''Variable Check Rule'''===


==='''Randomize Rule'''===
If the specified variable matches the specified conditions then the child rules will be executed in order.


Generates a different set of random numbers each time the session is run.
'''<kuid:-25:1049> Built-in Rule'''
 
'''<kuid:169301:100129> DLS Rule''' by '''Terry_Wagstaff'''


  '''Properties:'''
  '''Properties:'''
     '''None'''
     '''''<variable-name>''''' - enter a variable-name. Variable name is case sensitive.
'''Note:''' Place this rule near the top of the Session Rules list and ensure that there is at least 5 seconds before
    Mathematical relationship, select one of:-
    the call to a Random function.
      '''''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:'''
  '''Related Rules:'''
     '''[[#Variable Random|Variable Random]]''' - sets a variable to a random value.
    '''[[#Quick Session Variables Rule|Quick Session Variables Rule]] - allows the editing of any 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.


==='''Session Complete Rule'''===
==='''Variable Modify Rule'''===


Set session to a percentage of completion.
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:447264:1011> Base Rule'''
'''<kuid:-25:1050> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''Set session to percent complete ''<value>''''' - enter number as a percentage
     '''Change ''<Add to variable/Subtract from variable/Change variable>''''' - click to select one from:-
     '''[Check Box] Separate achievements for completion''' - check to set
      '''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:'''
  '''Related Rules:'''
     '''[[#End Session Rule|End Session Rule]]''' - end the Session with a fade out.
     '''[[#Quick Session Variables Rule|Quick Session Variables Rule]] - allows the editing of any session variables
'''[[#Variable Check Rule}Variable Check Rule]] - tests 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 Modify Continuous Rule'''===


==='''Startup Options Rule'''===
Adds, subtracts or sets a value to a specified variable every second.


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|Weather Rule]]'''.
'''<kuid:-25:1051> Built-in Rule'''
 
'''<kuid:-16:10212> Base Rule'''


  '''Properties:'''
  '''Properties:'''
    '''Current control method is ''<select>''''' - select one from:-
  '''''<Add/Subtract/Change variable to>''''' - select one.
      '''''Easy Mode''''' - standard keyboard control
      '''''<value>''''' - enter value to add, subtract or apply to ''<variable-name>''
      '''''Ask User''''' - let the user decide
      '''''<variable-name>''''' - enter variable-name. Variable-name is case sensitive.
      '''''Realistic Mode''''' - on screen levers, throttles, buttons, etc
'''Related Rules:'''
    '''Set weather to ''<select mode>'' with ''<select frequency>'' changeability''' - select
    '''[[#Quick Session Variables Rule|Quick Session Variables Rule]] - allows the editing of any session variables
      '''Weather mode:''' - select one of:-
'''[[#Variable Check Rule}Variable Check Rule]] - tests the value of a specified variable.
          '''''Clear'''''
    '''[[#Variable Modify Rule|Variable Modify Rule]]''' - changes the value of a specified variable.
          '''''Cloudy'''''  
    '''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.
          '''''Drizzle'''''
    '''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
          '''''Rain'''''
 
          '''''Stormy'''''
==='''Variable Random Rule'''===
          '''''Light Snow'''''
 
          '''''Medium Snow'''''
Assigns a random value to a variable.
          '''''Heavy Snow'''''
 
      '''Changeability:''' - select one of:-
'''<kuid:400260:100606> DLS Rule''' by '''tram_'''
          '''''Off''''' - the weather will not change from the mode selected above
 
          '''''Periodic''''' - slow gradual changes to the weather
'''Properties:'''
          '''''Extreme''''' - rapid and extreme changes to the weather
    '''Random variable ''<name>'' in ''minimum'' to ''maximum'' interval''' - enter name of variable. Variable-name is case sensitive.
    '''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 minimum possible value of ''variable_name'' is ''<value>''''' - enter the minimum value
    '''Set derailment realism to ''<select reality level>''''' - select one of:-
    '''The maximum possible value of ''variable_name'' is ''<value>''''' - enter the maximum value
      '''''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
'''Note:''' Times are Trainz clock time, not real time
  '''Related Rules:'''
  '''Related Rules:'''
     '''[[#Weather Rule|Weather Rule]]''' - changes weather conditions during Session play
     '''[[#Quick Session Variables Rule|Quick Session Variables Rule]] - allows the editing of any session variables
    '''[[#Randomize|Randomize]]''' - creates a different set of random numbers for each session run.
'''[[#Variable Check Rule}Variable Check Rule]] - tests 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.


'''[[#top|Back to Top]]'''
==='''Variable Show Rule'''===


=='''Time Rules'''==
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.


==='''Clock Rule'''===
'''<kuid:-25:971> Built-in Rule'''
 
Rule needed for animated clocks.
 
'''<kuid2:62310:30041:2> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
  '''Note:''' 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.
  '''[Check Box] Add'''
 
      '''''<variable-name>''''' - enter variable-name to add to HUD. Variable-name is case sensitive.
==='''Timecheck Rule'''===
      '''''<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:'''
    '''[[#Quick Session Variables Rule|Quick Session Variables Rule]] - allows the editing of any session variables
'''[[#Variable Check Rule}Variable Check Rule]] - tests 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.


Executes child rules at a set time.
==='''Vehicle Physics Rule'''===


'''<kuid2:122381:10008:3> Built-in Rule'''
Overrides the default vehicle physics properties for all vehicles or for those matching set criteria


'''Properties:'''
'''<kuid:-25:1052> Built-in Rule
    '''''<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.
'''Note:''' Times and days are Trainz clock times not real time.


==='''Wait Rule'''===
'''Properties:'''
 
    Select one of two option buttons:-
Wait for number of seconds before executing any following child rules
      '''( ) click to accept all trains'''
 
      '''( ) click to accept trains matching specific criteria'''
'''<kuid2:122381:10016:2> Built-in Rule'''
          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
'''Properties:'''
            '''''+''''' - click to add a ''specific'' vehicle from the session list
    '''''<click to set>''''' - enter the number of seconds for the wait delay
            '''''x''''' - click to remove the ''specific'' vehicle from the rule
  '''Note:''' Seconds is in Trainz clock time, not real time
          '''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule
            '''''+''''' - click to add a ''type'' of vehicle from the session list
            '''''x''''' - click to remove the ''type'' of vehicle from the rule
          '''Drivers''''' - identify the ''drivers'' that will trigger the rule
            '''''+''''' - click to add a ''driver'' from the session list
            '''''x''''' - click to remove a ''driver'' from the rule
    '''Coupler Parameters:'''
      '''Couplers break at ''<value>'' kN expansion force''' - enter force value
      '''Couplers break at when coupling above ''<value>'' kph''' - enter speed value
      '''[Check Box] Show coupler breakage in HUD''' - check to display breakage in on-screen HUD
    '''Wheelslip Parameters:'''
      '''Maximum tractive effort adjusted by ''<value>'' %''' - enter adjustment as a %
      '''Traction is reduced to ''<value>'' % while wheelslipping''' - enter value as a %
      '''Traction boost is ''<value>'' % while sanding''' - enter value as a %
    '''Sway Parameters:'''
      '''Cab sway level is set to ''<value>'' %''' - enter value as a %
'''[[#top|Back to Top]]''' |  '''[[#A, B, C|A, B, C]]''' | '''[[#D, E|D, E]]''' |  '''[[#F, G|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|S]]''' |  '''[[#T, U, V|T, U, V]]''' |  '''[[#W, X, Y, Z|W, X, Y, Z]]'''


'''[[#top|Back to Top]]'''
=='''W, X, Y, Z'''==
==='''Wait for Camera View Mode Rule'''===


=='''Variable Rules'''==
Waits for the camera to be changed to the designated view, then executes any following child rules


==='''Quick Session Variables Rule'''===
'''<kuid:-25:192> Built-in Rule'''


Allows the editing of any session variables
'''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
'''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
 
==='''Wait for Click on HUD Icon Rule'''===


'''<kuid2:61392:5003:30> DLS Rule''' by '''pguy'''
Waits for a click on the HUD Icon, then executes any following child rules
 
'''<kuid:-25:951> <kuid:-25:970> Built-in''' - two versions built-in with different kuids, both have the same properties


  '''Properties:'''
  '''Properties:'''
     '''''<local>''''' - click to edit local variables
     '''[Check Box] Trigger Once'''
      '''''<add new session variable>''''' - click to enter the name of new local variable
    '''HUD Panel ''<Click>''''' - click choose from list:-
          for each variable:-
      '''Bottom Right Menu'''
          '''''<variable-name>''''' - click to change variable name
      '''Camera Controls'''
          '''''<type>''''' - click to select one of:-
      '''DCC Controls'''
            '''string''' - text characters
     '''Icon ''<Click>''''' - click to choose from list. Selections depends on HUD Panel chosen
            '''int''' - integer
  '''Related Rules:'''
            '''float''' - real (decimal) numbers
     '''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - show or hide the Custom Heads Up Display.
            '''bool''' - boolean (true/false)
     '''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
            '''stringset''' - ''meaning not known at this time''
     '''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
            '''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 SP2
        '''''<global>''''' - no longer supported in SP2
'''Note:''' 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]] - tests 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 Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
   
   
==='''Variable Check Rule'''===
==='''Wait for Derailment Rule'''===


If the specified variable matches the specified conditions then the child rules will be executed in order.
Waits for a derailment to occur, then executes any following child rules


'''<kuid:-25:1049> Built-in Rule'''
'''<kuid:-25:1053> Built-in Rule


  '''Properties:'''
  '''Properties:'''
     '''''<variable-name>''''' - enter a variable-name. Variable name is case sensitive.
     '''[Check Box] Trigger derailment watch once''' - check to execute the rule once only
    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:'''
  '''Related Rules:'''
     '''[[#Quick Session Variables Rule|Quick Session Variables Rule]] - allows the editing of any session variables
     '''[[#Clean UP Derailed Trains Rule|Clean UP Derailed Trains Rule]]''' - cleans up derailed train cars after a set time delay
    '''[[#Variable Modify Rule|Variable Modify Rule]]''' - changes the value of a specified variable.
     '''[[#Replace Missing Vehicles Rule|Replace Missing Vehicles Rule]]''' - creates a replacement train after a derailment
    '''[[#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 Modify Rule'''===
==='''Wait for Driver On/Off Train 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.
Waits for a Driver to get off of a train, then executes any following child rules


'''<kuid:-25:1050> Built-in Rule'''
'''<kuid:-25:953> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
'''Change ''<Add to variable/Subtract from variable/Change variable>''''' - select one
  '''[Check Box] Trigger Rule Once''' - click to set''  
    '''[Check Box] (optional) Set the minimum value''' of '''''<variable-name>''''' to '''''<value>''''' - enter variable-name
  '''Wait for a driver character to get ''<On/Off>''''' a train that matches the following criteria''' - select '''On''' or '''Off'''
      (this will already be set by the change option) and a value. Variable-name is case sensitive.
  Select one of two option buttons:-
    '''[Check Box] (optional) Set the maximum value''' of '''''<variable-name>''''' to '''''<value>''''' - enter variable-name
    '''( ) click to accept all trains'''
      (this will already be set by the change option) and a value. Variable-name is case sensitive.
    '''( ) click to accept trains matching specific criteria'''
      '''Change option: Add to variable'''
        Selecting the second option will produce the following selection controls:-
          '''Add ''<value>''''' to '''variable ''<variable-name>''''' - enter value to add to variable, enter variable-name. Variable-name is case sensitive.
        '''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
          '''''<Do not undo the alteration if the rule is stopped/Undo the alteration if the rule is stopped>''''' - click to select one.
          '''''+''''' - click to add a ''specific'' vehicle from the session list
      '''Change option: Subtract from variable'''
          '''''x''''' - click to remove the ''specific'' vehicle from the rule
          '''Subtract ''<value>''''' from '''variable ''<variable-name>''''' - enter value to subtract from variable, enter variable-name.
        '''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule
            Variable-name is case sensitive.
          '''''+''''' - click to add a ''type'' of vehicle from the session list
          '''''<Do not undo the alteration if the rule is stopped/Undo the alteration if the rule is stopped>''''' - click to select one.
          '''''x''''' - click to remove the ''type'' of vehicle from the rule
      '''Change option: Change variable'''
        '''Drivers''''' - identify the ''drivers'' that will trigger the rule
          '''Change variable ''<variable-name>'' to ''<value>''''' - enter variable-name, enter new value.
          '''''+''''' - click to add a ''driver'' from the session list
            Variable-name is case sensitive. This change cannot be undone if the rule is stopped.
          '''''x''''' - click to remove a ''driver'' from the rule
'''Related Rules:'''
 
    '''[[#Quick Session Variables Rule|Quick Session Variables Rule]] - allows the editing of any session variables
==='''Wait for Driver/Train to be Locally Owned Rule'''===
'''[[#Variable Check Rule}Variable Check Rule]] - tests 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 Modify Continuous Rule'''===


Adds, subtracts or sets a value to a specified variable every second.
Waits for a specific driver or train car to be locally owned, then executes any following child rules. If the driver/train car becomes unowned again the child rules are paused


'''<kuid:-25:1051> Built-in Rule'''
'''<kuid2:401543:1173:1> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
  '''''<Add/Subtract/Change variable to>''''' - select one.
  '''Assets Ownership:''' - select one of two option buttons:-
      '''''<value>''''' - enter value to add, subtract or apply to ''<variable-name>''
    '''( ) Wait for ownership of a specific Driver'''
      '''''<variable-name>''''' - enter variable-name. Variable-name is case sensitive.
    '''( ) Wait for ownership of Driver'''
'''Related Rules:'''
  '''Driver or Vehicle ''<select>''''' - choose from session list
    '''[[#Quick Session Variables Rule|Quick Session Variables Rule]] - allows the editing of any session variables
'''[[#Variable Check Rule}Variable Check Rule]] - tests 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 Random Rule'''===
==='''Wait on Navigation Point Rule'''===


Assigns a random value to a variable.
Waits for a navigation point to be completed, then executes any following child rules


'''<kuid:-25:971> DLS Rule''' by '''tram_'''
'''<kuid:401543:1168> Base Rule'''


  '''Properties:'''
  '''Properties:'''
     '''Random variable ''<name>'' in ''minimum'' to ''maximum'' interval''' - enter name of variable. Variable-name is case sensitive.
     '''navigation point ''<click here to set>''''' - enter the number of the navigation point to be completed
     '''The minimum possible value of ''variable_name'' is ''<value>''''' - enter the minimum value
     '''in set ''<click here to set>''''' - enter the unique name for the navigation set created using the '''[[#Navigation Display Rule|Navigation Display Rule]]'''.
    '''The maximum possible value of ''variable_name'' is ''<value>''''' - enter the maximum value
      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:'''
     '''[[#Randomize|Randomize]]''' - creates a different set of random numbers for each session run.
     '''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
     '''[[#Quick Session Variables Rule|Quick Session Variables Rule]] - allows the editing of any session variables
     '''[[#Navigation Set Hide/Show rule|Navigation Set Hide/Show rule]]''' - makes a navigation set visible/invisible.
'''[[#Variable Check Rule}Variable Check Rule]] - tests the value of a specified variable.
     '''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - checks 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 Modify Continuous Rule|Variable Modify Continuous Rule]]''' - continuously changes the value of a specified 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.


==='''Variable Show Rule'''===
==='''Wait on Train Stop/Start 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.
Wait for a train to stop or start, then executes any following child rules


'''<kuid:-25:971> Built-in Rule'''
'''<kuid:-25:1069> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
  '''[Check Box] Add'''
    '''[Check Box] Trigger rule once'''  
      '''''<variable-name>''''' - enter variable-name to add to HUD. Variable-name is case sensitive.
    '''Wait for a train that matches the following criteria to ''<select>''''' - select one of:-
      '''''<label>''''' - (optional) enter a short label to be displayed on the HUD in front of the variable value.
      '''''start moving'''''
  '''[Check Box] Remove'''
      '''''stop moving'''''
      '''''<variable-name>''''' - enter variable-name to remove from HUD. Variable-name is case sensitive.
    Select one of two option buttons:-
'''Related Rules:'''
      '''( ) click to accept all trains'''
    '''[[#Quick Session Variables Rule|Quick Session Variables Rule]] - allows the editing of any session variables
      '''( ) click to accept trains matching specific criteria'''
'''[[#Variable Check Rule}Variable Check Rule]] - tests the value of a specified variable.
          Selecting the second option will produce the following selection controls:-
    '''[[#Variable Modify Rule|Variable Modify Rule]]''' - changes the value of a specified variable.
          '''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
    '''[[#Variable Modify Continuous Rule|Variable Modify Continuous Rule]]''' - continuously changes the value of a specified variable.
            '''''+''''' - click to add a ''specific'' vehicle from the session list
    '''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.
            '''''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'''===
 
Waits for the Waybill window to be opened or closed, then executes any following child rules
 
'''<kuid:-25:957> Built-in Rule'''


'''[[#top|Back to Top]]'''
'''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'''.


=='''Weather Rules'''==
==='''Wait Rule'''===
==='''EIRS Weather Rule NE USA Rule'''===


Customize random weather rule relative to the North East Region of the United States.
Wait for number of seconds before executing any following child rules


'''<kuid2:487222:1037:3> Built-in Rule'''
'''<kuid2:122381:10016:2> Built-in Rule'''


  '''Properties:'''
  '''Properties:'''
     '''Season ''<select>''''' - select one of:-
     '''''<click to set>''''' - enter the number of seconds for the wait delay
      '''''Summer'''''
  '''Note:''' Seconds is in Trainz clock time, not real time
      '''''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'''''
  '''Note:''' Minutes are Trainz clock times, not real times
'''Related Rules:'''
    '''[[#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


==='''Weather Rule'''===
==='''Weather Rule'''===
Line 2,012: Line 1,993:
     '''[[#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
     '''[[#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
     '''[[#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, C|A, B, C]]''' |  '''[[#D, E|D, E]]''' |  '''[[#F, G|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|S]]''' |  '''[[#T, U, V|T, U, V]]''' |  '''[[#W, X, Y, Z|W, X, Y, Z]]'''

Revision as of 04:26, 31 December 2017

This page is under construction

TRAINZ A New Era SP2. List of Trainz Session Rules in Alphabetical Order with Properties. All rules are the Copyright of N3V Games

See also Session Rules By Categories With Properties

kuid numbers are for the current versions of each rule at the time of writing. These numbers can change as rules are updated.

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

A, B, C

Achievement Check Rule

This rule allows you to customize session gameplay based on whether the player has received an achievement. If the rule is satisfied then it will execute any following child rules.

<kuid:401543:1190> Built-in 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> - change the selected Achievement Asset
      Achievement name: <not set> - 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
Note: Times are Trainz clock time, not real time

ATP Speed Limiter Rule

Limits allowable speed over set limit

<kuid2:321959:1000:1> Built-in Rule 

Properties:
   Limits the speed to <value> mph over the set limit - enter speed value in mph
Related Rules:
   AWS Configuration Rule - configures the Trainz implementation of the Automatic Warning System when approaching signals

AWS Configuration Rule

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

<kuid2:60850:89002:3> Built-in Rule 

Properties:
   Select one of three option buttons:-
      ( ) Active
      ( ) Passive
      ( ) Passive with HUD hidden
   [Check Box] Simulate AWS for unfitted cabs?
   [Check Box] Use modern sound set for unfitted cabs?
Related Rules:
   ATP Speed Limiter Rule - limits allowable speed over set limit

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
Note: Times are Trainz clock times, not real times
Related Rules:
   Focus Camera Rule - sets the initial camera view and starting vehicle for a session
   Set Camera Rule - sets the target object and properties of the camera
   Wait for Camera View Mode Rule - waits for the camera to be changed to the designated view, then executes any following child rules

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
Note: Time is Trainz clock time, not real time.
Related Rules:
   Replace Missing Vehicles Rule - creates a replacement train after a derailment
   Wait for Derailment Rule - executes child rules if a derailment occurs

Clock Rule

Rule needed for animated clocks.

<kuid2:62310:30041:2> Built-in Rule 

Properties:
Note: 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:
   Message Popup Rule - displays a pop-up browser window and waits for it to be closed.

Consist Check Rule

Waits for a consist to exist that matches a description then executes any following child rules. The order of the vehicles in the consist is not important.

<kuid:-25:1068> Built-in 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
Note: This rule will continue to check all consists for a match even after it has been triggered. 
   To disable this feature add another copy of the rule with the Rule disabled option selected as one of its child rules.

Control Check Rule

Checks if the control method changes, then executes any following child rules

<kuid:401543:1191> Built-in 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
Related Rules:
   Control Type Rule - sets the control method

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
    Ask User
    Realistic Mode
Related Rules:
   Control Check Rule - checks if the control method changes, then executes any following child rules

Coupler Breakage Check Rule

Checks for breaking couplers and, if found, executes any following child rules.

<kuid2:447264:1017:1> Built-in Rule 

Properties:
   None
Related Rules:
   Coupler Breakage HUD Rule - adds a coupler stress and breakage warning to the HUD
   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:
   Select one of two option buttons:-
      ( ) Show the Coupler Breakage Display
      ( ) Hide the Coupler Breakage Display
Related Rules:
   Coupler Breakage Check Rule - executes child rules when a breakage occurs
   Set Coupler Masks Rule - sets the coupling/decoupling masks on selected vehicles

CPC: Emit Train on Trigger Rule

Emits a train from a Portal or an Unportal after a triggered event.

<kuid2:117746:1044:12> DLS Rule by sforget 

Properties:
   Portal index from CPC <value> - click to enter (Un)Portal Index
   Use UnPortal <select> - click to select Yes or No
   Delay from Trigger to Emit <seconds> - click to set number of seconds
   Add Trigger <select> - click to add Trigger from Session List
Note: Times are Trainz clock time, not real time

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 | T, U, V | W, X, Y, Z

D, E

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

Disable/Enable Industry Rule

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

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:
   Flash HUD Icon Rule - flashes a HUD panel icon for a set duration.
   Show/Hide HUD Panel Rule - shows or hides a HUD panel.
   Variable Show Rule - adds or removes a specified variable and a descriptive label to the custom HUD.
   Wait for Click on HUD Icon Rule - waits for a click on the HUD Icon, then executes any following child rules.

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> 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
Related Rules:
   Close Message Popup Rule - closes a displayed pop-up browser window.
   Message Popup Rule - displays a pop-up browser window and waits for it to be closed.
   Set HTML Page Rule - sets parameters for the Display HTML Pages Rule
   Timed Limited Display HTML Rule (SP2 and later) - displays a HTML page in a browser window for a set time.

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.
Note: video must be in a valid web format.
Related Rules:
   Play Sound Rule] - plays a wav sound file

Driver Command Check Rule

Verifies the driver commands of a driver character, then executes any following child rules

<kuid:-25:447> Built-in 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
Related Rules:
   Driver Command Rule - specifies which commands will be available for the drivers
   Enable/Disable Driver Commands Rule - enable/disable specific driver commands on certain drivers

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 Diver Command and Description (if available) - check to make that command available to the driver
Related Rules:
   Driver Command Check Rule - checks the driver commands then executes any following child rules
   Enable/Disable Driver Commands Rule - enable/disable specific driver commands on certain drivers

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

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
Note: Minutes are Trainz clock times, not real times
Related Rules:
   Startup Options Rule - sets the weather conditions at the start of a Session
   Weather Rule - changes the weather conditions during Session play

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
Related Rules:
   Driver Command Rule - specifies which commands will be available for the drivers
   Driver Command Check Rule - checks the driver commands then executes any following child 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.
Note: Seconds are Trainz clock time, not real time.
Related Rules:
   Session Complete Rule - set the session to a percentage of completion

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

F, G

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

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.
Related Rules:
   Display Custom HUD Rule - show or hide the Custom Heads Up Display.
   Show/Hide HUD Panel Rule - shows or hides a HUD panel.
   Variable Show Rule - adds or removes a specified variable and a descriptive label to the custom HUD.
   Wait for Click on HUD Icon Rule - waits for a click on the HUD Icon, then executes any following child rules.

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
Related Rules:
   Cinematic Camera Rule - provides several different cinematic style cameras with animations
   Set Camera Rule - sets the target object and properties of the camera
   Wait for Camera View Mode Rule - waits for the camera to be changed to the designated view, then executes any following child rules

Generic TreeNode Debug Window Rule

No description.

<kuid:30501:1042> Base Rule 

Properties:
Note: I have been unable to find any references to this rule in Trainz except for the fact that it exists as a session rule.
Related Rules:
   Session Debug Rule - executes the first child if debug mode is selected, otherwise the second child rule is executed

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

H, I, J

InputTable Rule

Creates a list of message names to be used for various purposes.

<kuid2:131986:1012:1> Built-in 

Properties:

Interlocking Tower Configure Path

Alters settings on an interlocking tower path

<kuid:401543:3205> Base Rule 

Properties:
  Interlocking Tower <select> - to set Name and Objects
Related Rules:
   Interlocking Tower Path Selection UI - automatically reacts to messages from Interlocking Towers and displays a path selection dialog to the player.
   Interlocking Tower Set Path Rule - sets the state of an interlocking tower path for a train
   Interlocking Tower Enhanced Manager Rule (SP2 and later) - more management and control options for interlocking towers.

Interlocking Tower Enhanced Manager Rule (SP2 and later)

Provides more management and control options for interlocking towers.

<kuid2:61392:8130:40> DLS Rule by pguy 

Properties:
Related Rules:
   Interlocking Tower Configure Path - alters the settings on an interlocking tower path
   Interlocking Tower Path Selection UI - automatically reacts to messages from Interlocking Towers and displays a path selection dialog to the player.
   Interlocking Tower Set Path Rule - sets the state of an interlocking tower path for a train

Interlocking Tower Path Selection UI

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
Related Rules:
   Interlocking Tower Configure Path - alters the settings on an interlocking tower path
   Interlocking Tower Set Path Rule - sets the state of an interlocking tower path for a train
   Interlocking Tower Enhanced Manager Rule (SP2 and later) - more management and control options for interlocking towers.

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
Related Rules:
   Interlocking Tower Configure Path - alters the settings on an interlocking tower path
   Interlocking Tower Path Selection UI - automatically reacts to messages from Interlocking Towers and displays a path selection dialog to the player.
   Interlocking Tower Enhanced Manager Rule (SP2 and later) - more management and control options for interlocking towers.

Junction Derailment Prevention Rule

<kuid2:121843:100282:1> DLS Rule by pitkin

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

Properties:
   None
Note: Will not overrule a junction already locked by another AI train or locked against AI control using the Set Junctions Rule.
Related Rules:
   Set Junctions Rule - sets the selected junctions to a specific state (switch 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 | T, U, V | W, X, Y, Z

K, L, M

MaxPermittedSpeed Rule

Controls AI behavior. When active AI Trains only go as fast as permitted

<kuid2:60850:89000:7> Built-in Rule 

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

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> - 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.
      ( ) 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> - <function unknown at present>
         <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 Rule:
   Close Message Popup Rule - closes a displayed pop-up browser window.

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

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

Checks junctions are set or in alignment, then executes any following child rules.

<kuid:-25:168> Built-in 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:
   Set Junctions Rule - sets junctions to specific directions, locks and unlocks junctions, allows or denies AI control.

Multiple Resource Check Rule

If specified resources in a selected industries or vehicles reaches set levels, then executes any following child rules. This rule replaces the older Resource Check Rule

<kuid:-25:656> Built-in 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

Back to Top | A, B, C | D, E | F, G | H, I, J | K, L, M | N, O | P, Q | R | S | 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 but at a lower opacity.
   ( ) 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:
   Navigation Set Hide/Show rule - makes a navigation set visible/invisible.
   Navigation Set Check Rule - checks if a navigation set is complete or incomplete.
   Navigation Set Clear Rule - completes (terminates) a navigation set.
   Navigation Point Complete Rule - manually completes (terminates) a specific navigation point in a set.
   Wait on Navigation Point Rule -  checks if a specific navigation point in a set has been completed.

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.
Related Rules:
   Navigation Display Rule - creates a set of navigation points.
   Navigation Set Hide/Show rule - makes a navigation set visible/invisible.
   Navigation Set Check Rule - checks if a navigation set is complete or incomplete.
   Navigation Set Clear Rule - completes (terminates) a navigation set.
   Wait on Navigation Point Rule -  checks if a specific navigation point in a set has been completed.

Checks if a navigation set is complete or incomplete, then executes any following child rules

<kuid:401543:1165> Base 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.
Related Rules:
   Navigation Display Rule - creates a set of navigation points.
   Navigation Set Hide/Show rule - makes a navigation set visible/invisible.
   Navigation Set Clear Rule - completes (terminates) a navigation set.
   Navigation Point Complete Rule - manually completes (terminates) a specific navigation point in a set.
   Wait on Navigation Point Rule -  checks if a specific navigation point in a set has been completed.

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

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.
Related Rules:
   Navigation Display Rule - creates a set of navigation points.
   Navigation Set Check Rule - checks if a navigation set is complete or incomplete.
   Navigation Set Clear Rule - completes (terminates) a navigation set.
   Navigation Point Complete Rule - manually completes (terminates) a specific navigation point in a set.
   Wait on Navigation Point Rule -  checks if a specific navigation point in a set has been completed.

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
Related Rules:
   Objective Check Rule - checks if an objective is complete
   Objective Update Rule - changes the progress of a game objective

Objective Check Rule

Checks if an objective created with the Objective Add Rule is complete, then executes any following child rules

<kuid:401543:2003> Base Rule 

Properties:
   Unique Objective ID <value> - enter the unique ID created with the Objective Add Rule 
   Mode <select> - select one of three option buttons:-
      Wait for completion
      Wait for failure
      Wait for progress
Related Rules:
   Objective Add Rule - sets up a game objective
   Objective Update Rule - changes the progress of a game objective

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
Related Rules:
   Objective Add Rule - sets up a game objective
   Objective Check Rule - checks if an objective is complete

Ordered List Rule

Child rules will be executed in order once this rule starts

<kuid:-25:171> Built-in 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
Related Rules:
   Progressive List Rule - first child rule will be executed on the first run of this rule, the second child executed on the second run, etc
   Random List Rule - one of the child rules will be randomly selected and executed
   Reset List Rule - Resets and starts all child rules
   Simultaneous List Rule - all child rules are executed simultaneously

Back to Top | A, B, C | D, E | F, G | H, I, J | K, L, M | N, O | P, Q | R | S | 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

The first child rule will be executed on the first run of this rule, the second child executed on the second run, etc.

<kuid:-25:754> Built-in Rule 

Properties:
  After last child has been executed ...
  <successive runs will do nothing/the first child is chosen again> - click to select one
Related Rules:
   Ordered List Rule - child rules will be executed in order
   Random List Rule - one of the child rules will be randomly selected and executed
   Reset List Rule - Resets and starts all child rules
   Simultaneous List Rule - all child rules are executed simultaneously

Quick Session Variables Rule

Allows the editing of any 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 SP2
       <global> - no longer supported in SP2
Note: 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]] - tests the value of a specified variable. 

   Variable Modify Rule - changes the value of a specified variable.
   Variable Modify Continuous Rule - continuously changes the value of a specified variable.
   Variable Random Rule - assigns a random value to a variable.
   Variable Show Rule - adds or removes a specified variable and a descriptive label to the custom HUD.

QuickDrive Rule

Change the Session settings and add consists in Driver

<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 | T, U, V | W, X, Y, Z

R

Random List Rule

One of the child rules will be randomly selected and executed. The rule will not repeat to randomly select another child rule

<kuid:-25:758> Built-in Rule 

Properties:
   None
Related Rules:
   Ordered List Rule - child rules will be executed in order
   Progressive List Rule - first child rule will be executed on the first run of this rule, the second child executed on the second run, etc
   Reset List Rule - Resets and starts all child rules
   Simultaneous List Rule - all child rules are executed simultaneously

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
Note: 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 - sets a variable to a random value.

Ranked Session Begin Rule

Begins a ranked Session

<kuid:401543:2031> Base Rule 

Properties:
   Countdown Starting Value <value>
      hrs:
      min:
      sec:
   1 through 5 stars, points for each star <value> - enter number of points for each star rating
   Session timer mode: - select one of three option buttons:-
      ( ) Timer
      ( ) Countdown Starting value <value> - enter time hh:mm:ss
      ( ) None
Note: Times are Trainz clock time, not real time
Related Rules:
   Ranked Session Complete Rule - completes the active ranked Session

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
Related Rules:
   Ranked Session Begin Rule - begins a ranked Session

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
Related Rules:
   Clean Up Derailed Trains Rule - cleans up derailed train cars after a set time delay
   Wait for Derailment Rule - executes child rules if a derailment occurs

Reset List Rule

Resets and starts all child rules in an ongoing infinite cycle

<kuid:-25:762> Built-in Rule 

Properties:
   None
Related Rules:
   Ordered List Rule - child rules will be executed in order
   Progressive List Rule - first child rule will be executed on the first run of this rule, the second child executed on the second run, etc
   Random List Rule - one of the child rules will be randomly selected and executed

Resource Check Rule

Check the progress of the amount of a resource and target object, then executes any following child rules. This rule has been superseded by the Multiple Resource Check Rule

<kuid:-25:1067> Built-in 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
Related Rules:
   Multiple Resource Check Rule - checks specified resources in a selected industries or vehicles reaches set levels, then executes any following child rules.

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

S

Safety System Engaged Check Rule

Checks for safety systems making penalty applications on users and, if found, then executes any following child rules.

<kuid:447264:1216> Built-in Rule 

Properties:
   [Check Box] Trigger only once
Related Rules:
   Safety System Isolated Check Rule - executes child rules if safety systems have been isolated by user

Safety System Isolated Check Rule

Checks for safety systems being isolated by users and, if found, then executes any following child rules.

<kuid:447264:1217> Built-in Rule 

Properties:
   [Check Box] Trigger only once
Related Rules:
   Safety System Engaged Check Rule - executes child rules if safety systems have been engaged by user

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
Note: 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
Related Rules:
   End Session Rule - end the Session with a fade out.

Session Debug Rule

Executes the first child if Debug mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.

<kuid:30501:100180> Built-in Rule 

Properties:
   None
Note: 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. 
Related Rules:
   Generic TreeNode Debug Window Rule - no description

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
Note: 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
 Related Rules:
   Cinematic Camera Rule - provides several different cinematic style cameras with animations
   Focus Camera Rule - sets the initial camera view and starting vehicle for a session
   Wait for Camera View Mode Rule - waits for the camera to be changed to the designated view, then executes any following child rules

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
Related Rules:
   Coupler Breakage Check Rule - executes child rules when a breakage occurs
   Coupler Breakage HUD Rule - adds a coupler stress and breakage warning to the HUD

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> 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)
Related Rules:
   Display HTML Pages Rule - displays HTML pages in a browser window.
   Timed Limited Display HTML Rule (SP2 and later) - displays a HTML page in a browser window for a set time.

Set Junctions Rule

Sets the selected junctions to a specific state 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
Related Rules:
   Junction Derailment Prevention Rule - sets opposing junctions ahead of a train to prevent derailments
   Multiple Junction Alignment Check Rule - checks junctions are set or in alignment, then executes any following child rules

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
Note: The signal must support the state selected otherwise there will be no change in the signal

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
Related Rules:
   Display Custom HUD Rule - show or hide the Custom Heads Up Display.
   Flash HUD Icon Rule - flashes a HUD panel icon for a set duration.
   Variable Show Rule - adds or removes a specified variable and a descriptive label to the custom HUD.
   Wait for Click on HUD Icon Rule - waits for a click on the HUD Icon, then executes any following child rules.

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.
Related Rules:
   Minimap Options Rule - sets the display options for the minimap.

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

Checks for Drivers passing signals at danger (stop) and, if found, then executes any following child rules.

<kuid2:60850:89007:2> Built-in Rule 

Properties:
   [Check Box] Trigger only once

Simultaneous List Rule

Child rules are executed simultaneously once this rule starts

<kuid:-25:1048> Built-in 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
Related Rules:
   Ordered List Rule - child rules will be executed in order
   Progressive List Rule - first child rule will be executed on the first run of this rule, the second child executed on the second run, etc
   Random List Rule - one of the child rules will be randomly selected and executed
   Reset List Rule - Resets and starts all child rules

Speeding Check Rule

If player controlled trains are over the local speed limit or over a set (custom) speed, then executes any following child rules

<kuid2:60850:89004:3> Built-in 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 - standard keyboard control
      Ask User - let the user decide
      Realistic Mode - 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
Note: Times are Trainz clock time, not real time
Related Rules:
   Weather Rule - changes weather conditions during Session play

Station Visited Check Rule

Waits for a designated train or any train to call at one of the designated stations or industries, then executes any following child rules

<kuid2:60850:89005:3> Built-in 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 | T, U, V | W, X, Y, Z

T, U, V

Timecheck Rule

Executes child rules at a set time.

<kuid2:122381:10008:3> Built-in 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.
Note: Times and days are Trainz clock times not real time.

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.
Note: Seconds are Trainz clock time, not real time.
Related Rules:
   Close Message Popup Rule - closes open message popups
   Display HTML Pages Rule - displays HTML pages in a browser window.
   Message Popup Rule - displays a pop-up browser window and waits for it to be closed.
   Set HTML Page Rule - sets parameters for the Display HTML Pages Rule

Trackside Check Rule

Similar to the Trigger Check Rule but provides other options. If the rule is satisfied then it will execute any following child rules

<kuid2:46162:100207:1> DLS Rule by Josefpav 

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
Related Rules:
   Trigger Check Rule - waits for a specific train or any train to enter one of the designated triggers, then executes any following child rules.

Trigger Check Rule

Waits for a specific train or any train to enter one of the designated triggers, then executes any following child rules. This rule replaces the older and less versatile "Trigger Rule".

<kuid:-25:1071> Built-in 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
Related Rules:
   Trackside Check Rule - similar but provides other options.

Variable Check Rule

If the specified variable matches the specified conditions then the child rules will be executed in order.

<kuid:-25:1049> Built-in 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 - allows the editing of any session variables
   Variable Modify Rule - changes the value of a specified variable.
   Variable Modify Continuous Rule - continuously changes the value of a specified variable.
   Variable Random Rule - assigns a random value to a variable.
   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 - allows the editing of any session variables

[[#Variable Check Rule}Variable Check Rule]] - tests the value of a specified variable. 

   Variable Modify Continuous Rule - continuously changes the value of a specified variable.
   Variable Random Rule - assigns a random value to a variable.
   Variable Show Rule - adds or removes a specified variable and a descriptive label to the custom HUD.

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 - allows the editing of any session variables

[[#Variable Check Rule}Variable Check Rule]] - tests the value of a specified variable. 

   Variable Modify Rule - changes the value of a specified variable.
   Variable Random Rule - assigns a random value to a variable.
   Variable Show Rule - adds or removes a specified variable and a descriptive label to the custom HUD.

Variable Random Rule

Assigns a random 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 - allows the editing of any session variables
   Randomize - creates a different set of random numbers for each session run.

[[#Variable Check Rule}Variable Check Rule]] - tests the value of a specified variable. 

   Variable Modify Rule - changes the value of a specified variable.
   Variable Modify Continuous Rule - continuously changes the value of a specified variable.
   Variable Show Rule - adds or removes a specified variable and a descriptive label to the custom HUD.

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:
   Quick Session Variables Rule - allows the editing of any session variables

[[#Variable Check Rule}Variable Check Rule]] - tests the value of a specified variable. 

   Variable Modify Rule - changes the value of a specified variable.
   Variable Modify Continuous Rule - continuously changes the value of a specified variable.
   Variable Random Rule - assigns a random value to a variable.

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 | T, U, V | W, X, Y, Z

W, X, Y, Z

Wait for Camera View Mode Rule

Waits for the camera to be changed to the designated view, then executes any following child rules

<kuid:-25:192> Built-in 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
Related Rules:
   Cinematic Camera Rule - provides several different cinematic style cameras with animations
   Focus Camera Rule - sets the initial camera view and starting vehicle for a session
   Set Camera Rule - sets the target object and properties of the camera

Wait for Click on HUD Icon Rule

Waits for a click on the HUD Icon, then executes any following child rules

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

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
Related Rules:
   Display Custom HUD Rule - show or hide the Custom Heads Up Display.
   Flash HUD Icon Rule - flashes a HUD panel icon for a set duration.
   Show/Hide HUD Panel Rule - shows or hides a HUD panel.
   Variable Show Rule - adds or removes a specified variable and a descriptive label to the custom HUD.

Wait for Derailment Rule

Waits for a derailment to occur, then executes any following child rules

<kuid:-25:1053> Built-in Rule 

Properties:
   [Check Box] Trigger derailment watch once - check to execute the rule once only
Related Rules:
   Clean UP Derailed Trains Rule - cleans up derailed train cars after a set time delay
   Replace Missing Vehicles Rule - creates a replacement train after a derailment

Wait for Driver On/Off Train Rule

Waits for a Driver to get off of a train, then executes any following child rules

<kuid:-25:953> Built-in 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

Waits for a specific driver or train car to be locally owned, then executes any following child rules. If the driver/train car becomes unowned again the child rules are paused

<kuid2:401543:1173:1> Built-in 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

Waits for a navigation point to be completed, then executes any following child rules

<kuid:401543:1168> Base 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.
Related Rules:
   Navigation Display Rule - creates a set of navigation points.
   Navigation Set Hide/Show rule - makes a navigation set visible/invisible.
   Navigation Set Check Rule - checks if a navigation set is complete or incomplete.
   Navigation Set Clear Rule - completes (terminates) a navigation set.
   Navigation Point Complete Rule - manually completes (terminates) a specific navigation point in a set.

Wait on Train Stop/Start Rule

Wait for a train to stop or start, then executes any following child rules

<kuid:-25:1069> Built-in 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

Waits for the Waybill window to be opened or closed, then executes any following child rules

<kuid:-25:957> Built-in 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

Wait for number of seconds before executing any following child rules

<kuid2:122381:10016:2> Built-in Rule 

Properties:
   <click to set> - enter the number of seconds for the wait delay
Note: 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
Related Rules:
   EIRS Weather Rule NE USA Rule - customize random weather rule relative to the North East Region of the United States
   Startup Options Rule - sets the weather conditions at the start of a Session

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

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