Revision as of 07:36, 24 November 2019

The information in this Wiki Page applies to TANE, TRS19 and Trainz Plus. List of Trainz Session Rules in Alphabetical Order with Properties.

This page is always under construction. As new rules appear and are tested they will be added to this list. Current Count: 129

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

The rules listed in this page are all accessible in the

Surveyor Session Editor. Those rules that are identified as DLS Rule must be downloaded and installed from the Trainz DLS first.

Also available Session Rules By Categories With Properties

Description Key:

<kuid number> is for the rule version at the time of writing. This number will change if the rule is updated.
DLS Rule must be downloaded and installed from the DLS.
Base Rule and Built-in Rule is installed with Trainz.
Parent Rule will execute child rules if it returns a true result.
Obsolete Rule is no longer required (explanation given).
Legacy Rule has been replaced by another rule (new rule will be identified).
Rules that are named TANE SP2 or TANE SP3 will work in TRS19 and Trainz Plus.

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

A, B

Achievement Check Rule

Executes child rules when achievement conditions have been met

Rule Properties:

<kuid:401543:1190>

Built-in Rule

Parent Rule

Rule Settings:

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

Trainz Wiki Links:

How to Use Parent and Child Rules

Advanced Industry Load Configuration Rule

Locks train controls when loading/unloading at an industry, overrides time settings for begin load and begin unload operations

Rule Properties:

<kuid:30501:100007>

Base Rule

Rule Settings:

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

Notes:

Times are Trainz clock time, not real time

AI Start Rule

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

Rule Properties:

<kuid2:400048:100981:1>

DLS Rule by callavsg

Rule Settings:

   None

Related Rules:

AI Stop Rule - halts all AI drivers
Disallow AI Rule - cancels all AI driver commands

AI Stop Rule

Halts all AI controlled trains but does not delete their driver commands. AI trains can be restarted with the AI Start Rule or by issuing individual Continue Schedule commands.

Rule Properties:

<kuid2:400048:100980:1>

DLS Rule by callavsg

Rule Settings:

   None

Related Rules:

AI Start Rule - restarts all halted AI drivers
Disallow AI Rule - cancels all AI driver commands

ATP Speed Limiter Rule

Limits allowable speed over set limit

Rule Properties:

<kuid2:321959:1000:1>

Built-in Rule

Rule Settings:

   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

Rule Properties:

<kuid2:60850:89002:3>

Built-in Rule

Rule Settings:

    Select one of three option buttons:- 
      ( ) Active
      ( ) Passive
      ( ) Passive with HUD hidden
   [x] Simulate AWS for unfitted cabs?
   [x] Use modern sound set for unfitted cabs?

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

C

Cab Controls HUD Rule

Was used to provide the HUD controls for the cabin view. Now obsolete.

Rule Properties:

<kuid:-16:287428>

Base Rule

Obsolete Rule (function is now built into Trainz)

Rule Settings:

   None

Cinematic Camera Rule

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

Rule Properties:

<kuid2:401543:1166:3>

Built-in Rule

Rule Settings:

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

Notes:

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 - executes child rules when the camera view is changed

Clean Up Derailed Trains Rule

Cleans up derailed train cars after a set time delay

Rule Properties:

<kuid2:60850:89003:1>

Base Rule

Rule Settings:

   Set delay to clean up derailed traincars to
      <h>: - click to enter the number of hours (0-23) to wait
      <mm>: - click to enter the number of minutes (0-59) to wait
      <ss>: - click to enter the number of seconds (0-59) to wait

Notes:

Time is Trainz clock time, not real time.

Related Rules:

Replace Missing Vehicles Rule - creates a replacement train after a derailment
Wait for Derailment Rule - executes child rules when a derailment occurs

Trainz Wiki Links:

http://online.ts2009.com/mediaWiki/index.php/Clean_up_Derailed_Trains_Rule

Clock Rule

Rule needed for animated clocks.

Rule Properties:

<kuid2:62310:30041:2>

Built-in Rule

Rule Settings:

   None

Notes:

Apply this rule to your session to make use of the animated clocks. See the forum for code to include in your clock object to work with this rule.

Close Message Popup Rule

Closes open message popups

Rule Properties:

<kuid:447264:1526>

Built-in Rule

Rule Settings:

  None

Known Issues:

This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule

Related Rules:

Message Popup Rule - displays a pop-up browser window and waits for it to be closed.

Examples of Use:

How to Use Message Popup Rule (Applications)

Consist Check Rule

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

Rule Properties:

<kuid:-25:1068>

Built-in Rule

Parent Rule

Rule Settings:

   [x] Enforce strict exclusive testing - check to only accept an exact match with no unspecified vehicles in the consist.
      - leave unchecked to accept any consist that contains the specified vehicles. 
    Select one of two option buttons:- 
   ( ) Rule disabled - select to disable the operation of this rule
   ( ) Complete whenever a train matching the description exists - When selected, enter the consist description:-
      Specific vehicle - identify the specific vehicle(s) that will trigger the rule
         + - click to add a specific vehicle from the session list
         x - click to remove the specific vehicle from the rule
      Vehicle types - identify the type of vehicle(s) that will trigger the rule
         + - click to add a type of vehicle from the session list
         x - click to remove the type of vehicle from the rule
      Drivers - identify the driver(s) that will trigger the rule
         + - click to add a driver from the session list
         x - click to remove a driver from the rule

Known Issues:

When used as a top level parent rule it does not terminate after triggering but will continue to check all consists for a match and will trigger every time another match is found.

Examples of Use:

How to Use Variables in Sessions (Examples): Counting Consist Checks

Trainz Wiki Links:

ConsistDataHandler Rule

Was used by the QuickDrive Rule to place consists onto a route. Now obsolete.

Rule Properties:

<kuid:401543:1180>

Obsolete Rule (function is now built into Trainz)

Base Rule

Rule Settings:

   None

Control Check Rule

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

Rule Properties:

<kuid:401543:1191>

Built-in Rule

Parent Rule

Rule Settings:

 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

Trainz Wiki Links:

How to Use Parent and Child Rules

Control Path Rule

Sets the path for selected trains

Rule Properties:

<kuid:131986:158781>

DLS Rule by atilabarut

Legacy Rule (replaced by Interlocking Tower Rules)

Rule Settings:

 <add junction> - click to add a junction from the Session list
     For each junction:- 
      Set switch to <RIGHT/LEFT/FORWARD> - click to select one junction state
      Exiting from <FORWARD/BACKWARD/LEFT/RIGHT> - click to select the direction the train exits from the junction
      Permit type <EXCLUSIVE/DIRECTIONAL> - click to select permission type. 
          DIRECTIONAL permits all trains heading in the same direction to use the set path.
          EXCLUSIVE only allows one train to use the path at a time
      <up> - move the junction UP one level in the list
      <dn> - move the junction DOWN one level in the list
      <rm> - remove the junction from the list
 Name of the signal before entering the path <signal name> - click to select the signal before the first junction from the Session signal list
 Signal state in case the path is not cleared <GREEN/RED/YELLOW> - click to select a signal state
 Train for which path is controlled <train> - click to select a consist from the Session list
 Rule activates on train entering trigger <trigger name> - click to select a start trigger from the Session list
 Rule exits on train entering trigger <trigger name> - click to select an end trigger from the Session list

Notes:

This rule may not be compatible with Interlocking Towers.
Triggers have to be placed before the first junction and controlling signal and after the final junction.
Multiple paths can be set up by placing multiple copies of this rule under an Ordered List or Simultaneous List

Related Rules:

Junction Derailment Prevention Rule - sets opposing junctions ahead of a train to prevent derailments
Lock All Junctions Rule - locks all junctions against user control
Multiple Junction Alignment Check Rule - executes child rules when junctions are aligned
Set Junctions Rule - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).

Control Type Rule

Sets the control method

Rule Properties:

<kuid:-16:2030>

Base Rule

Rule Settings:

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

Related Rules:

Control Check Rule - executes child rules if the train control method changes

Coupler Breakage Check Rule

Executes child rules if there is a coupler breakage

Rule Properties:

<kuid2:447264:1017:1>

Built-in Rule

Parent Rule

Rule Settings:

   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

Trainz Wiki Links:

How to Use Parent and Child Rules

Coupler Breakage HUD Rule

HUD displays warning about coupler stress and breakage

Rule Properties:

<kuid:-25:423>

Built-in Rule

Rule Settings:

    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 if a coupler breaks
Set Coupler Masks Rule - sets the coupling/decoupling masks on selected vehicles

Custom Script Rule

No description

Rule Properties:

<kuid:447264:1526>

Built-in Rule

Rule Settings:

  None

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

D

DestSign Table Rule

Creates a list of destination names for a destination sign

Rule Properties:

<kuid2:206816:99004:2>

Built-in Rule

Rule Settings:

  <add destination> - enter a destination name to be added to the destination sign roll
  <import destinations from texture-group> - select a list of destination names from session
  [x] Enable industries/stations as destination - check to set
  [x] Enable Track Marks as destinations - check to set
  [x] Enable table of destinations - check to set

Directional Trigger Check Rule

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

Rule Properties:

<kuid2:532391:100003:1>

DLS Rule by bobhahn

Parent Rule

Rule Settings:

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

Notes:

This rule works best when used with the Directional Trigger track object available on the DLS.
The Directional Trigger, when installed, will appear as a Signal not as a Trackmark.
Normal (non directional) triggers can be used with this rule but the rule will have no direction sensitivity apart from the forward and backward in the rule properties.

Related Rules:

Trackside Check Rule - executes child rules when activated by a train. Provides different options to the Trigger Check Rule
Trigger Check Rule - executes child rules when a set train enters a set trigger (non-directional)

Examples of Use:

How to Control Signals in Sessions: Halt Before Clear

Trainz Wiki Links:

Disable/Enable Industry Rule

Enables/Disables vehicle load/unload for industry

Rule Properties:

<kuid2:401543:1171:1>

Built-in Rule

Rule Settings:

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

Disallow AI Rule

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

Rule Properties:

<kuid:400048:100603>

DLS Rule by callavsg

Rule Settings:

  None

Related Rules:

AI Start Rule - restarts all halted AI drivers
AI Stop Rule - halts all AI drivers

Display Custom HUD Rule

Show or hide the Custom Heads Up Display.

Rule Properties:

<kuid:-3:10206>

Base Rule

Rule Settings:

   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.
mc Display Custom HUD V2 Rule (SP2 and later) - shows or hides a graphical HUD.
Quick CustomHud Manager Rule (SP2 and later) - creates custom HUDs that can be assigned to different drivers
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 - executes child rules when a HUD icon is clicked

Trainz Wiki Links:

http://online.ts2009.com/mediaWiki/index.php/Display_Custom_HUD_Rule

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

Rule Properties:

<kuid:-25:442>

Legacy Rule (replaced by Message Popup Rule)

Base Rule

Rule Settings:

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

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.

Rule Properties:

<kuid:-25:138>

Built-in Rule

Rule Settings:

   Display page <index.html> of html asset <click to select> in a new browser window
      index.html - enter the filename of a HTML page in the selected HTML asset. The .html is optional in the filename.
      <click to select> - select the HTML asset from those installed.

Notes:

Video must be in a valid web format.

Related Rules:

Play Sound Rule - plays a wav sound file

Driver Command Check Rule

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

Rule Properties:

<kuid:-25:447>

Built-in Rule

Parent Rule

Rule Settings:

 [x] 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
Driver Schedule Rule - sets up a list of basic scheduled driver commands
Driver Setup Rule - creates a list of drivers and assign them their orders
Enable/Disable Driver Commands Rule - enable/disable specific driver commands on certain drivers
ScheduleAtTrackside Rule - issues set of driver commands at a trackmark or trigger
Schedule Library Rule - creates a library of driver schedules (commands)
Schedule Rule - allows a schedule of timed events to be applied to a train

Trainz Wiki Links:

How to Use Parent and Child Rules

Driver Command Rule

Specifies which commands will be available for the drivers

Rule Properties:

<kuid:-3:10057>

Base Rule

Rule Settings:

    For each installed Driver Command:- 
   [x] Name of Driver Command and Description (if available) - check to make that command available to the drivers

Notes:

Some Driver Commands that have been checked will not appear in the Command Lists for drivers if there is no target for their action. For example:

The Wait For Trigger command will not be available to any drivers if there are no triggers set.

The Call At command will not be available to any drivers if there are no industry active assets or passenger enabled stations.

Related Rules:

Driver Command Check Rule - executes child rules if the driver commands match a set list
Driver Schedule Rule - sets up a list of basic scheduled driver commands
Driver Setup Rule - creates a list of drivers and assign them their orders
Enable/Disable Driver Commands Rule - enable/disable specific driver commands on certain drivers
ScheduleAtTrackside Rule - issues set of driver commands at a trackmark or trigger
Schedule Library Rule - creates a library of driver schedules (commands)
Schedule Rule - allows a schedule of timed events to be applied to a train

Examples of Use:

How to Use Driver Command Rule

Trainz Wiki Links:

Driver Commands List

Driver Main Menu Options Rule

Show/Hide the Driver Main Menu Bar

Rule Properties:

<kuid:-25:448>

Built-in Rule

Rule Settings:

   <Show/Hide> the Driver Main Menu Bar - click Show or Hide to select

Driver Schedule Rule

Sets up a list of basic scheduled commands

Rule Properties:

<kuid2:82445:90001:9>

Built-in Rule

Rule Settings:

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

Related Rules:

Driver Command Check Rule - executes child rules if the driver commands match a set list
Driver Command Rule - specifies which commands will be available for the drivers
Driver Setup Rule - creates a list of drivers and assign them their orders
Enable/Disable Driver Commands Rule - enable/disable specific driver commands on certain drivers
ScheduleAtTrackside Rule - issues set of driver commands at a trackmark or trigger
Schedule Library Rule - creates a library of driver schedules (commands)
Schedule Rule - allows a schedule of timed events to be applied to a train

Examples of Use:

How to Use Variables in Sessions (Examples): Event Counter and Message Selection

Driver Setup Rule

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

Rule Properties:

<kuid:-16:2025>

Base Rule

Rule Settings:

   <driver icon> - click to select a new driver from the list of installed and built in drivers
   <loco> - click to select a new locomotive from the session list and assign it to this driver. Locos displayed in red have not been found in the session list
   <driver name> - click to enter a new name for the selected driver
   <driver mode> -  click to select one of:- 
      Autodetect - the program will detect the driver mode to be used. For example, if driver commands have been entered for this driver
         then the AI driver mode will be selected
      First Human Player - the driver will be assigned to the user or multiplayer who accesses her/him first
      AI driver - the AI will be given control even if no commands are present
      Multiplayer Driver - the driver will be assigned to a multiplayer user
   <remove> - this driver will be removed from the rule
   >> - click to enter driver commands from those specified in the Driver Command Rule
     Scroll down to the bottom of the list of entered drivers for more options:- 
 <Add another driver> - click to add another driver 
 [x] Remove all existing Drivers first -  see Known Issues below 
 [x] Generate new Drivers for empty Trains - when checked all newly added locos will automatically be given drivers

Known Issues:

The Remove all existing Drivers first option does not appear to work in TANE (but works in TRS19 and later)
Adding a large number of drivers to a session can cause Timeout errors. One known workaround is to split the drivers between two copies of the Driver Setup Rule and make the second copy a child of a Wait Rule. For more details see the Wiki How to Use Driver Setup Rule. This issue has been reported as FIXED in the latest beta versions of TRS19 SP1 and Trainz Plus

Notes:

The driver at the top of the list will have the camera focus when the Session starts. There is no way to move a driver up the list order except by removing the higher drivers

Related Rules:

Driver Command Check Rule - executes child rules if the driver commands match a set list
Driver Command Rule - specifies which commands will be available for the drivers
Driver Schedule Rule - sets up a list of basic scheduled driver commands
Enable/Disable Driver Commands Rule - enable/disable specific driver commands on certain drivers
ScheduleAtTrackside Rule - issues set of driver commands at a trackmark or trigger
Schedule Library Rule - creates a library of driver schedules (commands)
Schedule Rule - allows a schedule of timed events to be applied to a train

Examples of Use:

How to Use Driver Setup Rule

Trainz Wiki Links:

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

E, F, G

EIRS Weather Rule NE USA Rule

Customize random weather rule relative to the North East Region of the United States.

Rule Properties:

<kuid2:487222:1037:3>

Built-in Rule

Rule Settings:

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

Notes:

Minutes are Trainz clock times, not real times

Related Rules:

Random Weather Rule v2 - randomly changes the weather according to entered parameters
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

Rule Properties:

<kuid:-25:480>

Built-in Rule

Rule Settings:

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

Related Rules:

Driver Command Check Rule - executes child rules if the driver commands match a set list
Driver Command Rule - specifies which commands will be available for the drivers
Driver Schedule Rule - sets up a list of basic scheduled driver commands
Driver Setup Rule - creates a list of drivers and assign them their orders
ScheduleAtTrackside Rule - issues set of driver commands at a trackmark or trigger
Schedule Library Rule - creates a library of driver schedules (commands)
Schedule Rule - allows a schedule of timed events to be applied to a train

Trainz Wiki Links:

http://online.ts2009.com/mediaWiki/index.php/Enable/Disable_Driver_Commands_Rule

End Session Rule

End the Session with a fade out.

Rule Properties:

<kuid:-25:482>

Built-in Rule

Rule Settings:

   Fade out over <value> seconds - enter number of seconds for fade out.

Notes:

Seconds are Trainz clock time, not real time.

Related Rules:

Session Complete Rule - set the session to a percentage of completion

ExTrainz Manager Rule - TANE SP2

Provides information on consists, industries and products in both Surveyor and Driver modes. Once activated, the rule creates an additional short menu bar below the main menu bar.

Rule Properties:

<kuid:160293:10029>

DLS Rule by trev999

Rule Settings:

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

Known Issues:

This rule is NOT compatible with all industries.

Notes:

Rolling stock installed in the current session only (see settings above) can be searched to find a match for any selected product from any industry. In Surveyor (and Driver if that setting is enabled) click on the View Products sub menu link and click on a product name in the Product Window to display a list of all compatible rolling stock for that product.
Alternatively, click on the View Industries sub menu link and then click on a Product Icon to open a Product Window, then click on the View Rolling Stock link at the top of the window.
Industry class names are defined in the config.txt file of industry assets and are not normally accessible by users. However, you can exclude an entire group of related "industry asset classes" such as station, coalingtower, watertank, etc regardless of their actual names provided those assets have been given that "class name" by their creators.

Fade In/Out Rule

Fade in or out within seconds, using specified color and opacity values.

Rule Properties:

<kuid2:190611:200000:2>

Built-in Rule

Rule Settings:

   Red percentage:             <value> - enter the final % of red (0 = none, 100 = maximum)
   Green percentage:           <value> - enter the final % of green
   Blue percentage:            <value> - enter the final % of blue
   Alpha percentage (opacity): <value> - enter the final % of opacity (0 = invisible, 100 = solid)
   Fading duration:            <value> - enter the number of seconds required for the fade
   <help> - click to bring up help instructions

Notes:

Seconds are Trainz clock time, not real time.

Flash HUD Icon Rule

Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.

Rule Properties:

<kuid:-25:968>

Built-in Rule

Rule Settings:

    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 - shows or hides the Custom Heads Up Display.
mc Display Custom HUD V2 Rule (SP2 and later) - shows or hides a graphical HUD.
Quick CustomHud Manager Rule (SP2 and later) - creates custom HUDs that can be assigned to different drivers
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 - executes child rules when a HUD icon is clicked

Focus Camera Rule

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

Rule Properties:

<kuid2:122381:10014:1>

DLS Rule by mizi

Rule Settings:

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

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 - executes child rules when the camera view is changed

Generic TreeNode Debug Window Rule

No description.

Rule Properties:

<kuid:30501:1042>

Base Rule

Rule Settings:

   None

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

H, I, J

Hide Product Overlays Rule

Hides the commodity or product bar graphs that appear on active industries

Rule Properties:

<kuid:400048:100970>

DLS Rule by callavsg

Rule Settings:

  None

InputTable Rule

Creates a list of message names to be used for various purposes including passing data to Driver Commands

Rule Properties:

<kuid2:131986:1012:1>

Built-in Rule

Rule Settings:

   <add> - click to add a new entry to the table
    Each new entry will require an input message 
      <short message> - enter a message. The message must be in a format that is specific for each purpose
       For the MoveTurntable driver command the message must be formatted as:- 
         turntable,name_of_turntable,number_of_connecting_roads - the first entry must be the word turntable in lower case.
            name_of_turntable is the name of the turntable, 
            number_of_connecting_roads is the number of tracks connecting to the turntable
       For the WaitUntilTime driver command the message must be formatted as:- 
         time,hour,minute - the first entry must be the word time in lower case, 
            hour must be from 0 to 23, 
            minute must be from 0 to 59.
       For the Skip If Session-Variable and Wait Until S-Variable driver commands the message must be formatted as:- 
         svar,svar_name,svar_condition,value - the first entry must be the word svar in lower case, 
            svar_name is the name of the session variable, 
            svar_condition is an equality (eg eq for equal, gt for greater than, etc)
            value is an integer value to be compared to the session variable.
    Each entry in the table will be followed by the commands:- 
      cp - click to copy this entry to a new entry
      up - click to move this entry up one level
      dn - click to move this entry down one level
      rm - click to remove this entry from the table

Dependent Driver Commands:

The rule must be added to the Session for the following Driver Commands to work

Interlocking Tower Configure Path Rule

Alters settings on an interlocking tower path

Rule Properties:

<kuid:401543:3205>

Base Rule

Rule Settings:

  Interlocking Tower <select> - to set Name and Objects

Known Bugs:

The Interlocking Tower and Enhanced Interlocking Tower assets have a bug that saves their initial paths and properties in the Route and then saves any edits you make in the Session. The workaround is to always use Session Surveyor when using ITs and EITs.

Related Rules:

Interlocking Tower Path Selection UI Rule - automatically reacts to messages from Interlocking Towers and displays a path selection dialog to the player.
Interlocking Tower Set Path Rule - 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 Path Selection UI Rule

Will automatically react to messages from Interlocking Towers and display a path selection dialog to the player. Disable by removing rule from session

Rule Properties:

<kuid:401543:3203>

Base Rule

Rule Settings:

  [Checkbox] Show path activation message in Driver

Known Bugs:

The Interlocking Tower and Enhanced Interlocking Tower assets have a bug that saves their initial paths and properties in the Route and then saves any edits you make in the Session. The workaround is to always use Session Surveyor when using ITs and EITs.

Related Rules:

Interlocking Tower Configure Path Rule - 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

Rule Properties:

<kuid:401543:3204>

Base Rule

Rule Settings:

  Interlocking Tower <select> - to set Name and Objects

Known Bugs:

The Interlocking Tower and Enhanced Interlocking Tower assets have a bug that saves their initial paths and properties in the Route and then saves any edits you make in the Session. The workaround is to always use Session Surveyor when using ITs and EITs.

Related Rules:

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

Rule Properties:

<kuid2:61392:8130:41>

DLS Rule by pguy

Rule Settings:

   <towers> - click to select interlocking towers from the session list
      <do full check again> - click to run an error check on all interlocking towers
      List of all available interlocking towers -  for each tower:- 
         <view details> - click to view and edit the tower properties
         <copy from> - click to copy properties from another tower selected from the session list
   <debug log> - click to set the debug log properties

Notes:

It is recommended that you refer to the detailed instructions in the Trainz Wiki shown below.

Known Bugs:

The Interlocking Tower and Enhanced Interlocking Tower assets have a bug that saves their initial paths and properties in the Route and then saves any edits you make in the Session. The workaround is to always use Session Surveyor when using ITs and EITs.

Related Rules:

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

Trainz Wiki Links:

http://online.ts2009.com/mediaWiki/index.php/Enhanced_Interlocking_Tower_Manager_Rule

JTG Correct Vehicle Lights

Corrects the brightness of vehicle headlights. Now obsolete.

Rule Properties:

<kuid2:478657:999103:1>

DLS Rule by jtg-trainz

Obsolete Rule (function is now built into Trainz)

Rule Settings:

   None

Junction Derailment Prevention Rule

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

Rule Properties:

<kuid2:121843:100282:1>

DLS Rule by pitkin

Rule Settings:

   None

Notes:

This rule will not overrule a junction already locked by another AI train or locked against AI control using the Set Junctions Rule.

Related Rules:

Control Path Rule - sets the path for selected trains
Lock All Junctions Rule - locks all junctions against user control
Set Cleared Junctions Rule - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.
Set Junctions Rule - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).

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

K, L, M

Lock All Junctions Rule

Locks all junctions against user actions. AI operations are not affected. Once the AI releases a junction, it will be returned to its previous locked state.

Rule Properties:

<kuid:400048:100971>

DLS Rule by callavsg

Rule Settings:

   None

Notes:

Individual junctions can still be set, locked and unlocked by using the Set Junction Rule

Related Rules:

Set Cleared Junctions Rule - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.
Set Junctions Rule - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).

MaxPermittedSpeed Rule

Sets the maximum permitted speed of locomotives under AI control

Rule Properties:

<kuid2:60850:89000:7>

Built-in Rule

Rule Settings:

   None

Notes:

This rule cannot be configured from the Session Rules list. It must be configured in the config.txt file of each locomotive. Instructions with an example are shown in the rule Properties

mc Display Custom HUD V2 Rule (SP2 and later)

Shows or hides a graphical HUD which includes junction direction for the junction ahead. This rule has been superseded by the Quick CustomHud Manager Rule (SP2 and later)

Rule Properties:

<kuid2:61392:1072:10>

Legacy Rule (replaced by Quick CustomHud Manager Rule (SP2 and later))

DLS Rule by pguy

Rule Settings:

    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:

Display Custom HUD Rule - shows or hides the Custom Heads Up Display.
Flash HUD Icon Rule - flashes a HUD panel icon for a set duration.
Quick CustomHud Manager Rule (SP2 and later) - creates custom HUDs that can be assigned to different drivers
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 - executes child rules when a HUD icon is clicked

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.

Rule Properties:

<kuid:-25:1003>

Built-in Rule

Rule Settings:

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

Known Issues:

Because this rule will wait until it is closed (terminated) then it is not recommended for use in an Ordered List because you cannot guarantee that any following child rules will be executed. If it MUST be used in an Ordered List then place it last.

Related Rules:

Close Message Popup Rule - closes a displayed pop-up browser window.
Display HTML Pages Rule - display listed HTML files in order as a navigable sequence of pages.
Timed Limited Display HTML Rule (SP2 and later) - displays a HTML page in a browser window for a set time.

Examples of Use:

Trainz Wiki Links:

Minimap Options Rule

Sets the display options for the minimap.

Rule Properties:

<kuid:-25:636>

Built-in Rule

Rule Settings:

Default values - all checked
   [x] Map Textures
   [x] Gradients
   [x] Junctions
   [x] Signals
   [x] Triggers
   [x] Markers
   [x] Trackside Labels
   [x] Terrain Objects
   [x] Industrial Names
   [x] Named Objects
   [x] Consists

Related Rules:

Show/Hide Minimap Rule - shows the minimap window in Driver.

MissionCode Manager Rule (SP2 and later)

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

Rule Properties:

<kuid2:61392:8200:50>

DLS Rule by pguy

Rule Settings:

  Refer to the detailed instructions in the Trainz Wiki Links shown below.

Related Rules:

MissionCode Stops and Timetable Manager Rule (SP2 and later) - creates and edits stop zones and timetables for trains with mission codes

Dependent Driver Commands:

The rule must be added to the Session for the following Driver Commands to work

Trainz Wiki Links:

http://online.ts2009.com/mediaWiki/index.php/MissionCodes_Manager

MissionCode Stops and Timetable Manager Rule (SP2 and later)

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

Rule Properties:

<kuid2:61392:8300:50>

DLS Rule by pguy

Rule Settings:

  Refer to the detailed instructions in the Trainz Wiki Links shown below.

Related Rules:

MissionCode Manager Rule (SP2 and later) - creates and edits mission codes for trains

Trainz Wiki Links:

http://online.ts2009.com/mediaWiki/index.php/Mission_Code_Stops_and_TimeTables_Manager

Multiplayer Rule

Enables the session to be taken online in a Multiplayer environment.

Rule Properties:

<kuid:447264:1045>

Built-in Rule

Rule Settings:

   Suggested maximum number of players for this session <value> - enter a number
   Maximum number of drivers per player <value> - enter a number
   Players are permitted to claim drivers             [x] - check to allow players to select a driver
   Players can see each other's driver orders         [x] - check to allow players to view orders for other players
   Automatically target an available train on clients [x] - automatically assign a driver to each player

Multiple Junction Alignment Check Rule

Executes child rules if specific junctions are set.

Rule Properties:

<kuid:-25:168>

Built-in Rule

Parent Rule

Rule Settings:

   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:

Control Path Rule - sets the path for selected trains
Lock All Junctions Rule - locks all junctions against user control
Set Cleared Junctions Rule - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.
Set Junctions Rule - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).

Examples of Use:

How to Control Junctions in Sessions

Trainz Wiki Links:

How to Use Parent and Child Rules

Multiple Resource Check Rule

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

Rule Properties:

<kuid:-25:656>

Built-in Rule

Parent Rule

Rule Settings:

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

Notes:

This rule only checks for changing commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is full or empty.

Related Rules:

Resource Check Rule - executes child rules when set resource (commodity) levels are reached
Resource Verify Rule (fixed) - executes child rules when a set resource (commodity) level is reached

Examples of Use:

How to Use Navigation Point Rules (Applications): Wait for Loading to be Completed

Trainz Wiki Links:

How to Use Parent and Child Rules

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

N, O

Navigation Display Rule

Creates a set of navigation points. Multiple sets can be created by adding additional copies of this rule. This rule creates the navigation set, it does not display it.

Rule Properties:

<kuid2:401543:1161:1>

Base Rule

Rule Settings:

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

Related Rules:

Navigation Set Hide/Show Rule - makes a navigation set visible/invisible.
Navigation Set Check Rule - executes child rules if a navigation set has completed or is 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 - executes child rules when a navigation point has been completed

Examples of Use:

Navigation Point Complete Rule

Manually completes a navigation point in a set

Rule Properties:

<kuid:401543:1167>

Base Rule

Rule Settings:

   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.

Notes:

The navigation set and point must first be created by the Navigation Display Rule

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 - executes child rules if a navigation set has completed or is incomplete.
Navigation Set Clear Rule - completes (terminates) a navigation set.
Wait on Navigation Point Rule - executes child rules when a navigation point has been completed

Examples of Use:

Navigation Set Check Rule

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

Rule Properties:

<kuid:401543:1165>

Base Rule

Parent Rule

Rule Settings:

   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.

Notes:

The navigation set must first be created by the Navigation Display Rule

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 - executes child rules when a navigation point has been completed

Examples of Use:

Trainz Wiki Links:

How to Use Parent and Child Rules

Navigation Set Clear Rule

Clears a navigation set removing any uncompleted navigation points

Rule Properties:

<kuid:401543:1164>

Base Rule

Rule Settings:

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

Notes:

The navigation set must first be created by the Navigation Display Rule

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 - executes child rules if a navigation set has completed or is incomplete.
Navigation Point Complete Rule - manually completes (terminates) a specific navigation point in a set.
Wait on Navigation Point Rule - executes child rules when a navigation point has been completed

Examples of Use:

Navigation Set Hide/Show Rule

Shows and hides navigation sets. You can have multiple sets visible and hidden at the same time.

Rule Properties:

<kuid:401543:1163>

Base rule

Rule Settings:

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

Notes:

The navigation set must first be created by the Navigation Display Rule

Related Rules:

Navigation Display Rule - creates a set of navigation points.
Navigation Set Check Rule - executes child rules if a navigation set has completed or is 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 - executes child rules when a navigation point has been completed

Examples of Use:

Objective Add Rule

Sets up a game Objective with ID and display Name

Rule Properties:

<kuid:401543:2001>

Base Rule

Rule Settings:

   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 - executes child rules if an objective is completed
Objective Update Rule - changes the progress of a game objective

Objective Check Rule

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

Rule Properties:

<kuid:401543:2003>

Base Rule

Parent Rule

Rule Settings:

   Unique Objective ID <value> - enter the unique ID created with the Objective Add Rule 
   Mode <select> -  select one of three:- 
      Wait for completion
      Wait for failure
      Wait for progress

Related Rules:

Objective Add Rule - sets up a game objective
Objective Update Rule - changes the progress of a game objective

Trainz Wiki Links:

How to Use Parent and Child Rules

Objective Update Rule

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

Rule Properties:

<kuid:401543:2002>

Base Rule

Rule Settings:

   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 - executes child rules if an objective is completed

Ordered List Rule

Executes child rules in order once this rule starts

Rule Properties:

<kuid:-25:171>

Built-in Rule

Parent Rule

Rule Settings:

    Select one of two option buttons:- 
     ( ) This process will repeat <value> time(s) - enter the number of times this rule is to be repeated
     ( ) This process will repeat forever

Known Issues:

Some child rules will force a "wait" until certain conditions have been met (e.g. a mouse click or a set time has passed). These rules will delay the completion of any following child rules in the Ordered List Rule. If possible, place these rules last in the Ordered List.

For example: The Message Popup Rule will wait until it is closed before allowing the next child rule to be executed.

Related Rules:

Progressive List Rule - executes the first child rule on the first run, the second child on the second run, etc
Random List Rule - executes ONE randomly selected child rule
Reset List Rule - executes all child rules continuously
Simultaneous List Rule - executes all child rules simultaneously

Trainz Wiki Links:

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

P, Q

Play Sound Rule

Plays a wav sound file.

Rule Properties:

<kuid:-25:1045>

Built-in Rule

Rule Settings:

   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

Rule Properties:

<kuid:-25:746>

Base Rule

Rule Settings:

   Power station <select> - select a Power Station from the session list.
   Consumers:
      <add object> - add power consumers from the session list

Progressive List Rule

Executes the first child rule on the first run, the second child on the second run, the third child on the third run, etc.

Rule Properties:

<kuid:-25:754>

Built-in Rule

Parent Rule

Rule Settings:

  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 - executes child rules in order
Random List Rule - executes ONE randomly selected child rule
Reset List Rule - executes all child rules continuously
Simultaneous List Rule - executes all child rules simultaneously

Trainz Wiki Links:

Quick CustomHud Manager Rule (SP2 and later)

Allows the creation of new graphical heads up displays which are assigned to the drivers in Driver Mode. Replaces the mc Display Custom HUD V2 Rule (SP2 and later)

Rule Properties:

<kuid2:61392:5020:47>

DLS Rule by pguy

Rule Settings:

<Copy rule to data Clipboard> - click to copy the data from the selected HUD to a special clipboard area used by the rules created by pguy.
This is NOT the standard OS clipboard.
<Paste rule data from Clipboard> - if data is held in the special clipboard area, then click to paste that data into the selected HUD.
This is NOT the standard OS clipboard.
Current HUD Parameters
HUD to select: <HUD name> - click to select a HUD from those available. One or two default HUDs will be supplied.
new HUD - click to create a new HUD display with default properties. You will be required to enter a name for the new HUD
clone HUD - click to create a new HUD using the properties of the currently selected HUD. You will be required to enter a name for the new HUD
copy HUD - copies (overwrites) the currently selected HUD with the properties of another HUD. You will be required to enter the name of the HUD to be copied
For new, cloned or copied HUDs, additional commands will be shown:-
rename HUD - rename the selected HUD. You will be required to enter a new name for the HUD
delete HUD - delete the currently displayed HUD
In Driver Mode an additional command will be shown:-
Assign hud to current train - click to assign the currently selected HUD to the currently selected driver
[x] hud is displayed (on) - check to display HUD in Driver Mode
hud items nb entries max: <value> - enter the maximum number of items to be displayed in the HUD. Maximum is 30.
hud view limit: <value> - enter the maximum look-ahead distance in metres for the HUD. Minimum value is 1000, maximum value is 10000.
[x] display data in a centred window above orderbar - check to display the HUD centred on the screen just above the driver command bar in Driver Mode
For each individual HUD property:-
[x] HUD property - check to add this property to the HUD

Notes:

HUDs are assigned to drivers in Driver Mode by either adding a SetCustomHud (SP2 and later) command to individual drivers command lists or manually by clicking a green RM tool button displayed on the top menu and selecting Quick CustomHUD Manager from the menu.

Related Rules:

Display Custom HUD Rule - shows or hides the Custom Heads Up Display.
Flash HUD Icon Rule - flashes a HUD panel icon for a set duration.
mc Display Custom HUD V2 Rule (SP2 and later) - shows or hides a graphical HUD.
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 - executes child rules when a HUD icon is clicked

Dependent Driver Commands:

The rule must be added to the Session for the following Driver Commands to work

Set Custom HUD (SP2 and later)

Quick Portal Manager Standard Edition Rule (SP2 and later)

Manages portals and adds flexible timetables.

Rule Properties:

<kuid2:61392:5011:45>

DLS Rule by pguy

Rule Settings:

   Target date is day-of-week <dd/mm/yyyy> - day-of-week and date shown are for today's date. Click dd/mm/yyyy to change date.
   <Copy rule data to Clipboard> - click to copy the currently entered data to a special clipboard area used by the rules created by pguy. 
       This is NOT the standard OS clipboard. 
   <Paste rule data from Clipboard> - if data is held in the special clipboard area, then click to paste that data into the rule.
       This is NOT the standard OS clipboard. 
   [x] This rule is enabled - check to activate (enable) the rule.
   [x] Avoid duplicated driver if possible - check to prevent the same driver being used again. If a driver name is reused, the rule will select a different driver name.
   [x] Disable locomotives/vehicles enhanced mode - check to save vehicle properties when a train is removed by a portal. 
      These properties will be restored if the same train is emitted by a portal.  If checked then a new command will appear:- 
      <for all vehicles/for only locomotives/for only tagged vehicles> - click to select one.
   Portal selected: <portal name> [...] - select a portal to manage by clicking <portal name> or [...] and selecting a portal from the Session list.
   Portal output link: <[no link]> [...] - leave blank.
   Portal input link: <[no link]> [...] - leave blank unless you want to connect to a Global Input Queue. Click to select an input queue from the Session list.
   Default schedule for input trains is named: <schedule> - click to enter a schedule name.
   Today's schedule: <Insert new schedule> - click to enter a new schedule
    For each schedule:- 
      <hh:mm> - click to set the time when a train will be emitted from the portal. Times use the 24hr clock.
      <train name> - click to enter the train name
      <mission code> - click to enter the Mission Code created by the MissionCode Manager Rule (SP2 and later).
      <schedule> - click to enter the re-occurrence schedule in hh:mm (24hr clock) where, for example:
         02:30 means every 2 hrs 30 minutes,
         00:00 means once only,
         24:00 means once each day.
      <driver> - click to select a driver name or select auto-driver to let the rule select a driver.
         Current driver order bar is named <schedule> - click to enter a name for the order (Driver Command) bar used in this schedule.
      <hud> - click to select a HUD for this train. HUDs must be created using the Quick CustomHud Manager Rule (SP2 and later).
      Driver Command Bar - enter driver commands for this train.
       Choose one of two consist sets:- 
      <mono consist> consist for every day - if selected the same consist will be used each day.
         <no consist selected> - click to select a consist from those saved in your install.
      <multi consists> - if selected a different consist will be used each day. 
          For each day of the week:- 
            Day-of-week <no consist selected> - click to select a consist from those saved in your install.

Related Rules:

MissionCode Manager Rule (SP2 and later) - creates and manages Mission Codes for Interlocking Tower paths
Quick CustomHud Manager Rule (SP2 and later) - create driver HUDs

Trainz Wiki Links:

http://online.ts2009.com/mediaWiki/index.php/Quick_Portal_Manager

Quick Session Variables Rule

Allows the editing of session variables

Rule Properties:

<kuid2:61392:5003:30>

DLS Rule by pguy

Legacy Rule (use Variable Modify Rule)

Rule Settings:

   <local> - click to edit local variables
      <add new session variable> - click to enter the name of new local variable
          for each variable:- 
         <variable-name> - click to change variable name
         <type> -  click to select one of:- 
            string - text characters
            int - integer
            float - real (decimal) numbers
            bool - boolean (true/false)
            stringset - meaning not known at this time
            stringlist - meaning not known at this time
            tkmlist - trackmark list (no longer supported in TANE SP2)
            platformlist - platform list (no longer supported in TANE SP2)
            del - delete variable
            edit - edit variable
   <trains> - click to edit a train variable
      <train selected> - click to select a train from the session list. Initially none is selected
         <select train> - click to select a locomotive
         <select vehicle> - click to select a rail vehicle
          for the selected loco/vehicle:- 
            <Add new session variable> - click to enter the name of a new variable
               for the entered variable:- 
                 <variable-name> - click to change variable name
                 <type> - click to select type (see list above)
   <objects> - no longer supported in TANE SP2
   <global> - no longer supported in TANE SP2

Known Issues:

Rule creator, pguy, has indicated that the future of this rule is uncertain as parts of it have been devalued in the latest releases of Trainz.

Related Rules:

Variable Check Rule - executes child rules according to 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

Changes the Session settings.

Rule Properties:

<kuid:401543:1184>

Base Rule

Rule Settings:

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

Trainz Wiki Links:

http://online.ts2009.com/mediaWiki/index.php/QuickDrive_Rule

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

R

Random List Rule

Executes ONE randomly selected child rule once only. The rule will not repeat to randomly select another child rule

Rule Properties:

<kuid:-25:758>

Built-in Rule

Parent Rule

Rule Settings:

   None

Related Rules:

Ordered List Rule - executes child rules in order
Progressive List Rule - executes the first child rule on the first run, the second child rule on the second run, etc
Reset List Rule - executes all child rules continuously
Simultaneous List Rule - executes all child rules simultaneously

Trainz Wiki Links:

Random Weather Rule v2

Randomly changes the weather conditions between set values over a set duration.

Rule Properties:

<kuid:169301:100132>

DLS Rule by terry_wagstaff

Rule Settings:

   Starting weather <select> -  select one of:- 
         Clear weather, no clouds, rain or snow
         Cloudy weather, no rain 
         Drizzle, light rain
         Rain
         Stormy weather that includes lightning and thunder
         Snowing lightly
         Medium snowfall
         Heavy snow
   Best weather <select> -  select one of:- 
         Clear weather, no clouds, rain or snow
         Cloudy weather, no rain 
         Drizzle, light rain
         Rain
         Stormy weather that includes lightning and thunder
         Snowing lightly
         Medium snowfall
         Heavy snow
   Worst weather <select> -  select one of:- 
         Clear weather, no clouds, rain or snow
         Cloudy weather, no rain 
         Drizzle, light rain
         Rain
         Stormy weather that includes lightning and thunder
         Snowing lightly
         Medium snowfall
         Heavy snow
   Changing about every: <value> mins - enter number of minutes between weather changes

Notes:

This rule, once started, will run continuously and will not terminate. If this rule is to be used as a child rule of an Ordered List Rule then place it LAST in the list.

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
Weather Rule - changes the weather conditions during Session play

Randomize Rule

Generates a different set of random numbers each time the session is run.

Rule Properties:

<kuid:169301:100129>

DLS Rule by Terry_Wagstaff

Rule Settings:

   None

Notes:

Place this rule near the top of the Session Rules list and ensure that there is at least 5 seconds before the call to a Random function.

Related Rules:

Variable Random - sets a variable to a random integer value.

Ranked Session Begin Rule

Begins a ranked Session

Rule Properties:

<kuid:401543:2031>

Base Rule

Rule Settings:

   Countdown Starting Value <value>
      hrs:
      min:
      sec:
   1 through 5 stars, points for each star <value> - enter number of points for each star rating
   Session timer mode: -  select one of three option buttons:- 
      ( ) Timer
      ( ) Countdown Starting value <value> - enter time hh:mm:ss
      ( ) None

Notes:

Times are Trainz clock time, not real time

Related Rules:

Ranked Session Complete Rule - completes the active ranked Session

Ranked Session Complete Rule

Completes the active ranked Session

Rule Properties:

<kuid:401543:2032>

Base Rule

Rule Settings:

   Set the active ranked session as: -  select one of two option buttons:- 
      ( ) Complete
      ( ) Failed
   [x] 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

Rule Properties:

<kuid:447264:1214>

Built-in Rule

Rule Settings:

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

Related Rules:

Clean Up Derailed Trains Rule - cleans up derailed train cars after a set time delay
Wait for Derailment Rule - executes child rules when a derailment occurs

Reset List Rule

Executes ALL child rules continuously in an ongoing infinite cycle

Rule Properties:

<kuid:-25:762>

Built-in Rule

Parent Rule

Rule Settings:

   None

Related Rules:

Ordered List Rule - executes child rules in order
Progressive List Rule - executes the first child rule on the first run, the second child rule on the second run, etc
Random List Rule - executes ONE randomly selected child rule
Simultaneous List Rule - executes all child rules simultaneously

Trainz Wiki Links:

Resource Check Rule

Executes child rules if a selected industry or vehicle reaches a set commodity level. This rule has been superseded by the Multiple Resource Check Rule

Rule Properties:

<kuid:-25:1067>

Legacy Rule (replaced by Multiple Resource Check Rule)

Built-in Rule

Parent Rule

Rule Settings:

    Select one of two option buttons:- 
      ( ) Watch industry queue
         Target Object <select> - select an industry from the session list
         Queue <select> - select a product queue from the selected industry
         Product <select> - select a product from the selected queue
         Amount <value> - enter a quantity
          Select one of two option buttons:- 
            ( ) Complete when designated queue equals or exceeds required amount
            ( ) Complete when designated queue falls below required amount
      ( ) Watch vehicle
         Target Object <select> - select a rolling stock asset from the session list
         Queue <select> - select a product queue from the selected rolling stock
         Product <select> - select a product from the selected queue
         Amount <value> - enter a quantity
          Select one of two option buttons:- 
            ( ) Complete when designated queue equals or exceeds required amount
            ( ) Complete when designated queue falls below required amount

Notes:

This rule only checks for changing commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is full or empty.

Related Rules:

Multiple Resource Check Rule - executes child rules when set resource (commodity) levels are reached
Resource Verify Rule (fixed) - executes child rules when a set resource (commodity) level is reached

Trainz Wiki Links:

Resource Verify Rule (fixed)

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

Rule Properties:

<kuid:160293:10060>

DLS Rule by trev999

Parent Rule

Rule Settings:

    Select one of two option buttons:- 
   ( ) Watch industry queue
      Target object <click to select> - click to select an industry from the session list.
      Product <click to select> - click to select an industry product.
      Amount <value> - enter a quantity for the selected product.
       Select one of two option buttons:- 
      ( ) Complete when designated queue equals or exceeds designated amount
      ( ) Complete when designated queue falls below designated amount
   ( ) Watch vehicle queue
      Target object <click to select> - click to select a rolling stock vehicle from the session list.
      Product <click to select> - click to select a commodity product.
      Amount <value> - enter a quantity for the selected product.
       Select one of two option buttons:- 
      ( ) Complete when designated queue equals or exceeds designated amount
      ( ) Complete when designated queue falls below designated amount

Notes:

This rule will only monitor a single commodity in a single industry or vehicle.
This rule only checks for changing commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is full or empty.

Related Rules:

Multiple Resource Check Rule - executes child rules when set resource (commodity) levels are reached
Resource Check Rule - executes child rules when set resource (commodity) levels are reached

Trainz Wiki Links:

How to Use Parent and Child Rules

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

S-Se

Safety System Engaged Check Rule

Executes child rules if safety systems are applied.

Rule Properties:

<kuid:447264:1216>

Built-in Rule

Parent Rule

Rule Settings:

   [x] Trigger only once

Related Rules:

Safety System Isolated Check Rule - executes child rules if safety systems have been isolated

Trainz Wiki Links:

How to Use Parent and Child Rules

Safety System Isolated Check Rule

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

Rule Properties:

<kuid:447264:1217>

Built-in Rule

Parent Rule

Rule Settings:

   [x] Trigger only once

Related Rules:

Safety System Engaged Check Rule - executes child rules if safety systems have been engaged

Trainz Wiki Links:

How to Use Parent and Child Rules

ScheduleAtTrackside Rule

Allows a set of driver commands to be given to a train when it reaches a trackmark or trigger.

Rule Properties:

<kuid2:61392:2001:6>

DLS Rule by pguy

Rule Settings:

   <Select trackmark> - <Select trigger> - click one to select a trackmark from the Session list or a trigger from the Session list
   Schedule will be fired <in both directions/in trackside forward direction/in trackside backward direction> - click to select one. Only available if trackmark has been selected
   This rule will be applied <all along the session> - click to enter the number of times to trigger the rule. 0 = everytime (all along the session)
   Enter driver commands to schedule when train is at trackside
      >> - click to enter driver commands from those specified in the Driver Command Rule
    Select one of two option buttons:- 
      ( ) new schedule will replace current driver command - select to delete any current command list and replace it with the command list above
      ( ) new schedule will be appended to current driver commands - select to add the command list above above to the current driver command list
   <add a new trackside entry> - click to add a new ScheduleAtTrackside entry below

Related Rules:

Driver Command Check Rule - executes child rules if the driver commands match a set list
Driver Command Rule - specifies which commands will be available for the drivers
Driver Schedule Rule - sets up a list of basic scheduled driver commands
Driver Setup Rule - creates a list of drivers and assign them their orders
Enable/Disable Driver Commands Rule - enable/disable specific driver commands on certain drivers
Schedule Library Rule - creates a library of driver schedules (commands)
Schedule Rule - allows a schedule of timed events to be applied to a train

Schedule Library Rule

Creates a library of driver schedules (driver command lists) that can be given to drivers during the creation or running of a session

Rule Properties:

<kuid2:192081:12:5>

Built-in Rule by brummfondel

Rule Settings:

  <add schedule> | <add group>
      To add individual schedules click <add schedule> then:- 
       <library Entry Name> - enter a unique name for the schedule
          <library Entry Name> - click to edit name
          <remove> - click to delete this schedule from the list
          <copy> - click to add a copy this schedule to the current group
          <move to group> - click to move this schedule to a schedule group
          In the driver command bar:-
             >> - click to enter driver commands from those specified in the Driver Command Rule
       To add groups of schedules click <add group> then:- 
       <Group Name> - enter a unique name for the group
           - - click to close the group list
           + - click to open the group list
           <Group Name> - click to edit name
           <remove> - click to delete this group from the schedule list

Notes:

Create the library schedules in this rule first.
In Surveyor (using the Driver Setup Rule) or Driver (directly in a driver command bar) add the Driver Command Copy Commands From and select the command schedule to be added or appended. The driver command Copy Commands From must be enabled in the Driver Command Rule.

Related Rules:

Driver Command Check Rule - executes child rules if the driver commands match a set list
Driver Command Rule - specifies which commands will be available for the drivers
Driver Schedule Rule - sets up a list of basic scheduled driver commands
Driver Setup Rule - creates a list of drivers and assign them their orders
Enable/Disable Driver Commands Rule - enable/disable specific driver commands on certain drivers
ScheduleAtTrackside Rule - issues set of driver commands at a trackmark or trigger
Schedule Rule - applies a schedule of timed events to a train

Dependent Driver Commands

The rule must be added to the Session for the following Driver Command to work

Copy Commands From

Schedule Rule

Allows a schedule of timed events to be applied to a train

Rule Properties:

<kuid:-3:10185>

Base Rule

Rule Settings:

   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

Known Bugs:

There are reports that this rule does not work correctly particularly if a train arrives late or early.

Notes:

Times are Trainz clock times, not real time

Related Rules:

Driver Command Check Rule - executes child rules if the driver commands match a set list
Driver Command Rule - specifies which commands will be available for the drivers
Driver Schedule Rule - sets up a list of basic scheduled driver commands
Driver Setup Rule - creates a list of drivers and assign them their orders
Enable/Disable Driver Commands Rule - enable/disable specific driver commands on certain drivers
ScheduleAtTrackside Rule - issues set of driver commands at a trackmark or trigger
Schedule Library Rule - creates a library of driver schedules (commands)

Session Complete Rule

Set session to a percentage of completion.

Rule Properties:

<kuid:447264:1011>

Base Rule

Rule Settings:

   Set session to percent complete <value> - enter number as a percentage
   [x] 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 executes the second child rule.

Rule Properties:

<kuid:30501:100180>

Built-in Rule

Parent Rule

Rule Settings:

   None

Notes:

When a session starts with this rule enabled, the player will be given the choice of running the session in Debug or Normal mode. Selecting Debug will execute the first child rule. Selecting Normal will execute the second child rule.

Trainz Wiki Links:

How to Use Parent and Child Rules

Session Metadata Rule

Sets session metadata in the config file. Info can be read by other systems and displayed to the player.

Rule Properties:

<kuid:401543:2036>

Base Rule

Rule Settings:

   Type <Click> -  click to select one of:- 
      Simulation
      Challenge
   Length <value> - to enter number of minutes, default is 30 minutes
   Difficulty <Click> -  click to select one of:- 
      Normal - default
      Tutorial
      Easy
      Hard
      Expert

Notes:

Time is Trainz clock time, not real time

Set Camera Rule

Sets the target object and properties of the camera.

Rule Properties:

<kuid:-25:179>

Built-in Rule

Rule Settings:

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

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 - executes child rules when the camera view is changed

Set Coupler Masks Rule

Set the coupling/decoupling masks on the selected vehicles

Rule Properties:

<kuid:-25:980>

Built-in Rule

Rule Settings:

   <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 coupler breaks
Coupler Breakage HUD Rule - adds a coupler stress and breakage warning to the HUD

Set Cleared Junctions Rule

Sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied. If a junction is occupied it waits until the junction is cleared. Warning: not compatible with Interlocking Tower Assets

Rule Properties:

<kuid2:131986:157661:1>

DLS Rule by atilabarut

Rule Settings:

   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:

Control Path Rule - sets the path for selected trains
Junction Derailment Prevention Rule - sets opposing junctions ahead of a train to prevent derailments
Lock All Junctions Rule - locks all junctions against user control
Multiple Junction Alignment Check Rule - executes child rules when junctions are aligned
Set Junctions Rule - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).

Set Helper Icon Size Rule

Sets the size of helper icons such as the junction lever arrows.

Rule Properties:

<kuid:-25:791>

Built-in Rule

Rule Settings:

  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

Rule Properties:

<kuid:-25:792>

Legacy Rule (replaced by Message Popup Rule)

Built-in Rule

Rule Settings:

   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
         [x] Hide/Close window on "done" action
         [x] Window has no "done" button
         [x] Disable scrolling (not implemented yet)
         [x] Spare setting 1
         [x] Spare setting 2
         [x] Spare setting 3
         [x] Spare setting 4
         [x] Spare setting 5
      ( ) Use the page <select> (enter HTML page name) from the HTML asset <select> (select HTML asset)
      ( ) Use the string table entry <select> (enter Index) from the HTML asset <select> (select HTML asset)

Related Rules:

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

Set Junctions Rule

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

Rule Properties:

<kuid:-25:1065>

Built-in Rule

Rule Settings:

   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

Known Issues:

Rule is NOT compatible with Interlocking Towers

Related Rules:

Control Path Rule - sets the path for selected trains
Junction Derailment Prevention Rule - sets opposing junctions ahead of a train to prevent derailments
Lock All Junctions Rule - locks all junctions against user control
Multiple Junction Alignment Check Rule - executes child rules when junctions are aligned
Set Cleared Junctions Rule - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.

Examples of Use:

How to Control Junctions in Sessions

Set Signal Extended Rule

Sets the state of a selected signal Warning: not compatible with Interlocking Tower Assets

Rule Properties:

<kuid2:47662:20002:4>

Built-in Rule

Rule Settings:

   <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

Known Issues:

Rule is NOT compatible with Interlocking Towers

Notes:

The signal must support the state selected otherwise there will be no change in the signal

Related Rules:

Trigger Multiple Signals Rule - sets selected signals to DANGER (STOP) when selected triggers are activated

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

Sh-Sz

Show/Hide HUD Panel Rule

Shows or hides a HUD panel.

Rule Properties:

<kuid:-25:1047>

Built-in Rule

Rule Settings:

   <Show/Hide> the <click to select> HUD panel - select Show or Hide and then select the HUD panel

Related Rules:

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

Show/Hide Layer Rule

Shows or hides a layer from Driver.

Rule Properties:

<kuid2:401543:1170:1>

Built-in Rule

Rule Settings:

  <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 saved game is reloaded

Known Issues:

Rule will NOT check to see if the named layer exists or not

Related Driver Commands:

Layer Control

Examples of Use:

How to Use Layers: Layers in Driver Mode

Show/Hide Minimap Rule

Shows the minimap window in Driver.

Rule Properties:

<kuid:-25:794>

Built-in Rule

Rule Settings:

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

Rule Properties:

<kuid:401543:2020>

Built-in Rule

Rule Settings:

   On screen help (junction overlays, etc) -  select one of three option buttons:- 
      ( ) Show
      ( ) Hide
      ( ) Leave Unchanged
   On Screen Vehicle Names: -  select one of three option buttons:- 
      ( ) Show
      ( ) Hide
      ( ) Leave Unchanged

Signal Passed At Danger Check Rule

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

Rule Properties:

<kuid2:60850:89007:2>

Built-in Rule

Parent Rule

Rule Settings:

   [x] Trigger only once

Examples of Use:

How to Use Variables in Sessions (Examples): Event Counter and Message Selection

Trainz Wiki Links:

How to Use Parent and Child Rules

Simultaneous List Rule

Executes child rules simultaneously once this rule starts

Rule Properties:

<kuid:-25:1048>

Built-in Rule

Parent Rule

Rule Settings:

   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 - executes child rules in order
Progressive List Rule - executes the first child rule on the first run, the second child on the second run, etc
Random List Rule - executes ONE randomly selected child rule
Reset List Rule - executes all child rules continuously

Examples of Use:

Trainz Wiki Links:

http://online.ts2009.com/mediaWiki/index.php/Simultaneous_List

Speeding Check Rule

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

Rule Properties:

<kuid2:60850:89004:3>

Built-in Rule

Parent Rule

Rule Settings:

    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

Trainz Wiki Links:

How to Use Parent and Child Rules

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.

Rule Properties:

<kuid:-16:10212>

Base Rule

Rule Settings:

   Current control method is <select> -  select one from:- 
      Easy Mode - DCC (standard keyboard and mouse) control
      Ask User - let the user decide
      Realistic Mode - Cab controls (on screen levers, throttles, buttons, etc)
   Set weather to <select mode> with <select frequency> changeability -  select one of:- 
      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
   [x] Show in game help - check to switch on help options
   Use <select measurement system> units in Driver -  select one of:- 
      Metric - kilometres, metres. This will override the default settings in a session
      Imperial - miles, feet. This will override the default settings in a session
      Default - uses the measurement system specified in the session

Notes:

Times are Trainz clock time, not real time

Related Rules:

Time and Rate Rule - sets the session start time and the rate at which time passes.
Weather Rule - changes weather conditions during Session play

Station Visited Check Rule

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

Rule Properties:

<kuid2:60850:89005:3>

Built-in Rule

Parent Rule

Rule Settings:

   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

Trainz Wiki Links:

How to Use Parent and Child Rules

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

T

Time and Rate Rule

Sets the session start time and the rate at which time passes.

Rule Properties:

<kuid:-25:889>

Built-in Rule

Rule Settings:

   Set time to <hours:minutes> - enter the clock starting time as hours (0-23) and minutes (0-59)
   with a rate of <1x> - select a speed at which time will pass from 1x (normal) to 1440x (extremely fast)

Related Rules:

Startup Options Rule - sets the startup options for a session including time and rate
Timecheck Rule - executes child rules at a set time.

Timecheck Rule

Executes child rules at a set time.

Rule Properties:

<kuid2:122381:10008:3>

Built-in Rule

Parent Rule

Rule Settings:

   <hh:mm:ss> - enter execution time as hours (0-23), minutes (0-59) and seconds (0-59).
   [x] Execution time is on the day after the start time - when checked delays execution until the following day.

Known Issues:

Do not use this rule as a child of a repeating rule such as the Simultaneous List Rule or the Ordered List Rule.

Notes:

Times and days are Trainz clock times not real time.

Related Rules:

Time and Rate Rule - sets the session start time and the rate at which time passes.
Wait Rule - executes child rules after waiting for a set number of seconds.

Trainz Wiki Links:

How to Use Parent and Child Rules

Timed Limited Display HTML Rule (SP2 and later)

Displays an HTML browser window for a limited time.

Rule Properties:

<kuid2:61392:2005:32>

DLS Rule by pguy

Rule Settings:

  HTML Asset Name : <[Click to select HTML asset]> - click to select an HTML asset from those installed
  Page filename : <value> - click to enter the filename of the HTML page in the selected HTML asset. The .html filename extension is optional.
  Play duration (SessVar or duration in seconds) : <value> - enter a SessVar name or the number of seconds.
  Browser left position (SessVar or position) : <value> - enter a SessVar name or the number of pixels from the left screen edge.
  Browser top position (SessVar or position) : <value> - enter a SessVar name or the number of pixels from the top screen edge.
  Browser width (SessVar or position) : <value> - enter a SessVar name or the width in pixels.
  Browser height (SessVar or position) : <value> - enter a SessVar name or the browser height.
  [x] <Alert is not reshowable on request/Alert is showable on request> - check or click to allow or prevent the user viewing the page again.

Notes:

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

Trainz Wiki Links:

How to Create a HTML Asset

Trackside Check Rule

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

Rule Properties:

<kuid2:46162:100207:1>

DLS Rule by Josefpav

Parent Rule

Rule Settings:

   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
   [x] Auto reset this rule - check to execute the rule continuously
   Applies to train containing:
   <Add vehicle> - click to select a rail vehicle from the session list
   del - click to remove a selected vehicle from the rule

Related Rules:

Directional Trigger Check Rule - executes child rules when activated by a train moving in a set direction.
Trigger Check Rule - executes child rules when activated by a train

Trainz Wiki Links:

How to Use Parent and Child Rules

Trigger Check Rule

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

Rule Properties:

<kuid:-25:1071>

Built-in Rule

Parent Rule

Rule Settings:

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

Related Rules:

Directional Trigger Check Rule - executes child rules when activated by a train moving in a set direction.
Trackside Check Rule - executes child rules when activated by a train. Provides different options to the Trigger Check Rule

Examples of Use:

Trainz Wiki Links:

How to Use Parent and Child Rules

Trigger Multiple Signals Rule

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

Rule Properties:

<kuid2:116387:26:1>

DLS Rule by maggs

Rule Settings:

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

Related Rules:

Set Signal Extended Rule - sets a selected signal to a specific signal state

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

U, V

Un-Portal Rule

Provides portals to routes that have no portals by configuring track marks as portals.

Rule Properties:

<kuid2:117746:1024:10>

DLS Rule by sforget

Rule Settings:

   Maximum Trains on Route <value> - enter number
   Remove Excess Trains <YES/NO> - select either. Warning: Selecting YES may result in undesirable effects
   Remove Which Trains <Last created/Oldest> - select either
   New Un-Portal - click to select a new Un-portal from the session list of available track marks
    For each Un-portal:- 
      Track Mark Name - click on track mark name to configure the Un-Portal
      Configuration Settings:-
         Currently Editing Portal Track Mark Name Remove - click on name to edit a different Un-Portal, click on Remove to delete this Un-Portal
         Time between trains <value> minutes - enter number of minutes
         Timer Fluctuation <value> minutes - enter how much randomness to add to the "Time between trains"
         Direction Relative to TrackMark <Forwards/Backwards> - select one to indicate the direction of travel compared to the direction of the Track Mark
         Consume Trains <YES/NO> - select one
         Emit Immediately <YES/NO> - select one
         Order to Emit Trains <Random/Sequential> - select one to control train order from entered list of consists
         Wait for Triggered Event <YES/NO> - select one
         Add New Consist - click to add a consist to be emitted.
            + - click to add a specific vehicle from the session list
            x - click to remove the specific vehicle from the rule
            Add driver to consist - click to select a driver from the session list
            Add an existing saved consist - click to select a previously saved consist

Notes:

Minutes are Trainz clock time, not real time
If Consume Trains is set to YES then ALL trains that pass over that trackmark will be consumed so don't create the Un-Portal on a mainline

Related Rules:

Quick Portal Manager Standard Edition Rule (SP2 and later) - provides additional features for portals

Trainz Wiki Links:

How to Use Portals

Variable Check Rule

Executes child rules when a specific variable matches set conditions

Rule Properties:

<kuid:-25:1049>

Built-in Rule

Parent Rule

Rule Settings:

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

Examples of Use:

How to Use Variables in Sessions (Examples)

Trainz Wiki Links:

How to Use Parent and Child Rules

Variable Modify Continuous Rule

Adds, subtracts or sets a value to a specified variable every second.

Rule Properties:

<kuid:-25:1051>

Built-in Rule

Rule Settings:

  <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 session variables.
Variable Check Rule - executes child rules according to 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 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.

Rule Properties:

<kuid:-25:1050>

Built-in Rule

Rule Settings:

   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. </span>
             Variable-name is case sensitive. 
         <Do not undo the alteration if the rule is stopped/Undo the alteration if the rule is stopped> - click to select one.
      Change variable
         Change variable <variable-name> to <value> - enter variable-name, enter new value. 
             Variable-name is case sensitive. This change cannot be undone if the rule is stopped. 
   [x] (optional) Set the minimum value of <variable-name> to <value> - enter variable-name
      (this will already be set by the change option) and a value. Variable-name is case sensitive.
   [x] (optional) Set the maximum value of <variable-name> to <value> - enter variable-name
      (this will already be set by the change option) and a value. Variable-name is case sensitive.

Related Rules:

Quick Session Variables Rule - allows the editing of session variables.
Variable Check Rule - executes child rules according to 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.

Examples of Use:

How to Use Variables in Sessions (Examples)

Trainz Wiki Links:

http://online.ts2009.com/mediaWiki/index.php/Variable_Modify_Rule

Variable Random Rule

Assigns a random integer value to a variable.

Rule Properties:

<kuid:400260:100606>

DLS Rule by tram_

Rule Settings:

   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 session variables.
Randomize - creates a different set of random numbers for each session run.
Variable Check Rule - executes child rules according to 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.

Examples of Use:

How to Use Variables in Sessions (Examples)

Variable Show Rule

Adds or removes a specified variable and a descriptive label to the custom HUD. This rule does not make the custom HUD appear on the screen.

Rule Properties:

<kuid:-25:971>

Built-in Rule

Rule Settings:

  [x] Add
     <variable-name> - enter variable-name to add to HUD. Variable-name is case sensitive.
     <label> - (optional) enter a short label to be displayed on the HUD in front of the variable value.
  [x] Remove
     <variable-name> - enter variable-name to remove from HUD. Variable-name is case sensitive.

Related Rules:

Display Custom HUD Rule - shows or hides the Custom Heads Up Display.
Quick Session Variables Rule - allows the editing of session variables.
Variable Check Rule - executes child rules according to 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.

Examples of Use:

How to Use Variables in Sessions (Examples)

Vehicle Physics Rule

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

Rule Properties:

<kuid:-25:1052>

Built-in Rule

Rule Settings:

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

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

W, X, Y, Z

Wait for Camera View Mode Rule

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

Rule Properties:

<kuid:-25:192>

Built-in Rule

Parent Rule

Rule Settings:

   [x] 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
   [x] 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

Trainz Wiki Links:

How to Use Parent and Child Rules

Wait for Click on HUD Icon Rule

Executes child rules when the user clicks on a selected HUD icon

Rule Properties:

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

Built-in Rule

Parent Rule

Rule Settings:

   [x] Trigger Once
   HUD Panel <Click> -  click to 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 - shows or hides the Custom Heads Up Display.
Flash HUD Icon Rule - flashes a HUD panel icon for a set duration.
mc Display Custom HUD V2 Rule (SP2 and later) - shows or hides a graphical HUD.
Quick CustomHud Manager Rule (SP2 and later) - creates custom HUDs that can be assigned to different drivers
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.

Trainz Wiki Links:

How to Use Parent and Child Rules

Wait for Derailment Rule

Executes child rules when a derailment occurs

Rule Properties:

<kuid:-25:1053>

Built-in Rule

Parent Rule

Rule Settings:

   [x] 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

Trainz Wiki Links:

How to Use Parent and Child Rules

Wait for Driver On/Off Train Rule

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

Rule Properties:

<kuid:-25:953>

Built-in Rule

Parent Rule

Rule Settings:

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

Related Rules:

Wait for Driver/Train to be Locally Owned Rule - executes child rules when a vehicle or driver changes ownership

Trainz Wiki Links:

How to Use Parent and Child Rules

Wait for Driver/Train to be Locally Owned Rule

Executes child rules when a specific driver or vehicle is locally owned. If the driver/vehicle becomes unowned again the child rules are paused

Rule Properties:

<kuid2:401543:1173:1>

Built-in Rule

Parent Rule

Rule Settings:

 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

Related Rules:

Wait for Driver On/Off Train Rule - executes child rules when a driver gets on or off a train

Trainz Wiki Links:

How to Use Parent and Child Rules

Wait on Navigation Point Rule

Executes child rules when a specific navigation point is completed

Rule Properties:

<kuid:401543:1168>

Base Rule

Parent Rule

Rule Settings:

   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.

Notes:

The navigation set and point must first be created by the Navigation Display Rule

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 - executes child rules 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.

Examples of Use:

Trainz Wiki Links:

Wait on Train Stop/Start Rule

Executes child rules when a train stops or starts moving

Rule Properties:

<kuid:-25:1069>

Built-in Rule

Parent Rule

Rule Settings:

   [x] 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

Examples of Use:

How to Use Message Popup Rule (Applications): Navigation Point and Train Stopped Event Message

Trainz Wiki Links:

How to Use Parent and Child Rules

Wait on Waybill Screen/Main Screen Rule

Executes child rules when the Waybill window is opened or closed

Rule Properties:

<kuid:-25:957>

Built-in Rule

Parent Rule

Rule Settings:

   [x] Trigger rule once - check to trigger the rule once only
   Wait for the Waybill window to be <opened/closed> - select either opened or closed.

Trainz Wiki Links:

How to Use Parent and Child Rules

Wait Rule

Executes child rules after waiting for set number of seconds

Rule Properties:

<kuid2:122381:10016:2>

Built-in Rule

Parent Rule

Rule Settings:

   <click to set> - enter the number of seconds for the wait delay

Notes:

Seconds is in Trainz clock time, not real time

Related Rules:

Timecheck Rule - executes child rules at a set time.

Examples of Use:

Trainz Wiki Links:

How to Use Parent and Child Rules

Weather Rule

Changes the weather conditions during Session play.

Rule Properties:

<kuid:-25:960>

Built-in Rule

Rule Settings:

   Set weather to <select mode> with <select frequency> changeability -  select one of:- 
      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
Random Weather Rule v2 - randomly changes the weather according to entered parameters
Startup Options Rule - sets the weather conditions at the start of a Session

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

Trainz Wiki

More Tutorials and Guides to Using Trainz

@@ Line 4: / Line 4: @@
 <tr>
 <td>
-<span style="color: white; font-weight: 700;">This page is always under construction. As new rules appear and are tested they will be added to this list. Current Command Count: 129</span></td>
+<span style="color: white; font-weight: 700;">This page is always under construction. As new rules appear and are tested they will be added to this list. Current Count: 129</span></td>
 </tr>
 </table>

Session Rule List with Parameters

Revision as of 07:36, 24 November 2019

Contents

A, B

Achievement Check Rule

Advanced Industry Load Configuration Rule

AI Start Rule

AI Stop Rule

ATP Speed Limiter Rule

AWS Configuration Rule

C

Cab Controls HUD Rule

Cinematic Camera Rule

Clean Up Derailed Trains Rule

Clock Rule

Close Message Popup Rule

Consist Check Rule

ConsistDataHandler Rule

Control Check Rule

Control Path Rule

Control Type Rule

Coupler Breakage Check Rule

Coupler Breakage HUD Rule

Custom Script Rule

D

DestSign Table Rule

Directional Trigger Check Rule

Disable/Enable Industry Rule

Disallow AI Rule

Display Custom HUD Rule

Display HTML Pages Rule

Display Video Rule

Driver Command Check Rule

Driver Command Rule

Driver Main Menu Options Rule

Driver Schedule Rule

Driver Setup Rule

E, F, G

EIRS Weather Rule NE USA Rule

Enable/Disable Driver Commands Rule

End Session Rule

ExTrainz Manager Rule - TANE SP2

Fade In/Out Rule

Flash HUD Icon Rule

Focus Camera Rule

Generic TreeNode Debug Window Rule

H, I, J

Hide Product Overlays Rule

InputTable Rule

Interlocking Tower Configure Path Rule

Interlocking Tower Path Selection UI Rule

Interlocking Tower Set Path Rule

Interlocking Tower Enhanced Manager Rule (SP2 and later)

JTG Correct Vehicle Lights

Junction Derailment Prevention Rule

K, L, M

Lock All Junctions Rule

MaxPermittedSpeed Rule

mc Display Custom HUD V2 Rule (SP2 and later)

Message Popup Rule

Minimap Options Rule

MissionCode Manager Rule (SP2 and later)

MissionCode Stops and Timetable Manager Rule (SP2 and later)

Multiplayer Rule

Multiple Junction Alignment Check Rule

Multiple Resource Check Rule

N, O

Navigation Display Rule

Navigation Point Complete Rule

Navigation Set Check Rule

Navigation Set Clear Rule

Navigation Set Hide/Show Rule

Objective Add Rule

Objective Check Rule

Objective Update Rule

Ordered List Rule

P, Q

Play Sound Rule

Power Station Rule

Progressive List Rule