Session Rule List with Parameters: Difference between revisions

Revision as of 22:52, 15 July 2018

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

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

Also available Session Rules By Categories With Properties

Description Key:

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

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

A, B

Achievement Check Rule

Executes child rules when achievement conditions have been met

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

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?

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

C

Cab Controls HUD Rule

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

Rule Properties:

<kuid:-16:287428>

Base Rule

Obsolete Rule (function is now built into TANE)

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

Trainz Wiki Links:

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.

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

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

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

D

DestSign Table Rule

Creates a list of destination names for a destination sign

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)

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

DisplayIndustryStatus Rule (color modified)

Displays a summary of industry product levels when the "k" key is pressed.

Rule Properties:

<kuid:622415:100001>

DLS Rule by lockheed02 and marzipan

Rule Settings:

   None

Notes:

Pressing the k key in Driver mode will bring up a small window with a single link Display Industry Status (there may also be other links). Clicking this link will show the product levels of all industries.

Related Rules:

ExTrainz Manager Rule - TANE SP2 - displays information on consists, industries and products in Driver and Surveyor.

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
Schedule Rule - allows a schedule of timed events to be applied to a train

Trainz Wiki Links:

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
Schedule Rule - allows a schedule of timed events to be applied to a train

Trainz Wiki Links:

How to Use Driver Command Rule

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
Schedule Rule - allows a schedule of timed events to be applied to a train

Trainz Wiki Links:

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

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
Schedule Rule - allows a schedule of timed events to be applied to a train

Trainz Wiki Links:

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

E, F, G

EIRS Weather Rule NE USA Rule

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

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

Notes:

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

Known Issues:

This rule is NOT compatible with all industries.

Related Rules:

DisplayIndustryStatus Rule (color modified) - displays information on industry product levels.

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

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

H, I, J

Hide Product Overlays Rule

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

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 WaitUntilSVariable driver command the message must be formatted as:-
         svar,svar_name,svar_condition,value - the first entry must be the word svar in lower case, 
            svar_name is the name of the session variable, 
            svar_condition is an equality (eg eq for equal, gt for greater than, etc)
            value is an integer value to be compared to the session variable.
   Each entry in the table will be followed by the commands:-
      cp - click to copy this entry to a new entry
      up - click to move this entry up one level
      dn - click to move this entry down one level
      rm - click to remove this entry from the table

Interlocking Tower Configure Path Rule

Alters settings on an interlocking tower path

Rule Properties:

<kuid:401543:3205>

Base Rule

Rule Settings:

  Interlocking Tower <select> - to set Name and Objects

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

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

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

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 TANE Driver Additional Tools Menu)

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:

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

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

K, L, M

Lock All Junctions Rule

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

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.

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

ENTRY UNDER CONSTRUCTION

Trainz Wiki Links:

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

MissionCode Stops and Timetable Manager Rule (SP2 and later)

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

Rule Properties:

<kuid2:61392:8300:50>

DLS Rule by pguy

ENTRY UNDER CONSTRUCTION

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:

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

Trainz Wiki Links:

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

Trainz Wiki Links:

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

N, O

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

Trainz Wiki Links:

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.

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

Trainz Wiki Links:

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.

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

Trainz Wiki Links:

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.

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

Trainz Wiki Links:

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.

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

Trainz Wiki Links:

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:

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

P, Q

Play Sound Rule

Plays a wav sound file.

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

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

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 release of TANE.

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

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

R

Random List Rule

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

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

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

S-Se

Safety System Engaged Check Rule

Executes child rules if safety systems are applied.

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

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

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

'Other Links:

http://www.auran.com/games/gamefiles/trainz/tutorial1.html

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:

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

Trainz Wiki Links:

How to Control Junctions in Sessions

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

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 Cleared Junctions Rule - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.

Trainz Wiki Links:

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

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

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

Sh-Sz

Show/Hide HUD Panel Rule

Shows or hides a HUD panel.

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

Known Issues:

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

Trainz Wiki Links:

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

Trainz Wiki Links:

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

Trainz Wiki Links:

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

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

T

Time and Rate Rule

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

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

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

Trainz Wiki Links:

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

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

U, V

Variable Check Rule

Executes child rules when a specific variable matches set conditions

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.

Trainz Wiki Links:

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

Trainz Wiki Links:

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.

Trainz Wiki Links:

How to Use Variables in Sessions (Examples)

Variable Show Rule

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

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.

Trainz Wiki Links:

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 %

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

W, X, Y, Z

Wait for Camera View Mode Rule

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

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

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.

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

Trainz Wiki Links:

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.

Trainz Wiki Links:

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

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

@@ Line 1: / Line 1: @@
-'''TRAINZ A New Era (TANE) SP2. List of Trainz Session Rules by Categories with Properties. All rules are the Copyright of N3V Games'''
+'''TRAINZ A New Era (TANE) SP2. List of Trainz Session Rules in Alphabetical Order with Properties. All rules are the Copyright of N3V Games'''
 '''This page is always under construction. As new rules appear they will be added to this list.'''
 '''Only rules supplied with TANE or on the DLS are covered in this document.'''
-Also available '''[[Session Rule List with Parameters|Session Rule List (Alphabetical) with Parameters]]'''
+Also available '''[[Session Rules By Categories With Properties]]'''
 ----
 '''Description Key:'''
 *'''<kuid number>''' is for the rule version at the time of writing. This number will change if the rule is updated.
@@ Line 16: / Line 14: @@
 *'''Obsolete Rule''' is no longer required (explanation given).
 *'''Legacy Rule''' has been replaced by another rule (new rule will be identified).
 ----
+<table bgcolor=#ccffff>
+<tr>
+<td>
+'''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''
+</td>
+</tr>
+</table>
 __TOC__
-<table width="100%" bgcolor=#ffffaa>
+<table width="100%" bgcolor=#ccffff>
 <tr>
 <td>
-=='''Achievement Rules'''==
+=='''A, B'''==
 </td>
 </tr>
@@ Line 39: / Line 46: @@
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
      '''''<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:-
@@ Line 51: / Line 57: @@
 *'''[[How to Use Parent and Child Rules]]'''
-==='''Consist Check Rule'''===
+==='''Advanced Industry Load Configuration Rule'''===
-Executes child rules when a matching consist is found. The order of the vehicles in the consists is not important.
+Locks train controls when loading/unloading at an industry, overrides time settings for begin load and begin unload operations
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:1068>'''
+*'''<kuid:30501:100007>'''
-*'''Built-in Rule'''
+*'''Base Rule'''
-*'''Parent Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+    '''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
-    '''[x] Enforce strict exclusive testing''' - check to only accept an exact match with no unspecified vehicles in the consist.
+[[file:Notes.PNG]] '''<u>Notes:</u>'''
-       - leave unchecked to accept any consist that contains the specified vehicles.
+:Times are Trainz clock time, not real time
-    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
-[[file:Issues.PNG]] ''''<u>Known Issues:</u>'''
+==='''AI Start Rule'''===
-:When used as a top level parent rule it does not terminate after triggering but will continue to check all consists for a match and will trigger every time another match is found.
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+Restarts all halted AI controlled trains. Drivers will continue with the commands in their driver command list.
-*'''[[How to Use Parent and Child Rules]]'''
-*'''[[How to Use Variables in Sessions (Examples)#Example 3: Counting Consist Checks|How to Use Variables in Sessions (Examples): Counting Consist Checks]]'''
-*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Consist_Check_Rule</span>'''
-==='''Multiple Resource Check Rule'''===
+[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-Executes child rules if industries or vehicles reach set commodity levels. This rule replaces the older '''Resource Check Rule'''
+*'''<kuid2:400048:100981:1>'''
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+*'''DLS Rule''' by '''callavsg'''
-*'''<kuid:-25:656>'''
+[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-*'''Built-in Rule'''
+    '''None'''
+[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+*'''[[#AI Stop Rule|AI Stop Rule]]''' - halts all AI drivers
+*'''[[#Disallow AI Rule|Disallow AI Rule]]''' - cancels all AI driver commands
-*'''Parent Rule'''
+==='''AI Stop Rule'''===
-[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+Halts all AI controlled trains but does not delete their driver commands. AI trains can be restarted with the '''AI Start Rule''' or by issuing individual '''Continue Schedule''' commands.
-    '''<Product Level>''' - click to select a product test from two choices:-
+[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-       '''''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
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
+*'''<kuid2:400048:100980:1>'''
-:This rule only checks for ''changing'' commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is ''full'' or ''empty''.
+*'''DLS Rule''' by '''callavsg'''
+[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+    '''None'''
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Resource Check Rule|Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
+*'''[[#AI Start Rule|AI Start Rule]]''' - restarts all halted AI drivers
-*'''[[#Resource Verify Rule (fixed)|Resource Verify Rule (fixed)]]''' - executes child rules when a set resource (commodity) level is reached
+*'''[[#Disallow AI Rule|Disallow AI Rule]]''' - cancels all AI driver commands
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+==='''ATP Speed Limiter Rule'''===
-*'''[[How to Use Navigation Point Rules (Applications)#Application 3: Wait for Loading to be Completed|How to Use Navigation Point Rules (Applications): Wait for Loading to be Completed]]'''
-*'''[[How to Use Parent and Child Rules]]'''
-==='''Objective Add Rule'''===
+Limits allowable speed over set limit
-Sets up a game Objective with ID and display Name
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:401543:2001>'''
+*'''<kuid2:321959:1000:1>'''
-*'''Base Rule'''
+*'''Built-in Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''Priority ''<Select>''''' - select one of:-
+     '''Limits the speed to ''<value>'' mph over the set limit''' - enter speed value in mph
-       '''''Above Normal'''''
-       '''''Below Normal'''''
-       '''''Normal'''''
-       '''''Optional'''''
-       '''''Urgent'''''
-    '''Completion Target Number ''<value>''''' - to set Completion Target Number
-    '''Icon ''<select>''''' - to select Icon from list
-    '''Display Name ''<enter>''''' - to insert Name
-    '''Unique Objective ID ''<enter>''''' - enter a unique objective ID
-    '''Custom Message ''<Text Box>''''' - insert typed message in text area
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+==='''AWS Configuration Rule'''===
-*'''[[#Objective Check Rule|Objective Check Rule]]''' - executes child rules if an objective is completed
-*'''[[#Objective Update Rule|Objective Update Rule]]''' - changes the progress of a game objective
-==='''Objective Check Rule'''===
+This rule configures the Trainz implementation of the Automatic Warning System when approaching signals
-Executes child rules if an objective created with the '''Objective Add Rule''' is complete.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:401543:2003>'''
+*'''<kuid2:60850:89002:3>'''
-*'''Base Rule'''
+*'''Built-in Rule'''
-*'''Parent Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''Unique Objective ID ''<value>''''' - enter the unique ID created with the '''Objective Add Rule'''
+     Select one of three option buttons:-
-     '''Mode ''<select>''''' - select one of three:-
+       '''( ) Active'''
-       '''''Wait for completion'''''
+       '''( ) Passive'''
-       '''''Wait for failure'''''
+       '''( ) Passive with HUD hidden'''
-       '''''Wait for progress'''''
+    '''[x] Simulate AWS for unfitted cabs?'''
+     '''[x] Use modern sound set for unfitted cabs?'''
+----
+<table bgcolor=#ccffff>
+<tr>
+<td>
+'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''
+</td>
+</tr>
+</table>
+<table width="100%" bgcolor=#ccffff>
+<tr>
+<td>
+=='''C'''==
+</td>
+</tr>
+</table>
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+==='''Cab Controls HUD Rule'''===
-*'''[[#Objective Add Rule|Objective Add Rule]]''' - sets up a game objective
-*'''[[#Objective Update Rule|Objective Update Rule]]''' - changes the progress of a game objective
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+Was used to provide the HUD controls for the cabin view. Now obsolete.
-*'''[[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
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:401543:2002>'''
+*'''<kuid:-16:287428>'''
 *'''Base Rule'''
+*'''Obsolete Rule''' (function is now built into TANE)
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''Unique Objective ID ''<value>''''' - enter the unique ID created with the '''Objective Add Rule'''
+     '''None'''
-    '''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
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+==='''Cinematic Camera Rule'''===
-*'''[[#Objective Add Rule|Objective Add Rule]]''' - sets up a game objective
-*'''[[#Objective Check Rule|Objective Check Rule]]''' - executes child rules if an objective is completed
-==='''Ranked Session Begin 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.
-Begins a ranked Session
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:401543:2031>'''
+*'''<kuid2:401543:1166:3>'''
-*'''Base Rule'''
+*'''Built-in Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''Countdown Starting Value ''<value>'''''
+     '''[x] Lock camera controls for the duration''' - if checked user cannot alter camera view
-       '''''hrs:'''''
+    '''[x] Prevent train control for duration - if checked user cannot control train
-        '''''min:'''''
+    '''Camera target: ''<click to select>''''' - click to select the object from the session list that will be the camera target
-       '''''sec:'''''
+    '''Camera mode:''' - select one of three option buttons:-
-    '''1 through 5 stars, points for each star ''<value>''''' - enter number of points for each star rating
+       '''( ) Stationary'''
-    '''Session timer mode:''' - select one of three option buttons:-
+        '''( ) Circle targeted object'''
-       '''( ) Timer'''
+       '''( ) Move from one point to another (zoom, pan, etc)'''
-        '''( ) Countdown Starting value ''<value>''''' - enter time ''hh:mm:ss''
+    '''Initial camera values:'''
-       '''( ) None'''
+       '''[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
 [[file:Notes.PNG]] '''<u>Notes:</u>'''
-:Times are Trainz clock time, not real time
+:Times are Trainz clock times, not real times
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Ranked Session Complete Rule|Ranked Session Complete Rule]]''' - completes the active ranked Session
+*'''[[#Focus Camera Rule|Focus Camera Rule]]''' - sets the initial camera view and starting vehicle for a session
+*'''[[#Set Camera Rule|Set Camera Rule]]''' - sets the target object and properties of the camera
+*'''[[#Wait for Camera View Mode Rule|Wait for Camera View Mode Rule]]''' - executes child rules when the camera view is changed
-==='''Ranked Session Complete Rule'''===
+==='''Clean Up Derailed Trains Rule'''===
-Completes the active ranked Session
+Cleans up derailed train cars after a set time delay
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:401543:2032>'''
+*'''<kuid2:60850:89003:1>'''
 *'''Base Rule'''
@@ Line 252: / Line 221: @@
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''Set the active ranked session as:''' - select one of two option buttons:-
+     '''Set delay to clean up derailed traincars to'''
-        '''( ) Complete'''
+       '''''<h>'':''' - click to enter the number of hours (0-23) to wait
-        '''( ) Failed'''
+        '''''<mm>'':''' - click to enter the number of minutes (0-59) to wait
-    '''[x] Customize the completion message ''<text>''''' - enter a text message
+        '''''<ss>'':''' - click to enter the number of seconds (0-59) to wait
+[[file:Notes.PNG]] '''<u>Notes:</u>'''
+:Time is Trainz clock time, not real time.
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Ranked Session Begin Rule|Ranked Session Begin Rule]]''' - begins a ranked Session
+*'''[[#Replace Missing Vehicles Rule|Replace Missing Vehicles Rule]]''' - creates a replacement train after a derailment
+*'''[[#Wait for Derailment Rule|Wait for Derailment Rule]]''' - executes child rules when a derailment occurs
+[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Clean_up_Derailed_Trains_Rule</span>'''
-==='''Resource Check Rule'''===
+==='''Clock Rule'''===
-Executes child rules if a selected industry or vehicle reaches a set commodity level. This rule has been superseded by the '''Multiple Resource Check Rule'''
+Rule needed for animated clocks.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:1067>'''
+*'''<kuid2:62310:30041:2>'''
-*'''Legacy Rule''' (replaced by '''Multiple Resource Check Rule''')
+*'''Built-in Rule'''
-*'''Built-in Rule'''
-*'''Parent Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     Select one of two option buttons:-
+     '''None'''
-       '''( ) Watch industry queue'''
-          '''Target Object ''<select>''''' - select an industry from the session list
-          '''Queue ''<select>''''' - select a product queue from the selected industry
-          '''Product ''<select>''''' - select a product from the selected queue
-          '''Amount ''<value>''''' - enter a quantity
-          Select one of two option buttons:-
-             '''( ) Complete when designated queue equals or exceeds required amount'''
-             '''( ) Complete when designated queue falls below required amount'''
-       '''( ) Watch vehicle'''
-          '''Target Object ''<select>''''' - select a rolling stock asset from the session list
-          '''Queue ''<select>''''' - select a product queue from the selected rolling stock
-          '''Product ''<select>''''' - select a product from the selected queue
-          '''Amount ''<value>''''' - enter a quantity
-          Select one of two option buttons:-
-             '''( ) Complete when designated queue equals or exceeds required amount'''
-             '''( ) Complete when designated queue falls below required amount'''
 [[file:Notes.PNG]] '''<u>Notes:</u>'''
-: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''.
+: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.
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+==='''Close Message Popup Rule'''===
-*'''[[#Multiple Resource Check Rule|Multiple Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
-*'''[[#Resource Verify Rule (fixed)|Resource Verify Rule (fixed)]]''' - executes child rules when a set resource (commodity) level is reached
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+Closes open message popups
-*'''[[How to Use Parent and Child Rules]]'''
-*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Resource_Check_Rule</span>'''
-==='''Resource Verify Rule (fixed)'''===
+[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-Executes child rules if a selected industry or vehicle reaches a set commodity level. The rule resets when all child rules have completed.
+*'''<kuid:447264:1526>'''
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+*'''Built-in Rule'''
-*'''<kuid:160293:10060>'''
-*'''DLS Rule''' by '''trev999
-*'''Parent Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-    Select one of two option buttons:-
+   '''None'''
-    '''( ) 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'''
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
+[[file:Issues.PNG]] '''<u>Known Issues:</u>'''
-#This rule will only monitor a single commodity in a single industry or vehicle.
+:This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule
-#This rule only checks for ''changing'' commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is ''full'' or ''empty''.
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+*'''Related Rule:'''
-*'''[[#Multiple Resource Check Rule|Multiple Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
+*'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
-*'''[[#Resource Check Rule|Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
 [[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
-*'''[[How to Use Parent and Child Rules]]'''
+*'''[[How to Use Message Popup Rule]]'''
+*'''[[How to Use Message Popup Rule (Applications)]]'''
-==='''Station Visited Check Rule'''===
+==='''Consist Check Rule'''===
-Executes child rules if specific trains call at set stations or industries
+Executes child rules when a matching consist is found. The order of the vehicles in the consists is not important.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid2:60850:89005:3>'''
+*'''<kuid:-25:1068>'''
 *'''Built-in Rule'''
@@ Line 360: / Line 291: @@
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''Trigger: ''<select>''''' - click to select one of the following
+     '''[x] Enforce strict exclusive testing''' - check to only accept an exact match with no unspecified vehicles in the consist.
-       '''''Never''''' - stopping at the selected industries will never trigger the rule.
+        - leave unchecked to accept any consist that contains the specified vehicles.
-        '''''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'''
+    '''( ) Rule disabled''' - select to disable the operation of this rule
-       '''( ) click to accept trains matching specific criteria'''
+    '''( ) Complete whenever a train matching the description exists''' - When selected, enter the consist description:-
-          Selecting the second option will produce the following selection controls:-
+       '''Specific vehicle''' - identify the specific vehicle(s) that will trigger the rule
-          '''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
+          '''''+''''' - click to add a ''specific'' vehicle from the session list
-             '''''+''''' - click to add a ''specific'' vehicle from the session list
+          '''''x''''' - click to remove the ''specific'' vehicle from the rule
-             '''''x''''' - click to remove the ''specific'' vehicle from the rule
+       '''Vehicle types''''' - identify the ''type'' of vehicle(s) that will trigger 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
-             '''''+''''' - click to add a ''type'' of vehicle from the session list
+          '''''x''''' - click to remove the ''type'' of vehicle from the rule
-             '''''x''''' - click to remove the ''type'' of vehicle from the rule
+       '''Drivers''''' - identify the ''driver(s)'' that will trigger the rule
-          '''Drivers''''' - identify the ''drivers'' that will trigger the rule
+          '''''+''''' - click to add a ''driver'' from the session list
-             '''''+''''' - click to add a ''driver'' from the session list
+          '''''x''''' - click to remove a ''driver'' from the rule
-             '''''x''''' - click to remove a ''driver'' from the rule
+[[file:Issues.PNG]] '''<u>Known Issues:</u>'''
+:When used as a top level parent rule it does not terminate after triggering but will continue to check all consists for a match and will trigger every time another match is found.
 [[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
 *'''[[How to Use Parent and Child Rules]]'''
+*'''[[How to Use Variables in Sessions (Examples)#Example 3: Counting Consist Checks|How to Use Variables in Sessions (Examples): Counting Consist Checks]]'''
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Consist_Check_Rule</span>'''
+==='''ConsistDataHandler Rule'''===
-'''[[#top|Back to Top]]'''
+Was used by the '''QuickDrive Rule''' to place consists onto a route. Now obsolete.
-----
-<table width="100%" bgcolor=#ffffaa>
+[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-<tr>
-<td>
-=='''Camera Rules'''==
-</td>
-</tr>
-</table>
-==='''Cinematic Camera Rule'''===
+*'''<kuid:401543:1180>'''
-Provides several different cinematic style cameras with animations. Best used at the start of a session.
+*'''Obsolete Rule''' (function is now built into '''TANE''')
-Use the '''Trackside Camera''' (tracking view) found in the '''Set Camera Rule''' during session play.
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+*'''Base Rule'''
-*'''<kuid2:401543:1166:3>'''
-*'''Built-in Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''[x] Lock camera controls for the duration''' - if checked user cannot alter camera view
+     '''None'''
-    '''[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
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
+==='''Control Check Rule'''===
-:Times are Trainz clock times, not real times
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+Executes child rules if the train control method has been altered or a specific method has been selected.
-*'''[[#Focus Camera Rule|Focus Camera Rule]]''' - sets the initial camera view and starting vehicle for a session
-*'''[[#Set Camera Rule|Set Camera Rule]]''' - sets the target object and properties of the camera
-*'''[[#Wait for Camera View Mode Rule|Wait for Camera View Mode Rule]]''' - executes child rules when the camera view is changed
-==='''Focus Camera Rule'''===
+[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-Sets the initial camera view and starting vehicle for a session.
+*'''<kuid:401543:1191>'''
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+*'''Built-in Rule'''
-*'''<kuid2:122381:10014:1>'''
+*'''Parent Rule'''
-*'''DLS Rule''' by '''mizi'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-    '''Focus camera to:''' - select one of two option buttons
+  '''Execute child rules when:''' - select one of two option buttons:-
-       '''( ) Map object'''
+     '''( ) DCC mode is Selected'''
-       '''( ) Vehicle'''
+     '''( ) Cab mode is Selected'''
-    '''Named ''<?????>''''' - enter name of object or vehicle from session list
+  '''Execute child rules:''' - select one of two option buttons:-
-    '''Additionally:'''
+     '''( ) Every time control method is set'''
-       '''[x] set view mode to''' - check to select one of four option buttons
+     '''( ) Once only'''
-          '''( ) 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
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Cinematic Camera Rule|Cinematic Camera Rule]]''' - provides several different cinematic style cameras with animations
+*'''[[#Control Type Rule|Control Type Rule]]''' - sets the control method
-*'''[[#Set Camera Rule|Set Camera Rule]]''' - sets the target object and properties of the camera
-*'''[[#Wait for Camera View Mode Rule|Wait for Camera View Mode Rule]]''' - executes child rules when the camera view is changed
-==='''Set Camera Rule'''===
+[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+*'''[[How to Use Parent and Child Rules]]'''
-Sets the target object and properties of the camera.
+==='''Control Type Rule'''===
+Sets the control method
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:179>'''
+*'''<kuid:-16:2030>'''
-*'''Built-in Rule'''
+*'''Base Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-    '''[x] Set the target object of the camera to:''' - if checked, select one of three option buttons:-
+  '''Current control method is: ''<select>''''' - click to select one of
-       '''( ) Vehicle ''<click to select>''''' - select a vehicle from the Session list
+     '''''Easy Mode''''' - DCC (standard keyboard and mouse) control
-       '''( ) Junction ''<click to select>''''' - select a junction from the Session list
+     '''''Ask User''''' - let the user decide
-       '''( ) Map Object ''<click to select>''''' - select a named map object from the Session list
+     '''''Realistic Mode''''' - Cab controls (on screen levers, throttles, buttons, etc)
-    '''[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
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Cinematic Camera Rule|Cinematic Camera Rule]]''' - provides several different cinematic style cameras with animations
+*'''[[#Control Check Rule|Control Check Rule]]''' - executes child rules if the train control method changes
-*'''[[#Focus Camera Rule|Focus Camera Rule]]''' - sets the initial camera view and starting vehicle for a session
-*'''[[#Wait for Camera View Mode Rule|Wait for Camera View Mode Rule]]''' - executes child rules when the camera view is changed
-==='''Wait for Camera View Mode Rule'''===
+==='''Coupler Breakage Check Rule'''===
-Executes child rules when the camera view is changed to a selected view
+Executes child rules if there is a coupler breakage
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:192>'''
+*'''<kuid2:447264:1017:1>'''
 *'''Built-in Rule'''
@@ Line 520: / Line 391: @@
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''[x] Trigger rule once''' - check to set
+     '''None'''
-    '''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
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Cinematic Camera Rule|Cinematic Camera Rule]]''' - provides several different cinematic style cameras with animations
+*'''[[#Coupler Breakage HUD Rule|Coupler Breakage HUD Rule]]''' - adds a coupler stress and breakage warning to the HUD
-*'''[[#Focus Camera Rule|Focus Camera Rule]]''' - sets the initial camera view and starting vehicle for a session
+*'''[[#Set Coupler Masks Rule|Set Coupler Masks Rule]]''' - sets the coupling/decoupling masks on selected vehicles
-*'''[[#Set Camera Rule|Set Camera Rule]]''' - sets the target object and properties of the camera
 [[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
 *'''[[How to Use Parent and Child Rules]]'''
-'''[[#top|Back to Top]]'''
+==='''Coupler Breakage HUD Rule'''===
-----
-<table width="100%" bgcolor=#ffffaa>
+HUD displays warning about coupler stress and breakage
-<tr>
-<td>
-=='''Danger, Derailment and Safety Rules'''==
-</td>
-</tr>
-</table>
-==='''ATP Speed Limiter Rule'''===
-Limits allowable speed over set limit
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid2:321959:1000:1>'''
+*'''<kuid:-25:423>'''
 *'''Built-in Rule'''
@@ Line 559: / Line 412: @@
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''Limits the speed to ''<value>'' mph over the set limit''' - enter speed value in mph
+     Select one of two option buttons:-
+       '''( ) Show the Coupler Breakage Display'''
+       '''( ) Hide the Coupler Breakage Display'''
- '''<u>Related Rules:</u>'''
+[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-    '''[[#AWS Configuration Rule|AWS Configuration Rule]]''' - configures the Trainz implementation of the Automatic Warning System when approaching signals
+*'''[[#Coupler Breakage Check Rule|Coupler Breakage Check Rule]]''' - executes child rules if a coupler breaks
+*'''[[#Set Coupler Masks Rule|Set Coupler Masks Rule]]''' - sets the coupling/decoupling masks on selected vehicles
-==='''AWS Configuration Rule'''===
+==='''Custom Script Rule'''===
-This rule configures the Trainz implementation of the Automatic Warning System when approaching signals
+No description
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid2:60850:89002:3>'''
+*'''<kuid:447264:1526>'''
 *'''Built-in Rule'''
@@ Line 576: / Line 432: @@
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-    Select one of three option buttons:-
+   '''None'''
-       '''( ) Active'''
+----
-       '''( ) Passive'''
+<table bgcolor=#ccffff>
-       '''( ) Passive with HUD hidden'''
+<tr>
-    '''[x] Simulate AWS for unfitted cabs?'''
+<td>
-    '''[x] Use modern sound set for unfitted cabs?'''
+'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''
+</td>
+</tr>
+</table>
+<table width="100%" bgcolor=#ccffff>
+<tr>
+<td>
+=='''D'''==
+</td>
+</tr>
+</table>
-==='''Clean Up Derailed Trains Rule'''===
+==='''DestSign Table Rule'''===
-Cleans up derailed train cars after a set time delay
+Creates a list of destination names for a destination sign
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid2:60850:89003:1>'''
+*'''<kuid2:206816:99004:2>'''
-*'''Base Rule'''
+*'''Built-in Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-    '''Set delay to clean up derailed traincars to'''
+   '''''<add destination>''''' - enter a destination name to be added to the destination sign roll
-       '''''<h>'':''' - click to enter the number of hours (0-23) to wait
+   '''''<import destinations from texture-group>''''' - select a list of destination names from session
-       '''''<mm>'':''' - click to enter the number of minutes (0-59) to wait
+   '''[x] Enable industries/stations as destination''' - check to set
-       '''''<ss>'':''' - click to enter the number of seconds (0-59) to wait
+   '''[x] Enable Track Marks as destinations''' - check to set
+   '''[x] Enable table of destinations''' - check to set
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
+==='''Directional Trigger Check Rule'''===
-:Time is Trainz clock time, not real time.
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+Executes child rules when a set train enters a set trigger in a set direction. Adds direction to the '''Trigger Check Rule'''.
-*'''[[#Replace Missing Vehicles Rule|Replace Missing Vehicles Rule]]''' - creates a replacement train after a derailment
-*'''[[#Wait for Derailment Rule|Wait for Derailment Rule]]''' - executes child rules when a derailment occurs
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Clean_up_Derailed_Trains_Rule</span>'''
-==='''Coupler Breakage Check Rule'''===
+*'''<kuid2:532391:100003:1>'''
-Executes child rules if there is a coupler breakage
+*'''DLS Rule''' by '''bobhahn'''
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid2:447264:1017:1>'''
-*'''Built-in Rule'''
 *'''Parent Rule'''
@@ Line 624: / Line 481: @@
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''None'''
+     '''[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
+[[file:Notes.PNG]] '''<u>Notes:</u>'''
+#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.
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Coupler Breakage HUD Rule|Coupler Breakage HUD Rule]]''' - adds a coupler stress and breakage warning to the HUD
+*'''[[#Trackside Check Rule|Trackside Check Rule]]''' - executes child rules when activated by a train. Provides different options to the '''Trigger Check Rule'''
-*'''[[#Set Coupler Masks Rule|Set Coupler Masks Rule]]''' - sets the coupling/decoupling masks on selected vehicles
+*'''[[#Trigger Check Rule|Trigger Check Rule]]''' - executes child rules when a set train enters a set trigger (non-directional)
 [[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+*'''[[How to Control Signals in Sessions#Application 2: Halt Before Clear|How to Control Signals in Sessions: Halt Before Clear]]'''
+*'''[[How to Use Message Popup Rule (Applications)]]'''
 *'''[[How to Use Parent and Child Rules]]'''
+*'''[[How to Use Track Triggers]]'''
+*'''[[How to Use Variables in Sessions (Examples)]]'''
-==='''Coupler Breakage HUD Rule'''===
+==='''Disable/Enable Industry Rule'''===
-HUD displays warning about coupler stress and breakage
+Enables/Disables vehicle load/unload for industry
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:423>'''
+*'''<kuid2:401543:1171:1>'''
 *'''Built-in Rule'''
@@ Line 645: / Line 531: @@
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-    Select one of two option buttons:-
+   '''Load/unload ''<Disable/Enable>''''' - click to set to '''Disable''' or '''Enable'''
-       '''( ) Show the Coupler Breakage Display'''
+   '''Which Industry? ''<select>''''' - click to set Industry from Session List
-       '''( ) Hide the Coupler Breakage Display'''
+   '''Which Vehicles:''' - select one of two option buttons:-
+      '''( ) Apply to every vehicle in the session'''
+      '''( ) Apply only to a specific vehicles from Session List'''
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+==='''Disallow AI Rule'''===
-*'''[[#Coupler Breakage Check Rule|Coupler Breakage Check Rule]]''' - executes child rules if a coupler breaks
-*'''[[#Set Coupler Masks Rule|Set Coupler Masks Rule]]''' - sets the coupling/decoupling masks on selected vehicles
-==='''Junction Derailment Prevention Rule'''===
+Cancels (deletes) all current and waiting AI commands for all drivers
-Sets opposing (trailing) junctions ahead of a train to prevent derailments.  Works with both AI and manually driven trains.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid2:121843:100282:1>'''
+*'''<kuid:400048:100603>'''
-*'''DLS Rule''' by '''pitkin'''
+*'''DLS Rule''' by '''callavsg'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-    '''None'''
+   '''None'''
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
-:This rule will not overrule a junction already locked by another AI train or locked against AI control using the '''Set Junctions Rule'''.
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
+*'''[[#AI Start Rule|AI Start Rule]]''' - restarts all halted AI drivers
-*'''[[#Set Cleared Junctions Rule|Set Cleared Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.
+*'''[[#AI Stop Rule|AI Stop Rule]]''' - halts all AI drivers
-*'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).
-==='''Replace Missing Vehicles Rule'''===
+==='''Display Custom HUD Rule'''===
-Produces new trains to replace missing vehicles that have been removed from the session by the '''Clean Up Derailed Trains Rule'''
+Show or hide the Custom Heads Up Display.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:447264:1214>'''
+*'''<kuid:-3:10206>'''
-*'''Built-in Rule'''
+*'''Base Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''[x] Respawn trains if they are abandoned for 10 minutes'''
+     '''Show or Hide the Custom Heads up Display''' - select one of two option buttons:-
-    If checked:-
+       '''( ) Show the Custom Heads up Display'''
-       Select one of two option buttons:-
+       '''( ) Hide the Custom Heads up Display'''
-          '''( ) 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
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Clean Up Derailed Trains Rule|Clean Up Derailed Trains Rule]]''' - cleans up derailed train cars after a set time delay
+*'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
-*'''[[#Wait for Derailment Rule|Wait for Derailment Rule]]''' - executes child rules when a derailment occurs
+*'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
+*'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers
+*'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
+*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
+*'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked
+[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Display_Custom_HUD_Rule</span>'''
-==='''Safety System Engaged Check Rule'''===
+==='''Display HTML Pages Rule'''===
-Executes child rules if safety systems are applied.
+Creates a browser to display the listed HTML files in order as a navigable sequence of pages. This rule has been superseded by the '''Message Popup Rule'''
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:447264:1216>'''
+*'''<kuid:-25:442>'''
-*'''Built-in Rule'''
+*'''Legacy Rule''' (replaced by '''Message Popup Rule''')
-*'''Parent Rule'''
+*'''Base Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''[x] Trigger only once'''
+    '''''<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
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Safety System Isolated Check Rule|Safety System Isolated Check Rule]]''' - executes child rules if safety systems have been isolated
+*'''[[#Close Message Popup Rule|Close Message Popup Rule]]''' - closes a displayed pop-up browser window.
+*'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
+*'''[[#Set HTML Page Rule|Set HTML Page Rule]]''' - sets parameters for the '''Display HTML Pages Rule'''
+*'''[[#Timed Limited Display HTML Rule (SP2 and later)|Timed Limited Display HTML Rule (SP2 and later)]]''' - displays a HTML page in a browser window for a set time.
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+==='''Display Video Rule'''===
-*'''[[How to Use Parent and Child Rules]]'''
-==='''Safety System Isolated Check Rule'''===
+Displays a page containing a video clip from a HTML asset in a browser window.
-Executes child rules if safety systems are isolated (disengaged).
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:447264:1217>'''
+*'''<kuid:-25:138>'''
 *'''Built-in Rule'''
-*'''Parent Rule'''
+[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+    '''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.
-    '''[x] Trigger only once'''
+[[file:Notes.PNG]] '''<u>Notes:</u>'''
+:Video must be in a valid web format.
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Safety System Engaged Check Rule|Safety System Engaged Check Rule]]''' - executes child rules if safety systems have been engaged
+*'''[[#Play Sound Rule|Play Sound Rule]]''' - plays a wav sound file
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+==='''DisplayIndustryStatus Rule (color modified)'''===
-*'''[[How to Use Parent and Child Rules]]'''
-==='''Set Coupler Masks Rule'''===
+Displays a summary of industry product levels when the "k" key is pressed.
-Set the coupling/decoupling  masks on the selected vehicles
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:980>'''
+*'''<kuid:622415:100001>'''
-*'''Built-in Rule'''
+*'''DLS Rule''' by '''lockheed02''' and '''marzipan'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''''<Add vehicle>''''' - click to select a vehicle from the session list
+     '''None'''
-    '''''<Add All>''''' - click to add all vehicles in the session list
-    '''''<Delete All>''''' - click to remove all added vehicles from this rule
+[[file:Notes.PNG]] '''<u>Notes:</u>'''
-       For each selected vehicle:-
+:Pressing the '''k''' key in Driver mode will bring up a small window with a single link '''''Display Industry Status''''' (there may also be other links). Clicking this link will show the product levels of all industries.
-       '''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
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Coupler Breakage Check Rule|Coupler Breakage Check Rule]]''' - executes child rules when a coupler breaks
+*'''[[#ExTrainz Manager Rule - TANE SP2|ExTrainz Manager Rule - TANE SP2]]''' - displays information on consists, industries and products in Driver and Surveyor.
-*'''[[#Coupler Breakage HUD Rule|Coupler Breakage HUD Rule]]''' - adds a coupler stress and breakage warning to the HUD
-==='''Signal Passed At Danger Check Rule'''===
+==='''Driver Command Check Rule'''===
-Executes child rules if a signal or stop mark is ''Passed at Danger (STOP)''.
+Executes child rules if the driver commands match a set list.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid2:60850:89007:2>'''
+*'''<kuid:-25:447>'''
 *'''Built-in Rule'''
@@ Line 787: / Line 670: @@
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-    '''[x] Trigger only once'''
+  '''[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
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[How to Use Parent and Child Rules]]'''
+*'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
-*'''[[How to Use Variables in Sessions (Examples)#Example 2: Event Counter and Message Selection|How to Use Variables in Sessions (Examples): Event Counter and Message Selection]]
+*'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
+*'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
+*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
+*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
+[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+*'''[[How to Use Parent and Child Rules]]'''
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Driver_Command_Rule</span>'''
-==='''Speeding Check Rule'''===
+==='''Driver Command Rule'''===
-Executes child rules if player controlled trains are over the local speed limit or over a set (custom) speed
+Specifies which commands will be available for the drivers
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid2:60850:89004:3>'''
+*'''<kuid:-3:10057>'''
-*'''Built-in Rule'''
+*'''Base Rule'''
-*'''Parent Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+:
+    For each installed Driver Command:-
+    '''[x] ''Name of Driver Command'' and ''Description (if available)''''' - check to make that command available to the drivers
-    Select one of two options to set a speed limit to be observed
+[[file:Notes.PNG]] '''<u>Notes:</u>'''
-       '''( ) Watch for trains travelling above the posted speed limit'''
+: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:
-          '''''<speed value>''''' - click to enter a new overspeed tolerance value
+::The ''Wait For Trigger'' command will not be available to any drivers if there are no triggers set.
-          '''''<speed units>''''' - click to select one from the list:-
+::The ''Call At'' command will not be available to any drivers if there are no industry active assets or passenger enabled stations.
-             '''''Km/h''''' - Kilometres per hour
-             '''''MPH''''' - Miles per hour
+[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-             '''''mps''''' - metres per second
+*'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
-       '''( ) Watch for trains travelling above a custom speed'''
+*'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
-          '''''<speed value>''''' - click to enter a new custom speed value
+*'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
-          '''''<speed units>''''' - click to select one from the list:-
+*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
-             '''''Km/h''''' - Kilometres per hour
+*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
-             '''''MPH''''' - Miles per hour
-             '''''mps''''' - metres per second
-             '''Warning: This option is very performance intensive and should only be used in sessions with few trains'''
 [[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
-*'''[[How to Use Parent and Child Rules]]'''
+*'''[[How to Use Driver Setup Rule#Driver Command Rule|How to Use Driver Command Rule]]'''
-==='''Vehicle Physics Rule'''===
+==='''Driver Main Menu Options Rule'''===
-Overrides the default vehicle physics properties for all vehicles or for those matching set criteria
+Show/Hide the Driver Main Menu Bar
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:1052>'''
+*'''<kuid:-25:448>'''
 *'''Built-in Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-    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 %
-==='''Wait for Derailment Rule'''===
+    '''''<Show/Hide>'' the Driver Main Menu Bar''' - click '''Show''' or '''Hide''' to select
-Executes child rules when a derailment occurs
+==='''Driver Schedule Rule'''===
+Sets up a list of basic scheduled commands
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:1053>'''
+*'''<kuid2:82445:90001:9>'''
 *'''Built-in Rule'''
-*'''Parent Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''[x] Trigger derailment watch once''' - check to execute the rule once only
+     '''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
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Clean Up Derailed Trains Rule|Clean Up Derailed Trains Rule]]''' - cleans up derailed train cars after a set time delay
+*'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
-*'''[[#Replace Missing Vehicles Rule|Replace Missing Vehicles Rule]]''' - creates a replacement train after a derailment
+*'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
+*'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
+*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
+*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
 [[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
-*'''[[How to Use Parent and Child Rules]]'''
+*'''[[How to Use Variables in Sessions (Examples)#Example 2: Event Counter and Message Selection|How to Use Variables in Sessions (Examples): Event Counter and Message Selection]]
-'''[[#top|Back to Top]]'''
+==='''Driver Setup Rule'''===
-----
-<table width="100%" bgcolor=#ffffaa>
+Creates the list of drivers for this session and assigns them their orders
-<tr>
-<td>
-=='''Driver Rules'''==
-</td>
-</tr>
-</table>
-==='''AI Start Rule'''===
+[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-Restarts all halted AI controlled trains. Drivers will continue with the commands in their driver command list.
+*'''<kuid:-16:2025>'''
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+*'''Base Rule'''
-*'''<kuid2:400048:100981:1>'''
-*'''DLS Rule''' by '''callavsg'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''None'''
+     '''''<driver icon>''''' - click to select a new driver from the list of installed and built in drivers
+    '''''<loco>''''' - click to select a new locomotive from the session list and assign it to this driver. Locos displayed in red have not been found in the session list
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+    '''''<driver name>''''' - click to enter a new name for the selected driver
-*'''[[#AI Stop Rule|AI Stop Rule]]''' -  halts all AI drivers
+    '''''<driver mode>''''' - click to select one of:-
-*'''[[#Disallow AI Rule|Disallow AI Rule]]''' -  cancels all AI driver commands
+       '''''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
-==='''AI Stop Rule'''===
+[[file:Issues.PNG]] '''<u>Known Issues:</u>'''
+:The '''Remove all existing Drivers first''' option does not appear to work
-Halts all AI controlled trains but does not delete their driver commands. AI trains can be restarted with the '''AI Start Rule''' or by issuing individual '''Continue Schedule''' commands.
+[[file:Notes.PNG]] '''<u>Notes:</u>'''
+:The driver at the top of the list will have the camera focus when the Session starts. There is no way to move a driver up the list order except by removing the higher drivers
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+*'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
+*'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
+*'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
+*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
+*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
-*'''<kuid2:400048:100980:1>'''
+[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+*'''[[How to Use Driver Setup Rule]]'''
-*'''DLS Rule''' by '''callavsg'''
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Driver_Setup_Rule</span>'''
+----
-[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+<table bgcolor=#ccffff>
+<tr>
-    '''None'''
+<td>
+'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+</td>
-*'''[[#AI Start Rule|AI Start Rule]]''' -  restarts all halted AI drivers
+</tr>
-*'''[[#Disallow AI Rule|Disallow AI Rule]]''' -  cancels all AI driver commands
+</table>
+<table width="100%" bgcolor=#ccffff>
+<tr>
+<td>
+=='''E, F, G'''==
+</td>
+</tr>
+</table>
-==='''Control Check Rule'''===
+==='''EIRS Weather Rule NE USA Rule'''===
-Executes child rules if the train control method has been altered or a specific method has been selected.
+Customize random weather rule relative to the North East Region of the United States.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:401543:1191>'''
+*'''<kuid2:487222:1037:3>'''
 *'''Built-in Rule'''
-*'''Parent Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-  '''Execute child rules when:''' - select one of two option buttons:-
+    '''Season ''<select>''''' - select one of:-
-     '''( ) DCC mode is Selected'''
+       '''''Summer'''''
-     '''( ) Cab mode is Selected'''
+       '''''Fall'''''
-  '''Execute child rules:''' - select one of two option buttons:-
+       '''''Winter'''''
-     '''( ) Every time control method is set'''
+       '''''Spring'''''
-     '''( ) Once only'''
+    '''Random Changeability (minutes) ''<value>''''' - select one of:-
+       '''''2/5/10/15/20/30/45/60''''' - minutes''
+    '''Environment Settings ''<select>''''' - select one of:-
+       '''''Disable/Enable'''''
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+[[file:Notes.PNG]] '''<u>Notes:</u>'''
-*'''[[#Control Type Rule|Control Type Rule]]''' - sets the control method
+:Minutes are Trainz clock times, not real times
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[How to Use Parent and Child Rules]]'''
+*'''[[#Random Weather Rule v2|Random Weather Rule v2]]''' - randomly changes the weather according to entered parameters
+*'''[[#Startup Options Rule|Startup Options Rule]]''' - sets the weather conditions at the start of a Session
+*'''[[#Weather Rule|Weather Rule]]''' - changes the weather conditions during Session play
-==='''Control Type Rule'''===
+==='''Enable/Disable Driver Commands Rule'''===
-Sets the control method
+Enable/Disable specific driver commands on certain drivers. Multiple copies of the rule can be used to give different drivers or consists different command lists
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-16:2030>'''
+*'''<kuid:-25:480>'''
-*'''Base Rule'''
+*'''Built-in Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-  '''Current control method is: ''<select>''''' - click to select one of
+    '''<Enable/Disable>'' the following driver commands ...''' - click to select '''Enable''' or '''Disable'''
-     '''''Easy Mode''''' - DCC (standard keyboard and mouse) control
+    For each driver command:-
-     '''''Ask User''''' - let the user decide
+    '''[x] ''command name''''' - check to enable or disable
-     '''''Realistic Mode''''' - Cab controls (on screen levers, throttles, buttons, etc)
+    '''[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
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Control Check Rule|Control Check Rule]]''' - executes child rules if the train control method changes
+*'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
+*'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
+*'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
+*'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
+*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
-==='''Disallow AI Rule'''===
+[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Enable/Disable_Driver_Commands_Rule</span>'''
+==='''End Session Rule'''===
-Cancels (deletes) all current and waiting AI commands for all drivers
+End the Session with a fade out.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:400048:100603>'''
+*'''<kuid:-25:482>'''
-*'''DLS Rule''' by '''callavsg'''
+*'''Built-in Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-   '''None'''
+    '''Fade out over ''<value>'' seconds''' - enter number of seconds for fade out.
+[[file:Notes.PNG]] '''<u>Notes:</u>'''
+:Seconds are Trainz clock time, not real time.
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#AI Start Rule|AI Start Rule]]''' -  restarts all halted AI drivers
+*'''[[#Session Complete Rule|Session Complete Rule]]''' - set the session to a percentage of completion
-*'''[[#AI Stop Rule|AI Stop Rule]]''' -  halts all AI drivers
-==='''Driver Command Check Rule'''===
+==='''ExTrainz Manager Rule - TANE SP2'''===
-Executes child rules if the driver commands match a set list.
+Provides information on consists, industries and products in both Surveyor and Driver modes. Once activated, the rule creates an additional short menu bar below the main menu bar.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:447>'''
+*'''<kuid:160293:10029>'''
-*'''Built-in Rule'''
+*'''DLS Rule''' by '''trev999'''
-*'''Parent Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-  '''[x] Trigger rule once''' - check to allow the rule to execute only once
+    '''Diagnostic mode is ''<On/Off>''''' - click to select ''On'' or ''Off''. When set ''On'' diagnostic messages will be added to the Trainz Log file.
-  '''Driver character to watch the command list of ''<select>''' - select a driver name from the Session List''
+    '''Turn on message overlay ''<Yes/No>''''' - click to select ''Yes'' or ''No''. When set to ''Yes'' the message overlay (lower left of screen) will be active.
-  '''Wait for driver character to have a command list that matches this:'''
+    '''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.
-     '''''<add driver command>''''' - add a driver command from the session list. More commands can be added. Commands can be deleted.
+    '''Search only rolling stock already in session ''<Yes/No>''''' - click to select ''Yes'' or ''No''. When set to ''Yes'' only those rolling stock assets
-     '''''<add all>''''' - adds ALL driver commands in the session list. Individual commands can be removed.
+       installed in the session can be searched.
-     '''''<delete all>''''' - deletes all entered driver commands from the session rule
+    '''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.
+[[file:Notes.PNG]] '''<u>Notes:</u>'''
+#Rolling stock installed in '''TANE''' or in the current session only (see settings above) can be searched to find a match for any selected product from any industry. In Surveyor (and Driver if that setting is enabled) click on the '''View Products''' sub menu link and click on a product name in the '''Product Window''' to display a list of all compatible rolling stock for that product.
+#Alternatively, click on the '''View Industries''' sub menu link and then click on a ''Product Icon'' to open a '''Product Window''', then click     on the '''''View Rolling Stock''''' link at the top of the window.
+#Industry class names are defined in the config.txt file of industry assets and are not normally accessible by users. However, you can exclude an entire group of related "industry asset classes" such as ''station'', ''coalingtower'', ''watertank'', etc regardless of their actual names provided those assets have been given that "class name" by their creators.
+[[file:Issues.PNG]] '''<u>Known Issues:</u>'''
+:This rule is NOT compatible with all industries.
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
+*'''[[#DisplayIndustryStatus Rule (color modified)|DisplayIndustryStatus Rule (color modified)]]''' - displays information on industry product levels.
-*'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
-*'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
-*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
-*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+==='''Fade In/Out Rule'''===
-*'''[[How to Use Parent and Child Rules]]'''
-*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Driver_Command_Rule</span>'''
-==='''Driver Command Rule'''===
+Fade in or out within seconds, using specified color and opacity values.
-Specifies which commands will be available for the drivers
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-3:10057>'''
+*'''<kuid2:190611:200000:2>'''
-*'''Base Rule'''
+*'''Built-in Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-:
-    For each installed Driver Command:-
-    '''[x] ''Name of Driver Command'' and ''Description (if available)''''' - check to make that command available to the drivers
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
+    '''Red percentage:             ''<value>''''' - enter the final % of red (0 = none, 100 = maximum)
-:Some Driver Commands that have been checked will not appear in the Command Lists for drivers if there is no target for their action. For example:
+    '''Green percentage:           ''<value>''''' - enter the final % of green
-::The ''Wait For Trigger'' command will not be available to any drivers if there are no triggers set.
+    '''Blue percentage:            ''<value>''''' - enter the final % of blue
-::The ''Call At'' command will not be available to any drivers if there are no industry active assets or passenger enabled stations.
+    '''Alpha percentage (opacity): ''<value>''''' - enter the final % of opacity (0 = invisible, 100 = solid)
+    '''Fading duration:            ''<value>''''' - enter the number of seconds required for the fade
+    '''''<help>''''' - click to bring up help instructions
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+[[file:Notes.PNG]] '''<u>Notes:</u>'''
-*'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
+:Seconds are Trainz clock time, not real time.
-*'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
-*'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
-*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
-*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+==='''Flash HUD Icon Rule'''===
-*'''[[How to Use Driver Setup Rule#Driver Command Rule|How to Use Driver Command Rule]]'''
-==='''Driver Main Menu Options Rule'''===
+Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.
-Show/Hide the Driver Main Menu Bar
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:448>'''
+*'''<kuid:-25:968>'''
 *'''Built-in Rule'''
@@ Line 1,070: / Line 988: @@
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''''<Show/Hide>'' the Driver Main Menu Bar''' - click '''Show''' or '''Hide''' to select
+    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'''
-==='''Driver Schedule Rule'''===
+       TIP: Select the HUD panel first (the second ''<click to select>'' link).
+       Available HUD panels are (select one):-
-Sets up a list of basic scheduled commands
+          '''Bottom Right Menu'''
+          '''Camera Controls'''
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+          '''DCC Controls'''
+          '''Driver Main Menu'''
-*'''<kuid2:82445:90001:9>'''
+       Available icons will depend on the HUD panel selected.
+     '''( ) ''<Start/Stop>'' flashing the ''<click to select>'' icon on the ''<click to select>'' HUD panel'''
-*'''Built-in Rule'''
+        TIP: Select the HUD panel first (the second ''<click to select>'' link).
+       Available HUD panels are (select one):-
-[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+          '''Bottom Right Menu'''
+          '''Camera Controls'''
-     '''Driver Schedule Assigned to ''name of driver <icon>''''' - click '''icon''' to select a driver from those assigned in the '''Driver Setup Rule'''
+          '''DCC Controls'''
-    '''Next commands, will be executed'''
+          '''Driver Main Menu'''
-        '''''>>''''' - click to enter driver commands from those specified in the '''Driver Command Rule'''
+       Available icons will depend on the HUD panel selected.
-    '''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
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
+*'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
-*'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
+*'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
-*'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
+*'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers
-*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
+*'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
-*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
+*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
+*'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+==='''Focus Camera Rule'''===
-*'''[[How to Use Variables in Sessions (Examples)#Example 2: Event Counter and Message Selection|How to Use Variables in Sessions (Examples): Event Counter and Message Selection]]
-==='''Driver Setup Rule'''===
+Sets the initial camera view and starting vehicle for a session.
-Creates the list of drivers for this session and assigns them their orders
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-16:2025>'''
+*'''<kuid2:122381:10014:1>'''
-*'''Base Rule'''
+*'''DLS Rule''' by '''mizi'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''''<driver icon>''''' - click to select a new driver from the list of installed and built in drivers
+     '''Focus camera to:''' - select one of two option buttons
-    '''''<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
+       '''( ) Map object'''
-     '''''<driver name>''''' - click to enter a new name for the selected driver
+       '''( ) Vehicle'''
-     '''''<driver mode>''''' - click to select one of:-
+     '''Named ''<?????>''''' - enter name of object or vehicle from session list
-       '''''Autodetect''''' - the program will detect the driver mode to be used. For example, if driver commands have been entered for this driver
+     '''Additionally:'''
-           then the '''AI driver''' mode will be selected
+       '''[x] set view mode to''' - check to select one of four option buttons
-       '''''First Human Player''''' - the driver will be assigned to the user or multiplayer who accesses her/him first
+          '''( ) Internal view'''
-       '''''AI driver''''' - the AI will be given control even if no commands are present
+           '''( ) External view'''
-        '''''Multiplayer Driver''''' - the driver will be assigned to a multiplayer user
+          '''( ) Tracking view'''
-    '''''<remove>''''' - this driver will be removed from the rule
+          '''( ) Roaming view'''
-    '''''>>''''' - click to enter driver commands from those specified in the '''Driver Command Rule'''
+        '''[x] restrict user to manipulate the camera''' - check to set user limits on camera controls
-     --> Scroll down to the bottom of the list of entered drivers for more options
+          '''[x] allow internal view'''
-  '''''<Add another driver>''''' - click to add another driver
+          '''[x] allow external view'''
-  '''[x] Remove all existing Drivers first''' - see '''Known Issues''' below
+          '''[x] allow tracking view'''
-  '''[x] Generate new Drivers for empty Trains''' - when checked all newly added locos will automatically be given drivers
+          '''[x] allow roaming view'''
+          '''[x] allow change of view mode'''
-[[file:Issues.PNG]] ''''<u>Known Issues:</u>'''
+          '''[x] allow change vehicle in train'''
-:The '''Remove all existing Drivers first''' option does not appear to work
+          '''[x] allow change trains'''
+          '''[x] allow adjust camera viewpoint'''
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
+       '''[x] set camera angles''' - check to set the initial camera view point
-: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
+          '''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
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
+*'''[[#Cinematic Camera Rule|Cinematic Camera Rule]]''' - provides several different cinematic style cameras with animations
-*'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
+*'''[[#Set Camera Rule|Set Camera Rule]]''' - sets the target object and properties of the camera
-*'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
+*'''[[#Wait for Camera View Mode Rule|Wait for Camera View Mode Rule]]''' - executes child rules when the camera view is changed
-*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
-*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+==='''Generic TreeNode Debug Window Rule'''===
-*'''[[How to Use Driver Setup Rule]]'''
-*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Driver_Setup_Rule</span>'''
-==='''Enable/Disable Driver Commands Rule'''===
+No description.
-Enable/Disable specific driver commands on certain drivers. Multiple copies of the rule can be used to give different drivers or consists different command lists
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:480>'''
+*'''<kuid:30501:1042>'''
-*'''Built-in Rule'''
+*'''Base Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''<Enable/Disable>'' the following driver commands ...''' - click to select '''Enable''' or '''Disable'''
+     '''None'''
-    For each driver command:-
+----
-    '''[x] ''command name''''' - check to enable or disable
+<table bgcolor=#ccffff>
-    '''[x] ''command name''''' - check to enable or disable
+<tr>
-    '''[x] ''command name''''' - check to enable or disable
+<td>
-    etc
+'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''
-    Select one of two option buttons:-
+</td>
-       '''( ) click to accept all trains'''
+</tr>
-       '''( ) click to accept trains matching specific criteria'''
+</table>
-          Selecting the second option will produce the following selection controls:-
+<table width="100%" bgcolor=#ccffff>
-          '''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
+<tr>
-             '''''+''''' - click to add a ''specific'' vehicle from the session list
+<td>
-             '''''x''''' - click to remove the ''specific'' vehicle from the rule
+=='''H, I, J'''==
-          '''Vehicle types''''' - identify the ''type'' of vehicle or a set of vehicle ''types'' that will trigger the rule
+</td>
-             '''''+''''' - click to add a ''type'' of vehicle from the session list
+</tr>
-             '''''x''''' - click to remove the ''type'' of vehicle from the rule
+</table>
-          '''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
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+==='''Hide Product Overlays Rule'''===
-*'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
-*'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
-*'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
-*'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
-*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+Hides the commodity or product bar graphs that appear on active industries
-*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Enable/Disable_Driver_Commands_Rule</span>'''
-==='''JTG Correct Vehicle Lights'''===
-Corrects the brightness of vehicle headlights. Now obsolete.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid2:478657:999103:1>'''
+*'''<kuid:400048:100970>'''
-*'''DLS Rule''' by '''jtg-trainz'''
+*'''DLS Rule''' by '''callavsg'''
-*''' Obsolete Rule''' (function is now built into TANE Driver Additional Tools Menu)
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-    '''None'''
+   '''None'''
-==='''Quick Portal Manager Standard Edition Rule (SP2 and later)'''===
+==='''InputTable Rule'''===
-Manages portals and adds flexible timetables.
+Creates a list of message names to be used for various purposes including passing data to '''Driver Commands'''
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid2:61392:5011:45>'''
+*'''<kuid2:131986:1012:1>'''
-*'''DLS Rule''' by '''pguy'''
+*'''Built-in Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-    '''Target date is ''day-of-week'' ''&<nowiki />lt;dd/mm/yyyy&<nowiki />gt;''''' - ''day-of-week'' and ''date'' shown are for today's date. Click '''''dd/mm/yyyy''''' to change date.
+     '''''<add>''''' - click to add a new entry to the table
-     '''''<Copy rule data to Clipboard>''''' - click to copy the currently entered data to a special clipboard area used by the rules created by '''pguy'''.
+    Each new entry will require an input message
-        This is NOT the standard OS clipboard.
+        '''''<short message>''''' - enter a message. The message must be in a format that is specific for each purpose
-    '''''<Paste rule data from Clipboard>''''' - if data is held in the special clipboard area, then click to paste that data into the rule.
+        For the '''MoveTurntable''' driver command the message must be formatted as:-
-        This is NOT the standard OS clipboard.
+          '''turntable,name_of_turntable,number_of_connecting_roads''' - the first entry must be the word ''turntable'' in lower case.
-    '''[x] This rule is enabled''' - check to activate (enable) the rule.
+             ''name_of_turntable'' is the name of the turntable,
-    '''[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.
+             ''number_of_connecting_roads'' is the number of tracks connecting to the turntable
-    '''[x] Disable locomotives/vehicles enhanced mode''' - check to save vehicle properties when a train is removed by a portal.
+       For the '''WaitUntilTime''' driver command the message must be formatted as:-
-       These properties will be restored if the same train is emitted by a portal. If checked then a new command will appear:
+          '''time,hour,minute''' - the first entry must be the word ''time'' in lower case,
-       '''''<for all vehicles/for only locomotives/for only tagged vehicles>''''' - click to select one.
+             ''hour'' must be from 0 to 23,
-    '''Portal selected: ''<portal name> [...]''''' - select a portal to manage by clicking '''''<portal name>''''' or '''''[...]''''' and selecting a portal from the Session list.
+             ''minute'' must be from 0 to 59.
-    '''Portal output link: ''<[no link]> [...]''''' - leave blank.
+        For the '''WaitUntilSVariable''' driver command the message must be formatted as:-
-    '''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.
+          '''svar,svar_name,svar_condition,value''' - the first entry must be the word ''svar'' in lower case,
-    '''Default schedule for input trains is named: ''<schedule>''''' - click to enter a schedule name.
+             ''svar_name'' is the name of the session variable,
-    '''Today's schedule: ''<Insert new schedule>''''' - click to enter a new schedule
+             ''svar_condition'' is an equality (eg eq for equal, gt for greater than, etc)
-    For each schedule:-
+             ''value'' is an integer value to be compared to the session variable.
-       '''''<hh:mm>''''' - click to set the time when a train will be emitted from the portal. Times use the 24hr clock.
+    Each entry in the table will be followed by the commands:-
-        '''''<train name>''''' - click to enter the train name
+        '''''cp''''' - click to copy this entry to a new entry
-       '''''<mission code>''''' - click to enter the '''Mission Code''' created by the '''MissionCode Manager Rule (SP2 and later)'''.
+       '''''up''''' - click to move this entry up one level
-       '''''<schedule>''''' - click to enter the re-occurrence schedule in ''hh:mm'' (24hr clock) where, for example:
+        '''''dn''''' - click to move this entry down one level
-          ''02:30'' means every 2 hrs 30 minutes,
+        '''''rm''''' - click to remove this entry from the table
-          ''00:00'' means once only,
-          ''24:00'' means once each day.
-        '''''<driver>''''' - click to select a driver name or select '''''auto-driver''''' to let the rule select a driver.
-          '''Current driver order bar is named ''<schedule>''''' - click to enter a name for the order (Driver Command) bar used in this schedule.
-        '''''<hud>''''' - click to select a HUD for this train. HUDs must be created using the '''Quick CustomHud Manager Rule (SP2 and later)'''.
-       '''Driver Command Bar''' - enter driver commands for this train.
-       Choose one of two consist sets:
-        '''''<mono consist>'' consist for every day''' - if selected the same consist will be used each day.
-          '''''<no consist selected>''''' - click to select a consist from those saved in your install.
-       '''''<multi consists>''''' - if selected a different consist will be used each day.
-          For each day of the week:
-             '''Day-of-week ''<no consist selected>''''' - click to select a consist from those saved in your install.
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+==='''Interlocking Tower Configure Path Rule'''===
-*'''[[#MissionCode Manager Rule (SP2 and later)|MissionCode Manager Rule (SP2 and later)]]''' - creates and manages '''Mission Codes''' for '''Interlocking Tower''' paths
-*'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - create driver HUDs
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+Alters settings on an interlocking tower path
-*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Quick_Portal_Manager</span>'''
-==='''QuickDrive Rule'''===
-Changes the Session settings.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:401543:1184>'''
+*'''<kuid:401543:3205>'''
 *'''Base Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-    '''Open QuickDrive window when session is started          [x]''' - check to set
+    '''Interlocking Tower ''<select>''''' - to set Name and Objects
-   '''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
+[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-   '''Enable in game help by default                          [x]''' - check to allow help options to be displayed
+*'''[[#Interlocking Tower Path Selection UI Rule|Interlocking Tower Path Selection UI Rule]]''' - automatically reacts to messages from Interlocking Towers and displays a path selection dialog to the player.
-   '''Set the default Control method to:''' - select one of two option buttons:-
+*'''[[#Interlocking Tower Set Path Rule|Interlocking Tower Set Path Rule]]''' - sets the state of an interlocking tower path for a train
-      '''( ) Easy Mode'''
+*'''[[#Interlocking Tower Enhanced Manager Rule (SP2 and later)|Interlocking Tower Enhanced Manager Rule (SP2 and later)]]''' - more management and control options for interlocking towers.
-      '''( ) 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'''
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+==='''Interlocking Tower Path Selection UI Rule'''===
-*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/QuickDrive_Rule</span>'''
-==='''Schedule Rule'''===
+Will automatically react to messages from Interlocking Towers and display a path selection dialog to the player. Disable by removing rule from session
-Allows a schedule of timed events to be applied to a train
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-3:10185>'''
+*'''<kuid:401543:3203>'''
 *'''Base Rule'''
@@ Line 1,305: / Line 1,163: @@
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-    '''Insert track mark ''<select>''''' - select a track mark from the Session List
+   '''[Checkbox] Show path activation message in Driver'''
-    '''Arrival and Departure Time ''<Select>''''' - set time
-       '''''hh:mm:ss''''' - in hours/minutes/seconds
-    '''Current Train ''<select>''''' - select from session list
-    '''Insert destination ''<select>''''' - select from session list
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
+[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-:Times are Trainz clock times, not real time
+*'''[[#Interlocking Tower Configure Path Rule|Interlocking Tower Configure Path Rule]]''' - alters the settings on an interlocking tower path
+*'''[[#Interlocking Tower Set Path Rule|Interlocking Tower Set Path Rule]]''' - sets the state of an interlocking tower path for a train
+*'''[[#Interlocking Tower Enhanced Manager Rule (SP2 and later)|Interlocking Tower Enhanced Manager Rule (SP2 and later)]]''' - more management and control options for interlocking towers.
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+==='''Interlocking Tower Set Path Rule'''===
-*'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
-*'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
-*'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
-*'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
-*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
-[[file:WWWLinks.PNG]] ''''<u>Other Links:</u>'''
+Will set the state of an interlocking tower path for a train
-*'''<span class="plainlinks">http://www.auran.com/games/gamefiles/trainz/tutorial1.html</span>'''
-==='''Wait for Driver On/Off Train Rule'''===
-Executes child rules when a driver gets on or off a train
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:953>'''
+*'''<kuid:401543:3204>'''
-*'''Built-in Rule'''
+*'''Base Rule'''
-*'''Parent Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-  '''[x] Trigger Rule Once''' - click to set''
+   '''Interlocking Tower ''<select>''''' - to set Name and Objects
-  '''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
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Wait for Driver/Train to be Locally Owned Rule|Wait for Driver/Train to be Locally Owned Rule]]''' -  executes child rules when a vehicle or driver changes ownership
+*'''[[#Interlocking Tower Configure Path Rule|Interlocking Tower Configure Path Rule]]''' - alters the settings on an interlocking tower path
+*'''[[#Interlocking Tower Path Selection UI Rule|Interlocking Tower Path Selection UI Rule]]''' - automatically reacts to messages from Interlocking Towers and displays a path selection dialog to the player.
+*'''[[#Interlocking Tower Enhanced Manager Rule (SP2 and later)|Interlocking Tower Enhanced Manager Rule (SP2 and later)]]''' - more management and control options for interlocking towers.
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+==='''Interlocking Tower Enhanced Manager Rule (SP2 and later)'''===
-*'''[[How to Use Parent and Child Rules]]'''
-==='''Wait for Driver/Train to be Locally Owned Rule'''===
+Provides more management and control options for interlocking towers.
-Executes child rules when a specific driver or vehicle is locally owned. If the driver/vehicle becomes unowned again the child rules are paused
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid2:401543:1173:1>'''
+*'''<kuid2:61392:8130:41>'''
-*'''Built-in Rule'''
+*'''DLS Rule''' by '''pguy'''
-*'''Parent Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-  '''Assets Ownership:''' - select one of two option buttons:-
+    '''''<towers>''''' - click to select interlocking towers from the session list
-     '''( ) Wait for ownership of a specific Driver'''
+       '''''<do full check again>''''' - click to run an error check on all interlocking towers
-     '''( ) Wait for ownership of Driver'''
+       '''List of all available interlocking towers''' - for each tower:-
-  '''Driver or Vehicle ''<select>''''' - choose from session list
+          '''''<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
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Wait for Driver On/Off Train Rule|Wait for Driver On/Off Train Rule]]''' -  executes child rules when a driver gets on or off a train
+*'''[[#Interlocking Tower Configure Path Rule|Interlocking Tower Configure Path Rule]]''' - alters the settings on an interlocking tower path
+*'''[[#Interlocking Tower Path Selection UI Rule|Interlocking Tower Path Selection UI Rule]]''' - automatically reacts to messages from Interlocking Towers and displays a path selection dialog to the player.
+*'''[[#Interlocking Tower Set Path Rule|Interlocking Tower Set Path Rule]]''' - sets the state of an interlocking tower path for a train
 [[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
-*'''[[How to Use Parent and Child Rules]]'''
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Enhanced_Interlocking_Tower_Manager_Rule</span>'''
-'''[[#top|Back to Top]]'''
+==='''JTG Correct Vehicle Lights'''===
-----
-<table width="100%" bgcolor=#ffffaa>
+Corrects the brightness of vehicle headlights. Now obsolete.
-<tr>
-<td>
-=='''HUD (Heads Up Display) Rules'''==
-</td>
-</tr>
-</table>
-==='''Cab Controls HUD Rule'''===
-Was used to provide the HUD controls for the cabin view. Now obsolete.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-16:287428>'''
+*'''<kuid2:478657:999103:1>'''
-*'''Base Rule'''
+*'''DLS Rule''' by '''jtg-trainz'''
-*'''Obsolete Rule''' (function is now built into TANE)
+*''' Obsolete Rule''' (function is now built into TANE Driver Additional Tools Menu)
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
@@ Line 1,412: / Line 1,232: @@
      '''None'''
-==='''Coupler Breakage HUD Rule'''===
+==='''Junction Derailment Prevention Rule'''===
-HUD displays warning about coupler stress and breakage
+Sets opposing (trailing) junctions ahead of a train to prevent derailments.  Works with both AI and manually driven trains.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:423>'''
+*'''<kuid2:121843:100282:1>'''
-*'''Built-in Rule'''
+*'''DLS Rule''' by '''pitkin'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     Select one of two option buttons:-
+     '''None'''
-       '''( ) Show the Coupler Breakage Display'''
-       '''( ) Hide the Coupler Breakage Display'''
+[[file:Notes.PNG]] '''<u>Notes:</u>'''
+:This rule will not overrule a junction already locked by another AI train or locked against AI control using the '''Set Junctions Rule'''.
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Coupler Breakage Check Rule|Coupler Breakage Check Rule]]''' - executes child rules if a coupler breaks
+*'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
-*'''[[#Set Coupler Masks Rule|Set Coupler Masks Rule]]''' - sets the coupling/decoupling masks on selected vehicles
+*'''[[#Set Cleared Junctions Rule|Set Cleared Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.
+*'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).
+----
+<table bgcolor=#ccffff>
+<tr>
+<td>
+'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''
+</td>
+</tr>
+</table>
+<table width="100%" bgcolor=#ccffff>
+<tr>
+<td>
+=='''K, L, M'''==
+</td>
+</tr>
+</table>
-==='''Display Custom HUD Rule'''===
+==='''Lock All Junctions Rule'''===
-Show or hide the Custom Heads Up Display.
+Locks all junctions against user actions. AI operations are not affected. Once the AI releases a junction, it will be returned to its previous locked state.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-3:10206>'''
+*'''<kuid:400048:100971>'''
-*'''Base Rule'''
+*'''DLS Rule''' by '''callavsg'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''Show or Hide the Custom Heads up Display''' - select one of two option buttons:-
+     '''None'''
-       '''( ) Show the Custom Heads up Display'''
-       '''( ) Hide the Custom Heads up Display'''
+[[file:Notes.PNG]] '''<u>Notes:</u>'''
+:Individual junctions can still be set, locked and unlocked by using the '''Set Junction Rule'''
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
+*'''[[#Set Cleared Junctions Rule|Set Cleared Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.
-*'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
+*'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).
-*'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers
-*'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
-*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
-*'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+==='''MaxPermittedSpeed Rule'''===
-*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Display_Custom_HUD_Rule</span>'''
-==='''Flash HUD Icon Rule'''===
+Sets the maximum permitted speed of locomotives under AI control
-Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:968>'''
+*'''<kuid2:60850:89000:7>'''
 *'''Built-in Rule'''
@@ Line 1,471: / Line 1,302: @@
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-    Select one of two option buttons:-
+     '''None'''
-     '''( ) 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.
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+[[file:Notes.PNG]] '''<u>Notes:</u>'''
-*'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
+: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)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
-*'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers
-*'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
-*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
-*'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked
 ==='''mc Display Custom HUD V2 Rule (SP2 and later)'''===
@@ Line 1,523: / Line 1,333: @@
 *'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked
-==='''Quick CustomHud Manager Rule (SP2 and later)'''===
+==='''Message Popup Rule'''===
-Allows the creation of new graphical heads up displays which are assigned to the drivers in Driver Mode. Replaces the '''mc Display Custom HUD V2 Rule (SP2 and later)'''
+Displays a pop-up browser window and waits for it to be closed. Closure can be manual (by the user) or by another rule.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid2:61392:5020:47>'''
+*'''<kuid:-25:1003>'''
-*'''DLS Rule''' by '''pguy'''
+*'''Built-in Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''''<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'''.
+     '''[x] Pause game while message is displayed''' - stops the game until this message is closed
-       This is NOT the standard OS clipboard.
+    '''[x] Close previous popup windows''' - closes any Message Popups currently displayed before this message is shown
-     '''''<Paste rule data from Clipboard>''''' - if data is held in the special clipboard area, then click to paste that data into the selected HUD.
+     '''Message location ''<Top Left/Top Right/Bottom Left/Bottom Right>''''' - select one to position the browser window on the screen
-       This is NOT the standard OS clipboard.
+     '''Message Source:''' - select one of three option buttons:-
-     '''Current HUD Parameters'''
+        '''( ) Custom text''' - the simplest and easiest option
-        '''HUD to select: ''<HUD name>''''' - click to select a HUD from those available. One or two default HUDs will be supplied.
+          '''Icon ''<Click here to set>''''' - (optional) shows a list of message icons. Select one to be displayed with the message
-       '''''new HUD''''' - click to create a new HUD display with default properties. You will be required to enter a name for the new HUD
+          '''Icon ''<Clear icon>''''' - clears any currently displayed message icon
-       '''''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
+          '''Custom text box''' Enter text to be displayed. You will be limited to about 6 lines of text.
-       '''''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 longer messages or to include graphics, use the '''A predefined HTML page''' option.
-    For new, cloned or copied HUDs, additional commands will be shown:
+          '''''<HTML Wave>''''' - (optional) select the name of the HTML asset from the list shown that contains the wave file to be played.
-        '''''rename HUD''''' - rename the selected HUD. You will be required to enter a new name for the HUD
+          '''''<Wave Name>''''' - (optional) enter the name of a wave (.wav) sound file to be played.
-       '''''delete HUD''''' - delete the currently displayed HUD
+              The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension ".wav" is optional
-    In '''Driver Mode''' an additional command will be shown:
+          '''[x] Autoplay Wave:''' - plays the .wav sound file as soon as message is displayed.
-       '''''Assign hud to current train''''' - click to assign the currently selected HUD to the currently selected driver
+              If unchecked the sound will not be played.
-    '''[x] hud is displayed (on)''' - check to display HUD in '''Driver Mode'''
+        '''( ) A predefined HTML page''' - requires a working knowledge of HTML
-    '''hud items nb entries max: ''<value>''''' - enter the maximum number of items to be displayed in the HUD. Maximum is 30.
+          '''''<HTML Asset>''''' - select the name of the HTML asset that contains the required HTML page from the list shown.
-    '''hud view limit: ''<value>''''' - enter the maximum look-ahead distance in metres for the HUD. Minimum value is 1000, maximum value is 10000.
+          '''''<HTML Page>''''' - enter the filename of the HTML page to be displayed. The page must be in the HTML asset identified above.
-    '''[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'''
+              Filename is not case sensitive. Extension ".html" is optional.
-    For each individual HUD property:
+          '''''<HTML Wave>''''' - (optional) select the name of the HTML file containing the wave file to be played.
-       '''[x] ''HUD property''''' - check to add this property to the HUD
+              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.
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
+[[file:Issues.PNG]] '''<u>Known Issues:</u>'''
-: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.
+:Because this rule will wait until it is closed (terminated) then it is not recommended for use in an '''Ordered List''' because you cannot guarantee that any following child rules will be executed.  If it MUST be used in an '''Ordered List''' then place it last.
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
+*'''[[#Close Message Popup Rule|Close Message Popup Rule]]''' - closes a displayed pop-up browser window.
-*'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
+*'''[[#Display HTML Pages Rule|Display HTML Pages Rule]]''' - display listed HTML files in order as a navigable sequence of pages.
-*'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
+*'''[[#Timed Limited Display HTML Rule (SP2 and later)|Timed Limited Display HTML Rule (SP2 and later)]]''' - displays a HTML page in a browser window for a set time.
-*'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
-*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
-*'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked
-==='''Show/Hide HUD Panel Rule'''===
+[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+*'''[[How to Create a HTML Asset|How to Create a HTML Asset (Session Introduction Page and In Game Messages)]]'''
+*'''[[How to Use Message Popup Rule]]'''
+*'''[[How to Use Message Popup Rule (Applications)]]'''
+==='''Minimap Options Rule'''===
-Shows or hides a HUD panel.
+Sets the display options for the minimap.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:1047>'''
+*'''<kuid:-25:636>'''
 *'''Built-in Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+ ''Default values - all checked''
-     '''''<Show/Hide>'' the ''<click to select>'' HUD panel''' - select '''''Show''''' or '''''Hide''''' and then select the HUD panel
+    '''[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'''
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
+*'''[[#Show/Hide Minimap Rule|Show/Hide Minimap Rule]]''' - shows the minimap window in Driver.
-*'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
-*'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
-*'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers
-*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
-*'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked
-==='''Variable Show Rule'''===
+==='''MissionCode Manager Rule (SP2 and later)'''===
-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.
+Enables the addition, editing and management of Mission Codes used to auto select paths in '''Interlocking Towers'''.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:971>'''
+*'''<kuid2:61392:8200:50>'''
-*'''Built-in Rule'''
+*'''DLS Rule''' by '''pguy'''
-[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+ENTRY UNDER CONSTRUCTION
-   '''[x] Add'''
+[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
-      '''''<variable-name>''''' - enter variable-name to add to HUD. Variable-name is case sensitive.
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/MissionCodes_Manager</span>'''
-      '''''<label>''''' - (optional) enter a short label to be displayed on the HUD in front of the variable value.
-   '''[x] Remove'''
+==='''MissionCode Stops and Timetable Manager Rule (SP2 and later)'''===
-      '''''<variable-name>''''' - enter variable-name to remove from HUD. Variable-name is case sensitive.
+Enables the creation, editing and management of stop zones and timetables for trains following a path defined using mission codes.
+[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+*'''<kuid2:61392:8300:50>'''
+*'''DLS Rule''' by '''pguy'''
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+ENTRY UNDER CONSTRUCTION
-*'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
-*'''[[#Quick Session Variables Rule|Quick Session Variables Rule]]''' - allows the editing of session variables.
-*'''[[#Variable Check Rule|Variable Check Rule]]''' - executes child rules according to the value of a specified variable.
-*'''[[#Variable Modify Rule|Variable Modify Rule]]''' - changes the value of a specified variable.
-*'''[[#Variable Modify Continuous Rule|Variable Modify Continuous Rule]]''' - continuously changes the value of a specified variable.
-*'''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.
 [[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
-*'''[[How to Use Variables in Sessions (Examples)]]
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Mission_Code_Stops_and_TimeTables_Manager</span>'''
-==='''Wait for Click on HUD Icon Rule'''===
+==='''Multiplayer Rule'''===
-Executes child rules when the user clicks on a selected HUD icon
+Enables the session to be taken online in a Multiplayer environment.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:951> <kuid:-25:970>''' - two versions built-in with different kuids, both have the same properties
+*'''<kuid:447264:1045>'''
 *'''Built-in Rule'''
-*'''Parent Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''[x] Trigger Once'''
+     '''Suggested maximum number of players for this session ''<value>''''' - enter a number
-     '''HUD Panel ''<Click>''''' - click choose from list:-
+     '''Maximum number of drivers per player ''<value>''''' - enter a number
-       '''Bottom Right Menu'''
+    '''Players are permitted to claim drivers             [x]''' - check to allow players to select a driver
-       '''Camera Controls'''
+    '''Players can see each other's driver orders         [x]''' - check to allow players to view orders for other players
-       '''DCC Controls'''
+     '''Automatically target an available train on clients [x]''' - automatically assign a driver to each player
-     '''Icon ''<Click>''''' - click to choose from list. Selections depends on HUD Panel chosen
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+==='''Multiple Junction Alignment Check Rule'''===
-*'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
-*'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
-*'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
-*'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers
-*'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
-*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+Executes child rules if specific junctions are set.
-*'''[[How to Use Parent and Child Rules]]'''
-'''[[#top|Back to Top]]'''
+[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-----
-<table width="100%" bgcolor=#ffffaa>
+*'''<kuid:-25:168>'''
-<tr>
-<td>
-=='''Industry Rules'''==
-</td>
-</tr>
-</table>
-==='''Advanced Industry Load Configuration Rule'''===
+*'''Built-in Rule'''
-Locks train controls when loading/unloading at an industry, overrides time settings for begin load and begin unload operations
+*'''Parent Rule'''
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:30501:100007>'''
-*'''Base Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''Target object ''<select>''''' - select industry object from session list
+     '''Wait until ''<selection>''''' - select from:-
-     '''[x] Lock the train's controls during a stopped load/unload operation''' - check to disable driver controls while train is stopped and loading/unloading
+       '''any one''' - any of the junctions in the rule list (below) is set correctly
-     '''[x] Override 'begin load' and 'begin unload' durations to ''<value>'' seconds''' - if checked enter number of seconds to override
+       '''all''' - ALL of the junctions in the rule list are set correctly
+    '''''<Add junction>''''' - click to select a junction from the session list
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
+     '''''<Add all>''''' - click to select ALL junctions in the session list
-:Times are Trainz clock time, not real time
+     '''''<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
+[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+*'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
+*'''[[#Set Cleared Junctions Rule|Set Cleared Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.
+*'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).
+[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+*'''[[How to Control Junctions in Sessions]]'''
+*'''[[How to Use Parent and Child Rules]]'''
-==='''Disable/Enable Industry Rule'''===
+==='''Multiple Resource Check Rule'''===
-Enables/Disables vehicle load/unload for industry
+Executes child rules if industries or vehicles reach set commodity levels. This rule replaces the older '''Resource Check Rule'''
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid2:401543:1171:1>'''
+*'''<kuid:-25:656>'''
 *'''Built-in Rule'''
+*'''Parent Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-   '''Load/unload ''<Disable/Enable>''''' - click to set to '''Disable''' or '''Enable'''
+    '''<Product Level>''' - click to select a product test from two choices:-
-   '''Which Industry? ''<select>''''' - click to set Industry from Session List
+       '''''Reach/Exceed''''' - sets an upper limit for the resources being monitored.
-   '''Which Vehicles:''' - select one of two option buttons:-
+          For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon reaches or exceeds a specified level.
-      '''( ) Apply to every vehicle in the session'''
+          The initial level in the object must be below the set upper limit.
-      '''( ) Apply only to a specific vehicles from Session List'''
+       '''''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.
-==='''DisplayIndustryStatus Rule (color modified)'''===
+          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
-Displays a summary of industry product levels when the "k" key is pressed.
+[[file:Notes.PNG]] '''<u>Notes:</u>'''
+:This rule only checks for ''changing'' commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is ''full'' or ''empty''.
+[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+*'''[[#Resource Check Rule|Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
+*'''[[#Resource Verify Rule (fixed)|Resource Verify Rule (fixed)]]''' - executes child rules when a set resource (commodity) level is reached
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+*'''[[How to Use Navigation Point Rules (Applications)#Application 3: Wait for Loading to be Completed|How to Use Navigation Point Rules (Applications): Wait for Loading to be Completed]]'''
+*'''[[How to Use Parent and Child Rules]]'''
-*'''<kuid:622415:100001>'''
+----
+<table bgcolor=#ccffff>
+<tr>
+<td>
+'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''
+</td>
+</tr>
+</table>
+<table width="100%" bgcolor=#ccffff>
+<tr>
+<td>
+=='''N, O'''==
+</td>
+</tr>
+</table>
-*'''DLS Rule''' by '''lockheed02''' and '''marzipan'''
+==='''Navigation Display Rule'''===
-[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+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.
-    '''None'''
+[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
+*'''<kuid2:401543:1161:1>'''
-:Pressing the '''k''' key in Driver mode will bring up a small window with a single link '''''Display Industry Status''''' (there may also be other links). Clicking this link will show the product levels of all industries.
+*'''Base Rule'''
+[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+    '''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.
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#ExTrainz Manager Rule - TANE SP2|ExTrainz Manager Rule - TANE SP2]]''' - displays information on consists, industries and products in Driver and Surveyor.
+*'''[[#Navigation Set Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.
+*'''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set has completed or is incomplete.
+*'''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
+*'''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.
+*'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed
+[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+*'''[[How to Use Navigation Point Rules]]'''
+*'''[[How to Use Navigation Point Rules (Applications)]]'''
-==='''ExTrainz Manager Rule - TANE SP2'''===
+==='''Navigation Point Complete Rule'''===
-Provides information on consists, industries and products in both Surveyor and Driver modes. Once activated, the rule creates an additional short menu bar below the main menu bar.
+Manually completes a navigation point in a set
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:160293:10029>'''
+*'''<kuid:401543:1167>'''
-*'''DLS Rule''' by '''trev999'''
+*'''Base Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''Diagnostic mode is ''<On/Off>''''' - click to select ''On'' or ''Off''. When set ''On'' diagnostic messages will be added to the Trainz Log file.
+     '''Mark navigation point ''<click here to set>''''' - enter the navigation point number to be completed
-    '''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.
+     '''complete in set ''<click here to set>''''' - enter the unique name for the navigation set created using the '''Navigation Display Rule'''.
-     '''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.
+         Name must be in lowercase and have no spaces.
-    '''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.
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
+[[file:Issues.PNG]] '''<u>Known Issues:</u>'''
-#Rolling stock installed in '''TANE''' or in the current session only (see settings above) can be searched to find a match for any selected product from any industry. In Surveyor (and Driver if that setting is enabled) click on the '''View Products''' sub menu link and click on a product name in the '''Product Window''' to display a list of all compatible rolling stock for that product.
+:The rule will '''NOT''' check to see if the named navigation set and point exists or not.
-#Alternatively, click on the '''View Industries''' sub menu link and then click on a ''Product Icon'' to open a '''Product Window''', then click     on the '''''View Rolling Stock''''' link at the top of the window.
-#Industry class names are defined in the config.txt file of industry assets and are not normally accessible by users. However, you can exclude an entire group of related "industry asset classes" such as ''station'', ''coalingtower'', ''watertank'', etc regardless of their actual names provided those assets have been given that "class name" by their creators.
-[[file:Issues.PNG]] ''''<u>Known Issues:</u>'''
-:This rule is NOT compatible with all industries.
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#DisplayIndustryStatus Rule (color modified)|DisplayIndustryStatus Rule (color modified)]]''' - displays information on industry product levels.
+*'''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
+*'''[[#Navigation Set Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.
+*'''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set has completed or is incomplete.
+*'''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
+*'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed
-==='''Multiple Resource Check Rule'''===
+[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+*'''[[How to Use Navigation Point Rules]]'''
+*'''[[How to Use Navigation Point Rules (Applications)]]'''
-Executes child rules if industries or vehicles reach set commodity levels. This rule replaces the older '''Resource Check Rule'''
+==='''Navigation Set Check Rule'''===
+Executes child rules if a navigation set created with the '''Navigation Display Rule''' is complete (or incomplete).
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:656>'''
+*'''<kuid:401543:1165>'''
-*'''Built-in Rule'''
+*'''Base Rule'''
 *'''Parent Rule'''
@@ Line 1,771: / Line 1,651: @@
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''<Product Level>''' - click to select a product test from two choices:-
+     '''Checks if navigation point set ''<name>'':''' - enter the unique name for the navigation set created using the '''Navigation Display Rule'''.
-       '''''Reach/Exceed''''' - sets an upper limit for the resources being monitored.
+         Name must be in lowercase and have no spaces.
-          For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon reaches or exceeds a specified level.
+     '''is ''<Complete/Incomplete>''''' - click to select one
-          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
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
+[[file:Issues.PNG]] '''<u>Known Issues:</u>'''
-:This rule only checks for ''changing'' commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is ''full'' or ''empty''.
+:The rule will '''NOT''' check to see if the named navigation set exists or not.
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Resource Check Rule|Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
+*'''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
-*'''[[#Resource Verify Rule (fixed)|Resource Verify Rule (fixed)]]''' - executes child rules when a set resource (commodity) level is reached
+*'''[[#Navigation Set Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.
+*'''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
+*'''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.
+*'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed
 [[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
-*'''[[How to Use Navigation Point Rules (Applications)#Application 3: Wait for Loading to be Completed|How to Use Navigation Point Rules (Applications): Wait for Loading to be Completed]]'''
+*'''[[How to Use Navigation Point Rules]]'''
+*'''[[How to Use Navigation Point Rules (Applications)]]'''
 *'''[[How to Use Parent and Child Rules]]'''
-==='''Power Station Rule'''===
+==='''Navigation Set Clear Rule'''===
-Sets up a Power Station and its electricity consumers
+Clears a navigation set removing any uncompleted navigation points
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:746>'''
+*'''<kuid:401543:1164>'''
 *'''Base Rule'''
@@ Line 1,811: / Line 1,682: @@
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''Power station ''<select>''''' - select a Power Station from the session list.
+     '''''<Click here to set>''''' - enter the unique name for the navigation set created using the '''Navigation Display Rule'''.
-    '''Consumers:'''
+        Name must be in lowercase and have no spaces.
-       '''''<add object>''''' - add power consumers from the session list
+[[file:Issues.PNG]] '''<u>Known Issues:</u>'''
+:The rule will '''NOT''' check to see if the named navigation set exists or not.
-==='''Resource Check Rule'''===
+[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+*'''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
+*'''[[#Navigation Set Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.
+*'''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set has completed or is incomplete.
+*'''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.
+*'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed
-Executes child rules if a selected industry or vehicle reaches a set commodity level. This rule has been superseded by the '''Multiple Resource Check Rule'''
+[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+*'''[[How to Use Navigation Point Rules]]'''
+*'''[[How to Use Navigation Point Rules (Applications)]]'''
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+==='''Navigation Set Hide/Show Rule'''===
-*'''<kuid:-25:1067>'''
+Shows and hides navigation sets. You can have multiple sets visible and hidden at the same time.
-*'''Legacy Rule''' (replaced by '''Multiple Resource Check Rule''')
+[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''Built-in Rule'''
+*'''<kuid:401543:1163>'''
-*'''Parent Rule'''
+*'''Base rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     Select one of two option buttons:-
+     '''''<visibility>''''' - click to select one
-       '''( ) Watch industry queue'''
+       '''Hide''' - select to make the navigation set invisible
-          '''Target Object ''<select>''''' - select an industry from the session list
+       '''Show''' - select to make the navigation set visible
-          '''Queue ''<select>''''' - select a product queue from the selected industry
+    '''''<click here to set>''''' - enter the unique name for the navigation set created using the '''Navigation Display Rule'''.
-          '''Product ''<select>''''' - select a product from the selected queue
+         Name must be in lowercase and have no spaces.
-          '''Amount ''<value>''''' - enter a quantity
-          Select one of two option buttons:-
+[[file:Issues.PNG]] '''<u>Known Issues:</u>'''
-             '''( ) Complete when designated queue equals or exceeds required amount'''
+:The rule will '''NOT''' check to see if the named navigation set exists or not.
-             '''( ) 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'''
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
-:This rule only checks for ''changing'' commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is ''full'' or ''empty''.
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Multiple Resource Check Rule|Multiple Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
+*'''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
-*'''[[#Resource Verify Rule (fixed)|Resource Verify Rule (fixed)]]''' - executes child rules when a set resource (commodity) level is reached
+*'''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set has completed or is incomplete.
+*'''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
+*'''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.
+*'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed
 [[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
-*'''[[How to Use Parent and Child Rules]]'''
+*'''[[How to Use Navigation Point Rules]]'''
-*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Resource_Check_Rule</span>'''
+*'''[[How to Use Navigation Point Rules (Applications)]]'''
-==='''Resource Verify Rule (fixed)'''===
+==='''Objective Add Rule'''===
-Executes child rules if a selected industry or vehicle reaches a set commodity level. The rule resets when all child rules have completed.
+Sets up a game Objective with ID and display Name
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:160293:10060>'''
+*'''<kuid:401543:2001>'''
-*'''DLS Rule''' by '''trev999
+*'''Base Rule'''
-*'''Parent Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     Select one of two option buttons:-
+     '''Priority ''<Select>''''' - select one of:-
-    '''( ) Watch industry queue'''
+        '''''Above Normal'''''
-        '''Target object ''<click to select>''''' - click to select an industry from the session list.
+        '''''Below Normal'''''
-        '''Product ''<click to select>''''' - click to select an industry product.
+        '''''Normal'''''
-        '''Amount ''<value>''''' - enter a quantity for the selected product.
+        '''''Optional'''''
-       Select one of two option buttons:-
+        '''''Urgent'''''
-        '''( ) Complete when designated queue equals or exceeds designated amount'''
+    '''Completion Target Number ''<value>''''' - to set Completion Target Number
-        '''( ) Complete when designated queue falls below designated amount'''
+    '''Icon ''<select>''''' - to select Icon from list
-    '''( ) Watch vehicle queue'''
+    '''Display Name ''<enter>''''' - to insert Name
-       '''Target object ''<click to select>''''' - click to select a rolling stock vehicle from the session list.
+    '''Unique Objective ID ''<enter>''''' - enter a unique objective ID
-       '''Product ''<click to select>''''' - click to select a commodity product.
+    '''Custom Message ''<Text Box>''''' - insert typed message in text area
-       '''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'''
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
-#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''.
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Multiple Resource Check Rule|Multiple Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
+*'''[[#Objective Check Rule|Objective Check Rule]]''' - executes child rules if an objective is completed
-*'''[[#Resource Check Rule|Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
+*'''[[#Objective Update Rule|Objective Update Rule]]''' - changes the progress of a game objective
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+==='''Objective Check Rule'''===
-*'''[[How to Use Parent and Child Rules]]'''
-==='''Station Visited Check Rule'''===
+Executes child rules if an objective created with the '''Objective Add Rule''' is complete.
-Executes child rules if specific trains call at set stations or industries
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid2:60850:89005:3>'''
+*'''<kuid:401543:2003>'''
-*'''Built-in Rule'''
+*'''Base Rule'''
 *'''Parent Rule'''
@@ Line 1,915: / Line 1,773: @@
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''Trigger: ''<select>''''' - click to select one of the following
+     '''Unique Objective ID ''<value>''''' - enter the unique ID created with the '''Objective Add Rule'''
-       '''''Never''''' - stopping at the selected industries will never trigger the rule.
+     '''Mode ''<select>''''' - select one of three:-
-       '''''Once only''''' - the rule is triggered on the first visit only to any one of the selected industries
+        '''''Wait for completion'''''
-       '''''Once per industry''''' - the rule is triggered on the first visit to each industry with each individual product
+       '''''Wait for failure'''''
-       '''''Once per visit''''' - the rule is triggered on the first visit to each industry regardless of the product
+       '''''Wait for progress'''''
-       '''''Once per vehicle''''' - each vehicle can only trigger the rule once.
-     '''''<select industry>''''' - select industry or industries from session list
+[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-    Select one of two option buttons:-
+*'''[[#Objective Add Rule|Objective Add Rule]]''' - sets up a game objective
-        '''( ) click to accept all trains'''
+*'''[[#Objective Update Rule|Objective Update Rule]]''' - changes the progress of a game objective
-       '''( ) 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
 [[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
 *'''[[How to Use Parent and Child Rules]]'''
-'''[[#top|Back to Top]]'''
+==='''Objective Update Rule'''===
-----
-<table width="100%" bgcolor=#ffffaa>
+Changes progress of an objective outcome created with the '''Objective Add Rule''' according to Property choices
-<tr>
-<td>
-=='''Interlocking Tower, Junction and Signal Rules'''==
-</td>
-</tr>
-</table>
-==='''Interlocking Tower Configure Path Rule'''===
+[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-Alters settings on an interlocking tower path
+*'''<kuid:401543:2002>'''
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+*'''Base Rule'''
-*'''<kuid:401543:3205>'''
-*'''Base Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-   '''Interlocking Tower ''<select>''''' - to set Name and Objects
+    '''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
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Interlocking Tower Path Selection UI Rule|Interlocking Tower Path Selection UI Rule]]''' - automatically reacts to messages from Interlocking Towers and displays a path selection dialog to the player.
+*'''[[#Objective Add Rule|Objective Add Rule]]''' - sets up a game objective
-*'''[[#Interlocking Tower Set Path Rule|Interlocking Tower Set Path Rule]]''' - sets the state of an interlocking tower path for a train
+*'''[[#Objective Check Rule|Objective Check Rule]]''' - executes child rules if an objective is completed
-*'''[[#Interlocking Tower Enhanced Manager Rule (SP2 and later)|Interlocking Tower Enhanced Manager Rule (SP2 and later)]]''' - more management and control options for interlocking towers.
-==='''Interlocking Tower Path Selection UI Rule'''===
+==='''Ordered List Rule'''===
-Will automatically react to messages from Interlocking Towers and display a path selection dialog to the player. Disable by removing rule from session
+Executes child rules in order once this rule starts
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:401543:3203>'''
+*'''<kuid:-25:171>'''
+*'''Built-in Rule'''
-*'''Base Rule'''
+*'''Parent Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-   '''[Checkbox] Show path activation message in Driver'''
+    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'''
+[[file:Issues.PNG]] '''<u>Known Issues:</u>'''
+: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.
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Interlocking Tower Configure Path Rule|Interlocking Tower Configure Path Rule]]''' - alters the settings on an interlocking tower path
+*'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child on the second run, etc
-*'''[[#Interlocking Tower Set Path Rule|Interlocking Tower Set Path Rule]]''' - sets the state of an interlocking tower path for a train
+*'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule
-*'''[[#Interlocking Tower Enhanced Manager Rule (SP2 and later)|Interlocking Tower Enhanced Manager Rule (SP2 and later)]]''' - more management and control options for interlocking towers.
+*'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously
+*'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously
+[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+*'''[[How to Use Parent and Child Rules]]'''
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Ordered_List</span>'''
+----
+<table bgcolor=#ccffff>
+<tr>
+<td>
+'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''
+</td>
+</tr>
+</table>
+<table width="100%" bgcolor=#ccffff>
+<tr>
+<td>
+=='''P, Q'''==
+</td>
+</tr>
+</table>
-==='''Interlocking Tower Set Path Rule'''===
+==='''Play Sound Rule'''===
-Will set the state of an interlocking tower path for a train
+Plays a wav sound file.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:401543:3204>'''
+*'''<kuid:-25:1045>'''
-*'''Base Rule'''
+*'''Built-in Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-   '''Interlocking Tower ''<select>''''' - to set Name and Objects
+    '''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'''
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Interlocking Tower Configure Path Rule|Interlocking Tower Configure Path Rule]]''' - alters the settings on an interlocking tower path
+*'''[[#Display Video Rule|Display Video Rule]]''' - displays a page containing a video clip from a HTML asset in a browser window
-*'''[[#Interlocking Tower Path Selection UI Rule|Interlocking Tower Path Selection UI Rule]]''' - automatically reacts to messages from Interlocking Towers and displays a path selection dialog to the player.
-*'''[[#Interlocking Tower Enhanced Manager Rule (SP2 and later)|Interlocking Tower Enhanced Manager Rule (SP2 and later)]]''' - more management and control options for interlocking towers.
-==='''Interlocking Tower Enhanced Manager Rule (SP2 and later)'''===
+==='''Power Station Rule'''===
-Provides more management and control options for interlocking towers.
+Sets up a Power Station and its electricity consumers
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid2:61392:8130:41>'''
+*'''<kuid:-25:746>'''
-*'''DLS Rule''' by '''pguy'''
+*'''Base Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''''<towers>''''' - click to select interlocking towers from the session list
+     '''Power station ''<select>''''' - select a Power Station from the session list.
-       '''''<do full check again>''''' - click to run an error check on all interlocking towers
+    '''Consumers:'''
-        '''List of all available interlocking towers''' - for each tower:-
+        '''''<add object>''''' - add power consumers from the session list
-          '''''<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
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+==='''Progressive List Rule'''===
-*'''[[#Interlocking Tower Configure Path Rule|Interlocking Tower Configure Path Rule]]''' - alters the settings on an interlocking tower path
-*'''[[#Interlocking Tower Path Selection UI Rule|Interlocking Tower Path Selection UI Rule]]''' - automatically reacts to messages from Interlocking Towers and displays a path selection dialog to the player.
-*'''[[#Interlocking Tower Set Path Rule|Interlocking Tower Set Path Rule]]''' - sets the state of an interlocking tower path for a train
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+Executes the first child rule on the first run, the second child on the second run, the third child on the third run, etc.
-*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Enhanced_Interlocking_Tower_Manager_Rule</span>'''
-==='''Junction Derailment Prevention Rule'''===
+[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-Sets opposing (trailing) junctions ahead of a train to prevent derailments.  Works with both AI and manually driven trains.
+*'''<kuid:-25:754>'''
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+*'''Built-in Rule'''
-*'''<kuid2:121843:100282:1>'''
+*'''Parent Rule'''
-*'''DLS Rule''' by '''pitkin'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-    '''None'''
+   '''After last child has been executed ...'''
+   '''''<successive runs will do nothing/the first child is chosen again>''''' - click to select one
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
-:This rule will not overrule a junction already locked by another AI train or locked against AI control using the '''Set Junctions Rule'''.
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
+*'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order
-*'''[[#Set Cleared Junctions Rule|Set Cleared Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.
+*'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule
-*'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).
+*'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously
+*'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously
+[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+*'''[[How to Use Parent and Child Rules]]'''
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Progressive_List</span>'''
-==='''Lock All Junctions Rule'''===
+==='''Quick CustomHud Manager Rule (SP2 and later)'''===
-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.
+Allows the creation of new graphical heads up displays which are assigned to the drivers in Driver Mode. Replaces the '''mc Display Custom HUD V2 Rule (SP2 and later)'''
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:400048:100971>'''
+*'''<kuid2:61392:5020:47>'''
-*'''DLS Rule''' by '''callavsg'''
+*'''DLS Rule''' by '''pguy'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''None'''
+     '''''<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
 [[file:Notes.PNG]] '''<u>Notes:</u>'''
-:Individual junctions can still be set, locked and unlocked by using the '''Set Junction Rule'''
+:HUDs are assigned to drivers in '''Driver Mode''' by either adding a '''SetCustomHud (SP2 and later)''' command to individual drivers command lists or manually by clicking a green '''RM''' tool button displayed on the top menu and selecting '''Quick CustomHUD Manager''' from the menu.
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Set Cleared Junctions Rule|Set Cleared Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.
+*'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
-*'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).
+*'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
+*'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
+*'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
+*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
+*'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked
-==='''MissionCode Manager Rule (SP2 and later)'''===
+==='''Quick Portal Manager Standard Edition Rule (SP2 and later)'''===
-Enables the addition, editing and management of Mission Codes used to auto select paths in '''Interlocking Towers'''.
+Manages portals and adds flexible timetables.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid2:61392:8200:50>'''
+*'''<kuid2:61392:5011:45>'''
 *'''DLS Rule''' by '''pguy'''
-ENTRY UNDER CONSTRUCTION
+[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+    '''Target date is ''day-of-week'' ''&<nowiki />lt;dd/mm/yyyy&<nowiki />gt;''''' - ''day-of-week'' and ''date'' shown are for today's date. Click '''''dd/mm/yyyy''''' to change date.
-*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/MissionCodes_Manager</span>'''
+    '''''<Copy rule data to Clipboard>''''' - click to copy the currently entered data to a special clipboard area used by the rules created by '''pguy'''.
+       This is NOT the standard OS clipboard.
-==='''MissionCode Stops and Timetable Manager Rule (SP2 and later)'''===
+    '''''<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.
-Enables the creation, editing and management of stop zones and timetables for trains following a path defined using mission codes.
+    '''[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.
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+    '''[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:
-*'''<kuid2:61392:8300:50>'''
+       '''''<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.
-*'''DLS Rule''' by '''pguy'''
+    '''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.
-ENTRY UNDER CONSTRUCTION
+    '''Default schedule for input trains is named: ''<schedule>''''' - click to enter a schedule name.
+    '''Today's schedule: ''<Insert new schedule>''''' - click to enter a new schedule
+    For each schedule:-
+       '''''<hh:mm>''''' - click to set the time when a train will be emitted from the portal. Times use the 24hr clock.
+       '''''<train name>''''' - click to enter the train name
+       '''''<mission code>''''' - click to enter the '''Mission Code''' created by the '''MissionCode Manager Rule (SP2 and later)'''.
+       '''''<schedule>''''' - click to enter the re-occurrence schedule in ''hh:mm'' (24hr clock) where, for example:
+          ''02:30'' means every 2 hrs 30 minutes,
+          ''00:00'' means once only,
+          ''24:00'' means once each day.
+       '''''<driver>''''' - click to select a driver name or select '''''auto-driver''''' to let the rule select a driver.
+          '''Current driver order bar is named ''<schedule>''''' - click to enter a name for the order (Driver Command) bar used in this schedule.
+       '''''<hud>''''' - click to select a HUD for this train. HUDs must be created using the '''Quick CustomHud Manager Rule (SP2 and later)'''.
+       '''Driver Command Bar''' - enter driver commands for this train.
+       Choose one of two consist sets:
+       '''''<mono consist>'' consist for every day''' - if selected the same consist will be used each day.
+          '''''<no consist selected>''''' - click to select a consist from those saved in your install.
+       '''''<multi consists>''''' - if selected a different consist will be used each day.
+          For each day of the week:
+             '''Day-of-week ''<no consist selected>''''' - click to select a consist from those saved in your install.
+[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+*'''[[#MissionCode Manager Rule (SP2 and later)|MissionCode Manager Rule (SP2 and later)]]''' - creates and manages '''Mission Codes''' for '''Interlocking Tower''' paths
+*'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - create driver HUDs
 [[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
-*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Mission_Code_Stops_and_TimeTables_Manager</span>'''
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Quick_Portal_Manager</span>'''
-==='''Multiple Junction Alignment Check Rule'''===
+==='''Quick Session Variables Rule'''===
-Executes child rules if specific junctions are set.
+Allows the editing of session variables
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:168>'''
+*'''<kuid2:61392:5003:30>'''
-*'''Built-in Rule'''
+*'''DLS Rule''' by '''pguy'''
-*'''Parent Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''Wait until ''<selection>''''' - select from:-
+     '''''<local>''''' - click to edit local variables
-       '''any one''' - any of the junctions in the rule list (below) is set correctly
+       '''''<add new session variable>''''' - click to enter the name of new local variable
-       '''all''' - ALL of the junctions in the rule list are set correctly
+          for each variable:-
-     '''''<Add junction>''''' - click to select a junction from the session list
+          '''''<variable-name>''''' - click to change variable name
-    '''''<Add all>''''' - click to select ALL junctions in the session list
+          '''''<type>''''' - click to select one of:-
-    '''''<Delete all>''''' - click to delete ALL selected junctions from the rule list
+             '''string''' - text characters
-       For each selected junction:-
+             '''int''' - integer
-       '''''<setting>''''' - click to select one switch direction from:-
+             '''float''' - real (decimal) numbers
-          '''Left'''
+             '''bool''' - boolean (true/false)
-          '''Right'''
+             '''stringset''' - ''meaning not known at this time''
-          '''Center'''
+             '''stringlist''' - ''meaning not known at this time''
-          '''Any'''
+             '''tkmlist''' - trackmark list (no longer supported in TANE SP2)
-       '''''<remove>''''' - to delete this junction from the rule list
+             '''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
+[[file:Issues.PNG]] '''<u>Known Issues:</u>'''
+:Rule creator, '''pguy''', has indicated that the future of this rule is uncertain as parts of it have been devalued in the latest release of TANE.
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
+*'''[[#Variable Check Rule|Variable Check Rule]]''' - executes child rules according to the value of a specified variable.
-*'''[[#Set Cleared Junctions Rule|Set Cleared Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.
+*'''[[#Variable Modify Rule|Variable Modify Rule]]''' - changes the value of a specified variable.
-*'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).
+*'''[[#Variable Modify Continuous Rule|Variable Modify Continuous Rule]]''' - continuously changes the value of a specified variable.
+*'''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.
+*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+==='''QuickDrive Rule'''===
-*'''[[How to Control Junctions in Sessions]]'''
-*'''[[How to Use Parent and Child Rules]]'''
-==='''Set Cleared Junctions Rule'''===
+Changes the Session settings.
-Sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied. If a junction is occupied it waits until the junction is cleared. '''''Warning:'' not compatible with Interlocking Tower Assets'''
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid2:131986:157661:1>'''
+*'''<kuid:401543:1184>'''
-*'''DLS Rule''' by '''atilabarut'''
+*'''Base Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-    '''''Add Junction''''' - click to select a junction from the session junction list
+   '''Open QuickDrive window when session is started          [x]''' - check to set
-    '''''Add All''''' - click to add ALL junctions in the session junction list
+   '''Set time to ''<hours:minutes>'' with a rate of ''<speed x>''''' - set start time and rate at which time advances
-    '''''Delete All''''' - click to remove ALL entered junctions from the rule
+   '''Enable gameplay Session Mode                            [x]''' - check to set. Gameplay mode restricts the players options
-       '''Junction Options:''' - for each selected junction:-
+   '''Enable in game help by default                          [x]''' - check to allow help options to be displayed
-          '''''<direction>''''' - click to select the junction direction
+   '''Set the default Control method to:''' - select one of two option buttons:-
-             '''Left'''
+      '''( ) Easy Mode'''
-             '''Center'''
+      '''( ) Realistic Mode'''
-             '''Right'''
+      '''[x] Prevent player from changing this setting''' - check to set
-             '''Don't change'''
+   '''Realistic mode requires achievement: ''<text>'' in asset ''<asset name>''''' - enter achievement name and select an asset from Aurans Achievements
-          '''''<user control>''''' - click to select a user control option
+   '''Set the default derailment realism to:''' - select one of three option buttons:-
-             '''Locked''' - the junction setting cannot be changed by the user
+      '''( ) None'''
-             '''Unlocked''' - the junction setting can be changed by the user
+      '''( ) Arcade'''
-          '''''<AI control>''''' - click to select AI control
+      '''( ) Realistic'''
-             '''Allows AI control''' - an AI train can switch the junction
+      '''[x] Prevent player from changing this setting''' - check to set
-             '''Blocks AI control''' - an AI train cannot switch the junction
+   '''Set the default units to:''' - select one of three option buttons:-
-          '''''Remove''''' - click to remove this junction from the rule list
+      '''( ) Imperial'''
+      '''( ) Metric'''
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+      '''( ) Default'''
-*'''[[#Junction Derailment Prevention Rule|Junction Derailment Prevention Rule]]''' - sets opposing junctions ahead of a train to prevent derailments
-*'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
-*'''[[#Multiple Junction Alignment Check Rule|Multiple Junction Alignment Check Rule]]''' - executes child rules when junctions are aligned
-*'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).
 [[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
-*'''[[How to Control Junctions in Sessions]]'''
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/QuickDrive_Rule</span>'''
+----
+<table bgcolor=#ccffff>
+<tr>
+<td>
+'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''
+</td>
+</tr>
+</table>
+<table width="100%" bgcolor=#ccffff>
+<tr>
+<td>
+=='''R'''==
+</td>
+</tr>
+</table>
-==='''Set Junctions Rule'''===
+==='''Random List Rule'''===
-Sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control). '''''Warning:'' not compatible with Interlocking Tower Assets'''
+Executes ONE randomly selected child rule once only. The rule will not repeat to randomly select another child rule
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:1065>'''
+*'''<kuid:-25:758>'''
 *'''Built-in Rule'''
+*'''Parent Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''''Add Junction''''' - click to select a junction from the session junction list
+     '''None'''
-    '''''Add All''''' - click to add ALL junctions in the session junction list
-    '''''Delete All''''' - click to remove ALL entered junctions from the rule
+[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-       '''Junction Options:''' - for each selected junction:-
+*'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order
-          '''''<direction>''''' - click to select the junction direction
+*'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child rule on the second run, etc
-             '''Left'''
+*'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously
-             '''Center'''
+*'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously
-             '''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
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Junction Derailment Prevention Rule|Junction Derailment Prevention Rule]]''' - sets opposing junctions ahead of a train to prevent derailments
-*'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
-*'''[[#Multiple Junction Alignment Check Rule|Multiple Junction Alignment Check Rule]]''' - executes child rules when junctions are aligned
-*'''[[#Set Cleared Junctions Rule|Set Cleared Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.
 [[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
-*'''[[How to Control Junctions in Sessions]]'''
+*'''[[How to Use Parent and Child Rules]]'''
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Random_List</span>'''
-==='''Set Signal Extended Rule'''===
+==='''Random Weather Rule v2'''===
-Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''
+Randomly changes the weather conditions between set values over a set duration.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid2:47662:20002:4>'''
+*'''<kuid:169301:100132>'''
-*'''Built-in Rule'''
+*'''DLS Rule''' by '''terry_wagstaff'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''''<Select signal>'' to ''<signal state>''''' - click to select a signal from the session list and click to select a state from the list -
+     '''Starting weather ''<select>'' - select one of:-
-       '''Automatic'''
+          '''''Clear weather, no clouds, rain or snow'''''
-       '''Stop'''
+          '''''Cloudy weather, no rain'''''
-       '''Stop then Continue'''
+          '''''Drizzle, light rain'''''
-       '''Caution Left'''
+          '''''Rain'''''
-       '''Caution Right'''
+          '''''Stormy weather that includes lightning and thunder'''''
-       '''Caution'''
+          '''''Snowing lightly'''''
-       '''Advance Caution Left'''
+          '''''Medium snowfall'''''
-       '''Advance Caution Right'''
+          '''''Heavy snow'''''
-       '''Advance Caution'''
+    '''Best weather ''<select>'' - select one of:-
-       '''Proceed Left'''
+          '''''Clear weather, no clouds, rain or snow'''''
-       '''Proceed Right'''
+          '''''Cloudy weather, no rain'''''
-       '''Proceed'''
+          '''''Drizzle, light rain'''''
-       '''Slow'''
+          '''''Rain'''''
-       '''Medium'''
+          '''''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
 [[file:Notes.PNG]] '''<u>Notes:</u>'''
-:The signal must support the state selected otherwise there will be no change in the signal
+: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.
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Trigger Multiple Signals Rule|Trigger Multiple Signals Rule]]''' - sets selected signals to DANGER (STOP) when selected triggers are activated
+*'''[[#EIRS Weather Rule NE USA Rule|EIRS Weather Rule NE USA Rule]]''' - customize random weather rule relative to the North East Region of the United States
+*'''[[#Startup Options Rule|Startup Options Rule]]''' - sets the weather conditions at the start of a Session
+*'''[[#Weather Rule|Weather Rule]]''' - changes the weather conditions during Session play
-==='''Trigger Multiple Signals Rule'''===
+==='''Randomize Rule'''===
-Sets selected signals to DANGER (STOP) when selected triggers are activated. Signals will be at AUTOMATIC when the triggers are not activated.
+Generates a different set of random numbers each time the session is run.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid2:116387:26:1>'''
+*'''<kuid:169301:100129>'''
-*'''DLS Rule''' by '''maggs'''
+*'''DLS Rule''' by '''Terry_Wagstaff'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''<add signal>''' - select a signal from the Session List. More than one signal can be added.
+     '''None'''
-       '''<delete>''' - remove a signal from the rule.
-    '''<add trigger>''' - select a trigger from the Session List. More than one trigger can be added.
+[[file:Notes.PNG]] '''<u>Notes:</u>'''
-       '''<delete>''' - remove a trigger from the rule.
+: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.
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Set Signal Extended Rule|Set Signal Extended Rule]]''' -  sets a selected signal to a specific signal state
+*'''[[#Variable Random|Variable Random]]''' - sets a variable to a random integer value.
-'''[[#top|Back to Top]]'''
+==='''Ranked Session Begin Rule'''===
-----
-<table width="100%" bgcolor=#ffffaa>
+Begins a ranked Session
-<tr>
-<td>
-=='''Message Rules'''==
-</td>
-</tr>
-</table>
-==='''Close Message Popup Rule'''===
-Closes open message popups
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:447264:1526>'''
+*'''<kuid:401543:2031>'''
-*'''Built-in Rule'''
+*'''Base Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-   '''None'''
+    '''Countdown Starting Value ''<value>'''''
+       '''''hrs:'''''
-[[file:Issues.PNG]] ''''<u>Known Issues:</u>'''
+       '''''min:'''''
-:This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule
+       '''''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'''
-*'''Related Rule:'''
+[[file:Notes.PNG]] '''<u>Notes:</u>'''
-*'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
+:Times are Trainz clock time, not real time
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[How to Use Message Popup Rule]]'''
+*'''[[#Ranked Session Complete Rule|Ranked Session Complete Rule]]''' - completes the active ranked Session
-*'''[[How to Use Message Popup Rule (Applications)]]'''
-==='''DestSign Table Rule'''===
+==='''Ranked Session Complete Rule'''===
-Creates a list of destination names for a destination sign
+Completes the active ranked Session
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid2:206816:99004:2>'''
+*'''<kuid:401543:2032>'''
-*'''Built-in Rule'''
+*'''Base Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-   '''''<add destination>''''' - enter a destination name to be added to the destination sign roll
+    '''Set the active ranked session as:''' - select one of two option buttons:-
-   '''''<import destinations from texture-group>''''' - select a list of destination names from session
+       '''( ) Complete'''
-   '''[x] Enable industries/stations as destination''' - check to set
+       '''( ) Failed'''
-   '''[x] Enable Track Marks as destinations''' - check to set
+    '''[x] Customize the completion message ''<text>''''' - enter a text message
-   '''[x] Enable table of destinations''' - check to set
+[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+*'''[[#Ranked Session Begin Rule|Ranked Session Begin Rule]]''' - begins a ranked Session
-==='''Display HTML Pages Rule'''===
+==='''Replace Missing Vehicles Rule'''===
-Creates a browser to display the listed HTML files in order as a navigable sequence of pages. This rule has been superseded by the '''Message Popup Rule'''
+Produces new trains to replace missing vehicles that have been removed from the session by the '''Clean Up Derailed Trains Rule'''
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:442>'''
+*'''<kuid:447264:1214>'''
-*'''Legacy Rule''' (replaced by '''Message Popup Rule''')
+*'''Built-in Rule'''
-*'''Base Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''''<Add Page>''''' - adds the HTML page ''index.html'' from the selected HTML asset
+     '''[x] Respawn trains if they are abandoned for 10 minutes'''
-        '''''<index.html>''''' - click to change the page name. The extension ''.html'' is optional
+    If checked:-
-    '''''<Add All>''''' - adds all HTML pages from the session list '''(this appears to be disabled in TANE)'''
+        Select one of two option buttons:-
-    '''''<Delete All>''''' - delete all HTML pages from this property list
+          '''( ) Respawn trains at their original locations'''
-    '''[x] Prevent user from exiting browser until all pages viewed'''
+          '''( ) Respawn trains from portals'''
-    '''[x] Disable closing of browser window by user'''
+             '''''<+ Add a new portal>''''' - click to enter the name of a portal, there can be more than one portal.
-    '''[x] Disable browser window scrolling'''
+             Entered portal names that appear in red have not been found in the session
-    '''[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
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Close Message Popup Rule|Close Message Popup Rule]]''' - closes a displayed pop-up browser window.
+*'''[[#Clean Up Derailed Trains Rule|Clean Up Derailed Trains Rule]]''' - cleans up derailed train cars after a set time delay
-*'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
+*'''[[#Wait for Derailment Rule|Wait for Derailment Rule]]''' - executes child rules when a derailment occurs
-*'''[[#Set HTML Page Rule|Set HTML Page Rule]]''' - sets parameters for the '''Display HTML Pages Rule'''
-*'''[[#Timed Limited Display HTML Rule (SP2 and later)|Timed Limited Display HTML Rule (SP2 and later)]]''' - displays a HTML page in a browser window for a set time.
-==='''Display Video Rule'''===
+==='''Reset List Rule'''===
-Displays a page containing a video clip from a HTML asset in a browser window.
+Executes ALL child rules continuously in an ongoing infinite cycle
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:138>'''
+*'''<kuid:-25:762>'''
 *'''Built-in Rule'''
+*'''Parent Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''Display page ''<index.html>'' of html asset ''<click to select>'' in a new browser window
+     '''None'''
-       '''''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.
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
+[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-:Video must be in a valid web format.
+*'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order
+*'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child rule on the second run, etc
+*'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule
+*'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
-*'''[[#Play Sound Rule|Play Sound Rule]]''' - plays a wav sound file
+*'''[[How to Use Parent and Child Rules]]'''
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Reset_List</span>'''
-==='''DisplayIndustryStatus Rule (color modified)'''===
+==='''Resource Check Rule'''===
-Displays a summary of industry product levels when the "k" key is pressed.
+Executes child rules if a selected industry or vehicle reaches a set commodity level. This rule has been superseded by the '''Multiple Resource Check Rule'''
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:622415:100001>'''
+*'''<kuid:-25:1067>'''
-*'''DLS Rule''' by '''lockheed02''' and '''marzipan'''
+*'''Legacy Rule''' (replaced by '''Multiple Resource Check Rule''')
-[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+*'''Built-in Rule'''
-    '''None'''
+*'''Parent Rule'''
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
-:Pressing the '''k''' key in Driver mode will bring up a small window with a single link '''''Display Industry Status''''' (there may also be other links). Clicking this link will show the product levels of all industries.
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#ExTrainz Manager Rule - TANE SP2|ExTrainz Manager Rule - TANE SP2]]''' - displays information on consists, industries and products in Driver and Surveyor.
-==='''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.
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:160293:10029>'''
-*'''DLS Rule''' by '''trev999'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''Diagnostic mode is ''<On/Off>''''' - click to select ''On'' or ''Off''. When set ''On'' diagnostic messages will be added to the Trainz Log file.
+     Select one of two option buttons:-
-    '''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.
+       '''( ) Watch industry queue'''
-    '''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.
+          '''Target Object ''<select>''''' - select an industry from the session list
-    '''Search only rolling stock already in session ''<Yes/No>''''' - click to select ''Yes'' or ''No''. When set to ''Yes'' only those rolling stock assets
+          '''Queue ''<select>''''' - select a product queue from the selected industry
-       installed in the session can be searched.
+          '''Product ''<select>''''' - select a product from the selected queue
-    '''Graphic colours: ''<When Red, the industry does not require service/When Green, the industry does not require service>''''' - click to switch
+          '''Amount ''<value>''''' - enter a quantity
-       between the two colour options.
+          Select one of two option buttons:-
-    '''Industry page size: ''<value>''''' - enter the number of industries to be displayed in the Industry List window (maximum 250).
+             '''( ) Complete when designated queue equals or exceeds required amount'''
-    '''The following industries are excluded: ''<Add an industry to be excluded>''''' - name can be complete (e.g. "Coal Mine 2")
+             '''( ) Complete when designated queue falls below required amount'''
-       which will exclude that specific industry from the management list, or partial (e.g. "Coal") which will exclude all
+       '''( ) Watch vehicle'''
-       industries with the word "Coal" in their names. Entries are not case sensitive.
+          '''Target Object ''<select>''''' - select a rolling stock asset from the session list
-       Once industries have been excluded, additional commands will appear for each excluded industry:-
+          '''Queue ''<select>''''' - select a product queue from the selected rolling stock
-       '''''<delete> <industry name begins with/class name begins with> <name>''''' - click ''delete'' to remove this entry.
+          '''Product ''<select>''''' - select a product from the selected queue
-          - click ''industry name begins with/class name begins with'' to select between the two (see ''notes'' below).
+          '''Amount ''<value>''''' - enter a quantity
-          - click ''name'' to edit the name.
+          Select one of two option buttons:-
+             '''( ) Complete when designated queue equals or exceeds required amount'''
+             '''( ) Complete when designated queue falls below required amount'''
 [[file:Notes.PNG]] '''<u>Notes:</u>'''
-#Rolling stock installed in '''TANE''' or in the current session only (see settings above) can be searched to find a match for any selected product from any industry. In Surveyor (and Driver if that setting is enabled) click on the '''View Products''' sub menu link and click on a product name in the '''Product Window''' to display a list of all compatible rolling stock for that product.
+: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''.
-#Alternatively, click on the '''View Industries''' sub menu link and then click on a ''Product Icon'' to open a '''Product Window''', then click     on the '''''View Rolling Stock''''' link at the top of the window.
-#Industry class names are defined in the config.txt file of industry assets and are not normally accessible by users. However, you can exclude an entire group of related "industry asset classes" such as ''station'', ''coalingtower'', ''watertank'', etc regardless of their actual names provided those assets have been given that "class name" by their creators.
-[[file:Issues.PNG]] ''''<u>Known Issues:</u>'''
-:This rule is NOT compatible with all industries.
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#DisplayIndustryStatus Rule (color modified)|DisplayIndustryStatus Rule (color modified)]]''' - displays information on industry product levels.
+*'''[[#Multiple Resource Check Rule|Multiple Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
+*'''[[#Resource Verify Rule (fixed)|Resource Verify Rule (fixed)]]''' - executes child rules when a set resource (commodity) level is reached
-==='''Fade In/Out Rule'''===
+[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+*'''[[How to Use Parent and Child Rules]]'''
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Resource_Check_Rule</span>'''
+==='''Resource Verify Rule (fixed)'''===
-Fade in or out within seconds, using specified color and opacity values.
+Executes child rules if a selected industry or vehicle reaches a set commodity level. The rule resets when all child rules have completed.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid2:190611:200000:2>'''
+*'''<kuid:160293:10060>'''
+*'''DLS Rule''' by '''trev999
-*'''Built-in Rule'''
+*'''Parent Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''Red percentage:             ''<value>''''' - enter the final % of red (0 = none, 100 = maximum)
+     Select one of two option buttons:-
-    '''Green percentage:           ''<value>''''' - enter the final % of green
+    '''( ) Watch industry queue'''
-    '''Blue percentage:            ''<value>''''' - enter the final % of blue
+       '''Target object ''<click to select>''''' - click to select an industry from the session list.
-     '''Alpha percentage (opacity): ''<value>''''' - enter the final % of opacity (0 = invisible, 100 = solid)
+       '''Product ''<click to select>''''' - click to select an industry product.
-    '''Fading duration:            ''<value>''''' - enter the number of seconds required for the fade
+       '''Amount ''<value>''''' - enter a quantity for the selected product.
-    '''''<help>''''' - click to bring up help instructions
+       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'''
 [[file:Notes.PNG]] '''<u>Notes:</u>'''
-:Seconds are Trainz clock time, not real time.
+#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''.
-==='''Hide Product Overlays Rule'''===
+[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+*'''[[#Multiple Resource Check Rule|Multiple Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
+*'''[[#Resource Check Rule|Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
-Hides the commodity or product bar graphs that appear on active industries
+[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+*'''[[How to Use Parent and Child Rules]]'''
+----
+<table bgcolor=#ccffff>
+<tr>
+<td>
+'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''
+</td>
+</tr>
+</table>
+<table width="100%" bgcolor=#ccffff>
+<tr>
+<td>
+=='''S-Se'''==
+</td>
+</tr>
+</table>
+==='''Safety System Engaged Check Rule'''===
+Executes child rules if safety systems are applied.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:400048:100970>'''
+*'''<kuid:447264:1216>'''
+*'''Built-in Rule'''
-*'''DLS Rule''' by '''callavsg'''
+*'''Parent Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-   '''None'''
+    '''[x] Trigger only once'''
+[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+*'''[[#Safety System Isolated Check Rule|Safety System Isolated Check Rule]]''' - executes child rules if safety systems have been isolated
+[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+*'''[[How to Use Parent and Child Rules]]'''
-==='''InputTable Rule'''===
+==='''Safety System Isolated Check Rule'''===
-Creates a list of message names to be used for various purposes including passing data to '''Driver Commands'''
+Executes child rules if safety systems are isolated (disengaged).
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid2:131986:1012:1>'''
+*'''<kuid:447264:1217>'''
 *'''Built-in Rule'''
+*'''Parent Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''''<add>''''' - click to add a new entry to the table
+     '''[x] Trigger only once'''
-    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
+[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-       For the '''MoveTurntable''' driver command the message must be formatted as:-
+*'''[[#Safety System Engaged Check Rule|Safety System Engaged Check Rule]]''' - executes child rules if safety systems have been engaged
-          '''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,
+[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
-             ''number_of_connecting_roads'' is the number of tracks connecting to the turntable
+*'''[[How to Use Parent and Child Rules]]'''
-       For the '''WaitUntilTime''' driver command the message must be formatted as:-
-          '''time,hour,minute''' - the first entry must be the word ''time'' in lower case,
-             ''hour'' must be from 0 to 23,
-             ''minute'' must be from 0 to 59.
-       For the '''WaitUntilSVariable''' driver command the message must be formatted as:-
-          '''svar,svar_name,svar_condition,value''' - the first entry must be the word ''svar'' in lower case,
-             ''svar_name'' is the name of the session variable,
-             ''svar_condition'' is an equality (eg eq for equal, gt for greater than, etc)
-             ''value'' is an integer value to be compared to the session variable.
-    Each entry in the table will be followed by the commands:-
-       '''''cp''''' - click to copy this entry to a new entry
-       '''''up''''' - click to move this entry up one level
-       '''''dn''''' - click to move this entry down one level
-       '''''rm''''' - click to remove this entry from the table
-==='''Message Popup Rule'''===
+==='''Schedule 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.
+Allows a schedule of timed events to be applied to a train
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:1003>'''
+*'''<kuid:-3:10185>'''
-*'''Built-in Rule'''
+*'''Base Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''[x] Pause game while message is displayed''' - stops the game until this message is closed
+     '''Insert track mark ''<select>''''' - select a track mark from the Session List
-    '''[x] Close previous popup windows''' - closes any Message Popups currently displayed before this message is shown
+     '''Arrival and Departure Time ''<Select>''''' - set time
-    '''Message location ''<Top Left/Top Right/Bottom Left/Bottom Right>''''' - select one to position the browser window on the screen
+       '''''hh:mm:ss''''' - in hours/minutes/seconds
-     '''Message Source:''' - select one of three option buttons:-
+    '''Current Train ''<select>''''' - select from session list
-       '''( ) Custom text''' - the simplest and easiest option
+    '''Insert destination ''<select>''''' - select from session list
-          '''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.
-[[file:Issues.PNG]] ''''<u>Known Issues:</u>'''
+[[file:Notes.PNG]] '''<u>Notes:</u>'''
-: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.
+:Times are Trainz clock times, not real time
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Close Message Popup Rule|Close Message Popup Rule]]''' - closes a displayed pop-up browser window.
+*'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
-*'''[[#Display HTML Pages Rule|Display HTML Pages Rule]]''' - display listed HTML files in order as a navigable sequence of pages.
+*'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
-*'''[[#Timed Limited Display HTML Rule (SP2 and later)|Timed Limited Display HTML Rule (SP2 and later)]]''' - displays a HTML page in a browser window for a set time.
+*'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
+*'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
+*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+''''<u>Other Links:</u>'''
-*'''[[How to Create a HTML Asset|How to Create a HTML Asset (Session Introduction Page and In Game Messages)]]'''
+*'''<span class="plainlinks">http://www.auran.com/games/gamefiles/trainz/tutorial1.html</span>'''
-*'''[[How to Use Message Popup Rule]]'''
-*'''[[How to Use Message Popup Rule (Applications)]]'''
-==='''Minimap Options Rule'''===
+==='''Session Complete Rule'''===
-Sets the display options for the minimap.
+Set session to a percentage of completion.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:636>'''
+*'''<kuid:447264:1011>'''
-*'''Built-in Rule'''
+*'''Base Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
- ''Default values - all checked''
-     '''[x] Map Textures'''
+     '''Set session to percent complete ''<value>''''' - enter number as a percentage
-    '''[x] Gradients'''
+     '''[x] Separate achievements for completion''' - check to set
-     '''[x] Junctions'''
-    '''[x] Signals'''
-    '''[x] Triggers'''
-    '''[x] Markers'''
-    '''[x] Trackside Labels'''
-    '''[x] Terrain Objects'''
-    '''[x] Industrial Names'''
-    '''[x] Named Objects'''
-    '''[x] Consists'''
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Show/Hide Minimap Rule|Show/Hide Minimap Rule]]''' - shows the minimap window in Driver.
+*'''[[#End Session Rule|End Session Rule]]''' - end the Session with a fade out.
-==='''Play Sound Rule'''===
+==='''Session Debug Rule'''===
-Plays a wav sound file.
+Executes the first child if ''Debug'' mode is selected. Otherwise executes the second child rule.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:1045>'''
+*'''<kuid:30501:100180>'''
 *'''Built-in Rule'''
+*'''Parent Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''Default HTML ''<Click>''''' - click to to enter Sound File Name
+     '''None'''
-    '''HTML Assets ''<Click>''''' - click to select HTML asset
-    '''Rule Completes ''<Click>''''' -  to select one of:-
+[[file:Notes.PNG]] '''<u>Notes:</u>'''
-       '''sound has just started'''
+: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.
-       '''sound has finished playing'''
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
-*'''[[#Display Video Rule|Display Video Rule]]''' - displays a page containing a video clip from a HTML asset in a browser window
+*'''[[How to Use Parent and Child Rules]]'''
 ==='''Session Metadata Rule'''===
@@ Line 2,643: / Line 2,555: @@
 :Time is Trainz clock time, not real time
-==='''Set Helper Icon Size Rule'''===
+==='''Set Camera Rule'''===
-Sets the size of helper icons such as the junction lever arrows.
+Sets the target object and properties of the camera.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:791>'''
+*'''<kuid:-25:179>'''
 *'''Built-in Rule'''
@@ Line 2,655: / Line 2,567: @@
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-   '''Junction Arrows Size ''<Click>''''' - to set scale ratio smaller than default, default is 100%
+    '''[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
-==='''Set HTML Pages Rule'''===
+[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+*'''[[#Cinematic Camera Rule|Cinematic Camera Rule]]''' - provides several different cinematic style cameras with animations
+*'''[[#Focus Camera Rule|Focus Camera Rule]]''' - sets the initial camera view and starting vehicle for a session
+*'''[[#Wait for Camera View Mode Rule|Wait for Camera View Mode Rule]]''' - executes child rules when the camera view is changed
-Instructs the Display HTML Pages rule to perform specific operations. This rule has been superseded by the '''Message Popup Rule'''
+==='''Set Coupler Masks Rule'''===
+Set the coupling/decoupling  masks on the selected vehicles
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:792>'''
+*'''<kuid:-25:980>'''
-*'''Legacy Rule''' (replaced by '''Message Popup Rule''')
 *'''Built-in Rule'''
@@ Line 2,671: / Line 2,603: @@
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''Operations to preform on the display HTML pages sequence browser'''
+     '''''<Add vehicle>''''' - click to select a vehicle from the session list
-    Select one of six option buttons:-
+    '''''<Add All>''''' - click to add all vehicles in the session list
-       '''( ) to instruct the sequence browser to ''<select>''''' - to choose page operations
+    '''''<Delete All>''''' - click to remove all added vehicles from this rule
-       '''( ) to instruct the sequence browser to open the page ''<select>''''' - enter the HTML page name
+       For each selected vehicle:-
-       '''( ) to set browser parameters ''<select>''''' - choose one of:-
+       '''Coupling Mask'''
-          '''to Enable/Disable closing of the browser window by the user'''
+           '''Front''' and '''Back''' - choose for each
-           '''to Enable/Disable scrolling on the sequence browser window'''
+             '''''Locked'''''
-          '''to Show/Hide the sequence browser window'''
+             '''''Unlocked'''''
-       '''( ) Set the following flag for the page named ''<select>''''' - enter the HTML page name
+       '''Decoupling Mask'''
-          '''[x] Hide/Close window on 'done' action'''
+           '''Front''' and '''Back''' - choose for each
-          '''[x] Window has no 'done' button'''
+             '''''Locked'''''
-          '''[x] Disable scrolling(not implemented yet)'''
+             '''''Unlocked'''''
-          '''[x] Spare setting 1'''
+        '''''<Remove>''''' - click to remove this vehicle from the rule
-           '''[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)
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Display HTML Pages Rule|Display HTML Pages Rule]]''' - displays HTML pages in a browser window.
+*'''[[#Coupler Breakage Check Rule|Coupler Breakage Check Rule]]''' - executes child rules when a coupler breaks
-*'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
+*'''[[#Coupler Breakage HUD Rule|Coupler Breakage HUD Rule]]''' - adds a coupler stress and breakage warning to the HUD
-*'''[[#Timed Limited Display HTML Rule (SP2 and later)|Timed Limited Display HTML Rule (SP2 and later)]]''' - displays a HTML page in a browser window for a set time.
-==='''Show/Hide Layer Rule'''===
+==='''Set Cleared Junctions Rule'''===
-Shows or hides a layer from Driver.
+Sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied. If a junction is occupied it waits until the junction is cleared. '''''Warning:'' not compatible with Interlocking Tower Assets'''
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid2:401543:1170:1>'''
+*'''<kuid2:131986:157661:1>'''
-*'''Built-in Rule'''
+*'''DLS Rule''' by '''atilabarut'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-   '''''<visibility>''''' - select one of two options
+    '''''Add Junction''''' - click to select a junction from the session junction list
-      '''Show''' - select to make the layer visible
+    '''''Add All''''' - click to add ALL junctions in the session junction list
-      '''Hide''' - select to make the layer invisible
+    '''''Delete All''''' - click to remove ALL entered junctions from the rule
-   '''''<click here to set>''''' - enter name of layer. Name is case sensitive.
+       '''Junction Options:''' - for each selected junction:-
+          '''''<direction>''''' - click to select the junction direction
+             '''Left'''
+             '''Center'''
+             '''Right'''
+             '''Don't change'''
+          '''''<user control>''''' - click to select a user control option
+             '''Locked''' - the junction setting cannot be changed by the user
+             '''Unlocked''' - the junction setting can be changed by the user
+          '''''<AI control>''''' - click to select AI control
+             '''Allows AI control''' - an AI train can switch the junction
+             '''Blocks AI control''' - an AI train cannot switch the junction
+          '''''Remove''''' - click to remove this junction from the rule list
-[[file:BugMini.PNG]] '''<font color="red"><u>Known Bugs:</u></font>'''
+[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-:Layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded
+*'''[[#Junction Derailment Prevention Rule|Junction Derailment Prevention Rule]]''' - sets opposing junctions ahead of a train to prevent derailments
+*'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
-[[file:Issues.PNG]] ''''<u>Known Issues:</u>'''
+*'''[[#Multiple Junction Alignment Check Rule|Multiple Junction Alignment Check Rule]]''' - executes child rules when junctions are aligned
-:Rule will NOT check to see if the named layer exists or not
+*'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).
 [[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
-*'''[[How to Use Layers#Layers in Driver Mode|How to Use Layers: Layers in Driver Mode]]
+*'''[[How to Control Junctions in Sessions]]'''
-==='''Show/Hide Minimap Rule'''===
+==='''Set Helper Icon Size Rule'''===
-Shows the minimap window in Driver.
+Sets the size of helper icons such as the junction lever arrows.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:794>'''
+*'''<kuid:-25:791>'''
 *'''Built-in Rule'''
@@ Line 2,734: / Line 2,671: @@
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-    '''''<Show/Hide>'' the driver Minimap Window''' - click to switch between '''Show''' and '''Hide'''.
+   '''Junction Arrows Size ''<Click>''''' - to set scale ratio smaller than default, default is 100%
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+==='''Set HTML Pages Rule'''===
-*'''[[#Minimap Options Rule|Minimap Options Rule]]''' - sets the display options for the minimap.
-==='''Show/Hide On-screen Help Rule'''===
+Instructs the Display HTML Pages rule to perform specific operations. This rule has been superseded by the '''Message Popup Rule'''
-Shows or hides On-screen help in Driver.
+[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+*'''<kuid:-25:792>'''
-*'''<kuid:401543:2020>'''
+*'''Legacy Rule''' (replaced by '''Message Popup Rule''')
 *'''Built-in Rule'''
@@ Line 2,751: / Line 2,687: @@
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''On screen help (junction overlays, etc)''' - select one of three option buttons:-
+     '''Operations to preform on the display HTML pages sequence browser'''
-        '''( ) Show
+    Select one of six option buttons:-
-       '''( ) Hide
+        '''( ) to instruct the sequence browser to ''<select>''''' - to choose page operations
-        '''( ) Leave Unchanged
+        '''( ) to instruct the sequence browser to open the page ''<select>''''' - enter the HTML page name
-    '''On Screen Vehicle Names:''' -  - select one of three option buttons:-
+        '''( ) to set browser parameters ''<select>''''' - choose one of:-
-        '''( ) Show
+          '''to Enable/Disable closing of the browser window by the user'''
-       '''( ) Hide
+          '''to Enable/Disable scrolling on the sequence browser window'''
-       '''( ) Leave Unchanged
+          '''to Show/Hide the sequence browser window'''
+       '''( ) Set the following flag for the page named ''<select>''''' - enter the HTML page name
-==='''Timed Limited Display HTML Rule (SP2 and later)'''===
+          '''[x] Hide/Close window on 'done' action'''
+          '''[x] Window has no 'done' button'''
-Displays an HTML browser window for a limited time.
+          '''[x] Disable scrolling(not implemented yet)'''
+          '''[x] Spare setting 1'''
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+          '''[x] Spare setting 2'''
+          '''[x] Spare setting 3'''
-*'''<kuid2:61392:2005:32>'''
+          '''[x] Spare setting 4'''
+          '''[x] Spare setting 5'''
-*'''DLS Rule''' by '''pguy'''
+       '''( ) 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)
-[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-   '''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.
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
-:Seconds are Trainz clock time, not real time.
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Close Message Popup Rule|Close Message Popup Rule]]''' - closes open message popups
 *'''[[#Display HTML Pages Rule|Display HTML Pages Rule]]''' - displays HTML pages in a browser window.
 *'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
-*'''[[#Set HTML Page Rule|Set HTML Page Rule]]''' - sets parameters for the '''Display HTML Pages Rule'''
+*'''[[#Timed Limited Display HTML Rule (SP2 and later)|Timed Limited Display HTML Rule (SP2 and later)]]''' - displays a HTML page in a browser window for a set time.
-==='''Wait on Waybill Screen/Main Screen Rule'''===
+==='''Set Junctions Rule'''===
-Executes child rules when the Waybill window is opened or closed
+Sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control). '''''Warning:'' not compatible with Interlocking Tower Assets'''
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:957>'''
+*'''<kuid:-25:1065>'''
 *'''Built-in Rule'''
-*'''Parent Rule'''
+[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+    '''''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
-    '''[x] Trigger rule once''' - check to trigger the rule once only
+[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-    '''Wait for the Waybill window to be ''<opened/closed>''''' - select either '''opened''' or '''closed'''.
+*'''[[#Junction Derailment Prevention Rule|Junction Derailment Prevention Rule]]''' - sets opposing junctions ahead of a train to prevent derailments
+*'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
+*'''[[#Multiple Junction Alignment Check Rule|Multiple Junction Alignment Check Rule]]''' - executes child rules when junctions are aligned
+*'''[[#Set Cleared Junctions Rule|Set Cleared Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied.
 [[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
-*'''[[How to Use Parent and Child Rules]]'''
+*'''[[How to Control Junctions in Sessions]]'''
-'''[[#top|Back to Top]]'''
+==='''Set Signal Extended Rule'''===
-----
-<table width="100%" bgcolor=#ffffaa>
+Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''
-<tr>
-<td>
-=='''Miscellaneous Rules'''==
-</td>
-</tr>
-</table>
-Some of these rules have no user accessible functions but may be used by other rules. Others do not fit in any other category.
+[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-==='''ConsistDataHandler Rule'''===
+*'''<kuid2:47662:20002:4>'''
-Was used by the '''QuickDrive Rule''' to place consists onto a route. Now obsolete.
+*'''Built-in Rule'''
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-*'''<kuid:401543:1180>'''
+    '''''<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'''
-*'''Obsolete Rule''' (function is now built into '''TANE''')
+[[file:Notes.PNG]] '''<u>Notes:</u>'''
+:The signal must support the state selected otherwise there will be no change in the signal
-*'''Base Rule'''
+[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+*'''[[#Trigger Multiple Signals Rule|Trigger Multiple Signals Rule]]''' - sets selected signals to DANGER (STOP) when selected triggers are activated
+----
+<table bgcolor=#ccffff>
+<tr>
+<td>
+'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''
+</td>
+</tr>
+</table>
+<table width="100%" bgcolor=#ccffff>
+<tr>
+<td>
+=='''Sh-Sz'''==
+</td>
+</tr>
+</table>
-[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+==='''Show/Hide HUD Panel Rule'''===
-    '''None'''
+Shows or hides a HUD panel.
-==='''Custom Script Rule'''===
+[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-No description
+*'''<kuid:-25:1047>'''
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:447264:1526>'''
 *'''Built-in Rule'''
@@ Line 2,851: / Line 2,811: @@
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-   '''None'''
+    '''''<Show/Hide>'' the ''<click to select>'' HUD panel''' - select '''''Show''''' or '''''Hide''''' and then select the HUD panel
+[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+*'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
+*'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
+*'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
+*'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers
+*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
+*'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked
-==='''Generic TreeNode Debug Window Rule'''===
+==='''Show/Hide Layer Rule'''===
-No description.
+Shows or hides a layer from Driver.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:30501:1042>'''
+*'''<kuid2:401543:1170:1>'''
-*'''Base Rule'''
+*'''Built-in Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-    '''None'''
+   '''''<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.
-==='''Session Debug Rule'''===
+[[file:BugMini.PNG]] '''<font color="red"><u>Known Bugs:</u></font>'''
+:Layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded
-Executes the first child if ''Debug'' mode is selected. Otherwise executes the second child rule.
+[[file:Issues.PNG]] '''<u>Known Issues:</u>'''
+:Rule will NOT check to see if the named layer exists or not
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+*'''[[How to Use Layers#Layers in Driver Mode|How to Use Layers: Layers in Driver Mode]]
-*'''<kuid:30501:100180>'''
+==='''Show/Hide Minimap Rule'''===
-*'''Built-in Rule'''
+Shows the minimap window in Driver.
-*'''Parent Rule'''
+[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+*'''<kuid:-25:794>'''
-    '''None'''
+*'''Built-in Rule'''
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
+[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-:When a session starts with this rule enabled, the player will be given the choice of running the session in '''''Debug''''' or '''''Normal''''' mode. Selecting ''Debug'' will execute the first child rule. Selecting ''Normal'' will execute the second child rule.
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+    '''''<Show/Hide>'' the driver Minimap Window''' - click to switch between '''Show''' and '''Hide'''.
-*'''[[How to Use Parent and Child Rules]]'''
-'''[[#top|Back to Top]]'''
+[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-----
+*'''[[#Minimap Options Rule|Minimap Options Rule]]''' - sets the display options for the minimap.
-<table width="100%" bgcolor=#ffffaa>
-<tr>
-<td>
-=='''Navigation Rules'''==
+==='''Show/Hide On-screen Help Rule'''===
-</td>
-</tr>
-</table>
-==='''Directional Trigger Check Rule'''===
+Shows or hides On-screen help in Driver.
-Executes child rules when a set train enters a set trigger in a set direction. Adds direction to the '''Trigger Check Rule'''.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid2:532391:100003:1>'''
+*'''<kuid:401543:2020>'''
-*'''DLS Rule''' by '''bobhahn'''
+*'''Built-in Rule'''
-*'''Parent Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''[x] Trigger only once '''
+     '''On screen help (junction overlays, etc)''' - select one of three option buttons:-
-    '''[x] Wait for child rules to complete even if no trains are present in rule trigger'''
+        '''( ) Show
-    '''[x] Only activate when the entering vehicle of the train is heading ''<select direction>'' into the trigger''' - select one of two directions:-
+       '''( ) Hide
-        '''''forward'''''
+        '''( ) Leave Unchanged
-        '''''backward'''''
+     '''On Screen Vehicle Names:''' -  - select one of three option buttons:-
-     '''Triggers List'''
+        '''( ) Show
-       '''''<add trigger>''''' - select a trigger from the session list
+        '''( ) Hide
-       '''''<delete trigger>''''' - delete a selected trigger from the rule
+       '''( ) Leave Unchanged
-    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
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
+==='''Signal Passed At Danger Check Rule'''===
-#This rule works best when used with the '''Directional Trigger''' track object available on the DLS.
-#The Directional Trigger, when installed, will appear as a ''Signal'' not as a ''Trackmark''.
-#Normal (non directional) triggers can be used with this rule but the rule will have no direction sensitivity apart from the ''forward'' and ''backward'' in the rule properties.
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+Executes child rules if a signal or stop mark is ''Passed at Danger (STOP)''.
-*'''[[#Trackside Check Rule|Trackside Check Rule]]''' - executes child rules when activated by a train. Provides different options to the '''Trigger Check Rule'''
-*'''[[#Trigger Check Rule|Trigger Check Rule]]''' - executes child rules when a set train enters a set trigger (non-directional)
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''[[How to Control Signals in Sessions#Application 2: Halt Before Clear|How to Control Signals in Sessions: Halt Before Clear]]'''
-*'''[[How to Use Message Popup Rule (Applications)]]'''
-*'''[[How to Use Parent and Child Rules]]'''
-*'''[[How to Use Track Triggers]]'''
-*'''[[How to Use Variables in Sessions (Examples)]]'''
-==='''Navigation Display Rule'''===
+*'''<kuid2:60850:89007:2>'''
-Creates a set of navigation points. Multiple sets can be created by adding additional copies of this rule. This rule creates the navigation set, it does not display it.
+*'''Built-in Rule'''
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+*'''Parent Rule'''
-*'''<kuid2:401543:1161:1>'''
+[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-*'''Base Rule'''
+    '''[x] Trigger only once'''
-[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+*'''[[How to Use Parent and Child Rules]]'''
+*'''[[How to Use Variables in Sessions (Examples)#Example 2: Event Counter and Message Selection|How to Use Variables in Sessions (Examples): Event Counter and Message Selection]]
-    '''Unique set ID: ''<click here to set>''''' - enter a unique name for the navigation set. Name must be in lowercase and have no spaces.
+==='''Simultaneous List Rule'''===
-    '''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.
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+Executes child rules simultaneously once this rule starts
-*'''[[#Navigation Set Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.
-*'''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set has completed or is incomplete.
-*'''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
-*'''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.
-*'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''[[How to Use Navigation Point Rules]]'''
-*'''[[How to Use Navigation Point Rules (Applications)]]'''
-==='''Navigation Point Complete Rule'''===
+*'''<kuid:-25:1048>'''
-Manually completes a navigation point in a set
+*'''Built-in Rule'''
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+*'''Parent Rule'''
-*'''<kuid:401543:1167>'''
-*'''Base Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''Mark navigation point ''<click here to set>''''' - enter the navigation point number to be completed
+     '''Rule completes when ...''' - click to chose one of the following:-
-    '''complete in set ''<click here to set>''''' - enter the unique name for the navigation set created using the '''Navigation Display Rule'''.
+       '''''one of the child rules has completed'''''
-         Name must be in lowercase and have no spaces.
+       '''''all child rules have reached a completed state'''''
+       '''''all child rules have reached a "was completed" state'''''
-[[file:Issues.PNG]] ''''<u>Known Issues:</u>'''
-:The rule will '''NOT''' check to see if the named navigation set and point exists or not.
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
+*'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order
-*'''[[#Navigation Set Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.
+*'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child on the second run, etc
-*'''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set has completed or is incomplete.
+*'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule
-*'''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
+*'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously
-*'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed
 [[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
-*'''[[How to Use Navigation Point Rules]]'''
+*'''[[How to Use Message Popup Rule (Applications)#Application 1: Timed Message|How to Use Message Popup Rule (Applications): Timed Message]]
-*'''[[How to Use Navigation Point Rules (Applications)]]'''
+*'''[[How to Use Parent and Child Rules]]'''
+*'''[[How to Use Variables in Sessions (Examples)#Example 2: Event Counter and Message Selection|How to Use Variables in Sessions (Examples): Event Counter and Message Selection]]
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Simultaneous_List</span>'''
-==='''Navigation Set Check Rule'''===
+==='''Speeding Check Rule'''===
-Executes child rules if a navigation set created with the '''Navigation Display Rule''' is complete (or incomplete).
+Executes child rules if player controlled trains are over the local speed limit or over a set (custom) speed
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:401543:1165>'''
+*'''<kuid2:60850:89004:3>'''
-*'''Base Rule'''
+*'''Built-in Rule'''
 *'''Parent Rule'''
@@ Line 3,041: / Line 2,950: @@
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''Checks if navigation point set ''<name>'':''' - enter the unique name for the navigation set created using the '''Navigation Display Rule'''.
+     Select one of two options to set a speed limit to be observed
-         Name must be in lowercase and have no spaces.
+       '''( ) Watch for trains travelling above the posted speed limit'''
-    '''is ''<Complete/Incomplete>''''' - click to select one
+          '''''<speed value>''''' - click to enter a new overspeed tolerance value
+          '''''<speed units>''''' - click to select one from the list:-
-[[file:Issues.PNG]] ''''<u>Known Issues:</u>'''
+             '''''Km/h''''' - Kilometres per hour
-:The rule will '''NOT''' check to see if the named navigation set exists or not.
+             '''''MPH''''' - Miles per hour
+             '''''mps''''' - metres per second
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+       '''( ) Watch for trains travelling above a custom speed'''
-*'''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
+          '''''<speed value>''''' - click to enter a new custom speed value
-*'''[[#Navigation Set Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.
+          '''''<speed units>''''' - click to select one from the list:-
-*'''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
+             '''''Km/h''''' - Kilometres per hour
-*'''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.
+             '''''MPH''''' - Miles per hour
-*'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed
+             '''''mps''''' - metres per second
+             '''Warning: This option is very performance intensive and should only be used in sessions with few trains'''
 [[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
-*'''[[How to Use Navigation Point Rules]]'''
-*'''[[How to Use Navigation Point Rules (Applications)]]'''
 *'''[[How to Use Parent and Child Rules]]'''
-==='''Navigation Set Clear Rule'''===
+==='''Startup Options Rule'''===
-Clears a navigation set removing any uncompleted navigation points
+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'''.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:401543:1164>'''
+*'''<kuid:-16:10212>'''
 *'''Base Rule'''
@@ Line 3,072: / Line 2,980: @@
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''''<Click here to set>''''' - enter the unique name for the navigation set created using the '''Navigation Display Rule'''.
+     '''Current control method is ''<select>''''' - select one from:-
-        Name must be in lowercase and have no spaces.
+       '''''Easy Mode''''' - DCC (standard keyboard and mouse) control
+       '''''Ask User''''' - let the user decide
-[[file:Issues.PNG]] ''''<u>Known Issues:</u>'''
+       '''''Realistic Mode''''' - Cab controls (on screen levers, throttles, buttons, etc)
-:The rule will '''NOT''' check to see if the named navigation set exists or not.
+    '''Set weather to ''<select mode>'' with ''<select frequency>'' changeability''' - select
+       '''Weather mode:''' - select one of:-
+          '''''Clear'''''
+          '''''Cloudy'''''
+          '''''Drizzle'''''
+          '''''Rain'''''
+          '''''Stormy'''''
+          '''''Light Snow'''''
+          '''''Medium Snow'''''
+          '''''Heavy Snow'''''
+       '''Changeability:''' - select one of:-
+          '''''Off''''' - the weather will not change from the mode selected above
+          '''''Periodic''''' - slow gradual changes to the weather
+          '''''Extreme''''' - rapid and extreme changes to the weather
+    '''Set time to ''<hours>'':''<minutes>'' with a rate of ''<select speed>''''' - set the starting time and the speed at which the Trainz clock will run
+    '''Set derailment realism to ''<select reality level>''''' - select one of:-
+       '''''None''''' - no train derailments will occur
+       '''''Arcade''''' - train derailments will be exaggerated (beyond normal)
+       '''''Realistic''''' - train derailments will occur as realistically as possible
+    '''[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
+[[file:Notes.PNG]] '''<u>Notes:</u>'''
+:Times are Trainz clock time, not real time
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
+*'''[[#Time and Rate Rule|Time and Rate Rule]]''' - sets the session start time and the rate at which time passes.
-*'''[[#Navigation Set Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.
+*'''[[#Weather Rule|Weather Rule]]''' - changes weather conditions during Session play
-*'''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set has completed or is incomplete.
-*'''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.
-*'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+==='''Station Visited Check Rule'''===
-*'''[[How to Use Navigation Point Rules]]'''
-*'''[[How to Use Navigation Point Rules (Applications)]]'''
-==='''Navigation Set Hide/Show Rule'''===
+Executes child rules if specific trains call at set stations or industries
-Shows and hides navigation sets. You can have multiple sets visible and hidden at the same time.
+[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+*'''<kuid2:60850:89005:3>'''
-*'''<kuid:401543:1163>'''
+*'''Built-in Rule'''
-*'''Base rule'''
+*'''Parent Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''''<visibility>''''' - click to select one
+     '''Trigger: ''<select>''''' - click to select one of the following
-        '''Hide''' - select to make the navigation set invisible
+       '''''Never''''' - stopping at the selected industries will never trigger the rule.
-        '''Show''' - select to make the navigation set visible
+        '''''Once only''''' - the rule is triggered on the first visit only to any one of the selected industries
-     '''''<click here to set>''''' - enter the unique name for the navigation set created using the '''Navigation Display Rule'''.
+       '''''Once per industry''''' - the rule is triggered on the first visit to each industry with each individual product
-         Name must be in lowercase and have no spaces.
+        '''''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
-[[file:Issues.PNG]] ''''<u>Known Issues:</u>'''
+[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
-:The rule will '''NOT''' check to see if the named navigation set exists or not.
+*'''[[How to Use Parent and Child Rules]]'''
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+----
-*'''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
+<table bgcolor=#ccffff>
-*'''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set has completed or is incomplete.
+<tr>
-*'''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
+<td>
-*'''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.
+'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''
-*'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed
+</td>
+</tr>
+</table>
+<table width="100%" bgcolor=#ccffff>
+<tr>
+<td>
+=='''T'''==
+</td>
+</tr>
+</table>
+==='''Time and Rate Rule'''===
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+Sets the session start time and the rate at which time passes.
-*'''[[How to Use Navigation Point Rules]]'''
-*'''[[How to Use Navigation Point Rules (Applications)]]'''
-==='''Schedule Rule'''===
-Allows a schedule of timed events to be applied to a train
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-3:10185>'''
+*'''<kuid:-25:889>'''
-*'''Base Rule'''
+*'''Built-in Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''Insert track mark ''<select>''''' - select a track mark from the Session List
+     '''Set time to ''<hours:minutes>''''' - enter the clock starting time as hours ('''0-23''') and minutes ('''0-59''')
-    '''Arrival and Departure Time ''<Select>''''' - set time
+     '''with a rate of ''<1x>''''' - select a speed at which time will pass from '''1x''' (normal) to '''1440x''' (extremely fast)
-       '''''hh:mm:ss''''' - in hours/minutes/seconds
-     '''Current Train ''<select>''''' - select from session list
-    '''Insert destination ''<select>''''' - select from session list
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
+[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-:Times are Trainz clock times, not real time
+*'''[[#Startup Options Rule|Startup Options Rule]]''' - sets the startup options for a session including time and rate
+*'''[[#Timecheck Rule|Timecheck Rule]]''' - executes child rules at a set time.
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+==='''Timecheck Rule'''===
-*'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
-*'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
-*'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
-*'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
-*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
-[[file:WWWLinks.PNG]] ''''<u>Other Links:</u>'''
+Executes child rules at a set time.
-*'''<span class="plainlinks">http://www.auran.com/games/gamefiles/trainz/tutorial1.html</span>'''
-==='''Trackside Check Rule'''===
-Executes child rules when a set train enters a set trigger. Similar to the '''Trigger Check Rule''' but provides different options.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid2:46162:100207:1>'''
+*'''<kuid2:122381:10008:3>'''
-*'''DLS Rule''' by '''Josefpav'''
+*'''Built-in Rule'''
 *'''Parent Rule'''
@@ Line 3,166: / Line 3,103: @@
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''Applies to:''' - select one of three option buttons:-
+     '''''<hh:mm:ss>''''' - enter execution time as hours (0-23), minutes (0-59) and seconds (0-59).
-       '''( ) Junction'''
+     '''[x] Execution time is on the day after the start time''' - when checked delays execution until the following day.
-       '''( ) Trigger'''
-       '''( ) Trackmark'''
+[[file:Issues.PNG]] '''<u>Known Issues:</u>'''
-    '''Trackside object name: ''<specify>''''' - select object name from session list
+:Do not use this rule as a child of a repeating rule such as the '''Simultaneous List Rule''' or the '''Ordered List Rule'''.
-    '''Wait for train to:''' - select one of three option buttons:-
-       '''( ) Enter'''
+[[file:Notes.PNG]] '''<u>Notes:</u>'''
-       '''( ) Stop at'''
+:Times and days are Trainz clock times not real time.
-       '''( ) 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
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Directional Trigger Check Rule|Directional Trigger Check Rule]]''' -  executes child rules when activated by a train moving in a set direction.
+*'''[[#Time and Rate Rule|Time and Rate Rule]]''' - sets the session start time and the rate at which time passes.
-*'''[[#Trigger Check Rule|Trigger Check Rule]]''' - executes child rules when activated by a train
+*'''[[#Wait Rule|Wait Rule]]''' - executes child rules after waiting for a set number of seconds.
 [[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
 *'''[[How to Use Parent and Child Rules]]'''
-==='''Trigger Check Rule'''===
+==='''Timed Limited Display HTML Rule (SP2 and later)'''===
-Executes child rules when a set train enters a set trigger. This rule replaces the older and less versatile '''Trigger Rule'''.
+Displays an HTML browser window for a limited time.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:1071>'''
+*'''<kuid2:61392:2005:32>'''
-*'''Built-in Rule'''
+*'''DLS Rule''' by '''pguy'''
-*'''Parent Rule'''
+[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+   '''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.
-    '''[x] Trigger only once '''
+[[file:Notes.PNG]] '''<u>Notes:</u>'''
-    '''[x] Wait for child rules to complete even if no trains are present in rule trigger'''
+:Seconds are Trainz clock time, not real time.
-    '''[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
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Directional Trigger Check Rule|Directional Trigger Check Rule]]''' -  executes child rules when activated by a train moving in a set direction.
+*'''[[#Close Message Popup Rule|Close Message Popup Rule]]''' - closes open message popups
-*'''[[#Trackside Check Rule|Trackside Check Rule]]''' - executes child rules when activated by a train. Provides different options to the '''Trigger Check Rule'''
+*'''[[#Display HTML Pages Rule|Display HTML Pages Rule]]''' - displays HTML pages in a browser window.
+*'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
+*'''[[#Set HTML Page Rule|Set HTML Page Rule]]''' - sets parameters for the '''[[#Display HTML Pages Rule|Display HTML Pages Rule]]'''
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+==='''Trackside Check Rule'''===
-*'''[[How to Use Message Popup Rule (Applications)]]'''
-*'''[[How to Use Navigation Point Rules (Applications)#Application 3: Wait for Loading to be Completed|How to Use Navigation Point Rules (Applications): Wait for Loading to be Completed]]
-*'''[[How to Use Parent and Child Rules]]'''
-*'''[[How to Use Track Triggers]]'''
-*'''[[How to Use Variables in Sessions (Examples)]]
-==='''Wait on Navigation Point Rule'''===
+Executes child rules when a set train enters a set trigger. Similar to the '''Trigger Check Rule''' but provides different options.
-Executes child rules when a specific navigation point is completed
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:401543:1168>'''
+*'''<kuid2:46162:100207:1>'''
-*'''Base Rule'''
+*'''DLS Rule''' by '''Josefpav'''
 *'''Parent Rule'''
@@ Line 3,248: / Line 3,163: @@
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''navigation point ''<click here to set>''''' - enter the number of the navigation point to be completed
+     '''Applies to:''' - select one of three option buttons:-
-     '''in set ''<click here to set>''''' - enter the unique name for the navigation set created using the '''Navigation Display Rule'''.
+       '''( ) Junction'''
-        Name must be in lowercase and have no spaces.
+       '''( ) Trigger'''
+       '''( ) Trackmark'''
-[[file:Issues.PNG]] ''''<u>Known Issues:</u>'''
+     '''Trackside object name: ''<specify>''''' - select object name from session list
-:The rule will '''NOT''' check to see if the named navigation set and point exists or not.
+    '''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
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
+*'''[[#Directional Trigger Check Rule|Directional Trigger Check Rule]]''' - executes child rules when activated by a train moving in a set direction.
-*'''[[#Navigation Set Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.
+*'''[[#Trigger Check Rule|Trigger Check Rule]]''' - executes child rules when activated by a train
-*'''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set is complete or incomplete.
-*'''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
-*'''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.
 [[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
-*'''[[How to Use Message Popup Rule (Applications)#Application 2: Navigation Point and Train Stopped Event Message|How to Use Message Popup Rule (Applications): Navigation Point and Train Stopped Event Message]]
+*'''[[How to Use Parent and Child Rules]]'''
-*'''[[How to Use Navigation Point Rules]]'''
-*'''[[How to Use Navigation Point Rules (Applications)]]'''
-*'''[[How to Use Parent and Child Rules]]'''
-==='''Wait on Train Stop/Start Rule'''===
+==='''Trigger Check Rule'''===
-Executes child rules when a train stops or starts moving
+Executes child rules when a set train enters a set trigger. This rule replaces the older and less versatile '''Trigger Rule'''.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:1069>'''
+*'''<kuid:-25:1071>'''
 *'''Built-in Rule'''
@@ Line 3,282: / Line 3,198: @@
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''[x] Trigger rule once'''
+     '''[x] Trigger only once '''
-     '''Wait for a train that matches the following criteria to ''<select>''''' - select one of:-
+     '''[x] Wait for child rules to complete even if no trains are present in rule trigger'''
-        '''''start moving'''''
+    '''[x] Only activate when the entering vehicle of the train is heading ''<select direction>'' into the trigger''' - select one of two directions:-
-        '''''stop moving'''''
+        '''''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 or set of specific vehicles that will trigger the rule
+           '''Specific vehicle''' - identify the specific vehicle(s) that will trigger the rule
               '''''+''''' - click to add a ''specific'' vehicle from the session list
               '''''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
+           '''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 ''drivers'' that will trigger 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
+[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+*'''[[#Directional Trigger Check Rule|Directional Trigger Check Rule]]''' - executes child rules when activated by a train moving in a set direction.
+*'''[[#Trackside Check Rule|Trackside Check Rule]]''' - executes child rules when activated by a train. Provides different options to the '''Trigger Check Rule'''
 [[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
-*'''[[How to Use Message Popup Rule (Applications)#Application 2: Navigation Point and Train Stopped Event Message|How to Use Message Popup Rule (Applications): Navigation Point and Train Stopped Event Message]]'''
+*'''[[How to Use Message Popup Rule (Applications)]]
+*'''[[How to Use Navigation Point Rules (Applications)#Application 3: Wait for Loading to be Completed|How to Use Navigation Point Rules (Applications): Wait for Loading to be Completed]]
 *'''[[How to Use Parent and Child Rules]]'''
+*'''[[How to Use Track Triggers]]'''
+*'''[[How to Use Variables in Sessions (Examples)]]
+==='''Trigger Multiple Signals Rule'''===
-'''[[#top|Back to Top]]'''
+Sets selected signals to DANGER (STOP) when selected triggers are activated. Signals will be at AUTOMATIC when the triggers are not activated.
-----
-<table width="100%" bgcolor=#ffffaa>
+[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-<tr>
-<td>
-=='''Resources Rules'''==
-</td>
-</tr>
-</table>
-==='''DisplayIndustryStatus Rule (color modified)'''===
+*'''<kuid2:116387:26:1>'''
-Displays a summary of industry product levels when the "k" key is pressed.
+*'''DLS Rule''' by '''maggs'''
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:622415:100001>'''
-*'''DLS Rule''' by '''lockheed02''' and '''marzipan'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''None'''
+     '''<add signal>''' - select a signal from the Session List. More than one signal can be added.
+       '''<delete>''' - remove a signal from the rule.
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
+    '''<add trigger>''' - select a trigger from the Session List. More than one trigger can be added.
-:Pressing the '''k''' key in Driver mode will bring up a small window with a single link '''''Display Industry Status''''' (there may also be other links). Clicking this link will show the product levels of all industries.
+       '''<delete>''' - remove a trigger from the rule.
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#ExTrainz Manager Rule - TANE SP2|ExTrainz Manager Rule - TANE SP2]]''' - displays information on consists, industries and products in Driver and Surveyor.
+*'''[[#Set Signal Extended Rule|Set Signal Extended Rule]]''' - sets a selected signal to a specific signal state
+----
+<table bgcolor=#ccffff>
+<tr>
+<td>
+'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''
+</td>
+</tr>
+</table>
+<table width="100%" bgcolor=#ccffff>
+<tr>
+<td>
+=='''U, V'''==
+</td>
+</tr>
+</table>
+==='''Variable Check Rule'''===
-==='''ExTrainz Manager Rule - TANE SP2'''===
+Executes child rules when a specific variable matches set conditions
-Provides information on consists, industries and products in both Surveyor and Driver modes. Once activated, the rule creates an additional short menu bar below the main menu bar.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:160293:10029>'''
+*'''<kuid:-25:1049>'''
-*'''DLS Rule''' by '''trev999'''
+*'''Built-in Rule'''
+*'''Parent Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''Diagnostic mode is ''<On/Off>''''' - click to select ''On'' or ''Off''. When set ''On'' diagnostic messages will be added to the Trainz Log file.
+     '''''<variable-name>''''' - enter a variable-name. Variable name is case sensitive.
-    '''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.
+    Mathematical relationship, select one of:-
-    '''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.
+       '''''is less than''''' - enter a '''''<value>''''' to test against
-    '''Search only rolling stock already in session ''<Yes/No>''''' - click to select ''Yes'' or ''No''. When set to ''Yes'' only those rolling stock assets
+       '''''is less than or equal to''''' - enter a '''''<value>''''' to test against
-       installed in the session can be searched.
+       '''''is equal to''''' - enter a '''''<value>''''' to test against
-    '''Graphic colours: ''<When Red, the industry does not require service/When Green, the industry does not require service>''''' - click to switch
+       '''''is greater than or equal to''''' - enter a '''''<value>''''' to test against
-        between the two colour options.
+        '''''is greater than''''' - enter a '''''<value>''''' to test against
-    '''Industry page size: ''<value>''''' - enter the number of industries to be displayed in the Industry List window (maximum 250).
+        '''''is not equal to''''' - enter a '''''<value>''''' to test against
-    '''The following industries are excluded: ''<Add an industry to be excluded>''''' - name can be complete (e.g. "Coal Mine 2")
+       '''''is between x and y''''' - enter a minimum '''''<x-value>''''' and a maximum '''''<y-value>'''''
-       which will exclude that specific industry from the management list, or partial (e.g. "Coal") which will exclude all
+     Evaluation type. Select one from:-
-       industries with the word "Coal" in their names. Entries are not case sensitive.
+       '''''<This condition will be evaluated only once ...>''''' - any changes to the variable that occur after
-       Once industries have been excluded, additional commands will appear for each excluded industry:-
+               it has been checked will not change the result of this rule
-        '''''<delete> <industry name begins with/class name begins with> <name>''''' - click ''delete'' to remove this entry.
+       '''''<This condition will be evaluated once every second>''''' - the rule will be rerun and the variable
-          - click ''industry name begins with/class name begins with'' to select between the two (see ''notes'' below).
+               rechecked every second
-          - click ''name'' to edit the name.
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
-#Rolling stock installed in '''TANE''' or in the current session only (see settings above) can be searched to find a match for any selected product from any industry. In Surveyor (and Driver if that setting is enabled) click on the '''View Products''' sub menu link and click on a product name in the '''Product Window''' to display a list of all compatible rolling stock for that product.
-#Alternatively, click on the '''View Industries''' sub menu link and then click on a ''Product Icon'' to open a '''Product Window''', then click     on the '''''View Rolling Stock''''' link at the top of the window.
-#Industry class names are defined in the config.txt file of industry assets and are not normally accessible by users. However, you can exclude an entire group of related "industry asset classes" such as ''station'', ''coalingtower'', ''watertank'', etc regardless of their actual names provided those assets have been given that "class name" by their creators.
-[[file:Issues.PNG]] ''''<u>Known Issues:</u>'''
-:This rule is NOT compatible with all industries.
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#DisplayIndustryStatus Rule (color modified)|DisplayIndustryStatus Rule (color modified)]]''' - displays information on industry product levels.
+*'''[[#Quick Session Variables Rule|Quick Session Variables Rule]]''' - allows the editing of session variables.
+*'''[[#Variable Modify Rule|Variable Modify Rule]]''' - changes the value of a specified variable.
+*'''[[#Variable Modify Continuous Rule|Variable Modify Continuous Rule]]''' - continuously changes the value of a specified variable.
+*'''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.
+*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
-==='''Hide Product Overlays Rule'''===
+[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+*'''[[How to Use Parent and Child Rules]]'''
+*'''[[How to Use Variables in Sessions (Examples)]]
+==='''Variable Modify Continuous Rule'''===
-Hides the commodity or product bar graphs that appear on active industries
+Adds, subtracts or sets a value to a specified variable every second.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:400048:100970>'''
+*'''<kuid:-25:1051>'''
-*'''DLS Rule''' by '''callavsg'''
+*'''Built-in Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-    '''None'''
+    '''''<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.
+[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+*'''[[#Quick Session Variables Rule|Quick Session Variables Rule]]''' - allows the editing of session variables.
+*'''[[#Variable Check Rule|Variable Check Rule]]''' - executes child rules according to the value of a specified variable.
+*'''[[#Variable Modify Rule|Variable Modify Rule]]''' - changes the value of a specified variable.
+*'''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.
+*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
-==='''Multiple Resource Check Rule'''===
+==='''Variable Modify Rule'''===
-Executes child rules if industries or vehicles reach set commodity levels. This rule replaces the older '''Resource Check 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.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:656>'''
+*'''<kuid:-25:1050>'''
 *'''Built-in Rule'''
-*'''Parent Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''<Product Level>''' - click to select a product test from two choices:-
+     '''Change ''<Add to variable/Subtract from variable/Change variable>''''' - click to select one from:-
-        '''''Reach/Exceed''''' - sets an upper limit for the resources being monitored.
+        '''Add to variable'''
-          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.
+          '''Add ''<value>''''' to '''variable ''<variable-name>''''' - enter value to add to variable, enter variable-name. Variable-name is case sensitive.
-          The initial level in the object must be below the set upper limit.
+           '''''<Do not undo the alteration if the rule is stopped/Undo the alteration if the rule is stopped>''''' - click to select one.
-       '''''Fall below''''' - sets a lower limit for the resources being monitored.
+       '''Subtract from variable'''
-           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.
+          '''Subtract ''<value>''''' from '''variable ''<variable-name>''''' - enter value to subtract from variable, enter variable-name.
-          The initial level in the object must be above the set lower limit.
+             Variable-name is case sensitive.
-          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.
+          '''''<Do not undo the alteration if the rule is stopped/Undo the alteration if the rule is stopped>''''' - click to select one.
-    '''''<value>''''' - enter required quantity value
+        '''Change variable'''
-    '''''<select>''''' - select a product from session list of products
+           '''Change variable ''<variable-name>'' to ''<value>''''' - enter variable-name, enter new value.
-    '''''<Add object>''''' - click to select a source or target object. Multiple objects and their queues can be added to the rule.
+             Variable-name is case sensitive. This change cannot be undone if the rule is stopped.
-        ALL the entered products must reach/exceed or fall below the specified value for the rule to be triggered.
+    '''[x] (optional) Set the minimum value''' of '''''<variable-name>''''' to '''''<value>''''' - enter variable-name
-       For each object:-
+       (this will already be set by the change option) and a value. Variable-name is case sensitive.
-           '''''<Object>''''' - click to select session active industry or product enabled rail vehicle
+    '''[x] (optional) Set the maximum value''' of '''''<variable-name>''''' to '''''<value>''''' - enter variable-name
-          '''''<Queue>''''' - select product queue (there may be only one available)
+       (this will already be set by the change option) and a value. Variable-name is case sensitive.
-          '''''<Remove>''''' - removes the object and its product queue from the rule
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
-:This rule only checks for ''changing'' commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is ''full'' or ''empty''.
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Resource Check Rule|Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
+*'''[[#Quick Session Variables Rule|Quick Session Variables Rule]]''' - allows the editing of session variables.
-*'''[[#Resource Verify Rule (fixed)|Resource Verify Rule (fixed)]]''' - executes child rules when a set resource (commodity) level is reached
+*'''[[#Variable Check Rule|Variable Check Rule]]''' - executes child rules according to the value of a specified variable.
+*'''[[#Variable Modify Continuous Rule|Variable Modify Continuous Rule]]''' - continuously changes the value of a specified variable.
+*'''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.
+*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
 [[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
-*'''[[How to Use Navigation Point Rules (Applications)#Application 3: Wait for Loading to be Completed|How to Use Navigation Point Rules (Applications): Wait for Loading to be Completed]]'''
+*'''[[How to Use Variables in Sessions (Examples)]]
-*'''[[How to Use Parent and Child Rules]]'''
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Variable_Modify_Rule</span>'''
-==='''Resource Check Rule'''===
+==='''Variable Random 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'''
+Assigns a random integer value to a variable.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:1067>'''
+*'''<kuid:400260:100606>'''
-*'''Legacy Rule''' (replaced by '''Multiple Resource Check Rule''')
+*'''DLS Rule''' by '''tram_'''
-*'''Built-in Rule'''
-*'''Parent Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     Select one of two option buttons:-
+     '''Random variable ''<name>'' in ''minimum'' to ''maximum'' interval''' - enter name of variable. Variable-name is case sensitive.
-       '''( ) Watch industry queue'''
+    '''The minimum possible value of ''variable_name'' is ''<value>''''' - enter the minimum value
-          '''Target Object ''<select>''''' - select an industry from the session list
+    '''The maximum possible value of ''variable_name'' is ''<value>''''' - enter the maximum value
-          '''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'''
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
-:This rule only checks for ''changing'' commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is ''full'' or ''empty''.
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Multiple Resource Check Rule|Multiple Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
+*'''[[#Quick Session Variables Rule|Quick Session Variables Rule]]''' - allows the editing of session variables.
-*'''[[#Resource Verify Rule (fixed)|Resource Verify Rule (fixed)]]''' - executes child rules when a set resource (commodity) level is reached
+*'''[[#Randomize|Randomize]]''' - creates a different set of random numbers for each session run.
+*'''[[#Variable Check Rule|Variable Check Rule]]''' - executes child rules according to the value of a specified variable.
+*'''[[#Variable Modify Rule|Variable Modify Rule]]''' - changes the value of a specified variable.
+*'''[[#Variable Modify Continuous Rule|Variable Modify Continuous Rule]]''' - continuously changes the value of a specified variable.
+*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
 [[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
-*'''[[How to Use Parent and Child Rules]]'''
+*'''[[How to Use Variables in Sessions (Examples)]]
-*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Resource_Check_Rule</span>'''
-==='''Resource Verify Rule (fixed)'''===
+==='''Variable Show Rule'''===
-Executes child rules if a selected industry or vehicle reaches a set commodity level. The rule resets when all child rules have completed.
+Adds or removes a specified variable and a descriptive label to the custom HUD. This rule does not make the custom HUD appear on the screen.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:160293:10060>'''
+*'''<kuid:-25:971>'''
-*'''DLS Rule''' by '''trev999
+*'''Built-in Rule'''
-*'''Parent Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-    Select one of two option buttons:-
+   '''[x] Add'''
-    '''( ) Watch industry queue'''
+      '''''<variable-name>''''' - enter variable-name to add to HUD. Variable-name is case sensitive.
-       '''Target object ''<click to select>''''' - click to select an industry from the session list.
+      '''''<label>''''' - (optional) enter a short label to be displayed on the HUD in front of the variable value.
-       '''Product ''<click to select>''''' - click to select an industry product.
+   '''[x] Remove'''
-       '''Amount ''<value>''''' - enter a quantity for the selected product.
+      '''''<variable-name>''''' - enter variable-name to remove from HUD. Variable-name is case sensitive.
-       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'''
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
-#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''.
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Multiple Resource Check Rule|Multiple Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
+*'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
-*'''[[#Resource Check Rule|Resource Check Rule]]''' - executes child rules when set resource (commodity) levels are reached
+*'''[[#Quick Session Variables Rule|Quick Session Variables Rule]]''' - allows the editing of session variables.
+*'''[[#Variable Check Rule|Variable Check Rule]]''' - executes child rules according to the value of a specified variable.
+*'''[[#Variable Modify Rule|Variable Modify Rule]]''' - changes the value of a specified variable.
+*'''[[#Variable Modify Continuous Rule|Variable Modify Continuous Rule]]''' - continuously changes the value of a specified variable.
+*'''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.
 [[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
-*'''[[How to Use Parent and Child Rules]]'''
+*'''[[How to Use Variables in Sessions (Examples)]]
-'''[[#top|Back to Top]]'''
+==='''Vehicle Physics Rule'''===
-----
-<table width="100%" bgcolor=#ffffaa>
+Overrides the default vehicle physics properties for all vehicles or for those matching set criteria
-<tr>
-<td>
-=='''Session Sequence Rules'''==
-</td>
-</tr>
-</table>
-==='''Ordered List Rule'''===
-Executes child rules in order once this rule starts
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:171>'''
+*'''<kuid:-25:1052>'''
 *'''Built-in Rule'''
-*'''Parent Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
      Select one of two option buttons:-
-      '''( ) This process will repeat ''<value>'' time(s)''' - enter the number of times this rule is to be repeated
+       '''( ) click to accept all trains'''
-      '''( ) This process will repeat forever'''
+       '''( ) click to accept trains matching specific criteria'''
+          Selecting the second option will produce the following selection controls:-
-[[file:Issues.PNG]] ''''<u>Known Issues:</u>'''
+          '''Specific vehicle''' - identify the specific vehicle or set of specific vehicles that will trigger the rule
-:Some child rules will force a "wait" until certain conditions have been met (e.g. a mouse click or a set time has passed). These rules will delay the completion of any following child rules in the '''Ordered List Rule'''. If possible, place these rules last in the Ordered List.
+             '''''+''''' - click to add a ''specific'' vehicle from the session list
-::For example: The '''Message Popup Rule''' will wait until it is closed before allowing the next child rule to be executed.
+             '''''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
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+             '''''+''''' - click to add a ''type'' of vehicle from the session list
-*'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child on the second run, etc
+             '''''x''''' - click to remove the ''type'' of vehicle from the rule
-*'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule
+          '''Drivers''''' - identify the ''drivers'' that will trigger the rule
-*'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously
+             '''''+''''' - click to add a ''driver'' from the session list
-*'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously
+             '''''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 %
+----
+<table bgcolor=#ccffff>
+<tr>
+<td>
+'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''
+</td>
+</tr>
+</table>
+<table width="100%" bgcolor=#ccffff>
+<tr>
+<td>
+=='''W, X, Y, Z'''==
+</td>
+</tr>
+</table>
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+==='''Wait for Camera View Mode Rule'''===
-*'''[[How to Use Parent and Child Rules]]'''
-*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Ordered_List</span>'''
-==='''Progressive List Rule'''===
+Executes child rules when the camera view is changed to a selected view
-Executes the first child rule on the first run, the second child on the second run, the third child on the third run, etc.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:754>'''
+*'''<kuid:-25:192>'''
 *'''Built-in Rule'''
@@ Line 3,573: / Line 3,489: @@
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-   '''After last child has been executed ...'''
+    '''[x] Trigger rule once''' - check to set
-   '''''<successive runs will do nothing/the first child is chosen again>''''' - click to select one
+    '''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
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order
+*'''[[#Cinematic Camera Rule|Cinematic Camera Rule]]''' - provides several different cinematic style cameras with animations
-*'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule
+*'''[[#Focus Camera Rule|Focus Camera Rule]]''' - sets the initial camera view and starting vehicle for a session
-*'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously
+*'''[[#Set Camera Rule|Set Camera Rule]]''' - sets the target object and properties of the camera
-*'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously
 [[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
 *'''[[How to Use Parent and Child Rules]]'''
-*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Progressive_List</span>'''
-==='''Random List Rule'''===
+==='''Wait for Click on HUD Icon Rule'''===
-Executes ONE randomly selected child rule once only. The rule will not repeat to randomly select another child rule
+Executes child rules when the user clicks on a selected HUD icon
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:758>'''
+*'''<kuid:-25:951> <kuid:-25:970>''' - two versions built-in with different kuids, both have the same properties
 *'''Built-in Rule'''
@@ Line 3,600: / Line 3,519: @@
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''None'''
+     '''[x] Trigger Once'''
+    '''HUD Panel ''<Click>''''' - click choose from list:-
+       '''Bottom Right Menu'''
+       '''Camera Controls'''
+       '''DCC Controls'''
+    '''Icon ''<Click>''''' - click to choose from list. Selections depends on HUD Panel chosen
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order
+*'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
-*'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child rule on the second run, etc
+*'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
-*'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously
+*'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
-*'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously
+*'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers
+*'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
+*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
 [[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
 *'''[[How to Use Parent and Child Rules]]'''
-*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Random_List</span>'''
-==='''Reset List Rule'''===
+==='''Wait for Derailment Rule'''===
-Executes ALL child rules continuously in an ongoing infinite cycle
+Executes child rules when a derailment occurs
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:762>'''
+*'''<kuid:-25:1053>'''
 *'''Built-in Rule'''
@@ Line 3,626: / Line 3,551: @@
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''None'''
+     '''[x] Trigger derailment watch once''' - check to execute the rule once only
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order
+*'''[[#Clean Up Derailed Trains Rule|Clean Up Derailed Trains Rule]]''' - cleans up derailed train cars after a set time delay
-*'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child rule on the second run, etc
+*'''[[#Replace Missing Vehicles Rule|Replace Missing Vehicles Rule]]''' - creates a replacement train after a derailment
-*'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule
-*'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously
 [[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
 *'''[[How to Use Parent and Child Rules]]'''
-*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Reset_List</span>'''
-==='''Simultaneous List Rule'''===
+==='''Wait for Driver On/Off Train Rule'''===
-Executes child rules simultaneously once this rule starts
+Executes child rules when a driver gets on or off a train
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:1048>'''
+*'''<kuid:-25:953>'''
 *'''Built-in Rule'''
@@ Line 3,652: / Line 3,574: @@
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-    '''Rule completes when ...''' - click to chose one of the following:-
+  '''[x] Trigger Rule Once''' - click to set''
-       '''''one of the child rules has completed'''''
+  '''Wait for a driver character to get ''<On/Off>''''' a train that matches the following criteria''' - select '''On''' or '''Off'''
-       '''''all child rules have reached a completed state'''''
+  Select one of two option buttons:-
-       '''''all child rules have reached a "was completed" state'''''
+     '''( ) 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
 [[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order
+*'''[[#Wait for Driver/Train to be Locally Owned Rule|Wait for Driver/Train to be Locally Owned Rule]]''' - executes child rules when a vehicle or driver changes ownership
-*'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child on the second run, etc
-*'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule
-*'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously
 [[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
-*'''[[How to Use Message Popup Rule (Applications)#Application 1: Timed Message|How to Use Message Popup Rule (Applications): Timed Message]]
 *'''[[How to Use Parent and Child Rules]]'''
-*'''[[How to Use Variables in Sessions (Examples)#Example 2: Event Counter and Message Selection|How to Use Variables in Sessions (Examples): Event Counter and Message Selection]]
-*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Simultaneous_List</span>'''
-'''[[#top|Back to Top]]'''
+==='''Wait for Driver/Train to be Locally Owned Rule'''===
-----
-<table width="100%" bgcolor=#ffffaa>
+Executes child rules when a specific driver or vehicle is locally owned. If the driver/vehicle becomes unowned again the child rules are paused
-<tr>
-<td>
-=='''Speed Rules'''==
-</td>
-</tr>
-</table>
-==='''ATP Speed Limiter Rule'''===
-Limits allowable speed over set limit
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid2:321959:1000:1>'''
+*'''<kuid2:401543:1173:1>'''
 *'''Built-in Rule'''
+*'''Parent Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-    '''Limits the speed to ''<value>'' mph over the set limit''' - enter speed value in mph
+  '''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
+[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+*'''[[#Wait for Driver On/Off Train Rule|Wait for Driver On/Off Train Rule]]''' - executes child rules when a driver gets on or off a train
+[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+*'''[[How to Use Parent and Child Rules]]'''
-==='''Speeding Check Rule'''===
+==='''Wait on Navigation Point Rule'''===
-Executes child rules if player controlled trains are over the local speed limit or over a set (custom) speed
+Executes child rules when a specific navigation point is completed
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid2:60850:89004:3>'''
+*'''<kuid:401543:1168>'''
-*'''Built-in Rule'''
+*'''Base Rule'''
 *'''Parent Rule'''
@@ Line 3,708: / Line 3,635: @@
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     Select one of two options to set a speed limit to be observed
+     '''navigation point ''<click here to set>''''' - enter the number of the navigation point to be completed
-       '''( ) Watch for trains travelling above the posted speed limit'''
+    '''in set ''<click here to set>''''' - enter the unique name for the navigation set created using the '''Navigation Display Rule'''.
-          '''''<speed value>''''' - click to enter a new overspeed tolerance value
+       Name must be in lowercase and have no spaces.
-          '''''<speed units>''''' - click to select one from the list:-
-             '''''Km/h''''' - Kilometres per hour
+[[file:Issues.PNG]] '''<u>Known Issues:</u>'''
-             '''''MPH''''' - Miles per hour
+:The rule will '''NOT''' check to see if the named navigation set and point exists or not.
-             '''''mps''''' - metres per second
-       '''( ) Watch for trains travelling above a custom speed'''
+[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-          '''''<speed value>''''' - click to enter a new custom speed value
+*'''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
-          '''''<speed units>''''' - click to select one from the list:-
+*'''[[#Navigation Set Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.
-             '''''Km/h''''' - Kilometres per hour
+*'''[[#Navigation Set Check Rule|Navigation Set Check Rule]]''' - executes child rules if a navigation set is complete or incomplete.
-             '''''MPH''''' - Miles per hour
+*'''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
-             '''''mps''''' - metres per second
+*'''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.
-             '''Warning: This option is very performance intensive and should only be used in sessions with few trains'''
 [[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+*'''[[How to Use Message Popup Rule (Applications)#Application 2: Navigation Point and Train Stopped Event Message|How to Use Message Popup Rule (Applications): Navigation Point and Train Stopped Event Message]]
+*'''[[How to Use Navigation Point Rules]]'''
+*'''[[How to Use Navigation Point Rules (Applications)]]'''
 *'''[[How to Use Parent and Child Rules]]'''
-==='''MaxPermittedSpeed Rule'''===
+==='''Wait on Train Stop/Start Rule'''===
-Sets the maximum permitted speed of locomotives under AI control
+Executes child rules when a train stops or starts moving
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid2:60850:89000:7>'''
+*'''<kuid:-25:1069>'''
 *'''Built-in Rule'''
+*'''Parent Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''None'''
+     '''[x] Trigger rule once'''
+    '''Wait for a train that matches the following criteria to ''<select>''''' - select one of:-
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
+       '''''start moving'''''
-: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
+       '''''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
-'''[[#top|Back to Top]]'''
+[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
-----
+*'''[[How to Use Message Popup Rule (Applications)#Application 2: Navigation Point and Train Stopped Event Message|How to Use Message Popup Rule (Applications): Navigation Point and Train Stopped Event Message]]'''
+*'''[[How to Use Parent and Child Rules]]'''
-<table width="100%" bgcolor=#ffffaa>
+==='''Wait on Waybill Screen/Main Screen Rule'''===
-<tr>
-<td>
-=='''Startup and Termination Rules'''==
-</td>
-</tr>
-</table>
-==='''End Session Rule'''===
+Executes child rules when the Waybill window is opened or closed
-End the Session with a fade out.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:482>'''
+*'''<kuid:-25:957>'''
 *'''Built-in Rule'''
+*'''Parent Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''Fade out over ''<value>'' seconds''' - enter number of seconds for fade out.
+     '''[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'''.
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
+[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
-:Seconds are Trainz clock time, not real time.
+*'''[[How to Use Parent and Child Rules]]'''
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+==='''Wait Rule'''===
-*'''[[#Session Complete Rule|Session Complete Rule]]''' - set the session to a percentage of completion
-==='''Multiplayer Rule'''===
+Executes child rules after waiting for set number of seconds
-Enables the session to be taken online in a Multiplayer environment.
 [[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:447264:1045>'''
+*'''<kuid2:122381:10016:2>'''
 *'''Built-in Rule'''
+*'''Parent Rule'''
 [[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''Suggested maximum number of players for this session ''<value>''''' - enter a number
+     '''''<click to set>''''' - enter the number of seconds for the wait delay
-    '''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
-==='''Randomize Rule'''===
+[[file:Notes.PNG]] '''<u>Notes:</u>'''
+:Seconds is in Trainz clock time, not real time
-Generates a different set of random numbers each time the session is run.
+[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+*'''[[#Timecheck Rule|Timecheck Rule]]''' - executes child rules at a set time.
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
+[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
+*'''[[How to Use Message Popup Rule (Applications)#Application 1: Timed Message|How to Use Message Popup Rule (Applications): Timed Message]]'''
+*'''[[How to Use Navigation Point Rules (Applications)#Application 4: User Path Selection|How to Use Navigation Point Rules (Applications): User Path Selection]]
+*'''[[How to Use Parent and Child Rules]]'''
-*'''<kuid:169301:100129>'''
+==='''Weather Rule'''===
-*'''DLS Rule''' by '''Terry_Wagstaff'''
+Changes the weather conditions during Session play.
-[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
+[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-    '''None'''
+*'''<kuid:-25:960>'''
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
+*'''Built-in Rule'''
-: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.
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
+[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-*'''[[#Variable Random|Variable Random]]''' - sets a variable to a random integer value.
-==='''Session Complete Rule'''===
+     '''Set weather to ''<select mode>'' with ''<select frequency>'' changeability''' - select
+        '''Weather mode:''' - select one of:-
-Set session to a percentage of completion.
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:447264:1011>'''
-*'''Base Rule'''
-[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-    '''Set session to percent complete ''<value>''''' - enter number as a percentage
-    '''[x] Separate achievements for completion''' - check to set
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#End Session Rule|End Session Rule]]''' - end the Session with a fade out.
-==='''Startup Options Rule'''===
-Specifies the starting options for the session. The weather settings will set the ''initial'' conditions, including the variability. To manually change the weather during play, use the '''Weather Rule'''.
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-16:10212>'''
-*'''Base Rule'''
-[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-    '''Current control method is ''<select>''''' - select one from:-
-       '''''Easy Mode''''' - DCC (standard keyboard and mouse) control
-       '''''Ask User''''' - let the user decide
-       '''''Realistic Mode''''' - Cab controls (on screen levers, throttles, buttons, etc)
-    '''Set weather to ''<select mode>'' with ''<select frequency>'' changeability''' - select
-       '''Weather mode:''' - select one of:-
-          '''''Clear'''''
-          '''''Cloudy'''''
-          '''''Drizzle'''''
-          '''''Rain'''''
-          '''''Stormy'''''
-          '''''Light Snow'''''
-          '''''Medium Snow'''''
-          '''''Heavy Snow'''''
-       '''Changeability:''' - select one of:-
-          '''''Off''''' - the weather will not change from the mode selected above
-          '''''Periodic''''' - slow gradual changes to the weather
-          '''''Extreme''''' - rapid and extreme changes to the weather
-    '''Set time to ''<hours>'':''<minutes>'' with a rate of ''<select speed>''''' - set the starting time and the speed at which the Trainz clock will run
-    '''Set derailment realism to ''<select reality level>''''' - select one of:-
-       '''''None''''' - no train derailments will occur
-       '''''Arcade''''' - train derailments will be exaggerated (beyond normal)
-       '''''Realistic''''' - train derailments will occur as realistically as possible
-    '''[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
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
-:Times are Trainz clock time, not real time
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Time and Rate Rule|Time and Rate Rule]]''' - sets the session start time and the rate at which time passes.
-*'''[[#Weather Rule|Weather Rule]]''' - changes weather conditions during Session play
-'''[[#top|Back to Top]]'''
-----
-<table width="100%" bgcolor=#ffffaa>
-<tr>
-<td>
-=='''Time Rules'''==
-</td>
-</tr>
-</table>
-==='''Clock Rule'''===
-Rule needed for animated clocks.
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid2:62310:30041:2>'''
-*'''Built-in Rule'''
-[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-    '''None'''
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
-:Apply this rule to your session to make use of the animated clocks. See the forum for code to include in your clock object to work with this rule.
-==='''Time and Rate Rule'''===
-Sets the session start time and the rate at which time passes.
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:889>'''
-*'''Built-in Rule'''
-[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-    '''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)
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Startup Options Rule|Startup Options Rule]]''' - sets the startup options for a session including time and rate
-*'''[[#Timecheck Rule|Timecheck Rule]]''' - executes child rules at a set time.
-==='''Timecheck Rule'''===
-Executes child rules at a set time.
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid2:122381:10008:3>'''
-*'''Built-in Rule'''
-*'''Parent Rule'''
-[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-    '''''<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.
-[[file:Issues.PNG]] ''''<u>Known Issues:</u>'''
-:Do not use this rule as a child of a repeating rule such as the '''Simultaneous List Rule''' or the '''Ordered List Rule'''.
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
-:Times and days are Trainz clock times not real time.
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Time and Rate Rule|Time and Rate Rule]]''' - sets the session start time and the rate at which time passes.
-*'''[[#Wait Rule|Wait Rule]]''' - executes child rules after waiting for a set number of seconds.
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
-*'''[[How to Use Parent and Child Rules]]'''
-==='''Wait Rule'''===
-Executes child rules after waiting for set number of seconds
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid2:122381:10016:2>'''
-*'''Built-in Rule'''
-*'''Parent Rule'''
-[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-    '''''<click to set>''''' - enter the number of seconds for the wait delay
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
-:Seconds is in Trainz clock time, not real time
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Timecheck Rule|Timecheck Rule]]''' - executes child rules at a set time.
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
-*'''[[How to Use Message Popup Rule (Applications)#Application 1: Timed Message|How to Use Message Popup Rule (Applications): Timed Message]]'''
-*'''[[How to Use Navigation Point Rules (Applications)#Application 4: User Path Selection|How to Use Navigation Point Rules (Applications): User Path Selection]]
-*'''[[How to Use Parent and Child Rules]]'''
-'''[[#top|Back to Top]]'''
-----
-<table width="100%" bgcolor=#ffffaa>
-<tr>
-<td>
-=='''Variable Rules'''==
-</td>
-</tr>
-</table>
-==='''Quick Session Variables Rule'''===
-Allows the editing of session variables
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid2:61392:5003:30>'''
-*'''DLS Rule''' by '''pguy'''
-[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-    '''''<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
-[[file:Issues.PNG]] ''''<u>Known Issues:</u>'''
-:Rule creator, '''pguy''', has indicated that the future of this rule is uncertain as parts of it have been devalued in the latest release of TANE.
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Variable Check Rule|Variable Check Rule]]''' - executes child rules according to the value of a specified variable.
-*'''[[#Variable Modify Rule|Variable Modify Rule]]''' - changes the value of a specified variable.
-*'''[[#Variable Modify Continuous Rule|Variable Modify Continuous Rule]]''' - continuously changes the value of a specified variable.
-*'''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.
-*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
-==='''Variable Check Rule'''===
-Executes child rules when a specific variable matches set conditions
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:1049>'''
-*'''Built-in Rule'''
-*'''Parent Rule'''
-[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-    '''''<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
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Quick Session Variables Rule|Quick Session Variables Rule]]''' - allows the editing of session variables.
-*'''[[#Variable Modify Rule|Variable Modify Rule]]''' - changes the value of a specified variable.
-*'''[[#Variable Modify Continuous Rule|Variable Modify Continuous Rule]]''' - continuously changes the value of a specified variable.
-*'''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.
-*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
-*'''[[How to Use Parent and Child Rules]]'''
-*'''[[How to Use Variables in Sessions (Examples)]]
-==='''Variable Modify Continuous Rule'''===
-Adds, subtracts or sets a value to a specified variable every second.
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:1051>'''
-*'''Built-in Rule'''
-[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-   '''''<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.
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Quick Session Variables Rule|Quick Session Variables Rule]]''' - allows the editing of session variables.
-*'''[[#Variable Check Rule|Variable Check Rule]]''' - executes child rules according to the value of a specified variable.
-*'''[[#Variable Modify Rule|Variable Modify Rule]]''' - changes the value of a specified variable.
-*'''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.
-*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
-==='''Variable Modify Rule'''===
-Change the value of a specified variable. This rule can also used to create a new variable and set its initial value by using the "Change variable" option.
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:1050>'''
-*'''Built-in Rule'''
-[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-    '''Change ''<Add to variable/Subtract from variable/Change variable>''''' - click to select one from:-
-       '''Add to variable'''
-          '''Add ''<value>''''' to '''variable ''<variable-name>''''' - enter value to add to variable, enter variable-name. Variable-name is case sensitive.
-          '''''<Do not undo the alteration if the rule is stopped/Undo the alteration if the rule is stopped>''''' - click to select one.
-       '''Subtract from variable'''
-          '''Subtract ''<value>''''' from '''variable ''<variable-name>''''' - enter value to subtract from variable, enter variable-name.
-             Variable-name is case sensitive.
-          '''''<Do not undo the alteration if the rule is stopped/Undo the alteration if the rule is stopped>''''' - click to select one.
-       '''Change variable'''
-          '''Change variable ''<variable-name>'' to ''<value>''''' - enter variable-name, enter new value.
-             Variable-name is case sensitive. This change cannot be undone if the rule is stopped.
-    '''[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.
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Quick Session Variables Rule|Quick Session Variables Rule]]''' - allows the editing of session variables.
-*'''[[#Variable Check Rule|Variable Check Rule]]''' - executes child rules according to the value of a specified variable.
-*'''[[#Variable Modify Continuous Rule|Variable Modify Continuous Rule]]''' - continuously changes the value of a specified variable.
-*'''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.
-*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
-*'''[[How to Use Variables in Sessions (Examples)]]
-*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Variable_Modify_Rule</span>'''
-==='''Variable Random Rule'''===
-Assigns a random integer value to a variable.
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:400260:100606>'''
-*'''DLS Rule''' by '''tram_'''
-[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-    '''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
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Quick Session Variables Rule|Quick Session Variables Rule]]''' - allows the editing of session variables.
-*'''[[#Randomize|Randomize]]''' - creates a different set of random numbers for each session run.
-*'''[[#Variable Check Rule|Variable Check Rule]]''' - executes child rules according to the value of a specified variable.
-*'''[[#Variable Modify Rule|Variable Modify Rule]]''' - changes the value of a specified variable.
-*'''[[#Variable Modify Continuous Rule|Variable Modify Continuous Rule]]''' - continuously changes the value of a specified variable.
-*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
-*'''[[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.
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:971>'''
-*'''Built-in Rule'''
-[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-   '''[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.
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
-*'''[[#Quick Session Variables Rule|Quick Session Variables Rule]]''' - allows the editing of session variables.
-*'''[[#Variable Check Rule|Variable Check Rule]]''' - executes child rules according to the value of a specified variable.
-*'''[[#Variable Modify Rule|Variable Modify Rule]]''' - changes the value of a specified variable.
-*'''[[#Variable Modify Continuous Rule|Variable Modify Continuous Rule]]''' - continuously changes the value of a specified variable.
-*'''[[#Variable Random Rule|Variable Random Rule]]''' - assigns a random value to a variable.
-[[file:WikiLink.PNG]] '''<u>Trainz Wiki Links:</u>'''
-*'''[[How to Use Variables in Sessions (Examples)]]
-'''[[#top|Back to Top]]'''
-----
-<table width="100%" bgcolor=#ffffaa>
-<tr>
-<td>
-=='''Weather Rules'''==
-</td>
-</tr>
-</table>
-==='''EIRS Weather Rule NE USA Rule'''===
-Customize random weather rule relative to the North East Region of the United States.
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid2:487222:1037:3>'''
-*'''Built-in Rule'''
-[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-    '''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'''''
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
-:Minutes are Trainz clock times, not real times
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#Random Weather Rule v2|Random Weather Rule v2]]''' - randomly changes the weather according to entered parameters
-*'''[[#Startup Options Rule|Startup Options Rule]]''' - sets the weather conditions at the start of a Session
-*'''[[#Weather Rule|Weather Rule]]''' - changes the weather conditions during Session play
-==='''Random Weather Rule v2'''===
-Randomly changes the weather conditions between set values over a set duration.
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:169301:100132>'''
-*'''DLS Rule''' by '''terry_wagstaff'''
-[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-    '''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
-[[file:Notes.PNG]] '''<u>Notes:</u>'''
-: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.
-[[file:PageLink.PNG]] '''<u>Related Rules:</u>'''
-*'''[[#EIRS Weather Rule NE USA Rule|EIRS Weather Rule NE USA Rule]]''' - customize random weather rule relative to the North East Region of the United States
-*'''[[#Startup Options Rule|Startup Options Rule]]''' - sets the weather conditions at the start of a Session
-*'''[[#Weather Rule|Weather Rule]]''' - changes the weather conditions during Session play
-==='''Weather Rule'''===
-Changes the weather conditions during Session play.
-[[file:Properties.PNG]] '''<u>Rule Properties:</u>'''
-*'''<kuid:-25:960>'''
-*'''Built-in Rule'''
-[[file:Settings.PNG]] '''<u>Rule Settings:</u>'''
-     '''Set weather to ''<select mode>'' with ''<select frequency>'' changeability''' - select
-        '''Weather mode:''' - select one of:-
            '''''Clear'''''
            '''''Cloudy'''''
@@ Line 4,321: / Line 3,769: @@
 *'''[[#Random Weather Rule v2|Random Weather Rule v2]]''' - randomly changes the weather according to entered parameters
 *'''[[#Startup Options Rule|Startup Options Rule]]''' - sets the weather conditions at the start of a Session
-'''[[#top|Back to Top]]'''
 ----
+<table bgcolor=#ccffff>
+<tr>
+<td>
+'''[[#top|Back to Top]]''' | '''[[#A, B|A, B]]''' | '''[[#C|C]]''' | '''[[#D|D]]''' | '''[[#E, F, G|E, F, G]]''' | '''[[#H, I, J|H, I, J]]''' | '''[[#K, L, M|K, L, M]]''' | '''[[#N, O|N, O]]''' | '''[[#P, Q|P, Q]]''' | '''[[#R|R]]''' | '''[[#S-Se|S-Se]]''' | '''[[#Sh-Sz|Sh-Sz]]''' | '''[[#T|T]]''' | '''[[#U, V|U, V]]''' | '''[[#W, X, Y, Z|W, X, Y, Z]]'''
+</td>
+</tr>
+</table>

Session Rule List with Parameters: Difference between revisions

Pware (talk | contribs)

Revision as of 22:52, 15 July 2018

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

DisplayIndustryStatus Rule (color modified)

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