Revision as of 21:35, 1 November 2019

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

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

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

The rules listed in this page are all accessible in the

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

Also available Session Rule List (Alphabetical) with Parameters

Description Key:

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

Achievement Rules

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

Consist Check Rule

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

Rule Properties:

<kuid:-25:1068>

Built-in Rule

Parent Rule

Rule Settings:

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

Known Issues:

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

Examples of Use:

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

Trainz Wiki Links:

Multiple Resource Check Rule

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

Rule Properties:

<kuid:-25:656>

Built-in Rule

Parent Rule

Rule Settings:

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

Notes:

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

Related Rules:

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

Examples of Use:

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

Trainz Wiki Links:

How to Use Parent and Child Rules

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

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

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

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

Camera Rules

Cinematic Camera Rule

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

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

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

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

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

Back to Top

Danger, Derailment and Safety Rules

ATP Speed Limiter Rule

Limits allowable speed over set limit

Rule Properties:

<kuid2:321959:1000:1>

Built-in Rule

Rule Settings:

   Limits the speed to <value> mph over the set limit - enter speed value in mph

Related Rules:

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

AWS Configuration Rule

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

Rule Properties:

<kuid2:60850:89002:3>

Built-in Rule

Rule Settings:

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

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

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

Junction Derailment Prevention Rule

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

Rule Properties:

<kuid2:121843:100282:1>

DLS Rule by pitkin

Rule Settings:

   None

Notes:

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

Related Rules:

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

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

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

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

Signal Passed At Danger Check Rule

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

Rule Properties:

<kuid2:60850:89007:2>

Built-in Rule

Parent Rule

Rule Settings:

   [x] Trigger only once

Examples of Use:

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

Trainz Wiki Links:

How to Use Parent and Child Rules

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

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 %

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

Back to Top

Driver Rules

AI Start Rule

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

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

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

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

Driver Command Check Rule

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

Rule Properties:

<kuid:-25:447>

Built-in Rule

Parent Rule

Rule Settings:

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

Related Rules:

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

Trainz Wiki Links:

How to Use Parent and Child Rules

Driver Command Rule

Specifies which commands will be available for the drivers

Rule Properties:

<kuid:-3:10057>

Base Rule

Rule Settings:

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

Notes:

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

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

Related Rules:

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

Examples of Use:

How to Use Driver Command Rule

Trainz Wiki Links:

Driver Commands List

Driver Main Menu Options Rule

Show/Hide the Driver Main Menu Bar

Rule Properties:

<kuid:-25:448>

Built-in Rule

Rule Settings:

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

Driver Schedule Rule

Sets up a list of basic scheduled commands

Rule Properties:

<kuid2:82445:90001:9>

Built-in Rule

Rule Settings:

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

Related Rules:

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

Examples of Use:

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

Driver Setup Rule

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

Rule Properties:

<kuid:-16:2025>

Base Rule

Rule Settings:

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

Known Issues:

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

Notes:

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

Related Rules:

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

Examples of Use:

How to Use Driver Setup Rule

Trainz Wiki Links:

Enable/Disable Driver Commands Rule

Enable/Disable specific driver commands on certain drivers. Multiple copies of the rule can be used to give different drivers or consists different command lists

Rule Properties:

<kuid:-25:480>

Built-in Rule

Rule Settings:

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

Related Rules:

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

Trainz Wiki Links:

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

JTG Correct Vehicle Lights

Corrects the brightness of vehicle headlights. Now obsolete.

Rule Properties:

<kuid2:478657:999103:1>

DLS Rule by jtg-trainz

Obsolete Rule (function is now built into Trainz Driver Additional Tools Menu)

Rule Settings:

   None

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

ScheduleAtTrackside Rule

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

Rule Properties:

<kuid2:61392:2001:6>

DLS Rule by pguy

Rule Settings:

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

Related Rules:

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

Schedule Library Rule

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

Rule Properties:

<kuid2:192081:12:5>

Built-in Rule by brummfondel

Rule Settings:

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

Notes:

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

Related Rules:

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

Dependent Driver Commands:

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

Copy Commands From

Schedule Rule

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

Rule Properties:

<kuid:-3:10185>

Base Rule

Rule Settings:

   Insert track mark <select> - select a track mark from the Session List
   Arrival and Departure Time <Select> - set time
      hh:mm:ss - in hours/minutes/seconds
   Current Train <select> - select from session list
   Insert destination <select> - select from session list

Known Bugs:

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

Notes:

Times are Trainz clock times, not real time

Related Rules:

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

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

Back to Top

HUD (Heads Up Display) Rules

Cab Controls HUD Rule

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

Rule Properties:

<kuid:-16:287428>

Base Rule

Obsolete Rule (function is now built into Trainz)

Rule Settings:

   None

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

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

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

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

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.

Dependent Driver Commands:

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

Set Custom HUD (SP2 and later)

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

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

Variable Show Rule

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

Rule Properties:

<kuid:-25:971>

Built-in Rule

Rule Settings:

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

Related Rules:

Display Custom HUD Rule - shows or hides the Custom Heads Up Display.
Quick Session Variables Rule - allows the editing of session variables.
Variable Check Rule - executes child rules according to the value of a specified variable.
Variable Modify Rule - changes the value of a specified variable.
Variable Modify Continuous Rule - continuously changes the value of a specified variable.
Variable Random Rule - assigns a random value to a variable.

Examples of Use:

How to Use Variables in Sessions (Examples)

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

Back to Top

Industry Rules

Advanced Industry Load Configuration Rule

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

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

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

ExTrainz Manager Rule - TANE SP2

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

Rule Properties:

<kuid:160293:10029>

DLS Rule by trev999

Rule Settings:

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

Known Issues:

This rule is NOT compatible with all industries.

Notes:

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

Multiple Resource Check Rule

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

Rule Properties:

<kuid:-25:656>

Built-in Rule

Parent Rule

Rule Settings:

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

Notes:

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

Related Rules:

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

Examples of Use:

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

Trainz Wiki Links:

How to Use Parent and Child Rules

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

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

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

Interlocking Tower, Junction and Signal Rules

Control Path Rule

Sets the path for selected trains

Rule Properties:

<kuid:131986:158781>

DLS Rule by atilabarut

Legacy Rule (replaced by Interlocking Tower Rules)

Rule Settings:

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

Notes:

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

Related Rules:

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

Interlocking Tower Configure Path Rule

Alters settings on an interlocking tower path

Rule Properties:

<kuid:401543:3205>

Base Rule

Rule Settings:

  Interlocking Tower <select> - to set Name and Objects

Known Bugs:

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

Related Rules:

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

Interlocking Tower Path Selection UI Rule

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

Rule Properties:

<kuid:401543:3203>

Base Rule

Rule Settings:

  [Checkbox] Show path activation message in Driver

Known Bugs:

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

Related Rules:

Interlocking Tower Configure Path Rule - alters the settings on an interlocking tower path
Interlocking Tower Set Path Rule - sets the state of an interlocking tower path for a train
Interlocking Tower Enhanced Manager Rule (SP2 and later) - more management and control options for interlocking towers.

Interlocking Tower Set Path Rule

Will set the state of an interlocking tower path for a train

Rule Properties:

<kuid:401543:3204>

Base Rule

Rule Settings:

  Interlocking Tower <select> - to set Name and Objects

Known Bugs:

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

Related Rules:

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

Interlocking Tower Enhanced Manager Rule (SP2 and later)

Provides more management and control options for interlocking towers.

Rule Properties:

<kuid2:61392:8130:41>

DLS Rule by pguy

Rule Settings:

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

Notes:

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

Known Bugs:

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

Related Rules:

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

Trainz Wiki Links:

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

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

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

MissionCode Manager Rule (SP2 and later)

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

Rule Properties:

<kuid2:61392:8200:50>

DLS Rule by pguy

Rule Settings:

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

Dependent Driver Commands:

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

AddMissionCode (SP2 and Later)
RemoveMissionCode (SP2 and Later)
SetMissionCode (SP2 and Later)

Related Rules:

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

Trainz Wiki Links:

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

MissionCode Stops and Timetable Manager Rule (SP2 and later)

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

Rule Properties:

<kuid2:61392:8300:50>

DLS Rule by pguy

Rule Settings:

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

Related Rules:

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

Trainz Wiki Links:

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

Multiple Junction Alignment Check Rule

Executes child rules if specific junctions are set.

Rule Properties:

<kuid:-25:168>

Built-in Rule

Parent Rule

Rule Settings:

   Wait until <selection> - select from:-
      any one - any of the junctions in the rule list (below) is set correctly
      all - ALL of the junctions in the rule list are set correctly
   <Add junction> - click to select a junction from the session list
   <Add all> - click to select ALL junctions in the session list
   <Delete all> - click to delete ALL selected junctions from the rule list
      For each selected junction:-
      <setting> - click to select one switch direction from:-
         Left
         Right
         Center
         Any
      <remove> - to delete this junction from the rule list

Related Rules:

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

Examples of Use:

How to Control Junctions in Sessions

Trainz Wiki Links:

How to Use Parent and Child Rules

Set Cleared Junctions Rule

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

Rule Properties:

<kuid2:131986:157661:1>

DLS Rule by atilabarut

Rule Settings:

   Add Junction - click to select a junction from the session junction list
   Add All - click to add ALL junctions in the session junction list
   Delete All - click to remove ALL entered junctions from the rule
      Junction Options: - for each selected junction:-
         <direction> - click to select the junction direction
            Left
            Center
            Right
            Don't change
         <user control> - click to select a user control option
            Locked - the junction setting cannot be changed by the user
            Unlocked - the junction setting can be changed by the user
         <AI control> - click to select AI control
            Allows AI control - an AI train can switch the junction
            Blocks AI control - an AI train cannot switch the junction
         Remove - click to remove this junction from the rule list

Related Rules:

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

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

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

Examples of Use:

How to Control Junctions in Sessions

Set Signal Extended Rule

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

Rule Properties:

<kuid2:47662:20002:4>

Built-in Rule

Rule Settings:

   <Select signal> to <signal state> - click to select a signal from the session list and click to select a state from the list -
      Automatic
      Stop
      Stop then Continue
      Caution Left
      Caution Right
      Caution
      Advance Caution Left
      Advance Caution Right
      Advance Caution
      Proceed Left
      Proceed Right
      Proceed
      Slow
      Medium

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

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

Message Rules

Close Message Popup Rule

Closes open message popups

Rule Properties:

<kuid:447264:1526>

Built-in Rule

Rule Settings:

  None

Known Issues:

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

Related Rules:

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

Examples of Use:

How to Use Message Popup Rule (Applications)

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

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

ExTrainz Manager Rule - TANE SP2

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

Rule Properties:

<kuid:160293:10029>

DLS Rule by trev999

Rule Settings:

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

Known Issues:

This rule is NOT compatible with all industries.

Notes:

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

Fade In/Out Rule

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

Rule Properties:

<kuid2:190611:200000:2>

Built-in Rule

Rule Settings:

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

Notes:

Seconds are Trainz clock time, not real time.

Hide Product Overlays Rule

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

Rule Properties:

<kuid:400048:100970>

DLS Rule by callavsg

Rule Settings:

  None

InputTable Rule

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

Rule Properties:

<kuid2:131986:1012:1>

Built-in Rule

Rule Settings:

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

Dependent Driver Commands:

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

MoveTurntable
Skip If Session-Variable
Wait Until S-Variable

Message Popup Rule

Displays a pop-up browser window and waits for it to be closed. Closure can be manual (by the user) or by another rule.

Rule Properties:

<kuid:-25:1003>

Built-in Rule

Rule Settings:

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

Known Issues:

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

Related Rules:

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

Examples of Use:

Trainz Wiki Links:

Minimap Options Rule

Sets the display options for the minimap.

Rule Properties:

<kuid:-25:636>

Built-in Rule

Rule Settings:

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

Related Rules:

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

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

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

Show/Hide Layer Rule

Shows or hides a layer from Driver.

Rule Properties:

<kuid2:401543:1170:1>

Built-in Rule

Rule Settings:

  <visibility> - select one of two options
     Show - select to make the layer visible
     Hide - select to make the layer invisible
  <click here to set> - enter name of layer. Name is case sensitive.

Known Bugs:

Layers set to Hide when a game is saved will be Shown when the saved game is reloaded

Known Issues:

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

Related Driver Commands:

Layer Control

Examples of Use:

How to Use Layers: Layers in Driver Mode

Show/Hide Minimap Rule

Shows the minimap window in Driver.

Rule Properties:

<kuid:-25:794>

Built-in Rule

Rule Settings:

   <Show/Hide> the driver Minimap Window - click to switch between Show and Hide.

Related Rules:

Minimap Options Rule - sets the display options for the minimap.

Show/Hide On-screen Help Rule

Shows or hides On-screen help in Driver.

Rule Properties:

<kuid:401543:2020>

Built-in Rule

Rule Settings:

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

Timed Limited Display HTML Rule (SP2 and later)

Displays an HTML browser window for a limited time.

Rule Properties:

<kuid2:61392:2005:32>

DLS Rule by pguy

Rule Settings:

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

Notes:

Seconds are Trainz clock time, not real time.

Related Rules:

Close Message Popup Rule - closes open message popups
Display HTML Pages Rule - displays HTML pages in a browser window.
Message Popup Rule - displays a pop-up browser window and waits for it to be closed.
Set HTML Page Rule - sets parameters for the Display HTML Pages Rule

Trainz Wiki Links:

How to Create a HTML Asset

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

Back to Top

Miscellaneous Rules

Some of these rules have no user accessible functions but may be used by other rules. Others do not fit in any other category.

ConsistDataHandler Rule

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

Rule Properties:

<kuid:401543:1180>

Obsolete Rule (function is now built into Trainz)

Base Rule

Rule Settings:

   None

Custom Script Rule

No description

Rule Properties:

<kuid:447264:1526>

Built-in Rule

Rule Settings:

  None

Generic TreeNode Debug Window Rule

No description.

Rule Properties:

<kuid:30501:1042>

Base Rule

Rule Settings:

   None

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

Back to Top

Navigation Rules

Directional Trigger Check Rule

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

Rule Properties:

<kuid2:532391:100003:1>

DLS Rule by bobhahn

Parent Rule

Rule Settings:

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

Notes:

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

Related Rules:

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

Examples of Use:

How to Control Signals in Sessions: Halt Before Clear

Trainz Wiki Links:

Navigation Display Rule

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

Rule Properties:

<kuid2:401543:1161:1>

Base Rule

Rule Settings:

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

Related Rules:

Navigation Set Hide/Show Rule - makes a navigation set visible/invisible.
Navigation Set Check Rule - executes child rules if a navigation set has completed or is incomplete.
Navigation Set Clear Rule - completes (terminates) a navigation set.
Navigation Point Complete Rule - manually completes (terminates) a specific navigation point in a set.
Wait on Navigation Point Rule - executes child rules when a navigation point has been completed

Examples of Use:

Navigation Point Complete Rule

Manually completes a navigation point in a set

Rule Properties:

<kuid:401543:1167>

Base Rule

Rule Settings:

   Mark navigation point <click here to set> - enter the navigation point number to be completed
   complete in set <click here to set> - enter the unique name for the navigation set created using the Navigation Display Rule.
        Name must be in lowercase and have no spaces.

Known Issues:

The rule will NOT check to see if the named navigation set and point exists or not.

Notes:

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

Related Rules:

Navigation Display Rule - creates a set of navigation points.
Navigation Set Hide/Show Rule - makes a navigation set visible/invisible.
Navigation Set Check Rule - executes child rules if a navigation set has completed or is incomplete.
Navigation Set Clear Rule - completes (terminates) a navigation set.
Wait on Navigation Point Rule - executes child rules when a navigation point has been completed

Examples of Use:

Navigation Set Check Rule

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

Rule Properties:

<kuid:401543:1165>

Base Rule

Parent Rule

Rule Settings:

   Checks if navigation point set <name>: - enter the unique name for the navigation set created using the Navigation Display Rule.
        Name must be in lowercase and have no spaces.
   is <Complete/Incomplete> - click to select one

Known Issues:

The rule will NOT check to see if the named navigation set exists or not.

Notes:

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

Related Rules:

Navigation Display Rule - creates a set of navigation points.
Navigation Set Hide/Show Rule - makes a navigation set visible/invisible.
Navigation Set Clear Rule - completes (terminates) a navigation set.
Navigation Point Complete Rule - manually completes (terminates) a specific navigation point in a set.
Wait on Navigation Point Rule - executes child rules when a navigation point has been completed

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.

Notes:

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

Related Rules:

Navigation Display Rule - creates a set of navigation points.
Navigation Set Hide/Show Rule - makes a navigation set visible/invisible.
Navigation Set Check Rule - executes child rules if a navigation set has completed or is incomplete.
Navigation Point Complete Rule - manually completes (terminates) a specific navigation point in a set.
Wait on Navigation Point Rule - executes child rules when a navigation point has been completed

Examples of Use:

Navigation Set Hide/Show Rule

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

Rule Properties:

<kuid:401543:1163>

Base rule

Rule Settings:

   <visibility> - click to select one
      Hide - select to make the navigation set invisible
      Show - select to make the navigation set visible
   <click here to set> - enter the unique name for the navigation set created using the Navigation Display Rule.
        Name must be in lowercase and have no spaces.

Known Issues:

The rule will NOT check to see if the named navigation set exists or not.

Notes:

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

Related Rules:

Navigation Display Rule - creates a set of navigation points.
Navigation Set Check Rule - executes child rules if a navigation set has completed or is incomplete.
Navigation Set Clear Rule - completes (terminates) a navigation set.
Navigation Point Complete Rule - manually completes (terminates) a specific navigation point in a set.
Wait on Navigation Point Rule - executes child rules when a navigation point has been completed

Examples of Use:

Schedule Rule

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

Rule Properties:

<kuid:-3:10185>

Base Rule

Rule Settings:

   Insert track mark <select> - select a track mark from the Session List
   Arrival and Departure Time <Select> - set time
      hh:mm:ss - in hours/minutes/seconds
   Current Train <select> - select from session list
   Insert destination <select> - select from session list

Known Bugs:

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

Notes:

Times are Trainz clock times, not real time

Related Rules:

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

Trackside Check Rule

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

Rule Properties:

<kuid2:46162:100207:1>

DLS Rule by Josefpav

Parent Rule

Rule Settings:

   Applies to: - select one of three option buttons:-
      ( ) Junction
      ( ) Trigger
      ( ) Trackmark
   Trackside object name: <specify> - select object name from session list
   Wait for train to: - select one of three option buttons:-
      ( ) Enter
      ( ) Stop at
      ( ) Leave
   [x] Auto reset this rule - check to execute the rule continuously
   Applies to train containing:
   <Add vehicle> - click to select a rail vehicle from the session list
   del - click to remove a selected vehicle from the rule

Related Rules:

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

Trainz Wiki Links:

How to Use Parent and Child Rules

Trigger Check Rule

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

Rule Properties:

<kuid:-25:1071>

Built-in Rule

Parent Rule

Rule Settings:

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

Related Rules:

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

Examples of Use:

Trainz Wiki Links:

How to Use Parent and Child Rules

Wait on Navigation Point Rule

Executes child rules when a specific navigation point is completed

Rule Properties:

<kuid:401543:1168>

Base Rule

Parent Rule

Rule Settings:

   navigation point <click here to set> - enter the number of the navigation point to be completed
   in set <click here to set> - enter the unique name for the navigation set created using the Navigation Display Rule.
      Name must be in lowercase and have no spaces.

Known Issues:

The rule will NOT check to see if the named navigation set and point exists or not.

Notes:

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

Related Rules:

Navigation Display Rule - creates a set of navigation points.
Navigation Set Hide/Show Rule - makes a navigation set visible/invisible.
Navigation Set Check Rule - executes child rules if a navigation set is complete or incomplete.
Navigation Set Clear Rule - completes (terminates) a navigation set.
Navigation Point Complete Rule - manually completes (terminates) a specific navigation point in a set.

Examples of Use:

Trainz Wiki Links:

Wait on Train Stop/Start Rule

Executes child rules when a train stops or starts moving

Rule Properties:

<kuid:-25:1069>

Built-in Rule

Parent Rule

Rule Settings:

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

Examples of Use:

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

Trainz Wiki Links:

How to Use Parent and Child Rules

Back to Top

Portal Rules

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
Un-Portal Rule - configures trackmarks as portals

Trainz Wiki Links:

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

Un-Portal Rule

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

Rule Properties:

<kuid2:117746:1024:10>

DLS Rule by sforget

Rule Settings:

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

Notes:

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

Related Rules:

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

Trainz Wiki Links:

How to Use Portals

Back to Top

Resources Rules

ExTrainz Manager Rule - TANE SP2

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

Rule Properties:

<kuid:160293:10029>

DLS Rule by trev999

Rule Settings:

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

Known Issues:

This rule is NOT compatible with all industries.

Notes:

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

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

Multiple Resource Check Rule

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

Rule Properties:

<kuid:-25:656>

Built-in Rule

Parent Rule

Rule Settings:

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

Notes:

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

Related Rules:

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

Examples of Use:

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

Trainz Wiki Links:

How to Use Parent and Child Rules

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

Schedule Rules

Driver Command Check Rule

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

Rule Properties:

<kuid:-25:447>

Built-in Rule

Parent Rule

Rule Settings:

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

Related Rules:

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

Trainz Wiki Links:

Driver Command Rule

Specifies which commands will be available for the drivers

Rule Properties:

<kuid:-3:10057>

Base Rule

Rule Settings:

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

Notes:

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

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

Related Rules:

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

Examples of Use:

How to Use Driver Command Rule

Trainz Wiki Links:

Driver Commands List

Driver Schedule Rule

Sets up a list of basic scheduled commands

Rule Properties:

<kuid2:82445:90001:9>

Built-in Rule

Rule Settings:

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

Related Rules:

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

Examples of Use:

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

Driver Setup Rule

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

Rule Properties:

<kuid:-16:2025>

Base Rule

Rule Settings:

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

Known Issues:

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

Notes:

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

Related Rules:

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

Examples of Use:

How to Use Driver Setup Rule

Trainz Wiki Links:

Enable/Disable Driver Commands Rule

Enable/Disable specific driver commands on certain drivers. Multiple copies of the rule can be used to give different drivers or consists different command lists

Rule Properties:

<kuid:-25:480>

Built-in Rule

Rule Settings:

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

Related Rules:

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

Trainz Wiki Links:

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

ScheduleAtTrackside Rule

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

Rule Properties:

<kuid2:61392:2001:6>

DLS Rule by pguy

Rule Settings:

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

Related Rules:

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

Schedule Library Rule

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

Rule Properties:

<kuid2:192081:12:5>

Built-in Rule by brummfondel

Rule Settings:

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

Notes:

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

Related Rules:

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

Dependent Driver Commands:

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

Copy Commands From

Schedule Rule

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

Rule Properties:

<kuid:-3:10185>

Base Rule

Rule Settings:

   Insert track mark <select> - select a track mark from the Session List
   Arrival and Departure Time <Select> - set time
      hh:mm:ss - in hours/minutes/seconds
   Current Train <select> - select from session list
   Insert destination <select> - select from session list

Known Bugs:

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

Notes:

Times are Trainz clock times, not real time

Related Rules:

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

Session Sequence Rules

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:

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:

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:

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:

Simultaneous List Rule

Executes child rules simultaneously once this rule starts

Rule Properties:

<kuid:-25:1048>

Built-in Rule

Parent Rule

Rule Settings:

   Rule completes when ... - click to chose one of the following:-
      one of the child rules has completed
      all child rules have reached a completed state
      all child rules have reached a "was completed" state

Related Rules:

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

Examples of Use:

Trainz Wiki Links:

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

Back to Top

Speed Rules

ATP Speed Limiter Rule

Limits allowable speed over set limit

Rule Properties:

<kuid2:321959:1000:1>

Built-in Rule

Rule Settings:

   Limits the speed to <value> mph over the set limit - enter speed value in mph

Related Rules:

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

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

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

Back to Top

Startup and Termination Rules

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

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

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.

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.

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

Back to Top

Time Rules

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.

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

Wait Rule

Executes child rules after waiting for set number of seconds

Rule Properties:

<kuid2:122381:10016:2>

Built-in Rule

Parent Rule

Rule Settings:

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

Notes:

Seconds is in Trainz clock time, not real time

Related Rules:

Timecheck Rule - executes child rules at a set time.

Examples of Use:

Trainz Wiki Links:

How to Use Parent and Child Rules

Back to Top

Variable Rules

Quick Session Variables Rule

Allows the editing of session variables

Rule Properties:

<kuid2:61392:5003:30>

DLS Rule by pguy

Legacy Rule (use Variable Modify Rule)

Rule Settings:

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

Known Issues:

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

Related Rules:

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

Variable Check Rule

Executes child rules when a specific variable matches set conditions

Rule Properties:

<kuid:-25:1049>

Built-in Rule

Parent Rule

Rule Settings:

   <variable-name> - enter a variable-name. Variable name is case sensitive.
   Mathematical relationship, select one of:-
      is less than - enter a <value> to test against
      is less than or equal to - enter a <value> to test against
      is equal to - enter a <value> to test against
      is greater than or equal to - enter a <value> to test against
      is greater than - enter a <value> to test against
      is not equal to - enter a <value> to test against
      is between x and y - enter a minimum <x-value> and a maximum <y-value>
   Evaluation type. Select one from:-
      <This condition will be evaluated only once ...> - any changes to the variable that occur after
              it has been checked will not change the result of this rule
      <This condition will be evaluated once every second> - the rule will be rerun and the variable 
              rechecked every second

Related Rules:

Quick Session Variables Rule - allows the editing of session variables.
Variable Modify Rule - changes the value of a specified variable.
Variable Modify Continuous Rule - continuously changes the value of a specified variable.
Variable Random Rule - assigns a random value to a variable.
Variable Show Rule - adds or removes a specified variable and a descriptive label to the custom HUD.

Examples of Use:

How to Use Variables in Sessions (Examples)

Trainz Wiki Links:

How to Use Parent and Child Rules

Variable Modify Continuous Rule

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

Rule Properties:

<kuid:-25:1051>

Built-in Rule

Rule Settings:

  <Add/Subtract/Change variable to> - select one.
     <value> - enter value to add, subtract or apply to <variable-name>
     <variable-name> - enter variable-name. Variable-name is case sensitive.

Related Rules:

Quick Session Variables Rule - allows the editing of session variables.
Variable Check Rule - executes child rules according to the value of a specified variable.
Variable Modify Rule - changes the value of a specified variable.
Variable Random Rule - assigns a random value to a variable.
Variable Show Rule - adds or removes a specified variable and a descriptive label to the custom HUD.

Variable Modify Rule

Change the value of a specified variable. This rule can also used to create a new variable and set its initial value by using the "Change variable" option.

Rule Properties:

<kuid:-25:1050>

Built-in Rule

Rule Settings:

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

Related Rules:

Quick Session Variables Rule - allows the editing of session variables.
Variable Check Rule - executes child rules according to the value of a specified variable.
Variable Modify Continuous Rule - continuously changes the value of a specified variable.
Variable Random Rule - assigns a random value to a variable.
Variable Show Rule - adds or removes a specified variable and a descriptive label to the custom HUD.

Examples of Use:

How to Use Variables in Sessions (Examples)

Trainz Wiki Links:

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

Variable Random Rule

Assigns a random integer value to a variable.

Rule Properties:

<kuid:400260:100606>

DLS Rule by tram_

Rule Settings:

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

Related Rules:

Quick Session Variables Rule - allows the editing of session variables.
Randomize - creates a different set of random numbers for each session run.
Variable Check Rule - executes child rules according to the value of a specified variable.
Variable Modify Rule - changes the value of a specified variable.
Variable Modify Continuous Rule - continuously changes the value of a specified variable.
Variable Show Rule - adds or removes a specified variable and a descriptive label to the custom HUD.

Examples of Use:

How to Use Variables in Sessions (Examples)

Variable Show Rule

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

Rule Properties:

<kuid:-25:971>

Built-in Rule

Rule Settings:

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

Related Rules:

Display Custom HUD Rule - shows or hides the Custom Heads Up Display.
Quick Session Variables Rule - allows the editing of session variables.
Variable Check Rule - executes child rules according to the value of a specified variable.
Variable Modify Rule - changes the value of a specified variable.
Variable Modify Continuous Rule - continuously changes the value of a specified variable.
Variable Random Rule - assigns a random value to a variable.

Examples of Use:

How to Use Variables in Sessions (Examples)

Back to Top

Weather Rules

EIRS Weather Rule NE USA Rule

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

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

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

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

Trainz Wiki

More Tutorials and Guides to Using Trainz

How to Guides
Driver Commands List
Session Rules List (Alphabetical) with Parameters

@@ Line 1: / Line 1: @@
-The information in this Wiki Page applies to '''TANE''', '''TRS19''' and '''Trainz Plus'''.
+The information in this Wiki Page applies to '''TANE''', '''TRS19''' and '''Trainz Plus'''. List of '''Trainz Session Rules''' in ''Classification or Category Order'' with Properties.
-<table bgcolor="green">
+<table bgcolor=#ffff00>
 <tr>
 <td>
-<span style="color: white; font-weight: 700;">This page is always under construction. As new driver commands appear and are tested they will be added to this list. Current Command Count: 57</span></td>
+<span style="color: black; font-weight: 700;">This page is always under construction. As new rules appear and are tested they will be added to this list. Current Command Count: 128</span></td>
 </tr>
 </table>
-'''Only driver commands supplied with Trainz or on the DLS are covered in this document.'''<br>
+'''Only rules supplied with Trainz or on the DLS are covered in this document.'''<br>
-<table width="100%" bgcolor=#a8ff8a>
+<table width="100%" bgcolor=#ffffaa>
 <tr>
 <td>
-The driver commands listed in this page are all found in Trainz '''Surveyor''' from the '''Edit Session''' option in the '''Main Menu''' and are accessed by the [[file:WikiLink.PNG|link=]]&nbsp;'''[[Session_Rule_List_with_Parameters#Driver_Command_Rule|Driver Command Rule]]''' and the [[file:WikiLink.PNG|link=]]&nbsp;'''[[Session_Rule_List_with_Parameters#Driver_Setup_Rule|Driver Setup Rule]]'''.<br>
+The rules listed in this page are all accessible in the [[file:WikiLink.PNG|link=]] '''[[How to Use Session Editor|Surveyor Session Editor]]'''. Those rules that are identified as '''DLS Rule''' must be downloaded and installed from the '''Trainz DLS''' first.</td>
-See the Trainz Wiki Page [[file:WikiLink.PNG|link=]]&nbsp;'''[[How_to_Use_Driver_Setup_Rule|How to Use the Driver Setup Rule]]''' for more information on both rules.
-Those commands that are identified as a '''DLS Command''' must be downloaded and installed from the Trainz DLS first.</td>
 </tr>
 </table>
+Also available [[file:WikiLink.PNG|link=]] '''[[Session Rule List with Parameters|Session Rule List (Alphabetical) with Parameters]]'''
 ----
 '''Description Key:'''
-*'''<kuid number>''' is for the command version at the time of writing. This number will change if the command is updated.
+*'''<kuid number>''' is for the rule version at the time of writing. This number will change if the rule is updated.
-*'''DLS Command''' must be downloaded and installed from the '''DLS'''.
+*'''DLS Rule''' must be downloaded and installed from the '''DLS'''.
-*'''Base Command''' and '''Built-in Command''' are installed with '''Trainz'''.
+*'''Base Rule''' and '''Built-in Rule''' is installed with '''Trainz'''.
-*'''Obsolete Command''' is no longer required (explanation given).
+*'''Parent Rule''' will execute child rules if it returns a ''true'' result.
-*'''Legacy Command''' has been replaced by another command (new command will be identified).
+*'''Obsolete Rule''' is no longer required (explanation given).
-*'''SP2 and later''' means '''TANE SP2''' and later versions including '''TRS19''' and '''Trainz Plus'''.
+*'''Legacy Rule''' has been replaced by another rule (new rule will be identified).
+*Rules that are named '''TANE SP2''' or '''TANE SP3''' will work in '''TRS19''' and '''Trainz Plus'''.
 ----
 __TOC__
-<table width="100%" bgcolor=#a8ff8a>
+<table width="100%" bgcolor=#ffff88>
 <tr>
 <td>
-='''Interlocking Tower and Mission Code Commands'''=
+='''Achievement Rules'''=
 </td>
 </tr>
 </table>
 <br>
-<table width=100% width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''AddMissionCode (SP2 and Later) '''==
+=='''Achievement Check Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Executes child rules when achievement conditions have been met
-<tr valign="top">
-<td>[[file:CMD_AddMissionCode.PNG|50px|link=]]</td>
-<td>Adds a mission code (a sequence of IT or EIT paths) to any mission codes already loaded for the train. The mission code must be set by the '''Mission Code Manager Rule (SP2 and Later)'''</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
-*'''<kuid2:61392:8203:56> AddMissionCode (SP2 and later)'''
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''DLS Command''' by '''pguy'''
+*'''<kuid:401543:1190>'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+*'''Built-in Rule'''
-   '''''<mission codes>''''' - select a mission code from the Session list
+*'''Parent Rule'''
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-:The mission code must be created by the '''Mission Code Manager Rule (SP2 and Later)''' using paths created with '''Interlocking Towers'''
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+    '''''<Not configured, click here to select an achievement asset>''''' - click to select an '''Achievement Asset''' from those installed
-*'''[[#RemoveMissionCode (SP2 and Later)|RemoveMissionCode (SP2 and Later)]]''' - sets a mission code for the train
+       When an '''Achievement Asset''' has been selected, the following will appear:-
-*'''[[#SetMissionCode (SP2 and Later)|SetMissionCode (SP2 and Later)]]''' - removes a mission code from those already set for the train
+       '''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
-[[file:PageLink3.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Required Session Rules:</span><br>
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
-:'''Rules that MUST be added to the Session for this Driver Command to operate'''
+*'''[[How to Use Parent and Child Rules]]'''
-*'''[[Session_Rule_List_with_Parameters#MissionCode_Manager_Rule_.28SP2_and_later.29|Mission Code Manager Rule (SP2 and later)]]'''
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
+=='''Consist Check Rule'''==
-=='''IT CancelEnhancedPath'''==
 </td>
 </tr>
 </table>
-<table>
+Executes child rules when a matching consist is found. The order of the vehicles in the consists is not important.
-<tr valign="top">
-<td>[[file:CMD_ITCancelEnhancedPath.png|50px|link=]]</td>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-<td>Cancels an active Enhanced Interlocking Tower (EIT) path for the train that had been set by the '''IT SetPath Command'''</td>
-</tr>
+*'''<kuid:-25:1068>'''
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+*'''Built-in Rule'''
-*'''<kuid2:61392:8114:54> IT CancelEnhancedPath'''
+*'''Parent Rule'''
-*'''DLS Command''' by '''pguy'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+    '''[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
-   '''<Select EIT>''' - select from list of session EITs
+[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
-      '''<Select Path>''' - select the active path from that EIT
+: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:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
-#The active path must be created using '''Enhanced Interlocking Towers'''
+*'''[[How to Use Variables in Sessions (Examples)#Example 3: Counting Consist Checks|How to Use Variables in Sessions (Examples): Counting Consist Checks]]'''
-#Cancelling a path makes it available for other consists and allows conflicting paths to be made active
-#An active path is automatically cancelled after it has been completed by a train
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
-*'''[[#IT SetPath|IT SetPath]]''' - sets an active path
+*'''[[How to Use Parent and Child Rules]]'''
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Consist_Check_Rule</span>'''
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
+=='''Multiple Resource Check Rule'''==
-=='''IT SetPath'''==
 </td>
 </tr>
 </table>
-<table>
+Executes child rules if industries or vehicles reach set commodity levels. This rule replaces the older '''Resource Check Rule'''
-<tr valign="top">
-<td>[[file:CMD_ITSetPath.png|50px|link=]]</td>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-<td>Selects and sets a path for the train from those available from Interlocking Towers (ITs) and Enhanced Interlocking Towers (EITs). If this path was created by an EIT it can be cancelled prior to its use by the '''IT CancelEnhancedPath Command'''</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+*'''<kuid:-25:656>'''
-*'''<kuid2:61392:8111:54> IT SetPath'''
+*'''Built-in Rule'''
-*'''DLS Command''' by '''pguy'''
+*'''Parent Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-   '''<Select IT or EIT>''' - select from list of session ITs and/or EITs
+    '''<Product Level>''' - click to select a product test from two choices:-
-      '''<Select Path>''' - select from available paths for that IT/EIT
+       '''''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|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
-#The paths must be created using '''Interlocking Towers'''
+: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''.
-#An active path is automatically cancelled after it has been completed by a train
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#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:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+*'''[[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]]'''
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
-*'''[[#IT CancelEnhancedPath|IT CancelEnhancedPath]]''' - cancels an active EIT path
+*'''[[How to Use Parent and Child Rules]]'''
-*'''[[#IT SetPathAndWaitActive|IT SetPathAndWaitActive]]''' - sets an active IT or EIT path and waits until it is active
-*'''[[#IT SetPathAndWaitNotRed|IT SetPathAndWaitNotRed]]''' - sets an active IT or EIT path and waits until the signal ahead is not red
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
+=='''Objective Add Rule'''==
-=='''IT SetPathAndWaitActive'''==
 </td>
 </tr>
 </table>
-<table>
+Sets up a game Objective with ID and display Name
-<tr valign="top">
-<td>[[file:CMD_ITSetPath.png|50px|link=]]</td>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-<td>Selects and sets a path for the train from those available from Interlocking Towers (ITs) and Enhanced Interlocking Towers (EITs) and waits until the path becomes active. If this path was created by an EIT it can be cancelled prior to its use by the '''IT CancelEnhancedPath Command'''</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
-*'''<kuid2:61392:8113:54> IT SetPathAndWaitActive'''
-*'''DLS Command''' by '''pguy'''
+*'''<kuid:401543:2001>'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+*'''Base Rule'''
-   '''<Select IT or EIT>''' - select from list of session ITs and/or EITs
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-      '''<Select Path>''' - select from available paths for that IT/EIT
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+    '''Priority ''<Select>''''' - select one of:-
-#The paths must be created using '''Interlocking Towers'''
+       '''''Above Normal'''''
-#An active path is automatically cancelled after it has been completed by a train
+       '''''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:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-*'''[[#IT CancelEnhancedPath|IT CancelEnhancedPath]]''' - cancels an active EIT path
+*'''[[#Objective Check Rule|Objective Check Rule]]''' - executes child rules if an objective is completed
-*'''[[#IT SetPath|IT SetPath]]''' - sets an active IT or EIT path
+*'''[[#Objective Update Rule|Objective Update Rule]]''' - changes the progress of a game objective
-*'''[[#IT SetPathAndWaitNotRed|IT SetPathAndWaitNotRed]]''' - sets an active IT or EIT path and waits until the signal ahead is not red
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
+=='''Objective Check Rule'''==
-=='''IT SetPathAndWaitNotRed'''==
 </td>
 </tr>
 </table>
-<table>
+Executes child rules if an objective created with the '''Objective Add Rule''' is complete.
-<tr valign="top">
-<td>[[file:CMD_ITSetPath.png|50px|link=]]</td>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-<td>Selects and sets a path for the train from those available from Interlocking Towers (ITs) and Enhanced Interlocking Towers (EITs) and waits until the next signal is not showing red. If this path was created by an EIT it can be cancelled prior to its use by the '''IT CancelEnhancedPath Command'''</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+*'''<kuid:401543:2003>'''
-*'''<kuid2:61392:8112:54> IT SetPathAndWaitNotRed'''
+*'''Base Rule'''
-*'''DLS Command''' by '''pguy'''
+*'''Parent Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-   '''<Select IT or EIT>''' - select from list of session ITs and/or EITs
+    '''Unique Objective ID ''<value>''''' - enter the unique ID created with the '''Objective Add Rule'''
-      '''<Select Path>''' - select from available paths for that IT/EIT
+    '''Mode ''<select>''''' - select one of three:-
+       '''''Wait for completion'''''
+       '''''Wait for failure'''''
+       '''''Wait for progress'''''
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-#The paths must be created using '''Interlocking Towers'''
+*'''[[#Objective Add Rule|Objective Add Rule]]''' - sets up a game objective
-#An active path is automatically cancelled after it has been completed by a train
+*'''[[#Objective Update Rule|Objective Update Rule]]''' - changes the progress of a game objective
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
-*'''[[#IT CancelEnhancedPath|IT CancelEnhancedPath]]''' - cancels an active EIT path
+*'''[[How to Use Parent and Child Rules]]'''
-*'''[[#IT SetPath|IT SetPath]]''' - sets an active IT or EIT path
-*'''[[#IT SetPathAndWaitActive|IT SetPathAndWaitActive]]''' - sets an active IT or EIT path and waits until it is active
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
+=='''Objective Update Rule'''==
-=='''RemoveMissionCode (SP2 and Later) '''==
 </td>
 </tr>
 </table>
-<table>
-<tr valign="top">
-<td>[[file:CMD_RemoveMissionCode.PNG|50px|link=]]</td>
-<td>Removes a mission code (a sequence of IT or EIT paths) from any mission codes already loaded for the train. The mission code must be set by the '''Mission Code Manager Rule (SP2 and Later)''' and given to the driver by the '''SetMissionCode (SP2 and later)''' or '''AddMissionCode (SP2 and Later)''' driver commands or by the '''Mission Code Manager Rule (SP2 and Later)''' itself</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
-*'''<kuid2:61392:8204:56> RemoveMissionCode (SP2 and later)'''
+Changes progress of an objective outcome created with the '''Objective Add Rule''' according to Property choices
-*'''DLS Command''' by '''pguy'''
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+*'''<kuid:401543:2002>'''
-   '''''<mission codes>''''' - select a mission code from the Session list
+*'''Base Rule'''
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-:The mission code must be created by the '''Mission Code Manager Rule (SP2 and Later)''' using paths created with '''Interlocking Towers'''
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+    '''Unique Objective ID ''<value>''''' - enter the unique ID created with the '''Objective Add Rule'''
-*'''[[#AddMissionCode (SP2 and Later)|AddMissionCode (SP2 and Later)]]''' - adds another mission code to the train
+    '''Mode ''<select>''''' - select one from the following options
-*'''[[#SetMissionCode (SP2 and Later)|SetMissionCode (SP2 and Later)]]''' - removes a mission code from those already set for the train
+       '''''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:PageLink3.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Required Session Rules:</span><br>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-:'''Rules that MUST be added to the Session for this Driver Command to operate'''
+*'''[[#Objective Add Rule|Objective Add Rule]]''' - sets up a game objective
-*'''[[Session_Rule_List_with_Parameters#MissionCode_Manager_Rule_.28SP2_and_later.29|Mission Code Manager Rule (SP2 and later)]]'''
+*'''[[#Objective Check Rule|Objective Check Rule]]''' - executes child rules if an objective is completed
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
+=='''Ranked Session Begin Rule'''==
-=='''SetMissionCode (SP2 and Later) '''==
 </td>
 </tr>
 </table>
-<table>
+Begins a ranked Session
-<tr valign="top">
-<td>[[file:CMD_SetMissionCode.PNG|50px|link=]]</td>
-<td>Sets a mission code (a sequence of IT or EIT paths) for the train. The mission code must be set by the '''Mission Code Manager Rule (SP2 and Later)'''. Mission codes can also be given to trains in Surveyor or Driver mode through the '''Mission Code Manager Rule (SP2 and Later)'''</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''<kuid2:61392:8201:56> SetMissionCode (SP2 and later)'''
+*'''<kuid:401543:2031>'''
-*'''DLS Command''' by '''pguy'''
+*'''Base Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-   '''''<*Reset mission code>''''' - resets the currently loaded mission code, or
+    '''Countdown Starting Value ''<value>'''''
-   '''''<mission codes>''''' - select a mission code from the Session list
+       '''''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'''
 [[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
-:The mission code must be created by the '''Mission Code Manager Rule (SP2 and Later)''' using paths created with '''Interlocking Towers'''
+:Times are Trainz clock time, not real time
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
-*'''[[#AddMissionCode (SP2 and Later)|AddMissionCode (SP2 and Later)]]''' - adds another mission code to the train
-*'''[[#RemoveMissionCode (SP2 and Later)|RemoveMissionCode (SP2 and Later)]]''' - sets a mission code for the train
-[[file:PageLink3.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Required Session Rules:</span><br>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-:'''Rules that MUST be added to the Session for this Driver Command to operate'''
+*'''[[#Ranked Session Complete Rule|Ranked Session Complete Rule]]''' - completes the active ranked Session
-*'''[[Session_Rule_List_with_Parameters#MissionCode_Manager_Rule_.28SP2_and_later.29|Mission Code Manager Rule (SP2 and later)]]'''
 <br>
-<table bgcolor=#a8ff8a>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-'''[[#top|Back to Top]]'''
+=='''Ranked Session Complete Rule'''==
 </td>
 </tr>
 </table>
-<table width="100%" bgcolor=#a8ff8a>
+Completes the active ranked Session
-<tr>
-<td>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:401543:2032>'''
+*'''Base Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''Set the active ranked session as:''' - select one of two option buttons:-
+       '''( ) Complete'''
+       '''( ) Failed'''
+    '''[x] Customize the completion message ''<text>''''' - enter a text message
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#Ranked Session Begin Rule|Ranked Session Begin Rule]]''' - begins a ranked Session
-='''Junction and Signal Commands'''=
-</td>
-</tr>
-</table>
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''ControlJunction'''==
+=='''Resource Check Rule'''==
 </td>
 </tr>
 </table>
-<table>
+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'''
-<tr valign="top">
-<td>[[file:CMD_ControlJunction.png|50px|link=]]</td>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-<td>Sets the direction for a single specified junction switch.</td>
-</tr>
+*'''<kuid:-25:1067>'''
-</table>
+*'''Legacy Rule''' (replaced by '''Multiple Resource Check Rule''')
+*'''Built-in Rule'''
+*'''Parent Rule'''
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-*'''<kuid:131986:1011> ControlJunction'''
+    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'''
-*'''DLS Command''' by '''atilabarut'''
+[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+: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:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#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
-   '''Select switch direction''', one of '''''<LEFT/RIGHT/FORWARD>'''''
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
-      '''Select ''<switch name>''''' from the session list
+*'''[[How to Use Parent and Child Rules]]'''
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Resource_Check_Rule</span>'''
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
-*'''[[#SetOneJunction|SetOneJunction]]''' - sets the direction for a single specified junction switch
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''SetOneJunction'''==
+=='''Resource Verify Rule (fixed)'''==
 </td>
 </tr>
 </table>
-<table>
+Executes child rules if a selected industry or vehicle reaches a set commodity level. The rule resets when all child rules have completed.
-<tr valign="top">
-<td>[[file:CMD_SetOneJunction.png|50px|link=]]</td>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-<td>Sets the direction for a single specified junction switch.</td>
-</tr>
+*'''<kuid:160293:10060>'''
-</table>
+*'''DLS Rule''' by '''trev999
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+*'''Parent Rule'''
-*'''<kuid:121843:100445> SetOneJunction'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-*'''DLS Command''' by '''pitkin'''
+    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'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+#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''.
-   '''Select ''<switch name>''''' from the session list
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-      '''Select switch direction''', one of ''<LEFT/RIGHT/FORWARD/BACKWARD>'''''
+*'''[[#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
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
-*'''[[#ControlJunction|ControlJunction]]''' - sets the direction for a single specified junction switch
+*'''[[How to Use Parent and Child Rules]]'''
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Set Signal Ahead'''==
+=='''Station Visited Check Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Executes child rules if specific trains call at set stations or industries
-<tr valign="top">
-<td>[[file:CMD_SignalAhead.png|50px|link=]]</td>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-<td>Sets the state of the next signal ahead.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+*'''<kuid2:60850:89005:3>'''
-*'''<kuid2:368725:60003:6> Set Signal Ahead'''
+*'''Built-in Rule'''
-*'''DLS Command''' by '''elstoko'''
+*'''Parent Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-   '''''<Set next signal to>''''' - select one from
+    '''Trigger: ''<select>''''' - click to select one of the following
-      '''''<Stop>'''''
+       '''''Never''''' - stopping at the selected industries will never trigger the rule.
-      '''''<Caution Straight>'''''
+       '''''Once only''''' - the rule is triggered on the first visit only to any one of the selected industries
-      '''''<Caution Left>'''''
+       '''''Once per industry''''' - the rule is triggered on the first visit to each industry with each individual product
-      '''''<Caution Right>'''''
+       '''''Once per visit''''' - the rule is triggered on the first visit to each industry regardless of the product
-      '''''<Proceed Straight>'''''
+       '''''Once per vehicle''''' - each vehicle can only trigger the rule once.
-      '''''<Proceed Left>'''''
+    '''''<select industry>''''' - select industry or industries from session list
-      '''''<Proceed Right>'''''
+    Select one of two option buttons:-
-      '''''<Advance Caution>'''''
+       '''( ) click to accept all trains'''
-      '''''<Call on 1 (State 9)>'''''
+       '''( ) click to accept trains matching specific criteria'''
-      '''''<Call on 2 (State 10)>'''''
+          Selecting the second option will produce the following selection controls:-
-      '''''<Automatic>'''''
+          '''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:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
-#This command only works on signals that will respond to the function "SetSignalStateEx", not all signals will respond
+*'''[[How to Use Parent and Child Rules]]'''
-#The signal must support the selected state otherwise there will be no change
-#The signal will be reset after the train has cleared the signal
 <br>
-<table bgcolor=#a8ff8a>
+<table width="100%" bgcolor=#ffff88>
 <tr>
 <td>
@@ Line 423: / Line 483: @@
 </table>
-<table width="100%" bgcolor=#a8ff8a>
+<table width="100%" bgcolor=#ffff88>
 <tr>
 <td>
-='''Load and Unload Commands'''=
+='''Camera Rules'''=
 </td>
 </tr>
@@ Line 432: / Line 492: @@
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Instant Load'''==
+=='''Cinematic Camera Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Provides several different cinematic style cameras with animations. Best used at the start of a session.
-<tr valign="top">
+Use the '''Trackside Camera''' (tracking view) found in the '''Set Camera Rule''' during session play.
-<td>[[file:CMD_InstantLoad.png|50px|link=]]</td>
-<td>Instantly loads all rolling stock (except locos and tenders) in the train with the item(s) in their commodity queues.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''<kuid2:45324:555017:7> Instant Load Command'''
+*'''<kuid2:401543:1166:3>'''
-*'''DLS Command''' by '''norfolksouthern37'''
+*'''Built-in Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-  '''None'''
+    '''[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
+[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+:Times are Trainz clock times, not real times
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#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
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''InstantLoadLocos'''==
+=='''Focus Camera Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Sets the initial camera view and starting vehicle for a session.
-<tr valign="top">
-<td>[[file:CMD_InstantLoadLocos.png|50px|link=]]</td>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-<td>Instantly loads all locos and tenders in the train with the item(s) in their commodity queues (coal, water, diesel fuel).</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+*'''<kuid2:122381:10014:1>'''
-*'''<kuid2:117290:1022:1> InstantLoadLocos'''
+*'''DLS Rule''' by '''mizi'''
-*'''Built-in Command''' by '''nzhorse'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+    '''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
- '''None'''
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#Cinematic Camera Rule|Cinematic Camera Rule]]''' - provides several different cinematic style cameras with animations
+*'''[[#Set Camera Rule|Set Camera Rule]]''' - sets the target object and properties of the camera
+*'''[[#Wait for Camera View Mode Rule|Wait for Camera View Mode Rule]]''' - executes child rules when the camera view is changed
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''InstantUnLoad'''==
+=='''Set Camera Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Sets the target object and properties of the camera.
-<tr valign="top">
-<td>[[file:CMD_InstantUnLoad.png|50px|link=]]</td>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-<td>Instantly unloads the commodities in all rolling stock (except locos and tenders) in the train.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+*'''<kuid:-25:179>'''
-*'''<kuid2:67585:1021:2> InstantUnload'''
+*'''Built-in Rule'''
-*'''DLS Command''' by '''robin_hoods'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+    '''[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
- '''None'''
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#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
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Load'''==
+=='''Wait for Camera View Mode Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Executes child rules when the camera view is changed to a selected view
-<tr valign="top">
-<td>[[file:CMD_Load.png|50px|link=]]</td>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-<td>Instructs the AI driver to load the commodity or commodities waiting at an industry enabled asset into the rolling stock assets that have been configured to receive them. This may involve the AI driver moving the train forward a few wagons at a time until the entire length of the train has passed through the loading area. The '''Load''' command is also used for loading (and unloading) passengers at passenger enabled stations.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+*'''<kuid:-25:192>'''
-*'''<kuid:-3:10076> Load'''
+*'''Built-in Rule'''
-*'''Base Command'''
+*'''Parent Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
- '''None'''
+    '''[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
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-#If the industry where the loading is taking place uses up all the available commodities before all the wagons are fully loaded, then any following wagons will not be loaded until the commodity is available again but the AI driver will not stop to wait.
+*'''[[#Cinematic Camera Rule|Cinematic Camera Rule]]''' - provides several different cinematic style cameras with animations
-#With passenger enabled stations the '''Load''' command will first execute an '''Unload''' command to unload some of the passengers.
+*'''[[#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
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''[[How to Use Parent and Child Rules]]'''
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width="100%" bgcolor=#ffff88>
+<tr>
+<td>
+'''[[#top|Back to Top]]'''
+</td>
+</tr>
+</table>
+<table width="100%" bgcolor=#ffff88>
 <tr>
 <td>
-=='''Load At'''==
+='''Danger, Derailment and Safety Rules'''=
 </td>
 </tr>
 </table>
-<table>
+<br>
-<tr valign="top">
+<table width=100% width=100% bgcolor=#ffffcc>
-<td>[[file:CMD_IndustryIcon.png|50px|link=]]</td>
+<tr>
-<td>Combines the '''Drive To''' and '''Load''' commands. Instructs the AI driver to drive to an industry (or passenger enabled station) and load the commodity or commodities waiting there into the rolling stock assets that have been configured to receive them. This may involve the AI driver moving the train forward a few wagons at a time until the entire length of the train has passed through the loading area. The '''Load At''' command is also used for loading (and unloading) passengers at passenger enabled stations. All signals and speed signs are obeyed during the "Drive To" operation.</td>
+<td>
+=='''ATP Speed Limiter Rule'''==
+</td>
 </tr>
 </table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+Limits allowable speed over set limit
-*'''<kuid2:75377:84:1> Load At'''
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''DLS Command''' by '''stagecoach'''
+*'''<kuid2:321959:1000:1>'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+*'''Built-in Rule'''
- Select '''<name of industry>''' or industry enabled passenger station from the session list
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-   if applicable '''<name/number of track or platform>''' for industries and stations that have identified active platforms, tracks or loading bays
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+    '''Limits the speed to ''<value>'' mph over the set limit''' - enter speed value in mph
-#The AI driver will select the shortest available path to the destination.
-#If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will not attempt to find an alternative path to the destination. This can lead to the train stopping and waiting indefinately until the blockage is removed.
-#If the industry where the loading is taking place uses up all the available commodities before all the wagons are fully loaded, then any following wagons will not be loaded until the commodity is available again but the AI driver will not stop to wait.
-#With passenger enabled stations the '''Load''' command will first execute an '''Unload''' command to unload some of the passengers.
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-*'''[[#Drive To|Drive To]]''' - drives to an industry but does not seek alternative paths if blocked
+*'''[[#AWS Configuration Rule|AWS Configuration Rule]]''' - configures the Trainz implementation of the Automatic Warning System when approaching signals
-*'''[[#Load|Load]]''' - loads commodities at an industry (including a station)
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Terminate Passenger Train'''==
+=='''AWS Configuration Rule'''==
 </td>
 </tr>
 </table>
-<table>
+This rule configures the Trainz implementation of the Automatic Warning System when approaching signals
-<tr valign="top">
-<td>[[file:CMD_TerminateTrain.png|50px|link=]]</td>
-<td>An '''Unload''' command for passenger trains arriving at a terminal station. The train will be emptied of passengers.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''<kuid2:116387:16:2> Terminate Passenger Train'''
+*'''<kuid2:60850:89002:3>'''
-*'''Built-in Command''' by '''maggs'''
+*'''Built-in Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
- '''None'''
+    Select one of three option buttons:-
+       '''( ) Active'''
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+       '''( ) Passive'''
-#Issue a '''Drive To''' command (or similar) to the station before using this command. The station must be industry active.
+       '''( ) Passive with HUD hidden'''
+    '''[x] Simulate AWS for unfitted cabs?'''
+    '''[x] Use modern sound set for unfitted cabs?'''
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Unload'''==
+=='''Clean Up Derailed Trains Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Cleans up derailed train cars after a set time delay
-<tr valign="top">
-<td>[[file:CMD_Unload.png|50px|link=]]</td>
-<td>Instructs the AI driver to unload the commodity or commodities loaded in rolling stock assets to the industry enabled asset if it has been configured and is able to receive them. This may involve the AI driver moving the train forward a few wagons at a time until the entire length of the train has passed through the loading area. The '''Unload''' command is also used for unloading passengers at passenger enabled stations.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''<kuid:-3:10077> Unload'''
+*'''<kuid2:60850:89003:1>'''
-*'''Base Command'''
+*'''Base Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
- '''None'''
+    '''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
 [[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
-#If the industry where the unloading is taking place reaches its maximum capacity before all the wagons are fully unloaded, then any following wagons will not be unloaded until capacity is available again but the AI driver will not stop to wait.
+:Time is Trainz clock time, not real time.
-#With passenger enabled stations the '''Unload''' command will unload a set number of passengers, specifically:-
-::*Terminal stations = 100% of loaded passengers
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-::*Large stations = 50%
+*'''[[#Replace Missing Vehicles Rule|Replace Missing Vehicles Rule]]''' - creates a replacement train after a derailment
-::*Standard stations = 25%
+*'''[[#Wait for Derailment Rule|Wait for Derailment Rule]]''' - executes child rules when a derailment occurs
-::*Small stations = 10%
-:::The station size is set in the station properties
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Clean_up_Derailed_Trains_Rule</span>'''
 <br>
-<table bgcolor=#a8ff8a>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-'''[[#top|Back to Top]]'''
+=='''Coupler Breakage Check Rule'''==
 </td>
 </tr>
 </table>
-<table width="100%" bgcolor=#a8ff8a>
+Executes child rules if there is a coupler breakage
-<tr>
-<td>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-='''Movement Commands'''=
-</td>
+*'''<kuid2:447264:1017:1>'''
-</tr>
-</table>
-<br>
+*'''Built-in Rule'''
-<table width=100% bgcolor=#d7ffc9>
-<tr>
-<td>
-=='''AI Wait Until Green Signal'''==
-</td>
-</tr>
-</table>
-<table>
+*'''Parent Rule'''
-<tr valign="top">
-<td>[[file:CMD_WaitUntilGreen.png|50px|link=]]</td>
-<td>Instructs the AI driver to wait for a green signal ahead before executing the next driver command. The interface for this driver command is in Russian.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-*'''<kuid2:151055:100101:3> AI Wait until green signal'''
+    '''None'''
-*'''DLS Command''' by '''erendir'''
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#Coupler Breakage HUD Rule|Coupler Breakage HUD Rule]]''' - adds a coupler stress and breakage warning to the HUD
+*'''[[#Set Coupler Masks Rule|Set Coupler Masks Rule]]''' - sets the coupling/decoupling masks on selected vehicles
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
-   '''Ждать, пока не будет зелёный >''' - Translation: "Wait until it is green >"
+*'''[[How to Use Parent and Child Rules]]'''
-      '''На любом светофоре''' - Translation: "At any traffic light" - select for the next signal up to 3000m ahead
-      '''Только на станционном зале " Z7 " /Су''' - Translation: "Only at the station hall " Z7 " / su" - unknown meaning
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Change Train Direction'''==
+=='''Coupler Breakage HUD Rule'''==
 </td>
 </tr>
 </table>
-<table>
+HUD displays warning about coupler stress and breakage
-<tr valign="top">
-<td>[[file:CMD_ChangeDirection.png|50px|link=]]</td>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-<td>Reverses the driving direction of the train.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+*'''<kuid:-25:423>'''
-*'''<kuid2:70791:9001:1> Change Train Direction'''
+*'''Built-in Rule'''
-*'''Built-in Command''' by '''mgalling'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+    Select one of two option buttons:-
+       '''( ) Show the Coupler Breakage Display'''
+       '''( ) Hide the Coupler Breakage Display'''
- '''None'''
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#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
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Halt Train'''==
+=='''Junction Derailment Prevention Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Sets opposing (trailing) junctions ahead of a train to prevent derailments.  Works with both AI and manually driven trains.
-<tr valign="top">
-<td>[[file:CMD_HaltTrain.png|50px|link=]]</td>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-<td>Brings the train to an immediate stop.</td>
-</tr>
+*'''<kuid2:121843:100282:1>'''
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+*'''DLS Rule''' by '''pitkin'''
-*'''<kuid:401543:1090> Halt Train'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-*'''Base Command'''
+    '''None'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+:This rule will not overrule a junction already locked by another AI train or locked against AI control using the '''Set Junctions Rule'''.
- '''None'''
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#Control Path Rule|Control Path Rule]]''' - sets the path for selected trains
+*'''[[#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).
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Set Max Speed To'''==
+=='''Replace Missing Vehicles Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Produces new trains to replace missing vehicles that have been removed from the session by the '''Clean Up Derailed Trains Rule'''
-<tr valign="top">
-<td>[[file:CMD_MaxSpeed.png|50px|link=]]</td>
-<td>Instructs the AI driver to drive up to the set maximum speed (mph). This speed limit has no effect on other AI trains. Lower speed limit signs are obeyed.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
-*'''<kuid2:450022:90001:2> Set Max Speed To'''
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''DLS Command''' by '''nikkia'''
+*'''<kuid:447264:1214>'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+*'''Built-in Rule'''
- Select '''<No maximum speed>''' or '''<value>''' in mph
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+    '''[x] Respawn trains if they are abandoned for 10 minutes'''
-:The maximum speed, once set, will remain in place throughout the session unless cancelled or reset by another '''Set Max Speed To''' command.
+    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
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-*'''[[#Set Max Speed To (km/h)|Set Max Speed To (km/h)]]''' - set the maximum speed in km/h
+*'''[[#Clean Up Derailed Trains Rule|Clean Up Derailed Trains Rule]]''' - cleans up derailed train cars after a set time delay
+*'''[[#Wait for Derailment Rule|Wait for Derailment Rule]]''' - executes child rules when a derailment occurs
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Set Max Speed To (km/h)'''==
+=='''Safety System Engaged Check Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Executes child rules if safety systems are applied.
-<tr valign="top">
-<td>[[file:CMD_MaxSpeed.png|50px|link=]]</td>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-<td>Instructs the AI driver to drive up to the set maximum speed (km/h). This speed limit has no effect on other AI trains. Lower speed limit signs are obeyed.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+*'''<kuid:447264:1216>'''
-*'''<kuid:450022:90002> Set Max Speed To (km/h)'''
+*'''Built-in Rule'''
-*'''DLS Command''' by '''nikkia'''
+*'''Parent Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
- Select '''<No maximum speed>''' or '''<value>''' in km/h
+    '''[x] Trigger only once'''
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-:The maximum speed, once set, will remain in place throughout the session unless cancelled or reset by another '''Set Max Speed To''' command.
+*'''[[#Safety System Isolated Check Rule|Safety System Isolated Check Rule]]''' - executes child rules if safety systems have been isolated
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
-*'''[[#Set Max Speed To|Set Max Speed To]]''' - set the maximum speed in mph
+*'''[[How to Use Parent and Child Rules]]'''
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''WaitFor'''==
+=='''Safety System Isolated Check Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Executes child rules if safety systems are isolated (disengaged).
-<tr valign="top">
-<td>[[file:CMD_WaitFor.png|50px|link=]]</td>
-<td>Instructs the AI driver to wait for a set time period before executing the next instruction in the command list.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''<kuid:-3:10090> WaitFor'''
+*'''<kuid:447264:1217>'''
-*'''Base Command'''
+*'''Built-in Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+*'''Parent Rule'''
- Select '''<time delay>''' from list
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+    '''[x] Trigger only once'''
-:There are a limited range of available times from 5 seconds to 1 hour. A time delay that is not in this list (e.g. 3 minutes) can be achieved by using two (or more) '''WaitFor''' commands with the combined total of their times equaling the required time delay.
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#Safety System Engaged Check Rule|Safety System Engaged Check Rule]]''' - executes child rules if safety systems have been engaged
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
-*'''[[#Wait Until II|Wait Until II]]''' - sets the wait to a set clock time
+*'''[[How to Use Parent and Child Rules]]'''
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
+=='''Set Coupler Masks Rule'''==
-=='''WaitForTrigger'''==
 </td>
 </tr>
 </table>
-<table>
+Set the coupling/decoupling  masks on the selected vehicles
-<tr valign="top">
-<td>[[file:CMD_WaitForTrigger.png|50px|link=]]</td>
-<td>Instructs the AI driver to wait for a trigger event before executing the next instruction in the command list. The train triggering the event can be any train in the session.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''<kuid2:57344:80001:5> WaitFor'''
+*'''<kuid:-25:980>'''
-*'''Built-in Command''' by '''marinus'''
+*'''Built-in Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
- Select '''<trigger name>''' from the session list
+    '''''<Add vehicle>''''' - click to select a vehicle from the session list
-     Select '''<any train>''' or locomotive from '''<list of locomotive names>'''
+     '''''<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
-[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-*The presence of a large number of locos in a session can cause this command to fail due to a timeout error
+*'''[[#Coupler Breakage Check Rule|Coupler Breakage Check Rule]]''' - executes child rules when a coupler breaks
+*'''[[#Coupler Breakage HUD Rule|Coupler Breakage HUD Rule]]''' - adds a coupler stress and breakage warning to the HUD
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
-*Command will not appear in a drivers command list if there are no triggers set
 <br>
-<table width="100%" bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Wait Until II'''==
+=='''Signal Passed At Danger Check Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Executes child rules if a signal or stop mark is ''Passed at Danger (STOP)''.
-<tr valign="top">
-<td>[[file:CMD_WaitUntilII.png|50px|link=]]</td>
-<td>Instructs the AI driver to wait until the specified time</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''<kuid:32711:100025> Wait Until II'''
+*'''<kuid2:60850:89007:2>'''
-*'''Built-in Command''' by '''dap'''
+*'''Built-in Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+*'''Parent Rule'''
- Select '''<hours>''' 1 to 24
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-    Select '''<minutesx10>''' minutes 0 to 50 in increments of 10
-       Select '''<minutesx1>''' minutes 0 to 9
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+    '''[x] Trigger only once'''
-* If the driver is running up to 4 hours late this command will terminate immediately
-* If the wait until time is more than 4 hours behind the game time, the command will wait until tomorrow
-* The game time rate must be set to x1 (normal speed) for the command to work correctly
-* Run-time editing is not available for this command. To edit in Driver the command must be removed first
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
-*'''[[#WaitFor|WaitFor]]''' - sets the wait period for up to 1 hour
+*'''[[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]]
-<br>
-<table bgcolor=#a8ff8a>
-<tr>
-<td>
-'''[[#top|Back to Top]]'''
-='''Navigation Commands'''=
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
-</td>
+*'''[[How to Use Parent and Child Rules]]'''
-</tr>
-</table>
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''AutoDrivePastSignal'''==
+=='''Speeding Check Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Executes child rules if player controlled trains are over the local speed limit or over a set (custom) speed
-<tr valign="top">
-<td>[[file:CMD_AutoDrivePastSignal.png|50px|link=]]</td>
-<td>Instructs the AI driver to drive under '''Autopilot''' until the entire train clears the specified signal but the AI will not set any junction switches so the train will follow whatever path is set ahead of it. All signals and speed signs are obeyed. The train will slow to a halt after passing the signal.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''<kuid2:61392:7101:1> AutoDrivePastSignal Command'''
+*'''<kuid2:60850:89004:3>'''
-*'''DLS Command''' by '''pguy'''
+*'''Built-in Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+*'''Parent Rule'''
-   Select '''''<signal name>''''' from Session list
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+    Select one of two options to set a speed limit to be observed
-*It is the users responsibility to set all junction switches ahead of the train. The AI will not set the switches
+       '''( ) 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'''
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
-*'''[[#AutoPilot|AutoPilot]]''' - drives continuously or until a specified trackmark has been passed
+*'''[[How to Use Parent and Child Rules]]'''
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
+=='''Vehicle Physics Rule'''==
-=='''Autopilot'''==
 </td>
 </tr>
 </table>
-<table>
+Overrides the default vehicle physics properties for all vehicles or for those matching set criteria
-<tr valign="top">
-<td>[[file:CMD_AutoPilot.png|50px|link=]]</td>
-<td>Instructs the AI driver to drive but the AI will not set any junction switches so the train will follow whatever path is set ahead of it. All signals and speed signs are obeyed.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
-*'''<kuid2:71155:60001:5> Autopilot Command'''
-*'''DLS Command''' by '''_mutton_'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
- Select one of
+*'''<kuid:-25:1052>'''
-    '''<activate>''' - starts the Autopilot Command. This will only terminate when the '''Autopilot Command''' is removed from the driver command line
-    '''<stop at track mark>''' - select a trackmark from the session list. Starts the Autopilot Command and drives until the train reaches the selected trackmark (see '''Notes''' below)
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+*'''Built-in Rule'''
-#It is the users responsibility to set all junction switches ahead of the train. The AI will not set the switches
-#If the '''Stop at track mark''' option is used then:-
-:*the train will not set a path to the track mark, that is the users responsibility
-:*the train will run at the full posted line speed upto the track mark and then it will slow to a stop
-:*if the track mark is never reached because the correct path has not been set, the train will continue as it would for the '''activate''' option
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-*'''[[#AutoDrivePastSignal|AutoDrivePastSignal]]''' - drives until a specified signal has been passed
+    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 %
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Drive To'''==
+=='''Wait for Derailment Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Executes child rules when a derailment occurs
-<tr valign="top">
-<td>[[file:CMD_IndustryIcon.png|50px|link=]]</td>
-<td>Instructs the AI driver to Drive, via the shortest available path, to the designated Industry (including Passenger Stations). Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will '''NOT''' attempt to find a way around blockages when calculating the shortest path to the industry. All signals and speed signs are obeyed.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''<kuid:-3:11058> Drive To'''
+*'''<kuid:-25:1053>'''
-*'''Base Command'''
+*'''Built-in Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+*'''Parent Rule'''
- Select '''<name of industry>''' or industry enabled passenger station from the session list
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-   if applicable '''<name/number of track or platform>''' for industries and stations that have identified active platforms, tracks or loading bays
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+    '''[x] Trigger derailment watch once''' - check to execute the rule once only
-:If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will not attempt to find an alternative path to the destination. This can lead to the train stopping and waiting indefinately until the blockage is removed.
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-*'''[[#Navigate To|Navigate To]]''' - will seek alternative paths if blocked
+*'''[[#Clean Up Derailed Trains Rule|Clean Up Derailed Trains Rule]]''' - cleans up derailed train cars after a set time delay
+*'''[[#Replace Missing Vehicles Rule|Replace Missing Vehicles Rule]]''' - creates a replacement train after a derailment
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''[[How to Use Parent and Child Rules]]'''
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width="100%" bgcolor=#ffff88>
 <tr>
 <td>
-=='''Drive To Trackmark'''==
+'''[[#top|Back to Top]]'''
 </td>
 </tr>
 </table>
-<table>
+<table width="100%" bgcolor=#ffff88>
-<tr valign="top">
+<tr>
-<td>[[file:CMD_NavigateTo.png|50px|link=]]</td>
+<td>
-<td>Instructs the AI driver to Drive, via the shortest available path, to the designated Trackmark. Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will '''NOT''' attempt to find a way around blockages when calculating the shortest path to the trackmark. All signals and speed signs are obeyed.</td>
+='''Driver Rules'''=
+</td>
 </tr>
 </table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
-*'''<kuid:-3:11149> Drive To Trackmark'''
+<tr>
+<td>
+=='''AI Start Rule'''==
+</td>
+</tr>
+</table>
-*'''Base Command'''
+Restarts all halted AI controlled trains. Drivers will continue with the commands in their driver command list.
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
- Select '''<name of trackmark>''' from the session list
+*'''<kuid2:400048:100981:1>'''
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+*'''DLS Rule''' by '''callavsg'''
-:If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will not attempt to find an alternative path to the destination. This can lead to the train stopping and waiting indefinately until the blockage is removed.
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-*'''[[#Drive Via Trackmark|Drive Via Trackmark]]''' - drives through trackmark, will NOT seek alternative paths if blocked
-*'''[[#Navigate To Trackmark|Navigate To Trackmark]]''' - stops at trackmark, will seek alternative paths if blocked
-*'''[[#Navigate Via Trackmark|Navigate Via Trackmark]]''' - drives through trackmark, will seek alternative paths if blocked
-[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+    '''None'''
-*'''[[How to Use Track Markers]]'''
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#AI Stop Rule|AI Stop Rule]]''' -  halts all AI drivers
+*'''[[#Disallow AI Rule|Disallow AI Rule]]''' -  cancels all AI driver commands
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
+=='''AI Stop Rule'''==
-=='''Drive Via Trackmark'''==
 </td>
 </tr>
 </table>
-<table>
+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.
-<tr valign="top">
-<td>[[file:CMD_NavigateTo.png|50px|link=]]</td>
-<td>Instructs the AI driver to Drive, via the shortest available path, to and through the designated Trackmark. If there are no further commands then the AI will halt after passing the trackmark. Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will '''NOT''' attempt to find a way around blockages when calculating the shortest path to the trackmark. All signals and speed signs are obeyed.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
-*'''<kuid:-3:11209> Drive Via Trackmark'''
-*'''Base Command'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
- Select '''<name of trackmark>''' from the session list
+*'''<kuid2:400048:100980:1>'''
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+*'''DLS Rule''' by '''callavsg'''
-#This command is used to direct the AI along a set route to a final destination which is not normally the trackmark identified in this command.
-#If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will not attempt to find an alternative path to the designated trackmark. This can lead to the train stopping and waiting indefinately until the blockage is removed.
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-*'''[[#Drive To Trackmark|Drive To Trackmark]]''' - stops at trackmark, will NOT seek alternative paths if blocked
-*'''[[#Navigate To Trackmark|Navigate To Trackmark]]''' - stops at trackmark, will seek alternative paths if blocked
-*'''[[#Navigate Via Trackmark|Navigate Via Trackmark]]''' - drives through trackmark, will seek alternative paths if blocked
-[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+    '''None'''
-*'''[[How to Use Track Markers]]'''
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#AI Start Rule|AI Start Rule]]''' -  restarts all halted AI drivers
+*'''[[#Disallow AI Rule|Disallow AI Rule]]''' -  cancels all AI driver commands
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
+=='''Control Check Rule'''==
-=='''Navigate To'''==
 </td>
 </tr>
 </table>
-<table>
+Executes child rules if the train control method has been altered or a specific method has been selected.
-<tr valign="top">
-<td>[[file:CMD_IndustryIcon.png|50px|link=]]</td>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-<td>Instructs the AI driver to Navigate, via the shortest available path, to the designated Industry (including Passenger Station). Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will attempt to find a way around blockages when calculating the shortest path to the industry. All signals and speed signs are obeyed.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+*'''<kuid:401543:1191>'''
-*'''<kuid:-3:10058> Navigate To'''
+*'''Built-in Rule'''
-*'''Base Command'''
+*'''Parent Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
- Select '''<name of industry>''' or industry enabled passenger station from the session list
+  '''Execute child rules when:''' - select one of two option buttons:-
-   if applicable '''<name/number of track or platform>''' for industries and stations that have identified active platforms, tracks or loading bays
+     '''( ) 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'''
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-:If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will attempt to find an alternative path to the destination. This can lead to the train traveling backwards and down the wrong track.
+*'''[[#Control Type Rule|Control Type Rule]]''' - sets the control method
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
-*'''[[#Drive To|Drive To]]''' - does not seek alternative paths if blocked
+*'''[[How to Use Parent and Child Rules]]'''
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Navigate To Trackmark'''==
+=='''Control Type Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Sets the control method
-<tr valign="top">
-<td>[[file:CMD_NavigateTo.png|50px|link=]]</td>
-<td>Instructs the AI driver to Navigate, via the shortest available path, to the designated Trackmark. Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will attempt to find a way around blockages when calculating the shortest path to the trackmark. All signals and speed signs are obeyed.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
-*'''<kuid:-3:10149> Navigate To Trackmark'''
-*'''Base Command'''
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+*'''<kuid:-16:2030>'''
- Select '''<name of trackmark>''' from the session list
+*'''Base Rule'''
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-:If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will attempt to find an alternative path to the destination. This can lead to the train traveling backwards and down the wrong track.
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+  '''Current control method is: ''<select>''''' - click to select one of
-*'''[[#Drive To Trackmark|Drive To Trackmark]]''' - stops at trackmark, will NOT seek alternative paths if blocked
+     '''''Easy Mode''''' - DCC (standard keyboard and mouse) control
-*'''[[#Drive Via Trackmark|Drive Via Trackmark]]''' - drives through trackmark, will NOT seek alternative paths if blocked
+     '''''Ask User''''' - let the user decide
-*'''[[#Navigate Via Trackmark|Navigate Via Trackmark]]''' - drives through trackmark, will seek alternative paths if blocked
+     '''''Realistic Mode''''' - Cab controls (on screen levers, throttles, buttons, etc)
-[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-*'''[[How to Use Track Markers]]'''
+*'''[[#Control Check Rule|Control Check Rule]]''' - executes child rules if the train control method changes
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
+=='''Disallow AI Rule'''==
-=='''Navigate Via Trackmark'''==
 </td>
 </tr>
 </table>
-<table>
+Cancels (deletes) all current and waiting AI commands for all drivers
-<tr valign="top">
-<td>[[file:CMD_NavigateTo.png|50px|link=]]</td>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-<td>Instructs the AI driver to Drive, via the shortest available path, to and through the designated Trackmark. If there are no further commands then the AI will halt after passing the trackmark. Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will attempt to find a way around blockages when calculating the shortest path to the trackmark. All signals and speed signs are obeyed.</td>
+*'''<kuid:400048:100603>'''
+*'''DLS Rule''' by '''callavsg'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+   '''None'''
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#AI Start Rule|AI Start Rule]]''' -  restarts all halted AI drivers
+*'''[[#AI Stop Rule|AI Stop Rule]]''' -  halts all AI drivers
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Driver Command Check Rule'''==
+</td>
 </tr>
 </table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+Executes child rules if the driver commands match a set list.
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''<kuid:-3:10209> Navigate Via Trackmark'''
+*'''<kuid:-25:447>'''
-*'''Base Command'''
+*'''Built-in Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+*'''Parent Rule'''
- Select '''<name of trackmark>''' from the session list
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+  '''[x] Trigger rule once''' - check to allow the rule to execute only once
-#This command is used to direct the AI along a set route to a final destination which is not normally the trackmark identified in this command.
+  '''Driver character to watch the command list of ''<select>''' - select a driver name from the Session List''
-#If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will attempt to find an alternative path to the designated trackmark. This can lead to the train traveling backwards and down the wrong track.
+  '''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:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-*'''[[#Drive To Trackmark|Drive To Trackmark]]''' - stops at trackmark, will NOT seek alternative paths if blocked
+*'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
-*'''[[#Drive Via Trackmark|Drive Via Trackmark]]''' - drives through trackmark, will NOT seek alternative paths if blocked
+*'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
-*'''[[#Navigate To Trackmark|Navigate To Trackmark]]''' - stops at trackmark, will seek alternative paths if blocked
+*'''[[#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
+*'''[[#ScheduleAtTrackside Rule|ScheduleAtTrackside Rule]]''' - issues set of driver commands at a trackmark or trigger
+*'''[[#Schedule Library Rule|Schedule Library Rule]]''' - creates a library of driver schedules (commands)
+*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
 [[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
-*'''[[How to Use Track Markers]]'''
+*'''[[How to Use Parent and Child Rules]]'''
 <br>
-<table bgcolor=#a8ff8a>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-'''[[#top|Back to Top]]'''
+=='''Driver Command Rule'''==
 </td>
 </tr>
 </table>
-<table width="100%" bgcolor=#a8ff8a>
+Specifies which commands will be available for the drivers
-<tr>
-<td>
-='''Session Management Commands'''=
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-</td>
-</tr>
-</table>
-<br>
+*'''<kuid:-3:10057>'''
-<table width=100% bgcolor=#d7ffc9>
-<tr>
-<td>
-=='''Copy Commands From'''==
-</td>
-</tr>
-</table>
-<table>
+*'''Base Rule'''
-<tr valign="top">
-<td>[[file:CMD_CopyCommandsFrom.png|50px|link=]]</td>
-<td>Copies a driver schedule from a schedule library or another driver.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-*'''<kuid2:192081:1:7> Copy Commands From'''
+    For each installed Driver Command:-
+    '''[x] ''Name of Driver Command'' and ''Description (if available)''''' - check to make that command available to the drivers
-*'''Built-in Command''' by '''brummfondel'''
+[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+: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.
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
+*'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
+*'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
+*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
+*'''[[#ScheduleAtTrackside Rule|ScheduleAtTrackside Rule]]''' - issues set of driver commands at a trackmark or trigger
+*'''[[#Schedule Library Rule|Schedule Library Rule]]''' - creates a library of driver schedules (commands)
+*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
- '''Append''' - '''From Library''' - select a saved schedule from Schedule Library and add it to the end of the current schedule (if any)
+[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
- '''Append''' - '''From Vehicle''' - select a vehicle, copy its driver commands and add them to the end of the current schedule (if any)
+*'''[[How to Use Driver Setup Rule#Driver Command Rule|How to Use Driver Command Rule]]'''
- '''Insert''' - '''From Library''' - select a saved schedule from Schedule Library and insert it into the current schedule (if any)
- '''Insert''' - '''From Vehicle''' - select a vehicle, copy its driver commands and insert them into the current schedule (if any)
-[[file:PageLink3.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Required Session Rules:</span><br>
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
-:'''Rules that MUST be added to the Session for this Driver Command to operate'''
+*'''[[Driver_Commands_List|Driver Commands List]]'''
-*'''[[Session_Rule_List_with_Parameters#Schedule Library Rule|Schedule Library Rule]]'''
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Delete Train'''==
+=='''Driver Main Menu Options Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Show/Hide the Driver Main Menu Bar
-<tr valign="top">
-<td>[[file:CMD_DeleteTrain.png|50px|link=]]</td>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-<td>Deletes the train from the session.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
-*'''<kuid2:116387:15:3> Delete Train'''
+*'''<kuid:-25:448>'''
-*'''Built-in Command''' by '''maggs'''
+*'''Built-in Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
- '''None'''
+    '''''<Show/Hide>'' the Driver Main Menu Bar''' - click '''Show''' or '''Hide''' to select
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Insert Buff Label'''==
+=='''Driver Schedule Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Sets up a list of basic scheduled commands
-<tr valign="top">
-<td>[[file:CMD_InsertBuffLabel.png|50px|link=]]</td>
-<td>Inserts a driver command as a label for a block of driver commands.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''<kuid:160293:101002> Insert buff label'''
+*'''<kuid2:82445:90001:9>'''
-*'''DLS Command''' by '''trev999'''
+*'''Built-in Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''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
- '''Select ''<label number>''''' - select the label number (1 to 10)
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
+*'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
+*'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
+*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
+*'''[[#ScheduleAtTrackside Rule|ScheduleAtTrackside Rule]]''' - issues set of driver commands at a trackmark or trigger
+*'''[[#Schedule Library Rule|Schedule Library Rule]]''' - creates a library of driver schedules (commands)
+*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
-:Up to 10 labels can be inserted into each drivers command list
+*'''[[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]]
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
-*'''[[#Jump to Label|Jump to Label]]''' - unconditionally jumps to a named command label
-*'''[[#Skip if Session-Variable|Skip if Session Variable]]''' - conditionally jumps to the named command label if a selected session variable meets a set condition
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Jump to Label'''==
+=='''Driver Setup Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Creates the list of drivers for this session and assigns them their orders
-<tr valign="top">
-<td>[[file:CMD_JumpToLabel.png|50px|link=]]</td>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-<td>Unconditionally jumps to a named command label.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+*'''<kuid:-16:2025>'''
-*'''<kuid2:160293:101003:2> Jump to label'''
+*'''Base Rule'''
-*'''DLS Command''' by '''trev999'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+    '''''<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
- '''Select ''<label number>''''' - select the label number (1 to 20)
+[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
+#The '''Remove all existing Drivers first''' option does not appear to work in '''TANE''' (but works in '''TRS19''' and later)
+#Adding a large number of drivers to a session can cause ''Timeout'' errors. One known workaround is to split the drivers between two copies of the '''Driver Setup Rule''' and make the second copy a child of a '''Wait Rule'''. For more details see the Wiki '''[[How to Use Driver Setup Rule]]'''. This issue has been reported as '''FIXED''' in the latest '''beta''' versions of '''TRS19 SP1''' and '''Trainz Plus'''
 [[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
-:A '''label''' ('''Insert Buff label''' driver command) with the matching label number must be added to the driver commands
+: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:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#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
+*'''[[#ScheduleAtTrackside Rule|ScheduleAtTrackside Rule]]''' - issues set of driver commands at a trackmark or trigger
+*'''[[#Schedule Library Rule|Schedule Library Rule]]''' - creates a library of driver schedules (commands)
+*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
+[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+*'''[[How to Use Driver Setup Rule]]'''
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
-*'''[[#Insert Buff Label|Insert Buff Label]]''' - inserts a driver command as a label for a block of driver commands
+*'''[[Driver_Commands_List|Driver Commands List]]'''
-*'''[[#Skip if Session-Variable|Skip if Session Variable]]''' - conditionally jumps to the named command label if a selected session variable meets a set condition
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Driver_Setup_Rule</span>'''
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Layer Control'''==
+=='''Enable/Disable Driver Commands Rule'''==
 </td>
 </tr>
 </table>
-<table>
+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
-<tr valign="top">
-<td>[[file:CMD_LayerControl.png|50px|link=]]</td>
-<td>Shows or hides a selected layer.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''<kuid:160293:101080> Layer Control'''
+*'''<kuid:-25:480>'''
-*'''DLS Command''' by '''trev999'''
+*'''Built-in Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
- '''Show ''<list of layers in route and session>''''' - select a layer to make visible
+    '''<Enable/Disable>'' the following driver commands ...''' - click to select '''Enable''' or '''Disable'''
- '''Hide ''<list of layers in route and session>''''' - select a layer to make invisible
+    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
-[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Session Rules:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-*'''[[Session_Rule_List_with_Parameters#Show.2FHide_Layer_Rule|Show/Hide Layer 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
+*'''[[#ScheduleAtTrackside Rule|ScheduleAtTrackside Rule]]''' - issues set of driver commands at a trackmark or trigger
+*'''[[#Schedule Library Rule|Schedule Library Rule]]''' - creates a library of driver schedules (commands)
+*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
-[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
-*'''[[How_to_Use_Layers#Layers_in_Driver_Mode|Layers in Driver Mode]]'''
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Enable/Disable_Driver_Commands_Rule</span>'''
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Move to Train'''==
+=='''JTG Correct Vehicle Lights'''==
 </td>
 </tr>
 </table>
-<table>
+Corrects the brightness of vehicle headlights. Now obsolete.
-<tr valign="top">
-<td>[[file:CMD_MoveToTrain.png|50px|link=]]</td>
-<td>Moves the driver with all their remaining driver commands to another train.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
-*'''<kuid2:71155:60004:2> Move to train'''
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''DLS Command''' by '''_mutton_'''
+*'''<kuid2:478657:999103:1>'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+*'''DLS Rule''' by '''jtg-trainz'''
- '''All trains ''<list of locomotives>''''' - select a locomotive from the Session list
+*''' Obsolete Rule''' (function is now built into '''Trainz''' Driver Additional Tools Menu)
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-#The new train must not already have a driver - make sure that the '''Generate New Drivers for Empty Trains''' option in the '''Driver Setup Rule''' is not ticked.
-#If the new train does already have a driver then the command and any following commands will not be executed.
-[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+    '''None'''
-*'''[[How_to_Use_Driver_Setup_Rule|How to Use the Driver Setup Rule]]'''
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Set Custom HUD (SP2 and later)'''==
+=='''QuickDrive Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Changes the Session settings.
-<tr valign="top">
-<td>[[file:CMD_SetCustomHUD.png|50px|link=]]</td>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-<td>Sets a predefined HUD on the screen.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+*'''<kuid:401543:1184>'''
-*'''<kuid2:61392:7006:37> SetCustomHud (SP2 and later)'''
+*'''Base Rule'''
-*'''DLS Command''' by '''pguy'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+   '''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'''
- '''''<defHud>''''' - select the default HUD
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
- '''''<altHud>''''' - select the alternate HUD
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/QuickDrive_Rule</span>'''
- '''''<named Hud>''''' - select from a number of user defined HUDs
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
-#the '''Quick CustomHud Manager Rule (SP2 and later)''' must be added to a session for a HUD to be selected by this command
-#the default and alternate HUDs are preset but can be edited using the above rule
-#additional user defined and named HUDs can be created with the '''Quick CustomHud Manager Rule (SP2 and later)'''
-[[file:PageLink3.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Required Session Rules:</span><br>
-:'''Rules that MUST be added to the Session for this Driver Command to operate'''
-*'''[[Session_Rule_List_with_Parameters#Quick_CustomHud_Manager_Rule_(SP2_and_later)|Quick CustomHud Manager Rule (SP2 and later)]]'''
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
+=='''ScheduleAtTrackside Rule'''==
-=='''Skip if Session-Variable'''==
 </td>
 </tr>
 </table>
-<table>
+Allows a set of driver commands to be given to a train when it reaches a trackmark or trigger.
-<tr valign="top">
-<td>[[file:CMD_SkipIfSVar.png|50px|link=]]</td>
-<td>Jumps to the named command label if a selected session variable meets a set condition.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
-*'''<kuid2:160293:101014:3> Skip if session-variable'''
-*'''DLS Command''' by '''trev999'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
- '''Select ''<label number if>''''' - select the label number (1 to 20)
+*'''<kuid2:61392:2001:6>'''
-    '''''<Variable Name>''''' - from the '''InputTable Rule'''
-       '''''<condition>''''' - from the '''InputTable Rule'''
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+*'''DLS Rule''' by '''pguy'''
-#The '''InputTable Rule''' must be installed in the session before this command can be used. This rule must be configured to identify the session variable(s), test condition(s) and value(s).
-#A '''label''' ('''Insert Buff Label''' driver command) with the matching label number must be added to the driver commands
-[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-*'''TANE''' Sessions containing driver commands that use variables ''may not'' work correctly when imported into '''TRS19''' and '''Trainz Plus'''. The solution is to delete and then reinsert these commands in the imported Sessions
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+    '''''<Select trackmark>'' - ''<Select trigger>''''' - click one to select a trackmark from the Session list or a trigger from the Session list
-*'''[[#Insert Buff Label|Insert Buff Label]]''' - inserts a driver command as a label for a block of driver commands
+    '''Schedule will be fired ''<in both directions/in trackside forward direction/in trackside backward direction>''''' - click to select one. Only available if '''trackmark''' has been selected
-*'''[[#Jump to Label|Jump to Label]]''' - unconditionally jumps to a named command label
+    '''This rule will be applied ''<all along the session>''''' - click to enter the number of times to trigger the rule. 0 = everytime (all along the session)
+    '''Enter driver commands to schedule when train is at trackside'''
+       '''''>>''''' - click to enter driver commands from those specified in the '''Driver Command Rule'''
+    Select one of two option buttons:-
+       '''( ) new schedule will replace current driver command''' - select to delete any current command list and replace it with the command list above
+       '''( ) new schedule will be appended to current driver commands''' - select to add the command list above above to the current driver command list
+    '''''<add a new trackside entry>''''' - click to add a new '''ScheduleAtTrackside''' entry below
-[[file:PageLink3.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Required Session Rules:</span><br>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-:'''Rules that MUST be added to the Session for this Driver Command to operate'''
+*'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
-*'''[[Session Rule List with Parameters#InputTable Rule|InputTable Rule]]'''
+*'''[[#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
+*'''[[#Schedule Library Rule|Schedule Library Rule]]''' - creates a library of driver schedules (commands)
+*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
+=='''Schedule Library Rule'''==
-=='''Wait Until S-Variable V3'''==
 </td>
 </tr>
 </table>
-<table>
+Creates a library of driver schedules (driver command lists) that can be given to drivers during the creation or running of a session
-<tr valign="top">
-<td>[[file:CMD_WaitSVariable.png|50px|link=]]</td>
-<td>The AI driver will wait until the identified variable matches the condition specified before the next command will be executed</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''<kuid2:160293:101006:3> Wait Until S-variable V3'''
+*'''<kuid2:192081:12:5>'''
-*'''DLS Command''' by '''trev999'''
+*'''Built-in Rule''' by '''brummfondel'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
- '''Select ''<Variable Name>''''' - select the variable name from those entered in the '''InputTable Rule'''
+   '''''<add schedule>''''' | '''''<add group>'''''
-    '''Select <Condition><Value>''''' - select from those entered in the '''InputTable Rule'''
+      To add <u>individual schedules</u> click ''<add schedule>'' then
+        '''''<library Entry Name>''''' - enter a unique name for the schedule
+           '''''<library Entry Name>''''' - click to edit name
+           '''''<remove>''''' - click to delete this schedule from the list
+           '''''<copy>''''' - click to add a copy this schedule to the current group
+           '''''<move to group>''''' - click to move this schedule to a schedule group
+           In the driver command bar:-
+              '''''>>''''' - click to enter driver commands from those specified in the '''Driver Command Rule'''
+       To add <u>groups of schedules</u> click ''<add group>'' then
+        '''''<Group Name>''''' - enter a unique name for the group
+            '''-''' - click to close the group list
+            '''+''' - click to open the group list
+            '''''<Group Name>''''' - click to edit name
+            '''''<remove>''''' - click to delete this group from the schedule list
 [[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
-*The '''InputTable Rule''' must be installed in the session before this command can be used. This rule must be configured to identify the session variable(s), test condition(s) and value(s).
+#Create the library schedules in this rule first.
+#In '''Surveyor''' (using the '''Driver Setup Rule''') or '''Driver''' (directly in a driver command bar) add the Driver Command '''Copy Commands From''' and select the command schedule to be added or appended. The driver command '''Copy Commands From''' must be enabled in the '''Driver Command Rule'''.
-[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
-*'''TANE''' Sessions containing driver commands that use variables ''may not'' work correctly when imported into '''TRS19''' and '''Trainz Plus'''. The solution is to delete and then reinsert these commands in the imported Sessions
-[[file:PageLink3.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Required Session Rules:</span><br>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-:'''Rules that MUST be added to the Session for this Driver Command to operate'''
+*'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
-*'''[[Session Rule List with Parameters#InputTable Rule|InputTable Rule]]'''
+*'''[[#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
+*'''[[#ScheduleAtTrackside Rule|ScheduleAtTrackside Rule]]''' - issues set of driver commands at a trackmark or trigger
+*'''[[#Schedule Rule|Schedule Rule]]''' - applies a schedule of timed events to a train
+[[file:PageLink4.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Dependent Driver Commands:</span>
+:'''The rule must be added to the Session for the following Driver Command to work'''
+*'''[[Driver Commands List#Copy Commands From|Copy Commands From]]'''
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% bgcolor=#ffffcc>
 <tr>
 <td>
+=='''Schedule Rule'''==
-=='''WaitUntilSVariable'''==
 </td>
 </tr>
 </table>
-<table>
+Allows a schedule of timed events to be applied to a train
-<tr valign="top">
-<td>[[file:CMD_WaitSVar.png|50px|link=]]</td>
-<td>The AI driver will wait until the identified variable matches the condition specified before the next command will be executed</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''<kuid2:131986:1006:1> WaitUntilSVariable'''
+*'''<kuid:-3:10185>'''
-*'''DLS Command''' by '''atilabarut'''
+*'''Base Rule'''
-*'''Legacy Command''' has been replaced by '''Wait Until S-Variable'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+    '''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
- '''Select ''<Variable Name><Condition><Value>''''' - from the '''InputTable Rule'''
+[[file:BugMini.PNG|link=]] <span style="text-decoration: underline; font-weight: 700; color: red;">Known Bugs:</span>
+:There are reports that this rule does not work correctly particularly if a train arrives late or early.
 [[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
-*The '''InputTable Rule''' must be installed in the session before this command can be used. This rule must be configured to identify the session variable(s), test condition(s) and value(s).
+:Times are Trainz clock times, not real time
-[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-*'''TANE''' Sessions containing driver commands that use variables ''may not'' work correctly when imported into '''TRS19''' and '''Trainz Plus'''. The solution is to delete and then reinsert these commands in the imported Sessions
+*'''[[#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
+*'''[[#ScheduleAtTrackside Rule|ScheduleAtTrackside Rule]]''' - issues set of driver commands at a trackmark or trigger
+*'''[[#Schedule Library Rule|Schedule Library Rule]]''' - creates a library of driver schedules (commands)
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:WWWLinks.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Other Links:</span>
-*'''[[#Wait Until S-Variable V3|Wait Until S-Variable V3]]''' - AI driver waits for specified variable condition
+*'''<span class="plainlinks">http://www.auran.com/games/gamefiles/trainz/tutorial1.html</span>'''
-[[file:PageLink3.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Required Session Rules:</span><br>
-:'''Rules that MUST be added to the Session for this Driver Command to operate'''
-*'''[[Session Rule List with Parameters#InputTable Rule|InputTable Rule]]'''
 <br>
-<table bgcolor=#a8ff8a>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-'''[[#top|Back to Top]]'''
+=='''Wait for Driver On/Off Train Rule'''==
 </td>
 </tr>
 </table>
-<table width="100%" bgcolor=#a8ff8a>
+Executes child rules when a driver gets on or off a train
-<tr>
-<td>
-='''Train Operation Commands'''=
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-</td>
-</tr>
+*'''<kuid:-25:953>'''
-</table>
+*'''Built-in Rule'''
+*'''Parent Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+  '''[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
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#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
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''[[How to Use Parent and Child Rules]]'''
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Bellz'''==
+=='''Wait for Driver/Train to be Locally Owned Rule'''==
 </td>
 </tr>
 </table>
-<table>
+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 valign="top">
-<td>[[file:CMD_Bellz.png|50px|link=]]</td>
-<td>Rings the train bell.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''<kuid2:66277:80002:1> bellz'''
+*'''<kuid2:401543:1173:1>'''
-*'''Built-in Command''' by '''smileyman'''
+*'''Built-in Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+*'''Parent Rule'''
- '''None'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+  '''Assets Ownership:''' - select one of two option buttons:-
-:the locomotive must be equipped with a working bell.
+     '''( ) Wait for ownership of a specific Driver'''
+     '''( ) Wait for ownership of Driver'''
+  '''Driver or Vehicle ''<select>''''' - choose from session list
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-*'''[[#Hornz|Hornz]]''' - gives a blast of the horn (or whistle)
+*'''[[#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
-*'''[[#HornzExtended|HornzExtended]]''' - gives a specified number of horn blasts
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''[[How to Use Parent and Child Rules]]'''
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width="100%" bgcolor=#ffff88>
+<tr>
+<td>
+'''[[#top|Back to Top]]'''
+</td>
+</tr>
+</table>
+<table width="100%" bgcolor=#ffff88>
 <tr>
 <td>
-=='''Couple'''==
+='''HUD (Heads Up Display) Rules'''=
 </td>
 </tr>
 </table>
-<table>
+<br>
-<tr valign="top">
+<table width=100% width=100% bgcolor=#ffffcc>
-<td>[[file:CMD_Couple.png|50px|link=]]</td>
+<tr>
-<td>The AI driver moves the train (or just the locomotive if it is by itself) to couple with the specified wagon.</td>
+<td>
+=='''Cab Controls HUD Rule'''==
+</td>
 </tr>
 </table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+Was used to provide the HUD controls for the cabin view. Now obsolete.
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''<kuid:-3:10081> Couple'''
+*'''<kuid:-16:287428>'''
-*'''Base Command'''
+*'''Base Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+*'''Obsolete Rule''' (function is now built into '''Trainz''')
-   '''''<list of available wagons>''''' - select a wagon to couple to
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
-#The target wagon must be at the end of a consist or by itself. If the target is coupled in between other wagons then no coupling will take place.
-#There must be a clear path to the target wagon.
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+    '''None'''
-*'''[[#Couple At Trackmark|Couple At Trackmark]]''' - couples to the wagon closest to a specified trackmark
-*'''[[#Decouple|Decouple]]''' - decouples a consist at a specific place (does not work in the '''Driver Setup Rule''')
-*'''[[#Decouple DLX|Decouple DLX]]''' - decouples a consist at a specific, or a random, place. Upto 99 wagons
-*'''[[#Decouple Head N|Decouple Head N]]''' - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
-*'''[[#Decouple Number #|Decouple Number #]]''' - decouples a consist at a specific place. Upto 40 wagons
-*'''[[#Uncouplez|Uncouplez]]''' - decouples the locomotive (or locomotive + tender) from a consist
-*'''[[#UncouplezFrom|UncouplezFrom]]''' - decouples a consist at a specific place. Upto 20 wagons
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Couple At Trackmark'''==
+=='''Coupler Breakage HUD Rule'''==
 </td>
 </tr>
 </table>
-<table>
+HUD displays warning about coupler stress and breakage
-<tr valign="top">
-<td>[[file:CMD_Couple_At_Trackmark.png|50px|link=]]</td>
-<td>The AI driver moves the train (or just the locomotive if it is by itself) to couple with the wagon that is closest to a specified trackmark.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''<kuid:2:57145:81100:1> Couple At Trackmark'''
+*'''<kuid:-25:423>'''
-*'''DLS Command''' by '''marzipan'''
+*'''Built-in Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-   '''''<list of available trackmarks>''''' - select a trackmark
+    Select one of two option buttons:-
+       '''( ) Show the Coupler Breakage Display'''
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+       '''( ) Hide the Coupler Breakage Display'''
-#The end wagon of a consist must be within the effect radius of the trackmark. If there is no wagon with the radius then no coupling will take place.
-#The train will couple to the wagon closest to the trackmark and that may mean navigating to the other end of the consist.
-#There must be a clear path to the target wagon.
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-*'''[[#Couple|Couple]]''' - couples wagons in a consist
+*'''[[#Coupler Breakage Check Rule|Coupler Breakage Check Rule]]''' - executes child rules if a coupler breaks
-*'''[[#Decouple|Decouple]]''' - decouples a consist at a specific place (does not work in the '''Driver Setup Rule''')
+*'''[[#Set Coupler Masks Rule|Set Coupler Masks Rule]]''' - sets the coupling/decoupling masks on selected vehicles
-*'''[[#Decouple DLX|Decouple DLX]]''' - decouples a consist at a specific, or a random, place. Upto 99 wagons
-*'''[[#Decouple Head N|Decouple Head N]]''' - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
-*'''[[#Decouple Number #|Decouple Number #]]''' - decouples a consist at a specific place. Upto 40 wagons
-*'''[[#Uncouplez|Uncouplez]]''' - decouples the locomotive (or locomotive + tender) from a consist
-*'''[[#UncouplezFrom|UncouplezFrom]]''' - decouples a consist at a specific place. Upto 20 wagons
-[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
-*'''[[How to Use Track Markers]]'''
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
+=='''Display Custom HUD Rule'''==
-=='''Decouple'''==
 </td>
 </tr>
 </table>
-<table>
+Show or hide the Custom Heads Up Display.
-<tr valign="top">
-<td>[[file:CMD_Decouple.png|50px|link=]]</td>
-<td>The train is decoupled at the specified wagon (does not work in '''Driver Setup Rule''').</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''<kuid:-3:10082> Decouple'''
+*'''<kuid:-3:10206>'''
-*'''Base Command'''
+*'''Base Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-   '''''<list of available wagons>''''' - select a wagon to decouple from
+    '''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'''
-[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-*This command does not work when added to a driver's command list in the '''Driver Setup Rule''' in Surveyor but it does work when manually added to the driver's command list 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
+*'''[[#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:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
-#If programming a driver via the '''Driver Setup Rule''', use the alternative commands '''Decouple DLX''', '''Decouple Number #''', '''Uncouplez''' or '''UncouplezFrom'''
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Display_Custom_HUD_Rule</span>'''
-#The main problem with using decoupling commands in the '''Driver Setup Rule''' is that the number and identity of the wagons in a consist may not be known when the command is added to a driver's command list.
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
-*'''[[#Couple|Couple]]''' - couples wagons in a consist
-*'''[[#Couple At Trackmark|Couple At Trackmark]]''' - couples to the wagon closest to a specified trackmark
-*'''[[#Decouple DLX|Decouple DLX]]''' - decouples a consist at a specific, or a random, place. Upto 99 wagons
-*'''[[#Decouple Head N|Decouple Head N]]''' - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
-*'''[[#Decouple Number #|Decouple Number #]]''' - decouples a consist at a specific place. Upto 40 wagons
-*'''[[#Uncouplez|Uncouplez]]''' - decouples the locomotive (or locomotive + tender) from a consist
-*'''[[#UncouplezFrom|UncouplezFrom]]''' - decouples a consist at a specific place. Upto 20 wagons
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Decouple DLX'''==
+=='''Flash HUD Icon Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.
-<tr valign="top">
-<td>[[file:CMD_DecoupleDLX.png|50px|link=]]</td>
-<td>The train is decoupled at the specified wagon identified by name or number (upto 99 wagons), or at a random location.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
-*'''<kuid2:160293:100120:2> Decouple DLX'''
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''DLS Command''' by '''trev999'''
+*'''<kuid:-25:968>'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+*'''Built-in Rule'''
-   '''When Used in Surveyor using the Driver Setup Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-      '''''<1-33>''''' - select a wagon numbered 1 to 33 where 1 is the wagon (or tender) immediately following the locomotive
-      '''''<34-66>''''' - select a wagon from 34 to 66
-      '''''<67-99>''''' - select a wagon from 67 to 99
-      '''''<at position determined by>'''''
-         '''''<consist_count>''''' - requires the use of the '''special_instruction''' driver command
-         '''''<a random number>''''' - a random number which may be beyond the last wagon in the consist
-   '''When used in Driver Mode'''
-      '''''<1-33>''''' - each wagon is numbered and named. Select a wagon numbered 1 to 33 (or to the last wagon in that range)
-         where 1 is the wagon (or tender) immediately following the locomotive
-      '''If there are more than 33 wagons, then'''
-         '''''<34-66>''''' - each wagon is numbered and named. Select a wagon from 34 to 66 (or to the last wagon in that range)
-      '''if there are more than 66 wagons, then'''
-         '''''<67-99>''''' - each wagon is numbered and named. Select a wagon from 67 to 99 (or to the last wagon in that range)
-      '''''<at position determined by>'''''
-         '''''<consist_count>''''' - requires the use of the '''special_instruction''' driver command
-         '''''<a random number>''''' - a random number upto and including the last wagon in the consist
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+    Select one of two option buttons:-
-:The main problem with using decoupling commands in the '''Driver Setup Rule''' is that the number and identity of the wagons in a consist may not be known when the command is added to a driver's command list.
+    '''( ) 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:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-*'''[[#Couple|Couple]]''' - couples wagons in a consist
+*'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
-*'''[[#Couple At Trackmark|Couple At Trackmark]]''' - couples to the wagon closest to a specified trackmark
+*'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
-*'''[[#Decouple|Decouple]]''' - decouples a consist at a specific place (does not work in the '''Driver Setup Rule''')
+*'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers
-*'''[[#Decouple Head N|Decouple Head N]]''' - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
+*'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
-*'''[[#Decouple Number #|Decouple Number #]]''' - decouples a consist at a specific place. Upto 40 wagons
+*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
-*'''[[#Uncouplez|Uncouplez]]''' - decouples the locomotive (or locomotive + tender) from a consist
+*'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked
-*'''[[#UncouplezFrom|UncouplezFrom]]''' - decouples a consist at a specific place. Upto 20 wagons
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Decouple Head N'''==
+=='''mc Display Custom HUD V2 Rule (SP2 and later)'''==
 </td>
 </tr>
 </table>
-<table>
+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)'''
-<tr valign="top">
-<td>[[file:CMD_Decouple.png|50px|link=]]</td>
-<td>The train is decoupled to leave the selected number ('''N''') of wagons left in the consist.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''<kuid2:46162:70002:12> Decouple Head N'''
+*'''<kuid2:61392:1072:10>'''
-*'''DLS Command''' by '''josefpav'''
+*'''Legacy Rule''' (replaced by '''Quick CustomHUD Manager Rule (SP2 and later)''')
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+*'''DLS Rule''' by '''pguy'''
-   '''<select wagon number>''' - select the number of wagons (sorted by ASCII code not numerical value) to be left in the consist after the decoupling.
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-= the lead loco only (without its tender), 2 = loco + first wagon (which could be the tender), upto 75.
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+     '''Show or Hide the Custom Heads up Display''' - select one of two option buttons:-
-:The main problem with using decoupling commands in the '''Driver Setup Rule''' is that the number and identity of the wagons in a consist may not be known when the command is added to a driver's command list.
+     '''( ) Show the Custom Heads up Display'''
+     '''( ) Hide the Custom Heads up Display'''
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-*'''[[#Couple|Couple]]''' - couples wagons in a consist
+*'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
-*'''[[#Couple At Trackmark|Couple At Trackmark]]''' - couples to the wagon closest to a specified trackmark
+*'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
-*'''[[#Decouple|Decouple]]''' - decouples a consist at a specific place (does not work in the '''Driver Setup Rule''')
+*'''[[#Quick CustomHud Manager Rule (SP2 and later)|Quick CustomHud Manager Rule (SP2 and later)]]''' - creates custom HUDs that can be assigned to different drivers
-*'''[[#Decouple DLX|Decouple DLX]]''' - decouples a consist at a specific, or a random, place. Upto 99 wagons
+*'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
-*'''[[#Decouple Number #|Decouple Number #]]''' - decouples a consist at a specific place. Upto 40 wagons
+*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
-*'''[[#Uncouplez|Uncouplez]]''' - decouples the locomotive (or locomotive + tender) from a consist
+*'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked
-*'''[[#UncouplezFrom|UncouplezFrom]]''' - decouples a consist at a specific place. Upto 20 wagons
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Decouple Number #'''==
+=='''Quick CustomHud Manager Rule (SP2 and later)'''==
 </td>
 </tr>
 </table>
-<table>
+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)'''
-<tr valign="top">
-<td>[[file:CMD_DecoupleNumber.png|50px|link=]]</td>
-<td>The specified wagon number (#) and any following wagons will be uncoupled from the locomotive and consist.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''<kuid2:147570:80008:1> Decouple number #'''
+*'''<kuid2:61392:5020:47>'''
-*'''Built-in Command''' by '''erniesouchak'''
+*'''DLS Rule''' by '''pguy'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-   '''''<number>''''' - select a wagon number (1-40) to decouple from.
+    '''''<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|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
-#The first locomotive is #1, the second locomotive (if any) or the tender (on a steam locomotive) is #2, etc.
+: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.
-#The main problem with using decoupling commands in the '''Driver Setup Rule''' is that the number and identity of the wagons in a consist may not be known when the command is added to a driver's command list.
+[[file:PageLink4.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Dependent Driver Commands:</span>
+:'''The rule must be added to the Session for the following Driver Commands to work'''
+*'''[[Driver Commands List#Set Custom HUD (SP2 and later)|Set Custom HUD (SP2 and later)]]'''
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-*'''[[#Couple|Couple]]''' - couples wagons in a consist
+*'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
-*'''[[#Couple At Trackmark|Couple At Trackmark]]''' - couples to the wagon closest to a specified trackmark
+*'''[[#Flash HUD Icon Rule|Flash HUD Icon Rule]]''' - flashes a HUD panel icon for a set duration.
-*'''[[#Decouple|Decouple]]''' - decouples a consist at a specific place (does not work in the '''Driver Setup Rule''')
+*'''[[#mc Display Custom HUD V2 Rule (SP2 and later)|mc Display Custom HUD V2 Rule (SP2 and later)]]''' - shows or hides a graphical HUD.
-*'''[[#Decouple DLX|Decouple DLX]]''' - decouples a consist at a specific, or a random, place. Upto 99 wagons
+*'''[[#Show/Hide HUD Panel Rule|Show/Hide HUD Panel Rule]]''' - shows or hides a HUD panel.
-*'''[[#Decouple Head N|Decouple Head N]]''' - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
+*'''[[#Variable Show Rule|Variable Show Rule]]''' - adds or removes a specified variable and a descriptive label to the custom HUD.
-*'''[[#Uncouplez|Uncouplez]]''' - decouples the locomotive (or locomotive + tender) from a consist
+*'''[[#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]''' - executes child rules when a HUD icon is clicked
-*'''[[#UncouplezFrom|UncouplezFrom]]''' - decouples a consist at a specific place. Upto 20 wagons
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Hornz'''==
+=='''Show/Hide HUD Panel Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Shows or hides a HUD panel.
-<tr valign="top">
-<td>[[file:CMD_Hornz.png|50px|link=]]</td>
-<td>Gives one blast of the train horn or whistle.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''<kuid2:66277:80001:2> Hornz'''
+*'''<kuid:-25:1047>'''
-*'''Built-in Command''' by '''smileyman'''
+*'''Built-in Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
- '''None'''
+    '''''<Show/Hide>'' the ''<click to select>'' HUD panel''' - select '''''Show''''' or '''''Hide''''' and then select the HUD panel
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-*'''[[#Bellz|Bellz]]''' - rings the locomotive bell (if it has one)
+*'''[[#Display Custom HUD Rule|Display Custom HUD Rule]]''' - shows or hides the Custom Heads Up Display.
-*'''[[#HornzExtended|HornzExtended]]''' - gives a specified number of horn blasts
+*'''[[#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
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''HornzExtended'''==
+=='''Variable Show Rule'''==
 </td>
 </tr>
 </table>
-<table>
+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.
-<tr valign="top">
-<td>[[file:CMD_HornzExtended.png|50px|link=]]</td>
-<td>Gives a specified number of blasts of the train horn or whistle.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''<kuid:478639:100034> HornzExtended'''
+*'''<kuid:-25:971>'''
-*'''Built-in Command''' by '''ffccnn'''
+*'''Built-in Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
- Select one of '''''<Play once>'''''
+   '''[x] Add'''
-               '''''<Play twice>'''''
+      '''''<variable-name>''''' - enter variable-name to add to HUD. Variable-name is case sensitive.
-               ... up to ...
+      '''''<label>''''' - (optional) enter a short label to be displayed on the HUD in front of the variable value.
-               '''''<Play 10 times>'''''
+   '''[x] Remove'''
+      '''''<variable-name>''''' - enter variable-name to remove from HUD. Variable-name is case sensitive.
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-:When the command is executed, the AI will immediately move onto the next command in the sequence and will blast the horn during the execution of the following driver commands until the set count has been reached
+*'''[[#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:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:Ex.PNG|link=]] '''<u>Examples of Use:</u>'''
-*'''[[#Bellz|Bellz]]''' - rings the locomotive bell (if it has one)
+*'''[[How to Use Variables in Sessions (Examples)]]
-*'''[[#Hornz|Hornz]]''' - gives one blast of the horn or whistle
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''MoveTurntable'''==
+=='''Wait for Click on HUD Icon Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Executes child rules when the user clicks on a selected HUD icon
-<tr valign="top">
-<td>[[file:CMD_MoveTurntable.png|50px|link=]]</td>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-<td>Moves the specified turntable to the specified track position.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+*'''<kuid:-25:951> <kuid:-25:970>''' - two versions built-in with different kuids, both have the same properties
-*'''<kuid2:609850:100018:1> MoveTurntable'''
+*'''Built-in Rule'''
-*'''Built-in Command''' by '''vandragonax'''
+*'''Parent Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-   '''''<name of turntable>''''' - select the named turntable (see '''Notes''' below).
+    '''[x] Trigger Once'''
-   '''''<track #>'' or ''<relative track movement>''''' - select the track number (0 = 1st track) or a relative movement (prev, next)
+    '''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:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-:The '''InputTable Rule''' must be installed in the session before this command can be used. This rule must be configured to identify all the turntables and the number of tracks they have.
+*'''[[#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:PageLink3.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Required Session Rules:</span><br>
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
-:'''Rules that MUST be added to the Session for this Driver Command to operate'''
+*'''[[How to Use Parent and Child Rules]]'''
-*'''[[Session Rule List with Parameters#InputTable Rule|InputTable Rule]]'''
+<br>
+<table width="100%" bgcolor=#ffff88>
+<tr>
+<td>
+'''[[#top|Back to Top]]'''
+</td>
+</tr>
+</table>
-<br>
+<table width="100%" bgcolor=#ffff88>
-<table width=100% bgcolor=#d7ffc9>
 <tr>
 <td>
-=='''Priorityz'''==
+='''Industry Rules'''=
 </td>
 </tr>
 </table>
-<table>
+<br>
-<tr valign="top">
+<table width=100% width=100% bgcolor=#ffffcc>
-<td>[[file:CMD_Priorityz.png|50px|link=]]</td>
+<tr>
-<td>Sets the train priority value.</td>
+<td>
+=='''Advanced Industry Load Configuration Rule'''==
+</td>
 </tr>
 </table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+Locks train controls when loading/unloading at an industry, overrides time settings for begin load and begin unload operations
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''<kuid2:66277:80003:1> priorityz'''
+*'''<kuid:30501:100007>'''
-*'''Built-in Command''' by '''smileyman'''
+*'''Base Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
- '''''<value>''''' - select train priority value 1, 2 or 3
+    '''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
 [[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
-:The Priority value identifies the importance of the train for the '''Priority Trackmarkers'''. Usually (a guide only):-
+:Times are Trainz clock time, not real time
-:*Priority 1 = Express trains
-:*Priority 2 = Local Expresses or Fast Freights
-:*Priority 3 = Slow Local Freights or All Stops Services
-[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
-*'''[[How_to_Use_Track_Priority_Markers|How to Use Track Priority Markers]]'''
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Run Around'''==
+=='''Disable/Enable Industry Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Enables/Disables vehicle load/unload for industry
-<tr valign="top">
-<td>[[file:CMD_RunAround.png|50px|link=]]</td>
-<td>Uncouples the locomotive (plus tender if present) from the train, navigates to the other end of the train and couples to the last wagon.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
-*'''<kuid:-3:10083> Run Around'''
-*'''Base Command'''
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+*'''<kuid2:401543:1171:1>'''
- '''None'''
+*'''Built-in Rule'''
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-#There must be a path for the locomotive to follow from one end of the train to the other.
-#The locomotive must have sufficient clear space, free of track switches and signals, at both ends of the train to perform this movement.
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+   '''Load/unload ''<Disable/Enable>''''' - click to set to '''Disable''' or '''Enable'''
-*'''[[#Run Around Ex|Run Around Ex]]''' - performs the run around only if there is no loco already in position at the other end
+   '''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'''
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Run Around Ex'''==
+=='''ExTrainz Manager Rule - TANE SP2'''==
 </td>
 </tr>
 </table>
-<table>
+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.
-<tr valign="top">
-<td>[[file:CMD_RunAroundEx.png|50px|link=]]</td>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-<td>Uncouples the locomotive(s) (plus tender if present) from the train, navigates to the other end of the train and couples to the last wagon but ONLY if the other end of the train does not already have a locomotive in place.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+*'''<kuid:160293:10029>'''
-*'''<kuid2:117667:83:3> Run Around Ex'''
+*'''DLS Rule''' by '''trev999'''
-*'''DLS Command''' by '''nicroman'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+    '''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.
- '''None'''
+[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
+:This rule is NOT compatible with all industries.
 [[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
-#There must be a path for the locomotive to follow from one end of the train to the other.
+#Rolling stock installed in the current session only (see settings above) can be searched to find a match for any selected product from any industry. In Surveyor (and Driver if that setting is enabled) click on the '''View Products''' sub menu link and click on a product name in the '''Product Window''' to display a list of all compatible rolling stock for that product.
-#The locomotive must have sufficient clear space, free of track switches and signals, at both ends of the train to perform this movement.
+#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.
-#There must be no locomotive already coupled to the destination end of the train.
+#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:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
-*'''[[#Run Around|Run Around]]''' - unconditionally performs the run around
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Uncouplez'''==
+=='''Multiple Resource Check Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Executes child rules if industries or vehicles reach set commodity levels. This rule replaces the older '''Resource Check Rule'''
-<tr valign="top">
-<td>[[file:CMD_Uncouplez.png|50px|link=]]</td>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-<td>Uncouples the locomotive (plus tender if present) from the train.</td>
-</tr>
+*'''<kuid:-25:656>'''
-</table>
+*'''Built-in Rule'''
+*'''Parent Rule'''
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-*'''<kuid2:66277:80000:1> UnCouplez'''
+    '''<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
-*'''Built-in Command''' by '''smileyman'''
+[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+: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:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#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
- '''None'''
+[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+*'''[[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]]'''
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
-*'''[[#Couple|Couple]]''' - couples wagons in a consist
+*'''[[How to Use Parent and Child Rules]]'''
-*'''[[#Couple At Trackmark|Couple At Trackmark]]''' - couples to the wagon closest to a specified trackmark
-*'''[[#Decouple|Decouple]]''' - decouples a consist at a specific place (does not work in the '''Driver Setup Rule''')
-*'''[[#Decouple DLX|Decouple DLX]]''' - decouples a consist at a specific, or a random, place. Upto 99 wagons
-*'''[[#Decouple Head N|Decouple Head N]]''' - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
-*'''[[#Decouple Number #|Decouple Number #]]''' - decouples a consist at a specific place. Upto 40 wagons
-*'''[[#UncouplezFrom|UncouplezFrom]]''' - decouples a consist at a specific place. Upto 20 wagons
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''UncouplezFrom'''==
+=='''Power Station Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Sets up a Power Station and its electricity consumers
-<tr valign="top">
-<td>[[file:CMD_Uncouplez.png|50px|link=]]</td>
-<td>Uncouples the train at the wagon specified.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
-*'''<kuid2:66277:80005:2> UnCouplezFrom'''
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''Built-in Command''' by '''smileyman'''
+*'''<kuid:-25:746>'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+*'''Base Rule'''
-   '''''<number>''''' - select a wagon number (0-20) to decouple from.
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+    '''Power station ''<select>''''' - select a Power Station from the session list.
-#The first wagon '''after''' the locomotive (or the locomotive and tender) is #0, the second wagon is #1, etc.
+    '''Consumers:'''
-#The main problem with using decoupling commands in the '''Driver Setup Rule''' is that the number and identity of the wagons in a consist may not be known when the command is added to a driver's command list.
+       '''''<add object>''''' - add power consumers from the session list
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
-*'''[[#Couple|Couple]]''' - couples wagons in a consist
-*'''[[#Couple At Trackmark|Couple At Trackmark]]''' - couples to the wagon closest to a specified trackmark
-*'''[[#Decouple|Decouple]]''' - decouples a consist at a specific place (does not work in the '''Driver Setup Rule''')
-*'''[[#Decouple DLX|Decouple DLX]]''' - decouples a consist at a specific, or a random, place. Upto 99 wagons
-*'''[[#Decouple Head N|Decouple Head N]]''' - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
-*'''[[#Decouple Number #|Decouple Number #]]''' - decouples a consist at a specific place. Upto 40 wagons
-*'''[[#Uncouplez|Uncouplez]]''' - decouples the locomotive (or locomotive + tender) from a consist
 <br>
-<table bgcolor=#a8ff8a>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-'''[[#top|Back to Top]]'''
+=='''Resource Check Rule'''==
 </td>
 </tr>
 </table>
-<table width="100%" bgcolor=#a8ff8a>
+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'''
-<tr>
-<td>
-='''Navigation Commands'''=
-</td>
-</tr>
-</table>
-<br>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-<table width=100% bgcolor=#d7ffc9>
-<tr>
-<td>
-=='''AutoDrivePastSignal'''==
-</td>
-</tr>
-</table>
-<table>
+*'''<kuid:-25:1067>'''
-<tr valign="top">
-<td>[[file:CMD_AutoDrivePastSignal.png|50px|link=]]</td>
-<td>Instructs the AI driver to drive under '''Autopilot''' until the entire train clears the specified signal but the AI will not set any junction switches so the train will follow whatever path is set ahead of it. All signals and speed signs are obeyed. The train will slow to a halt after passing the signal.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+*'''Legacy Rule''' (replaced by '''Multiple Resource Check Rule''')
-*'''<kuid2:61392:7101:1> AutoDrivePastSignal Command'''
+*'''Built-in Rule'''
-*'''DLS Command''' by '''pguy'''
+*'''Parent Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-   Select '''''<signal name>''''' from Session list
+    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'''
 [[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
-*It is the users responsibility to set all junction switches ahead of the train. The AI will not set the switches
+: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:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-*'''[[#AutoPilot|AutoPilot]]''' - drives continuously or until a specified trackmark has been passed
+*'''[[#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|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''[[How to Use Parent and Child Rules]]'''
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Resource_Check_Rule</span>'''
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
+=='''Resource Verify Rule (fixed)'''==
-=='''Autopilot'''==
 </td>
 </tr>
 </table>
-<table>
+Executes child rules if a selected industry or vehicle reaches a set commodity level. The rule resets when all child rules have completed.
-<tr valign="top">
-<td>[[file:CMD_AutoPilot.png|50px|link=]]</td>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-<td>Instructs the AI driver to drive but the AI will not set any junction switches so the train will follow whatever path is set ahead of it. All signals and speed signs are obeyed.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+*'''<kuid:160293:10060>'''
-*'''<kuid2:71155:60001:5> Autopilot Command'''
+*'''DLS Rule''' by '''trev999
-*'''DLS Command''' by '''_mutton_'''
+*'''Parent Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
- Select one of
+    Select one of two option buttons:-
-     '''<activate>''' - starts the Autopilot Command. This will only terminate when the '''Autopilot Command''' is removed from the driver command line
+     '''( ) Watch industry queue'''
-     '''<stop at track mark>''' - select a trackmark from the session list. Starts the Autopilot Command and drives until the train reaches the selected trackmark (see '''Notes''' below)
+       '''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|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
-#It is the users responsibility to set all junction switches ahead of the train. The AI will not set the switches
+#This rule will only monitor a single commodity in a single industry or vehicle.
-#If the '''Stop at track mark''' option is used then:-
+#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 train will not set a path to the track mark, that is the users responsibility
-:*the train will run at the full posted line speed upto the track mark and then it will slow to a stop
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-:*if the track mark is never reached because the correct path has not been set, the train will continue as it would for the '''activate''' option
+*'''[[#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
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
-*'''[[#AutoDrivePastSignal|AutoDrivePastSignal]]''' - drives until a specified signal has been passed
+*'''[[How to Use Parent and Child Rules]]'''
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Drive To'''==
+=='''Station Visited Check Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Executes child rules if specific trains call at set stations or industries
-<tr valign="top">
-<td>[[file:CMD_IndustryIcon.png|50px|link=]]</td>
-<td>Instructs the AI driver to Drive, via the shortest available path, to the designated Industry (including Passenger Stations). Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will '''NOT''' attempt to find a way around blockages when calculating the shortest path to the industry. All signals and speed signs are obeyed.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''<kuid:-3:11058> Drive To'''
+*'''<kuid2:60850:89005:3>'''
-*'''Base Command'''
+*'''Built-in Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+*'''Parent Rule'''
- Select '''<name of industry>''' or industry enabled passenger station from the session list
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-   if applicable '''<name/number of track or platform>''' for industries and stations that have identified active platforms, tracks or loading bays
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+    '''Trigger: ''<select>''''' - click to select one of the following
-:If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will not attempt to find an alternative path to the destination. This can lead to the train stopping and waiting indefinately until the blockage is removed.
+       '''''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
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
-*'''[[#Navigate To|Navigate To]]''' - will seek alternative paths if blocked
+*'''[[How to Use Parent and Child Rules]]'''
+<br>
+<table width="100%" bgcolor=#ffff88>
+<tr>
+<td>
+'''[[#top|Back to Top]]'''
+</td>
+</tr>
+</table>
-<br>
+<table width="100%" bgcolor=#ffff88>
-<table width=100% bgcolor=#d7ffc9>
 <tr>
 <td>
-=='''Drive To Trackmark'''==
+='''Interlocking Tower, Junction and Signal Rules'''=
 </td>
 </tr>
 </table>
-<table>
+<br>
-<tr valign="top">
+<table width=100% width=100% bgcolor=#ffffcc>
-<td>[[file:CMD_NavigateTo.png|50px|link=]]</td>
+<tr>
-<td>Instructs the AI driver to Drive, via the shortest available path, to the designated Trackmark. Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will '''NOT''' attempt to find a way around blockages when calculating the shortest path to the trackmark. All signals and speed signs are obeyed.</td>
+<td>
+=='''Control Path Rule'''==
+</td>
 </tr>
 </table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+Sets the path for selected trains
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:131986:158781>'''
-*'''<kuid:-3:11149> Drive To Trackmark'''
+*'''DLS Rule''' by '''atilabarut'''
-*'''Base Command'''
+*'''Legacy Rule''' (replaced by '''Interlocking Tower Rules''')
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
- Select '''<name of trackmark>''' from the session list
+  '''<add junction>''''' - click to add a junction from the Session list
+     For each junction:-
+       '''Set switch to ''<RIGHT/LEFT/FORWARD>''''' - click to select one junction state
+       '''Exiting from ''<FORWARD/BACKWARD/LEFT/RIGHT>''''' - click to select the direction the train exits from the junction
+       '''Permit type ''<EXCLUSIVE/DIRECTIONAL>''''' - click to select permission type.
+           ''DIRECTIONAL'' permits all trains heading in the same direction to use the set path.
+           ''EXCLUSIVE'' only allows one train to use the path at a time
+       '''''<up>''''' - move the junction UP one level in the list
+       '''''<dn>''''' - move the junction DOWN one level in the list
+       '''''<rm>''''' - remove the junction from the list
+  '''Name of the signal before entering the path ''<signal name>''''' - click to select the signal before the first junction from the Session signal list
+  '''Signal state in case the path is not cleared ''<GREEN/RED/YELLOW>''''' - click to select a signal state
+  '''Train for which path is controlled ''<train>''''' - click to select a consist from the Session list
+  '''Rule activates on train entering trigger ''<trigger name>''''' - click to select a start trigger from the Session list
+  '''Rule exits on train entering trigger ''<trigger name>''''' - click to select an end trigger from the Session list
 [[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
-:If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will not attempt to find an alternative path to the destination. This can lead to the train stopping and waiting indefinately until the blockage is removed.
+#This rule may not be compatible with Interlocking Towers.
+#Triggers have to be placed before the first junction and controlling signal and after the final junction.
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+#Multiple paths can be set up by placing multiple copies of this rule under an '''Ordered List''' or '''Simultaneous List'''
-*'''[[#Drive Via Trackmark|Drive Via Trackmark]]''' - drives through trackmark, will NOT seek alternative paths if blocked
-*'''[[#Navigate To Trackmark|Navigate To Trackmark]]''' - stops at trackmark, will seek alternative paths if blocked
-*'''[[#Navigate Via Trackmark|Navigate Via Trackmark]]''' - drives through trackmark, will seek alternative paths if blocked
-[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-*'''[[How to Use Track Markers]]'''
+*'''[[#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).
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
+=='''Interlocking Tower Configure Path Rule'''==
-=='''Drive Via Trackmark'''==
 </td>
 </tr>
 </table>
-<table>
+Alters settings on an interlocking tower path
-<tr valign="top">
-<td>[[file:CMD_NavigateTo.png|50px|link=]]</td>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-<td>Instructs the AI driver to Drive, via the shortest available path, to and through the designated Trackmark. If there are no further commands then the AI will halt after passing the trackmark. Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will '''NOT''' attempt to find a way around blockages when calculating the shortest path to the trackmark. All signals and speed signs are obeyed.</td>
+*'''<kuid:401543:3205>'''
+*'''Base Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+   '''Interlocking Tower ''<select>''''' - to set Name and Objects
+[[file:BugMini.PNG|link=]] <span style="color: red; text-decoration: underline; font-weight: 700;">Known Bugs</span><span style="color: red; font-weight: 700;">:</span>
+:The '''Interlocking Tower''' and '''Enhanced Interlocking Tower''' assets have a bug that saves their initial paths and properties in the Route and then saves any edits you make in the Session. The workaround is to always use Session Surveyor when using ITs and EITs.
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#Interlocking Tower Path Selection UI Rule|Interlocking Tower Path Selection UI Rule]]''' - automatically reacts to messages from Interlocking Towers and displays a path selection dialog to the player.
+*'''[[#Interlocking Tower Set Path Rule|Interlocking Tower Set Path Rule]]''' - sets the state of an interlocking tower path for a train
+*'''[[#Interlocking Tower Enhanced Manager Rule (SP2 and later)|Interlocking Tower Enhanced Manager Rule (SP2 and later)]]''' - more management and control options for interlocking towers.
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Interlocking Tower Path Selection UI Rule'''==
+</td>
 </tr>
 </table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+Will automatically react to messages from Interlocking Towers and display a path selection dialog to the player. Disable by removing rule from session
-*'''<kuid:-3:11209> Drive Via Trackmark'''
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''Base Command'''
+*'''<kuid:401543:3203>'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+*'''Base Rule'''
- Select '''<name of trackmark>''' from the session list
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+   '''[Checkbox] Show path activation message in Driver'''
-#This command is used to direct the AI along a set route to a final destination which is not normally the trackmark identified in this command.
-#If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will not attempt to find an alternative path to the designated trackmark. This can lead to the train stopping and waiting indefinately until the blockage is removed.
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:BugMini.PNG|link=]] <span style="color: red; text-decoration: underline; font-weight: 700;">Known Bugs</span><span style="color: red; font-weight: 700;">:</span>
-*'''[[#Drive To Trackmark|Drive To Trackmark]]''' - stops at trackmark, will NOT seek alternative paths if blocked
+:The '''Interlocking Tower''' and '''Enhanced Interlocking Tower''' assets have a bug that saves their initial paths and properties in the Route and then saves any edits you make in the Session. The workaround is to always use Session Surveyor when using ITs and EITs.
-*'''[[#Navigate To Trackmark|Navigate To Trackmark]]''' - stops at trackmark, will seek alternative paths if blocked
-*'''[[#Navigate Via Trackmark|Navigate Via Trackmark]]''' - drives through trackmark, will seek alternative paths if blocked
-[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-*'''[[How to Use Track Markers]]'''
+*'''[[#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.
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
+=='''Interlocking Tower Set Path Rule'''==
-=='''Navigate To'''==
 </td>
 </tr>
 </table>
-<table>
+Will set the state of an interlocking tower path for a train
-<tr valign="top">
-<td>[[file:CMD_IndustryIcon.png|50px|link=]]</td>
-<td>Instructs the AI driver to Navigate, via the shortest available path, to the designated Industry (including Passenger Station). Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will attempt to find a way around blockages when calculating the shortest path to the industry. All signals and speed signs are obeyed.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''<kuid:-3:10058> Navigate To'''
+*'''<kuid:401543:3204>'''
-*'''Base Command'''
+*'''Base Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
- Select '''<name of industry>''' or industry enabled passenger station from the session list
+   '''Interlocking Tower ''<select>''''' - to set Name and Objects
-   if applicable '''<name/number of track or platform>''' for industries and stations that have identified active platforms, tracks or loading bays
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+[[file:BugMini.PNG|link=]] <span style="color: red; text-decoration: underline; font-weight: 700;">Known Bugs</span><span style="color: red; font-weight: 700;">:</span>
-:If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will attempt to find an alternative path to the destination. This can lead to the train traveling backwards and down the wrong track.
+:The '''Interlocking Tower''' and '''Enhanced Interlocking Tower''' assets have a bug that saves their initial paths and properties in the Route and then saves any edits you make in the Session. The workaround is to always use Session Surveyor when using ITs and EITs.
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-*'''[[#Drive To|Drive To]]''' - does not seek alternative paths if blocked
+*'''[[#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.
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Navigate To Trackmark'''==
+=='''Interlocking Tower Enhanced Manager Rule (SP2 and later)'''==
 </td>
 </tr>
 </table>
-<table>
+Provides more management and control options for interlocking towers.
-<tr valign="top">
-<td>[[file:CMD_NavigateTo.png|50px|link=]]</td>
-<td>Instructs the AI driver to Navigate, via the shortest available path, to the designated Trackmark. Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will attempt to find a way around blockages when calculating the shortest path to the trackmark. All signals and speed signs are obeyed.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''<kuid:-3:10149> Navigate To Trackmark'''
+*'''<kuid2:61392:8130:41>'''
-*'''Base Command'''
+*'''DLS Rule''' by '''pguy'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
- Select '''<name of trackmark>''' from the session list
+    '''''<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
 [[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
-:If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will attempt to find an alternative path to the destination. This can lead to the train traveling backwards and down the wrong track.
+*It is recommended that you refer to the detailed instructions in the Trainz Wiki shown below.
+[[file:BugMini.PNG|link=]] <span style="color: red; text-decoration: underline; font-weight: 700;">Known Bugs</span><span style="color: red; font-weight: 700;">:</span>
+:The '''Interlocking Tower''' and '''Enhanced Interlocking Tower''' assets have a bug that saves their initial paths and properties in the Route and then saves any edits you make in the Session. The workaround is to always use Session Surveyor when using ITs and EITs.
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-*'''[[#Drive To Trackmark|Drive To Trackmark]]''' - stops at trackmark, will NOT seek alternative paths if blocked
+*'''[[#Interlocking Tower Configure Path Rule|Interlocking Tower Configure Path Rule]]''' - alters the settings on an interlocking tower path
-*'''[[#Drive Via Trackmark|Drive Via Trackmark]]''' - drives through trackmark, will NOT seek alternative paths if blocked
+*'''[[#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.
-*'''[[#Navigate Via Trackmark|Navigate Via Trackmark]]''' - drives through trackmark, will seek alternative paths if blocked
+*'''[[#Interlocking Tower Set Path Rule|Interlocking Tower Set Path Rule]]''' - sets the state of an interlocking tower path for a train
 [[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
-*'''[[How to Use Track Markers]]'''
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Enhanced_Interlocking_Tower_Manager_Rule</span>'''
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
+=='''Junction Derailment Prevention Rule'''==
-=='''Navigate Via Trackmark'''==
 </td>
 </tr>
 </table>
-<table>
+Sets opposing (trailing) junctions ahead of a train to prevent derailments.  Works with both AI and manually driven trains.
-<tr valign="top">
-<td>[[file:CMD_NavigateTo.png|50px|link=]]</td>
-<td>Instructs the AI driver to Drive, via the shortest available path, to and through the designated Trackmark. If there are no further commands then the AI will halt after passing the trackmark. Switches ahead of the train that are not locked against the AI will be set to allow the train to proceed and reset after the train has cleared the switch. The AI driver will attempt to find a way around blockages when calculating the shortest path to the trackmark. All signals and speed signs are obeyed.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
-*'''<kuid:-3:10209> Navigate Via Trackmark'''
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''Base Command'''
+*'''<kuid2:121843:100282:1>'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+*'''DLS Rule''' by '''pitkin'''
- Select '''<name of trackmark>''' from the session list
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+    '''None'''
-#This command is used to direct the AI along a set route to a final destination which is not normally the trackmark identified in this command.
-#If the AI driver is blocked (e.g. by another train, a locked signal or switch) it will attempt to find an alternative path to the designated trackmark. This can lead to the train traveling backwards and down the wrong track.
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
-*'''[[#Drive To Trackmark|Drive To Trackmark]]''' - stops at trackmark, will NOT seek alternative paths if blocked
+:This rule will not overrule a junction already locked by another AI train or locked against AI control using the '''Set Junctions Rule'''.
-*'''[[#Drive Via Trackmark|Drive Via Trackmark]]''' - drives through trackmark, will NOT seek alternative paths if blocked
-*'''[[#Navigate To Trackmark|Navigate To Trackmark]]''' - stops at trackmark, will seek alternative paths if blocked
-[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-*'''[[How to Use Track Markers]]'''
+*'''[[#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).
 <br>
-<table bgcolor=#a8ff8a>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-'''[[#top|Back to Top]]'''
+=='''Lock All Junctions Rule'''==
 </td>
 </tr>
 </table>
-<table width="100%" bgcolor=#a8ff8a>
+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.
-<tr>
-<td>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:400048:100971>'''
+*'''DLS Rule''' by '''callavsg'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''None'''
+[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+:Individual junctions can still be set, locked and unlocked by using the '''Set Junction Rule'''
-='''Session Management Commands'''=
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-</td>
+*'''[[#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.
-</tr>
+*'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).
-</table>
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Copy Commands From'''==
+=='''MissionCode Manager Rule (SP2 and later)'''==
 </td>
 </tr>
 </table>
-<table>
+Enables the addition, editing and management of Mission Codes used to auto select paths in '''Interlocking Towers'''.
-<tr valign="top">
-<td>[[file:CMD_CopyCommandsFrom.png|50px|link=]]</td>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-<td>Copies a driver schedule from a schedule library or another driver.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+*'''<kuid2:61392:8200:50>'''
-*'''<kuid2:192081:1:7> Copy Commands From'''
+*'''DLS Rule''' by '''pguy'''
-*'''Built-in Command''' by '''brummfondel'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+   Refer to the detailed instructions in the '''Trainz Wiki Links''' shown below.
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:PageLink4.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Dependent Driver Commands:</span>
+:'''The rule must be added to the Session for the following Driver Commands to work'''
+*'''[[Driver Commands List#AddMissionCode (SP2 and Later)|AddMissionCode (SP2 and Later)]]'''
+*'''[[Driver Commands List#RemoveMissionCode (SP2 and Later)|RemoveMissionCode (SP2 and Later)]]'''
+*'''[[Driver Commands List#SetMissionCode (SP2 and Later)|SetMissionCode (SP2 and Later)]]'''
- '''Append''' - '''From Library''' - select a saved schedule from Schedule Library and add it to the end of the current schedule (if any)
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
- '''Append''' - '''From Vehicle''' - select a vehicle, copy its driver commands and add them to the end of the current schedule (if any)
+*'''[[#MissionCode Stops and Timetable Manager Rule (SP2 and later)|MissionCode Stops and Timetable Manager Rule (SP2 and later)]]''' - creates and edits stop zones and timetables for trains with mission codes
- '''Insert''' - '''From Library''' - select a saved schedule from Schedule Library and insert it into the current schedule (if any)
- '''Insert''' - '''From Vehicle''' - select a vehicle, copy its driver commands and insert them into the current schedule (if any)
-[[file:PageLink3.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Required Session Rules:</span><br>
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
-:'''Rules that MUST be added to the Session for this Driver Command to operate'''
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/MissionCodes_Manager</span>'''
-*'''[[Session_Rule_List_with_Parameters#Schedule Library Rule|Schedule Library Rule]]'''
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Delete Train'''==
+=='''MissionCode Stops and Timetable Manager Rule (SP2 and later)'''==
 </td>
 </tr>
 </table>
-<table>
+Enables the creation, editing and management of stop zones and timetables for trains following a path defined using mission codes.
-<tr valign="top">
-<td>[[file:CMD_DeleteTrain.png|50px|link=]]</td>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-<td>Deletes the train from the session.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+*'''<kuid2:61392:8300:50>'''
-*'''<kuid2:116387:15:3> Delete Train'''
+*'''DLS Rule''' by '''pguy'''
-*'''Built-in Command''' by '''maggs'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+   Refer to the detailed instructions in the '''Trainz Wiki Links''' shown below.
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#MissionCode Manager Rule (SP2 and later)|MissionCode Manager Rule (SP2 and later)]]''' - creates and edits mission codes for trains
- '''None'''
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Mission_Code_Stops_and_TimeTables_Manager</span>'''
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Insert Buff Label'''==
+=='''Multiple Junction Alignment Check Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Executes child rules if specific junctions are set.
-<tr valign="top">
-<td>[[file:CMD_InsertBuffLabel.png|50px|link=]]</td>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-<td>Inserts a driver command as a label for a block of driver commands.</td>
-</tr>
+*'''<kuid:-25:168>'''
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+*'''Built-in Rule'''
-*'''<kuid:160293:101002> Insert buff label'''
+*'''Parent Rule'''
-*'''DLS Command''' by '''trev999'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+    '''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
- '''Select ''<label number>''''' - select the label number (1 to 10)
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#Control Path Rule|Control Path Rule]]''' - sets the path for selected trains
+*'''[[#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:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
-:Up to 10 labels can be inserted into each drivers command list
+*'''[[How to Control Junctions in Sessions]]'''
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
-*'''[[#Jump to Label|Jump to Label]]''' - unconditionally jumps to a named command label
+*'''[[How to Use Parent and Child Rules]]'''
-*'''[[#Skip if Session-Variable|Skip if Session Variable]]''' - conditionally jumps to the named command label if a selected session variable meets a set condition
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Jump to Label'''==
+=='''Set Cleared Junctions Rule'''==
 </td>
 </tr>
 </table>
-<table>
+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'''
-<tr valign="top">
-<td>[[file:CMD_JumpToLabel.png|50px|link=]]</td>
-<td>Unconditionally jumps to a named command label.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''<kuid2:160293:101003:2> Jump to label'''
+*'''<kuid2:131986:157661:1>'''
-*'''DLS Command''' by '''trev999'''
+*'''DLS Rule''' by '''atilabarut'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
- '''Select ''<label number>''''' - select the label number (1 to 20)
+    '''''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
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-:A '''label''' ('''Insert Buff label''' driver command) with the matching label number must be added to the driver commands
+*'''[[#Control Path Rule|Control Path Rule]]''' - sets the path for selected trains
+*'''[[#Junction Derailment Prevention Rule|Junction Derailment Prevention Rule]]''' - sets opposing junctions ahead of a train to prevent derailments
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+*'''[[#Lock All Junctions Rule|Lock All Junctions Rule]]''' - locks all junctions against user control
-*'''[[#Insert Buff Label|Insert Buff Label]]''' - inserts a driver command as a label for a block of driver commands
+*'''[[#Multiple Junction Alignment Check Rule|Multiple Junction Alignment Check Rule]]''' - executes child rules when junctions are aligned
-*'''[[#Skip if Session-Variable|Skip if Session Variable]]''' - conditionally jumps to the named command label if a selected session variable meets a set condition
+*'''[[#Set Junctions Rule|Set Junctions Rule]]''' - sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control).
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Layer Control'''==
+=='''Set Junctions Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control). '''''Warning:'' not compatible with Interlocking Tower Assets'''
-<tr valign="top">
-<td>[[file:CMD_LayerControl.png|50px|link=]]</td>
-<td>Shows or hides a selected layer.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''<kuid:160293:101080> Layer Control'''
+*'''<kuid:-25:1065>'''
-*'''DLS Command''' by '''trev999'''
+*'''Built-in Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
- '''Show ''<list of layers in route and session>''''' - select a layer to make visible
+    '''''Add Junction''''' - click to select a junction from the session junction list
- '''Hide ''<list of layers in route and session>''''' - select a layer to make invisible
+    '''''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
-[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Session Rules:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-*'''[[Session_Rule_List_with_Parameters#Show.2FHide_Layer_Rule|Show/Hide Layer Rule]]'''
+*'''[[#Control Path Rule|Control Path Rule]]''' - sets the path for selected trains
+*'''[[#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:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
-*'''[[How_to_Use_Layers#Layers_in_Driver_Mode|Layers in Driver Mode]]'''
+*'''[[How to Control Junctions in Sessions]]'''
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Move to Train'''==
+=='''Set Signal Extended Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''
-<tr valign="top">
-<td>[[file:CMD_MoveToTrain.png|50px|link=]]</td>
-<td>Moves the driver with all their remaining driver commands to another train.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''<kuid2:71155:60004:2> Move to train'''
+*'''<kuid2:47662:20002:4>'''
-*'''DLS Command''' by '''_mutton_'''
+*'''Built-in Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
- '''All trains ''<list of locomotives>''''' - select a locomotive from the Session list
+    '''''<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'''
 [[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
-#The new train must not already have a driver - make sure that the '''Generate New Drivers for Empty Trains''' option in the '''Driver Setup Rule''' is not ticked.
+:The signal must support the state selected otherwise there will be no change in the signal
-#If the new train does already have a driver then the command and any following commands will not be executed.
-[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-*'''[[How_to_Use_Driver_Setup_Rule|How to Use the Driver Setup Rule]]'''
+*'''[[#Trigger Multiple Signals Rule|Trigger Multiple Signals Rule]]''' - sets selected signals to DANGER (STOP) when selected triggers are activated
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Set Custom HUD (SP2 and later)'''==
+=='''Trigger Multiple Signals Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Sets selected signals to DANGER (STOP) when selected triggers are activated. Signals will be at AUTOMATIC when the triggers are not activated.
-<tr valign="top">
-<td>[[file:CMD_SetCustomHUD.png|50px|link=]]</td>
-<td>Sets a predefined HUD on the screen.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
-*'''<kuid2:61392:7006:37> SetCustomHud (SP2 and later)'''
-*'''DLS Command''' by '''pguy'''
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+*'''<kuid2:116387:26:1>'''
- '''''<defHud>''''' - select the default HUD
+*'''DLS Rule''' by '''maggs'''
- '''''<altHud>''''' - select the alternate HUD
- '''''<named Hud>''''' - select from a number of user defined HUDs
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-#the '''Quick CustomHud Manager Rule (SP2 and later)''' must be added to a session for a HUD to be selected by this command
-#the default and alternate HUDs are preset but can be edited using the above rule
-#additional user defined and named HUDs can be created with the '''Quick CustomHud Manager Rule (SP2 and later)'''
-[[file:PageLink3.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Required Session Rules:</span><br>
+    '''<add signal>''' - select a signal from the Session List. More than one signal can be added.
-:'''Rules that MUST be added to the Session for this Driver Command to operate'''
+       '''<delete>''' - remove a signal from the rule.
-*'''[[Session_Rule_List_with_Parameters#Quick_CustomHud_Manager_Rule_(SP2_and_later)|Quick CustomHud Manager Rule (SP2 and later)]]'''
+    '''<add trigger>''' - select a trigger from the Session List. More than one trigger can be added.
+       '''<delete>''' - remove a trigger from the rule.
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#Set Signal Extended Rule|Set Signal Extended Rule]]''' -  sets a selected signal to a specific signal state
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width="100%" bgcolor=#ffff88>
 <tr>
 <td>
+'''[[#top|Back to Top]]'''
+</td>
+</tr>
+</table>
-=='''Skip if Session-Variable'''==
+<table width="100%" bgcolor=#ffff88>
+<tr>
+<td>
+='''Message Rules'''=
 </td>
 </tr>
 </table>
-<table>
+<br>
-<tr valign="top">
+<table width=100% width=100% bgcolor=#ffffcc>
-<td>[[file:CMD_SkipIfSVar.png|50px|link=]]</td>
+<tr>
-<td>Jumps to the named command label if a selected session variable meets a set condition.</td>
+<td>
+=='''Close Message Popup Rule'''==
+</td>
 </tr>
 </table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+Closes open message popups
-*'''<kuid2:160293:101014:3> Skip if session-variable'''
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''DLS Command''' by '''trev999'''
+*'''<kuid:447264:1526>'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+*'''Built-in Rule'''
- '''Select ''<label number if>''''' - select the label number (1 to 20)
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-    '''''<Variable Name>''''' - from the '''InputTable Rule'''
-       '''''<condition>''''' - from the '''InputTable Rule'''
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+   '''None'''
-#The '''InputTable Rule''' must be installed in the session before this command can be used. This rule must be configured to identify the session variable(s), test condition(s) and value(s).
-#A '''label''' ('''Insert Buff Label''' driver command) with the matching label number must be added to the driver commands
 [[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
-*'''TANE''' Sessions containing driver commands that use variables ''may not'' work correctly when imported into '''TRS19''' and '''Trainz Plus'''. The solution is to delete and then reinsert these commands in the imported Sessions
+:This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-*'''[[#Insert Buff Label|Insert Buff Label]]''' - inserts a driver command as a label for a block of driver commands
+*'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
-*'''[[#Jump to Label|Jump to Label]]''' - unconditionally jumps to a named command label
-[[file:PageLink3.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Required Session Rules:</span><br>
+[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
-:'''Rules that MUST be added to the Session for this Driver Command to operate'''
+*'''[[How to Use Message Popup Rule (Applications)]]'''
-*'''[[Session Rule List with Parameters#InputTable Rule|InputTable Rule]]'''
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
+=='''DestSign Table Rule'''==
-=='''Wait Until S-Variable V3'''==
 </td>
 </tr>
 </table>
-<table>
+Creates a list of destination names for a destination sign
-<tr valign="top">
-<td>[[file:CMD_WaitSVariable.png|50px|link=]]</td>
-<td>The AI driver will wait until the identified variable matches the condition specified before the next command will be executed</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''<kuid2:160293:101006:3> Wait Until S-variable V3'''
+*'''<kuid2:206816:99004:2>'''
-*'''DLS Command''' by '''trev999'''
+*'''Built-in Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
- '''Select ''<Variable Name>''''' - select the variable name from those entered in the '''InputTable Rule'''
+   '''''<add destination>''''' - enter a destination name to be added to the destination sign roll
-    '''Select <Condition><Value>''''' - select from those entered in the '''InputTable Rule'''
+   '''''<import destinations from texture-group>''''' - select a list of destination names from session
+   '''[x] Enable industries/stations as destination''' - check to set
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+   '''[x] Enable Track Marks as destinations''' - check to set
-*The '''InputTable Rule''' must be installed in the session before this command can be used. This rule must be configured to identify the session variable(s), test condition(s) and value(s).
+   '''[x] Enable table of destinations''' - check to set
-[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
-*'''TANE''' Sessions containing driver commands that use variables ''may not'' work correctly when imported into '''TRS19''' and '''Trainz Plus'''. The solution is to delete and then reinsert these commands in the imported Sessions
-[[file:PageLink3.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Required Session Rules:</span><br>
-:'''Rules that MUST be added to the Session for this Driver Command to operate'''
-*'''[[Session Rule List with Parameters#InputTable Rule|InputTable Rule]]'''
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
+=='''Display HTML Pages Rule'''==
-=='''WaitUntilSVariable'''==
 </td>
 </tr>
 </table>
-<table>
+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'''
-<tr valign="top">
-<td>[[file:CMD_WaitSVar.png|50px|link=]]</td>
-<td>The AI driver will wait until the identified variable matches the condition specified before the next command will be executed</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
-*'''<kuid2:131986:1006:1> WaitUntilSVariable'''
-*'''DLS Command''' by '''atilabarut'''
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''Legacy Command''' has been replaced by '''Wait Until S-Variable'''
+*'''<kuid:-25:442>'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+*'''Legacy Rule''' (replaced by '''Message Popup Rule''')
- '''Select ''<Variable Name><Condition><Value>''''' - from the '''InputTable Rule'''
+*'''Base Rule'''
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-*The '''InputTable Rule''' must be installed in the session before this command can be used. This rule must be configured to identify the session variable(s), test condition(s) and value(s).
-[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
+    '''''<Add Page>''''' - adds the HTML page ''index.html'' from the selected HTML asset
-*'''TANE''' Sessions containing driver commands that use variables ''may not'' work correctly when imported into '''TRS19''' and '''Trainz Plus'''. The solution is to delete and then reinsert these commands in the imported Sessions
+       '''''<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:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-*'''[[#Wait Until S-Variable V3|Wait Until S-Variable V3]]''' - AI driver waits for specified variable condition
+*'''[[#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:PageLink3.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Required Session Rules:</span><br>
-:'''Rules that MUST be added to the Session for this Driver Command to operate'''
-*'''[[Session Rule List with Parameters#InputTable Rule|InputTable Rule]]'''
 <br>
-<table bgcolor=#a8ff8a>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-'''[[#top|Back to Top]]'''
+=='''Display Video Rule'''==
 </td>
 </tr>
 </table>
-<table width="100%" bgcolor=#a8ff8a>
+Displays a page containing a video clip from a HTML asset in a browser window.
-<tr>
-<td>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:-25:138>'''
+*'''Built-in Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''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.
+[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+:Video must be in a valid web format.
-='''Train Operation Commands'''=
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-</td>
+*'''[[#Play Sound Rule|Play Sound Rule]]''' - plays a wav sound file
-</tr>
-</table>
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Bellz'''==
+=='''ExTrainz Manager Rule - TANE SP2'''==
 </td>
 </tr>
 </table>
-<table>
+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.
-<tr valign="top">
-<td>[[file:CMD_Bellz.png|50px|link=]]</td>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-<td>Rings the train bell.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+*'''<kuid:160293:10029>'''
-*'''<kuid2:66277:80002:1> bellz'''
+*'''DLS Rule''' by '''trev999'''
-*'''Built-in Command''' by '''smileyman'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+    '''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.
- '''None'''
+[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
+:This rule is NOT compatible with all industries.
 [[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
-:the locomotive must be equipped with a working bell.
+#Rolling stock installed in the current session only (see settings above) can be searched to find a match for any selected product from any industry. In Surveyor (and Driver if that setting is enabled) click on the '''View Products''' sub menu link and click on a product name in the '''Product Window''' to display a list of all compatible rolling stock for that product.
+#Alternatively, click on the '''View Industries''' sub menu link and then click on a ''Product Icon'' to open a '''Product Window''', then click     on the '''''View Rolling Stock''''' link at the top of the window.
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+#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.
-*'''[[#Hornz|Hornz]]''' - gives a blast of the horn (or whistle)
-*'''[[#HornzExtended|HornzExtended]]''' - gives a specified number of horn blasts
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Couple'''==
+=='''Fade In/Out Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Fade in or out within seconds, using specified color and opacity values.
-<tr valign="top">
-<td>[[file:CMD_Couple.png|50px|link=]]</td>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-<td>The AI driver moves the train (or just the locomotive if it is by itself) to couple with the specified wagon.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+*'''<kuid2:190611:200000:2>'''
-*'''<kuid:-3:10081> Couple'''
+*'''Built-in Rule'''
-*'''Base Command'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+    '''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
-   '''''<list of available wagons>''''' - select a wagon to couple to
 [[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
-#The target wagon must be at the end of a consist or by itself. If the target is coupled in between other wagons then no coupling will take place.
+:Seconds are Trainz clock time, not real time.
-#There must be a clear path to the target wagon.
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
-*'''[[#Couple At Trackmark|Couple At Trackmark]]''' - couples to the wagon closest to a specified trackmark
-*'''[[#Decouple|Decouple]]''' - decouples a consist at a specific place (does not work in the '''Driver Setup Rule''')
-*'''[[#Decouple DLX|Decouple DLX]]''' - decouples a consist at a specific, or a random, place. Upto 99 wagons
-*'''[[#Decouple Head N|Decouple Head N]]''' - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
-*'''[[#Decouple Number #|Decouple Number #]]''' - decouples a consist at a specific place. Upto 40 wagons
-*'''[[#Uncouplez|Uncouplez]]''' - decouples the locomotive (or locomotive + tender) from a consist
-*'''[[#UncouplezFrom|UncouplezFrom]]''' - decouples a consist at a specific place. Upto 20 wagons
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Couple At Trackmark'''==
+=='''Hide Product Overlays Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Hides the commodity or product bar graphs that appear on active industries
-<tr valign="top">
-<td>[[file:CMD_Couple_At_Trackmark.png|50px|link=]]</td>
-<td>The AI driver moves the train (or just the locomotive if it is by itself) to couple with the wagon that is closest to a specified trackmark.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
-*'''<kuid:2:57145:81100:1> Couple At Trackmark'''
-*'''DLS Command''' by '''marzipan'''
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+*'''<kuid:400048:100970>'''
-   '''''<list of available trackmarks>''''' - select a trackmark
+*'''DLS Rule''' by '''callavsg'''
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
-#The end wagon of a consist must be within the effect radius of the trackmark. If there is no wagon with the radius then no coupling will take place.
-#The train will couple to the wagon closest to the trackmark and that may mean navigating to the other end of the consist.
-#There must be a clear path to the target wagon.
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-*'''[[#Couple|Couple]]''' - couples wagons in a consist
-*'''[[#Decouple|Decouple]]''' - decouples a consist at a specific place (does not work in the '''Driver Setup Rule''')
-*'''[[#Decouple DLX|Decouple DLX]]''' - decouples a consist at a specific, or a random, place. Upto 99 wagons
-*'''[[#Decouple Head N|Decouple Head N]]''' - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
-*'''[[#Decouple Number #|Decouple Number #]]''' - decouples a consist at a specific place. Upto 40 wagons
-*'''[[#Uncouplez|Uncouplez]]''' - decouples the locomotive (or locomotive + tender) from a consist
-*'''[[#UncouplezFrom|UncouplezFrom]]''' - decouples a consist at a specific place. Upto 20 wagons
-[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+   '''None'''
-*'''[[How to Use Track Markers]]'''
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
+=='''InputTable Rule'''==
-=='''Decouple'''==
 </td>
 </tr>
 </table>
-<table>
+Creates a list of message names to be used for various purposes including passing data to '''Driver Commands'''
-<tr valign="top">
-<td>[[file:CMD_Decouple.png|50px|link=]]</td>
-<td>The train is decoupled at the specified wagon (does not work in '''Driver Setup Rule''').</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
-*'''<kuid:-3:10082> Decouple'''
-*'''Base Command'''
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+*'''<kuid2:131986:1012:1>'''
-   '''''<list of available wagons>''''' - select a wagon to decouple from
+*'''Built-in Rule'''
-[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-*This command does not work when added to a driver's command list in the '''Driver Setup Rule''' in Surveyor but it does work when manually added to the driver's command list in Driver
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+    '''''<add>''''' - click to add a new entry to the table
-#If programming a driver via the '''Driver Setup Rule''', use the alternative commands '''Decouple DLX''', '''Decouple Number #''', '''Uncouplez''' or '''UncouplezFrom'''
+    Each new entry will require an input message
-#The main problem with using decoupling commands in the '''Driver Setup Rule''' is that the number and identity of the wagons in a consist may not be known when the command is added to a driver's command list.
+       '''''<short message>''''' - enter a message. The message must be in a format that is specific for each purpose
+       For the '''MoveTurntable''' driver command the message must be formatted as:-
+          '''turntable,name_of_turntable,number_of_connecting_roads''' - the first entry must be the word ''turntable'' in lower case.
+             ''name_of_turntable'' is the name of the turntable,
+             ''number_of_connecting_roads'' is the number of tracks connecting to the turntable
+       For the '''WaitUntilTime''' driver command the message must be formatted as:-
+          '''time,hour,minute''' - the first entry must be the word ''time'' in lower case,
+             ''hour'' must be from 0 to 23,
+             ''minute'' must be from 0 to 59.
+       For the '''Skip If Session-Variable''' and '''Wait Until S-Variable''' driver commands the message must be formatted as:-
+          '''svar,svar_name,svar_condition,value''' - the first entry must be the word ''svar'' in lower case,
+             ''svar_name'' is the name of the session variable,
+             ''svar_condition'' is an equality (eg eq for equal, gt for greater than, etc)
+             ''value'' is an integer value to be compared to the session variable.
+    Each entry in the table will be followed by the commands:-
+       '''''cp''''' - click to copy this entry to a new entry
+       '''''up''''' - click to move this entry up one level
+       '''''dn''''' - click to move this entry down one level
+       '''''rm''''' - click to remove this entry from the table
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:PageLink4.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Dependent Driver Commands:</span>
-*'''[[#Couple|Couple]]''' - couples wagons in a consist
+:'''The rule must be added to the Session for the following Driver Commands to work'''
-*'''[[#Couple At Trackmark|Couple At Trackmark]]''' - couples to the wagon closest to a specified trackmark
+*'''[[Driver Commands List#MoveTurntable|MoveTurntable]]'''
-*'''[[#Decouple DLX|Decouple DLX]]''' - decouples a consist at a specific, or a random, place. Upto 99 wagons
+*'''[[Driver Commands List#Skip if Session-Variable|Skip If Session-Variable]]'''
-*'''[[#Decouple Head N|Decouple Head N]]''' - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
+*'''[[Driver Commands List#Wait Until S-Variable|Wait Until S-Variable]]'''
-*'''[[#Decouple Number #|Decouple Number #]]''' - decouples a consist at a specific place. Upto 40 wagons
-*'''[[#Uncouplez|Uncouplez]]''' - decouples the locomotive (or locomotive + tender) from a consist
-*'''[[#UncouplezFrom|UncouplezFrom]]''' - decouples a consist at a specific place. Upto 20 wagons
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Decouple DLX'''==
+=='''Message Popup Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Displays a pop-up browser window and waits for it to be closed. Closure can be manual (by the user) or by another rule.
-<tr valign="top">
-<td>[[file:CMD_DecoupleDLX.png|50px|link=]]</td>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-<td>The train is decoupled at the specified wagon identified by name or number (upto 99 wagons), or at a random location.</td>
-</tr>
+*'''<kuid:-25:1003>'''
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+*'''Built-in Rule'''
-*'''<kuid2:160293:100120:2> Decouple DLX'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-*'''DLS Command''' by '''trev999'''
+    '''[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.
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
+: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.
-   '''When Used in Surveyor using the Driver Setup Rule'''
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-      '''''<1-33>''''' - select a wagon numbered 1 to 33 where 1 is the wagon (or tender) immediately following the locomotive
+*'''[[#Close Message Popup Rule|Close Message Popup Rule]]''' - closes a displayed pop-up browser window.
-      '''''<34-66>''''' - select a wagon from 34 to 66
+*'''[[#Display HTML Pages Rule|Display HTML Pages Rule]]''' - display listed HTML files in order as a navigable sequence of pages.
-      '''''<67-99>''''' - select a wagon from 67 to 99
+*'''[[#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.
-      '''''<at position determined by>'''''
-         '''''<consist_count>''''' - requires the use of the '''special_instruction''' driver command
-         '''''<a random number>''''' - a random number which may be beyond the last wagon in the consist
-   '''When used in Driver Mode'''
-      '''''<1-33>''''' - each wagon is numbered and named. Select a wagon numbered 1 to 33 (or to the last wagon in that range)
-         where 1 is the wagon (or tender) immediately following the locomotive
-      '''If there are more than 33 wagons, then'''
-         '''''<34-66>''''' - each wagon is numbered and named. Select a wagon from 34 to 66 (or to the last wagon in that range)
-      '''if there are more than 66 wagons, then'''
-         '''''<67-99>''''' - each wagon is numbered and named. Select a wagon from 67 to 99 (or to the last wagon in that range)
-      '''''<at position determined by>'''''
-         '''''<consist_count>''''' - requires the use of the '''special_instruction''' driver command
-         '''''<a random number>''''' - a random number upto and including the last wagon in the consist
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
-:The main problem with using decoupling commands in the '''Driver Setup Rule''' is that the number and identity of the wagons in a consist may not be known when the command is added to a driver's command list.
+*'''[[How to Use Message Popup Rule]]'''
+*'''[[How to Use Message Popup Rule (Applications)]]'''
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
-*'''[[#Couple|Couple]]''' - couples wagons in a consist
+*'''[[How to Create a HTML Asset|How to Create a HTML Asset (Session Introduction Page and In Game Messages)]]'''
-*'''[[#Couple At Trackmark|Couple At Trackmark]]''' - couples to the wagon closest to a specified trackmark
+*'''[[How to Create a Message Popup Icon]]'''
-*'''[[#Decouple|Decouple]]''' - decouples a consist at a specific place (does not work in the '''Driver Setup Rule''')
-*'''[[#Decouple Head N|Decouple Head N]]''' - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
-*'''[[#Decouple Number #|Decouple Number #]]''' - decouples a consist at a specific place. Upto 40 wagons
-*'''[[#Uncouplez|Uncouplez]]''' - decouples the locomotive (or locomotive + tender) from a consist
-*'''[[#UncouplezFrom|UncouplezFrom]]''' - decouples a consist at a specific place. Upto 20 wagons
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Decouple Head N'''==
+=='''Minimap Options Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Sets the display options for the minimap.
-<tr valign="top">
-<td>[[file:CMD_Decouple.png|50px|link=]]</td>
-<td>The train is decoupled to leave the selected number ('''N''') of wagons left in the consist.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''<kuid2:46162:70002:12> Decouple Head N'''
+*'''<kuid:-25:636>'''
-*'''DLS Command''' by '''josefpav'''
+*'''Built-in Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+ ''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'''
-   '''<select wagon number>''' - select the number of wagons (sorted by ASCII code not numerical value) to be left in the consist after the decoupling.
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-= the lead loco only (without its tender), 2 = loco + first wagon (which could be the tender), upto 75.
+*'''[[#Show/Hide Minimap Rule|Show/Hide Minimap Rule]]''' - shows the minimap window in Driver.
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+<br>
-:The main problem with using decoupling commands in the '''Driver Setup Rule''' is that the number and identity of the wagons in a consist may not be known when the command is added to a driver's command list.
+<table width=100% width=100% bgcolor=#ffffcc>
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
-*'''[[#Couple|Couple]]''' - couples wagons in a consist
-*'''[[#Couple At Trackmark|Couple At Trackmark]]''' - couples to the wagon closest to a specified trackmark
-*'''[[#Decouple|Decouple]]''' - decouples a consist at a specific place (does not work in the '''Driver Setup Rule''')
-*'''[[#Decouple DLX|Decouple DLX]]''' - decouples a consist at a specific, or a random, place. Upto 99 wagons
-*'''[[#Decouple Number #|Decouple Number #]]''' - decouples a consist at a specific place. Upto 40 wagons
-*'''[[#Uncouplez|Uncouplez]]''' - decouples the locomotive (or locomotive + tender) from a consist
-*'''[[#UncouplezFrom|UncouplezFrom]]''' - decouples a consist at a specific place. Upto 20 wagons
-<br>
-<table width=100% bgcolor=#d7ffc9>
 <tr>
 <td>
-=='''Decouple Number #'''==
+=='''Play Sound Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Plays a wav sound file.
-<tr valign="top">
-<td>[[file:CMD_DecoupleNumber.png|50px|link=]]</td>
-<td>The specified wagon number (#) and any following wagons will be uncoupled from the locomotive and consist.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
-*'''<kuid2:147570:80008:1> Decouple number #'''
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''Built-in Command''' by '''erniesouchak'''
+*'''<kuid:-25:1045>'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+*'''Built-in Rule'''
-   '''''<number>''''' - select a wagon number (1-40) to decouple from.
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+    '''Default HTML ''<Click>''''' - click to to enter Sound File Name
-#The first locomotive is #1, the second locomotive (if any) or the tender (on a steam locomotive) is #2, etc.
+    '''HTML Assets ''<Click>''''' - click to select HTML asset
-#The main problem with using decoupling commands in the '''Driver Setup Rule''' is that the number and identity of the wagons in a consist may not be known when the command is added to a driver's command list.
+    '''Rule Completes ''<Click>''''' -  to select one of:-
+       '''sound has just started'''
+       '''sound has finished playing'''
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-*'''[[#Couple|Couple]]''' - couples wagons in a consist
+*'''[[#Display Video Rule|Display Video Rule]]''' - displays a page containing a video clip from a HTML asset in a browser window
-*'''[[#Couple At Trackmark|Couple At Trackmark]]''' - couples to the wagon closest to a specified trackmark
-*'''[[#Decouple|Decouple]]''' - decouples a consist at a specific place (does not work in the '''Driver Setup Rule''')
-*'''[[#Decouple DLX|Decouple DLX]]''' - decouples a consist at a specific, or a random, place. Upto 99 wagons
-*'''[[#Decouple Head N|Decouple Head N]]''' - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
-*'''[[#Uncouplez|Uncouplez]]''' - decouples the locomotive (or locomotive + tender) from a consist
-*'''[[#UncouplezFrom|UncouplezFrom]]''' - decouples a consist at a specific place. Upto 20 wagons
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Hornz'''==
+=='''Session Metadata Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Sets session metadata in the config file. Info can be read by other systems and displayed to the player.
-<tr valign="top">
-<td>[[file:CMD_Hornz.png|50px|link=]]</td>
-<td>Gives one blast of the train horn or whistle.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''<kuid2:66277:80001:2> Hornz'''
+*'''<kuid:401543:2036>'''
-*'''Built-in Command''' by '''smileyman'''
+*'''Base Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
- '''None'''
+    '''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'''
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
-*'''[[#Bellz|Bellz]]''' - rings the locomotive bell (if it has one)
+:Time is Trainz clock time, not real time
-*'''[[#HornzExtended|HornzExtended]]''' - gives a specified number of horn blasts
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''HornzExtended'''==
+=='''Set Helper Icon Size Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Sets the size of helper icons such as the junction lever arrows.
-<tr valign="top">
-<td>[[file:CMD_HornzExtended.png|50px|link=]]</td>
-<td>Gives a specified number of blasts of the train horn or whistle.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
-*'''<kuid:478639:100034> HornzExtended'''
-*'''Built-in Command''' by '''ffccnn'''
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+*'''<kuid:-25:791>'''
- Select one of '''''<Play once>'''''
+*'''Built-in Rule'''
-               '''''<Play twice>'''''
-               ... up to ...
-               '''''<Play 10 times>'''''
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-:When the command is executed, the AI will immediately move onto the next command in the sequence and will blast the horn during the execution of the following driver commands until the set count has been reached
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+   '''Junction Arrows Size ''<Click>''''' - to set scale ratio smaller than default, default is 100%
-*'''[[#Bellz|Bellz]]''' - rings the locomotive bell (if it has one)
-*'''[[#Hornz|Hornz]]''' - gives one blast of the horn or whistle
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''MoveTurntable'''==
+=='''Set HTML Pages Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Instructs the Display HTML Pages rule to perform specific operations. This rule has been superseded by the '''Message Popup Rule'''
-<tr valign="top">
-<td>[[file:CMD_MoveTurntable.png|50px|link=]]</td>
-<td>Moves the specified turntable to the specified track position.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''<kuid2:609850:100018:1> MoveTurntable'''
+*'''<kuid:-25:792>'''
-*'''Built-in Command''' by '''vandragonax'''
+*'''Legacy Rule''' (replaced by '''Message Popup Rule''')
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+*'''Built-in Rule'''
-   '''''<name of turntable>''''' - select the named turntable (see '''Notes''' below).
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-   '''''<track #>'' or ''<relative track movement>''''' - select the track number (0 = 1st track) or a relative movement (prev, next)
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+    '''Operations to preform on the display HTML pages sequence browser'''
-:The '''InputTable Rule''' must be installed in the session before this command can be used. This rule must be configured to identify all the turntables and the number of tracks they have.
+    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)
-[[file:PageLink3.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Required Session Rules:</span><br>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-:'''Rules that MUST be added to the Session for this Driver Command to operate'''
+*'''[[#Display HTML Pages Rule|Display HTML Pages Rule]]''' - displays HTML pages in a browser window.
-*'''[[Session Rule List with Parameters#InputTable Rule|InputTable Rule]]'''
+*'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
+*'''[[#Timed Limited Display HTML Rule (SP2 and later)|Timed Limited Display HTML Rule (SP2 and later)]]''' - displays a HTML page in a browser window for a set time.
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Priorityz'''==
+=='''Show/Hide Layer Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Shows or hides a layer from Driver.
-<tr valign="top">
-<td>[[file:CMD_Priorityz.png|50px|link=]]</td>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-<td>Sets the train priority value.</td>
-</tr>
+*'''<kuid2:401543:1170:1>'''
-</table>
+*'''Built-in Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+   '''''<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.
-*'''<kuid2:66277:80003:1> priorityz'''
+[[file:BugMini.PNG|link=]] <span style="color: red; text-decoration: underline; font-weight: 700;">Known Bugs</span><span style="color: red; font-weight: 700;">:</span>
+:Layers set to '''Hide''' when a game is saved will be '''Shown''' when the saved game is reloaded
-*'''Built-in Command''' by '''smileyman'''
+[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
+:Rule will NOT check to see if the named layer exists or not
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Driver Commands:</span>
+*'''[[Driver Commands List#Layer Control|Layer Control]]'''
-  '''''<value>''''' - select train priority value 1, 2 or 3
+[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+*'''[[How to Use Layers#Layers in Driver Mode|How to Use Layers: Layers in Driver Mode]]
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Show/Hide Minimap Rule'''==
+</td>
+</tr>
+</table>
+Shows the minimap window in Driver.
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:-25:794>'''
+*'''Built-in Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''''<Show/Hide>'' the driver Minimap Window''' - click to switch between '''Show''' and '''Hide'''.
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#Minimap Options Rule|Minimap Options Rule]]''' - sets the display options for the minimap.
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Show/Hide On-screen Help Rule'''==
+</td>
+</tr>
+</table>
+Shows or hides On-screen help in Driver.
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:401543:2020>'''
+*'''Built-in Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''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
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Timed Limited Display HTML Rule (SP2 and later)'''==
+</td>
+</tr>
+</table>
+Displays an HTML browser window for a limited time.
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid2:61392:2005:32>'''
+*'''DLS Rule''' by '''pguy'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+   '''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|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
-:The Priority value identifies the importance of the train for the '''Priority Trackmarkers'''. Usually (a guide only):-
+:Seconds are Trainz clock time, not real time.
-:*Priority 1 = Express trains
-:*Priority 2 = Local Expresses or Fast Freights
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-:*Priority 3 = Slow Local Freights or All Stops Services
+*'''[[#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.
-[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''[[#Message Popup Rule|Message Popup Rule]]''' - displays a pop-up browser window and waits for it to be closed.
-*'''[[How_to_Use_Track_Priority_Markers|How to Use Track Priority Markers]]'''
+*'''[[#Set HTML Page Rule|Set HTML Page Rule]]''' - sets parameters for the '''Display HTML Pages Rule'''
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''[[How to Create a HTML Asset]]'''
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Wait on Waybill Screen/Main Screen Rule'''==
+</td>
+</tr>
+</table>
+Executes child rules when the Waybill window is opened or closed
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:-25:957>'''
+*'''Built-in Rule'''
+*'''Parent Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''[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:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''[[How to Use Parent and Child Rules]]'''
+<br>
+<table width="100%" bgcolor=#ffff88>
+<tr>
+<td>
+'''[[#top|Back to Top]]'''
+</td>
+</tr>
+</table>
+<table width="100%" bgcolor=#ffff88>
+<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.
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''ConsistDataHandler Rule'''==
+</td>
+</tr>
+</table>
+Was used by the '''QuickDrive Rule''' to place consists onto a route. Now obsolete.
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:401543:1180>'''
+*'''Obsolete Rule''' (function is now built into '''Trainz''')
+*'''Base Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''None'''
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Custom Script Rule'''==
+</td>
+</tr>
+</table>
+No description
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:447264:1526>'''
+*'''Built-in Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+   '''None'''
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Generic TreeNode Debug Window Rule'''==
+</td>
+</tr>
+</table>
+No description.
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:30501:1042>'''
+*'''Base Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''None'''
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Session Debug Rule'''==
+</td>
+</tr>
+</table>
+Executes the first child if ''Debug'' mode is selected. Otherwise executes the second child rule.
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:30501:100180>'''
+*'''Built-in Rule'''
+*'''Parent Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''None'''
+[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+: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|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''[[How to Use Parent and Child Rules]]'''
+<br>
+<table width="100%" bgcolor=#ffff88>
+<tr>
+<td>
+'''[[#top|Back to Top]]'''
+</td>
+</tr>
+</table>
+<table width="100%" bgcolor=#ffff88>
+<tr>
+<td>
+='''Navigation Rules'''=
+</td>
+</tr>
+</table>
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Directional Trigger Check Rule'''==
+</td>
+</tr>
+</table>
+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|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid2:532391:100003:1>'''
+*'''DLS Rule''' by '''bobhahn'''
+*'''Parent Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''[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|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+#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|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#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:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+*'''[[How to Control Signals in Sessions#Application 2: Halt Before Clear|How to Control Signals in Sessions: Halt Before Clear]]'''
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''[[How to Use Parent and Child Rules]]'''
+*'''[[How to Use Track Triggers]]'''
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Navigation Display Rule'''==
+</td>
+</tr>
+</table>
+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.
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid2:401543:1161:1>'''
+*'''Base Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''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|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#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:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+*'''[[How to Use Navigation Point Rules]]'''
+*'''[[How to Use Navigation Point Rules (Applications)]]'''
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Navigation Point Complete Rule'''==
+</td>
+</tr>
+</table>
+Manually completes a navigation point in a set
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:401543:1167>'''
+*'''Base Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''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.
+[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
+:The rule will '''NOT''' check to see if the named navigation set and point exists or not.
+[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+:The navigation set and point must first be created by the '''Navigation Display Rule'''
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#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
+[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+*'''[[How to Use Navigation Point Rules]]'''
+*'''[[How to Use Navigation Point Rules (Applications)]]'''
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Navigation Set Check Rule'''==
+</td>
+</tr>
+</table>
+Executes child rules if a navigation set created with the '''Navigation Display Rule''' is complete (or incomplete).
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:401543:1165>'''
+*'''Base Rule'''
+*'''Parent Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''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
+[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
+:The rule will '''NOT''' check to see if the named navigation set exists or not.
+[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+:The navigation set must first be created by the '''Navigation Display Rule'''
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
+*'''[[#Navigation Set Hide/Show Rule|Navigation Set Hide/Show Rule]]''' - makes a navigation set visible/invisible.
+*'''[[#Navigation Set Clear Rule|Navigation Set Clear Rule]]''' - completes (terminates) a navigation set.
+*'''[[#Navigation Point Complete Rule|Navigation Point Complete Rule]]''' - manually completes (terminates) a specific navigation point in a set.
+*'''[[#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]''' - executes child rules when a navigation point has been completed
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''[[How to Use Navigation Point Rules]]'''
+*'''[[How to Use Navigation Point Rules (Applications)]]'''
+*'''[[How to Use Parent and Child Rules]]'''
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Navigation Set Clear Rule'''==
+</td>
+</tr>
+</table>
+Clears a navigation set removing any uncompleted navigation points
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:401543:1164>'''
+*'''Base Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''''<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.
+[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
+:The rule will '''NOT''' check to see if the named navigation set exists or not.
+[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+:The navigation set must first be created by the '''Navigation Display Rule'''
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#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
+[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+*'''[[How to Use Navigation Point Rules]]'''
+*'''[[How to Use Navigation Point Rules (Applications)]]'''
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Navigation Set Hide/Show Rule'''==
+</td>
+</tr>
+</table>
+Shows and hides navigation sets. You can have multiple sets visible and hidden at the same time.
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:401543:1163>'''
+*'''Base rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''''<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.
+[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
+:The rule will '''NOT''' check to see if the named navigation set exists or not.
+[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+:The navigation set must first be created by the '''Navigation Display Rule'''
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#Navigation Display Rule|Navigation Display Rule]]''' - creates a set of navigation points.
+*'''[[#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:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+*'''[[How to Use Navigation Point Rules]]'''
+*'''[[How to Use Navigation Point Rules (Applications)]]'''
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Schedule Rule'''==
+</td>
+</tr>
+</table>
+Allows a schedule of timed events to be applied to a train
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:-3:10185>'''
+*'''Base Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''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
+[[file:BugMini.PNG|link=]] <span style="text-decoration: underline; font-weight: 700; color: red;">Known Bugs:</span>
+:There are reports that this rule does not work correctly particularly if a train arrives late or early.
+[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+:Times are Trainz clock times, not real time
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#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
+*'''[[#ScheduleAtTrackside Rule|ScheduleAtTrackside Rule]]''' - issues set of driver commands at a trackmark or trigger
+[[file:WWWLinks.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Other Links:</span>
+*'''<span class="plainlinks">http://www.auran.com/games/gamefiles/trainz/tutorial1.html</span>'''
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Trackside Check Rule'''==
+</td>
+</tr>
+</table>
+Executes child rules when a set train enters a set trigger. Similar to the '''Trigger Check Rule''' but provides different options.
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid2:46162:100207:1>'''
+*'''DLS Rule''' by '''Josefpav'''
+*'''Parent Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''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
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#Directional Trigger Check Rule|Directional Trigger Check Rule]]''' -  executes child rules when activated by a train moving in a set direction.
+*'''[[#Trigger Check Rule|Trigger Check Rule]]''' - executes child rules when activated by a train
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''[[How to Use Parent and Child Rules]]'''
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Trigger Check Rule'''==
+</td>
+</tr>
+</table>
+Executes child rules when a set train enters a set trigger. This rule replaces the older and less versatile '''Trigger Rule'''.
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:-25:1071>'''
+*'''Built-in Rule'''
+*'''Parent Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''[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:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#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:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+*'''[[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 Track Triggers]]'''
+*'''[[How to Use Variables in Sessions (Examples)]]
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''[[How to Use Parent and Child Rules]]'''
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Wait on Navigation Point Rule'''==
+</td>
+</tr>
+</table>
+Executes child rules when a specific navigation point is completed
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:401543:1168>'''
+*'''Base Rule'''
+*'''Parent Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''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.
+[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
+:The rule will '''NOT''' check to see if the named navigation set and point exists or not.
+[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+:The navigation set and point must first be created by the '''Navigation Display Rule'''
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#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 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:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+*'''[[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 (Applications)]]'''
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''[[How to Use Navigation Point Rules]]'''
+*'''[[How to Use Parent and Child Rules]]'''
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Wait on Train Stop/Start Rule'''==
+</td>
+</tr>
+</table>
+Executes child rules when a train stops or starts moving
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:-25:1069>'''
+*'''Built-in Rule'''
+*'''Parent Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''[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
+[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+*'''[[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]]'''
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''[[How to Use Parent and Child Rules]]'''
+<br>
+<table width="100%" bgcolor=#ffff88>
+<tr>
+<td>
+'''[[#top|Back to Top]]'''
+</td>
+</tr>
+</table>
+<table width="100%" bgcolor=#ffff88>
+<tr>
+<td>
+='''Portal Rules'''=
+</td>
+</tr>
+</table>
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Quick Portal Manager Standard Edition Rule (SP2 and later)'''==
+</td>
+</tr>
+</table>
+Manages portals and adds flexible timetables.
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid2:61392:5011:45>'''
+*'''DLS Rule''' by '''pguy'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''Target date is ''day-of-week'' ''&<nowiki />lt;dd/mm/yyyy&<nowiki />gt;''''' - ''day-of-week'' and ''date'' shown are for today's date. Click '''''dd/mm/yyyy''''' to change date.
+    '''''<Copy rule data to Clipboard>''''' - click to copy the currently entered data to a special clipboard area used by the rules created by '''pguy'''.
+       This is NOT the standard OS clipboard.
+    '''''<Paste rule data from Clipboard>''''' - if data is held in the special clipboard area, then click to paste that data into the rule.
+       This is NOT the standard OS clipboard.
+    '''[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.
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#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
+*'''[[#Un-Portal Rule|Un-Portal Rule]]''' - configures trackmarks as portals
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Quick_Portal_Manager</span>'''
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Un-Portal Rule'''==
+</td>
+</tr>
+</table>
+Provides portals to routes that have no portals by configuring track marks as portals.
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid2:117746:1024:10>'''
+*'''DLS Rule''' by '''sforget'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''Maximum Trains on Route ''<value>''''' - enter number
+    '''Remove Excess Trains ''<YES/NO>''''' - select either. Warning: Selecting YES may result in undesirable effects
+    '''Remove Which Trains ''<Last created/Oldest>''''' - select either
+    '''''<u>New Un-Portal</u>''''' - click to select a new Un-portal from the session list of available track marks
+    For each Un-portal:-
+       '''''<u>Track Mark Name</u>''''' - click on track mark name to configure the Un-Portal
+       Configuration Settings:-
+          '''Currently Editing Portal ''<u>Track Mark Name</u> <u>Remove</u>''''' - click on name to edit a different Un-Portal, click on '''Remove''' to delete this Un-Portal
+          '''Time between trains ''<value>'' minutes''' - enter number of minutes
+          '''Timer Fluctuation ''<value>'' minutes''' - enter how much randomness to add to the "Time between trains"
+          '''Direction Relative to TrackMark ''<Forwards/Backwards>''''' - select one to indicate the direction of travel compared to the direction of the Track Mark
+          '''Consume Trains ''<YES/NO>''''' - select one
+          '''Emit Immediately ''<YES/NO>''''' - select one
+          '''Order to Emit Trains ''<Random/Sequential>''''' - select one to control train order from entered list of consists
+          '''Wait for Triggered Event ''<YES/NO>''''' - select one
+          '''''<u>Add New Consist</u>''''' - click to add a consist to be emitted.
+             '''''+''''' - click to add a ''specific'' vehicle from the session list
+             '''''x''''' - click to remove the ''specific'' vehicle from the rule
+             '''''<u>Add driver to consist</u>''''' - click to select a driver from the session list
+             '''''<u>Add an existing saved consist</u>''''' - click to select a previously saved consist
+[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+#Minutes are Trainz clock time, not real time
+#If '''Consume Trains''' is set to '''YES''' then ALL trains that pass over that trackmark will be consumed so don't create the Un-Portal on a mainline
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#Quick Portal Manager Standard Edition Rule (SP2 and later)|Quick Portal Manager Standard Edition Rule (SP2 and later)]]''' - provides additional features for portals
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''[[How to Use Portals]]'''
+<br>
+<table width="100%" bgcolor=#ffff88>
+<tr>
+<td>
+'''[[#top|Back to Top]]'''
+</td>
+</tr>
+</table>
+<table width="100%" bgcolor=#ffff88>
+<tr>
+<td>
+='''Resources Rules'''=
+</td>
+</tr>
+</table>
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''ExTrainz Manager Rule - TANE SP2'''==
+</td>
+</tr>
+</table>
+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|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:160293:10029>'''
+*'''DLS Rule''' by '''trev999'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''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.
+[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
+:This rule is NOT compatible with all industries.
+[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+#Rolling stock installed in the current session only (see settings above) can be searched to find a match for any selected product from any industry. In Surveyor (and Driver if that setting is enabled) click on the '''View Products''' sub menu link and click on a product name in the '''Product Window''' to display a list of all compatible rolling stock for that product.
+#Alternatively, click on the '''View Industries''' sub menu link and then click on a ''Product Icon'' to open a '''Product Window''', then click     on the '''''View Rolling Stock''''' link at the top of the window.
+#Industry class names are defined in the config.txt file of industry assets and are not normally accessible by users. However, you can exclude an entire group of related "industry asset classes" such as ''station'', ''coalingtower'', ''watertank'', etc regardless of their actual names provided those assets have been given that "class name" by their creators.
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Hide Product Overlays Rule'''==
+</td>
+</tr>
+</table>
+Hides the commodity or product bar graphs that appear on active industries
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:400048:100970>'''
+*'''DLS Rule''' by '''callavsg'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+   '''None'''
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Multiple Resource Check Rule'''==
+</td>
+</tr>
+</table>
+Executes child rules if industries or vehicles reach set commodity levels. This rule replaces the older '''Resource Check Rule'''
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:-25:656>'''
+*'''Built-in Rule'''
+*'''Parent Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''<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
+[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+: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|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#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:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+*'''[[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]]'''
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''[[How to Use Parent and Child Rules]]'''
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Resource Check Rule'''==
+</td>
+</tr>
+</table>
+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|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:-25:1067>'''
+*'''Legacy Rule''' (replaced by '''Multiple Resource Check Rule''')
+*'''Built-in Rule'''
+*'''Parent Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    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'''
+[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+: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|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#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|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''[[How to Use Parent and Child Rules]]'''
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Resource_Check_Rule</span>'''
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Resource Verify Rule (fixed)'''==
+</td>
+</tr>
+</table>
+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|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:160293:10060>'''
+*'''DLS Rule''' by '''trev999
+*'''Parent Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    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'''
+[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+#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|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#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
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''[[How to Use Parent and Child Rules]]'''
+<br>
+<table width="100%" bgcolor=#ffff88>
+<tr>
+<td>
+'''[[#top|Back to Top]]'''
+</td>
+</tr>
+</table>
+<table width="100%" bgcolor=#ffff88>
+<tr>
+<td>
+='''Schedule Rules'''=
+</td>
+</tr>
+</table>
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Driver Command Check Rule'''==
+</td>
+</tr>
+</table>
+Executes child rules if the driver commands match a set list.
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:-25:447>'''
+*'''Built-in Rule'''
+*'''Parent Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+  '''[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:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#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
+*'''[[#ScheduleAtTrackside Rule|ScheduleAtTrackside Rule]]''' - issues set of driver commands at a trackmark or trigger
+*'''[[#Schedule Library Rule|Schedule Library Rule]]''' - creates a library of driver schedules (commands)
+*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''[[How to Use Parent and Child Rules]]'''
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Driver_Command_Rule</span>'''
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Driver Command Rule'''==
+</td>
+</tr>
+</table>
+Specifies which commands will be available for the drivers
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:-3:10057>'''
+*'''Base Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+:
+    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|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+: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.
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
+*'''[[#Driver Schedule Rule|Driver Schedule Rule]]''' - sets up a list of basic scheduled driver commands
+*'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
+*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
+*'''[[#ScheduleAtTrackside Rule|ScheduleAtTrackside Rule]]''' - issues set of driver commands at a trackmark or trigger
+*'''[[#Schedule Library Rule|Schedule Library Rule]]''' - creates a library of driver schedules (commands)
+*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
+[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+*'''[[How to Use Driver Setup Rule#Driver Command Rule|How to Use Driver Command Rule]]'''
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''[[Driver_Commands_List|Driver Commands List]]'''
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Driver Schedule Rule'''==
+</td>
+</tr>
+</table>
+Sets up a list of basic scheduled commands
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid2:82445:90001:9>'''
+*'''Built-in Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''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|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#Driver Command Check Rule|Driver Command Check Rule]]''' - executes child rules if the driver commands match a set list
+*'''[[#Driver Command Rule|Driver Command Rule]]''' - specifies which commands will be available for the drivers
+*'''[[#Driver Setup Rule|Driver Setup Rule]]''' - creates a list of drivers and assign them their orders
+*'''[[#Enable/Disable Driver Commands Rule|Enable/Disable Driver Commands Rule]]''' - enable/disable specific driver commands on certain drivers
+*'''[[#ScheduleAtTrackside Rule|ScheduleAtTrackside Rule]]''' - issues set of driver commands at a trackmark or trigger
+*'''[[#Schedule Library Rule|Schedule Library Rule]]''' - creates a library of driver schedules (commands)
+*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
+[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+*'''[[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]]
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Driver Setup Rule'''==
+</td>
+</tr>
+</table>
+Creates the list of drivers for this session and assigns them their orders
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:-16:2025>'''
+*'''Base Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''''<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
+[[file:Issues.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
+#The '''Remove all existing Drivers first''' option does not appear to work in '''TANE''' (but works in '''TRS19''' and later)
+#Adding a large number of drivers to a session can cause ''Timeout'' errors. One known workaround is to split the drivers between two copies of the '''Driver Setup Rule''' and make the second copy a child of a '''Wait Rule'''. For more details see the Wiki '''[[How to Use Driver Setup Rule]]'''. This issue has been reported as '''FIXED''' in the latest '''beta''' versions of '''TRS19 SP1''' and '''Trainz Plus'''
+[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+: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:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#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
+*'''[[#ScheduleAtTrackside Rule|ScheduleAtTrackside Rule]]''' - issues set of driver commands at a trackmark or trigger
+*'''[[#Schedule Library Rule|Schedule Library Rule]]''' - creates a library of driver schedules (commands)
+*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
+[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+*'''[[How to Use Driver Setup Rule]]'''
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''[[Driver_Commands_List|Driver Commands List]]'''
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Driver_Setup_Rule</span>'''
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Enable/Disable Driver Commands Rule'''==
+</td>
+</tr>
+</table>
+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|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:-25:480>'''
+*'''Built-in Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''<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
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#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
+*'''[[#ScheduleAtTrackside Rule|ScheduleAtTrackside Rule]]''' - issues set of driver commands at a trackmark or trigger
+*'''[[#Schedule Library Rule|Schedule Library Rule]]''' - creates a library of driver schedules (commands)
+*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Enable/Disable_Driver_Commands_Rule</span>'''
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''ScheduleAtTrackside Rule'''==
+</td>
+</tr>
+</table>
+Allows a set of driver commands to be given to a train when it reaches a trackmark or trigger.
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid2:61392:2001:6>'''
+*'''DLS Rule''' by '''pguy'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''''<Select trackmark>'' - ''<Select trigger>''''' - click one to select a trackmark from the Session list or a trigger from the Session list
+    '''Schedule will be fired ''<in both directions/in trackside forward direction/in trackside backward direction>''''' - click to select one. Only available if '''trackmark''' has been selected
+    '''This rule will be applied ''<all along the session>''''' - click to enter the number of times to trigger the rule. 0 = everytime (all along the session)
+    '''Enter driver commands to schedule when train is at trackside'''
+       '''''>>''''' - click to enter driver commands from those specified in the '''Driver Command Rule'''
+    Select one of two option buttons:-
+       '''( ) new schedule will replace current driver command''' - select to delete any current command list and replace it with the command list above
+       '''( ) new schedule will be appended to current driver commands''' - select to add the command list above above to the current driver command list
+    '''''<add a new trackside entry>''''' - click to add a new '''ScheduleAtTrackside''' entry below
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#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
+*'''[[#Schedule Library Rule|Schedule Library Rule]]''' - creates a library of driver schedules (commands)
+*'''[[#Schedule Rule|Schedule Rule]]''' - allows a schedule of timed events to be applied to a train
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Schedule Library Rule'''==
+</td>
+</tr>
+</table>
+Creates a library of driver schedules (driver command lists) that can be given to drivers during the creation or running of a session
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid2:192081:12:5>'''
+*'''Built-in Rule''' by '''brummfondel'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+   '''''<add schedule>''''' | '''''<add group>'''''
+      To add <u>individual schedules</u> click ''<add schedule>'' then
+        '''''<library Entry Name>''''' - enter a unique name for the schedule
+           '''''<library Entry Name>''''' - click to edit name
+           '''''<remove>''''' - click to delete this schedule from the list
+           '''''<copy>''''' - click to add a copy this schedule to the current group
+           '''''<move to group>''''' - click to move this schedule to a schedule group
+           In the driver command bar:-
+              '''''>>''''' - click to enter driver commands from those specified in the '''Driver Command Rule'''
+       To add <u>groups of schedules</u> click ''<add group>'' then
+        '''''<Group Name>''''' - enter a unique name for the group
+            '''-''' - click to close the group list
+            '''+''' - click to open the group list
+            '''''<Group Name>''''' - click to edit name
+            '''''<remove>''''' - click to delete this group from the schedule list
+[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+#Create the library schedules in this rule first.
+#In '''Surveyor''' (using the '''Driver Setup Rule''') or '''Driver''' (directly in a driver command bar) add the Driver Command '''Copy Commands From''' and select the command schedule to be added or appended. The driver command '''Copy Commands From''' must be enabled in the '''Driver Command Rule'''.
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#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
+*'''[[#ScheduleAtTrackside Rule|ScheduleAtTrackside Rule]]''' - issues set of driver commands at a trackmark or trigger
+*'''[[#Schedule Rule|Schedule Rule]]''' - applies a schedule of timed events to a train
+[[file:PageLink4.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Dependent Driver Commands:</span>
+:'''The rule must be added to the Session for the following Driver Command to work'''
+*'''[[Driver Commands List#Copy Commands From|Copy Commands From]]'''
+<br>
+<table width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Schedule Rule'''==
+</td>
+</tr>
+</table>
+Allows a schedule of timed events to be applied to a train
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:-3:10185>'''
+*'''Base Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''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
+[[file:BugMini.PNG|link=]] <span style="text-decoration: underline; font-weight: 700; color: red;">Known Bugs:</span>
+:There are reports that this rule does not work correctly particularly if a train arrives late or early.
+[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+:Times are Trainz clock times, not real time
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#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
+*'''[[#ScheduleAtTrackside Rule|ScheduleAtTrackside Rule]]''' - issues set of driver commands at a trackmark or trigger
+*'''[[#Schedule Library Rule|Schedule Library Rule]]''' - creates a library of driver schedules (commands)
+[[file:WWWLinks.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Other Links:</span>
+*'''<span class="plainlinks">http://www.auran.com/games/gamefiles/trainz/tutorial1.html</span>'''
+<br>
+<table width="100%" bgcolor=#ffff88>
+<tr>
+<td>
+'''[[#top|Back to Top]]'''
+</td>
+</tr>
+</table>
+<table width="100%" bgcolor=#ffff88>
+<tr>
+<td>
+='''Session Sequence Rules'''=
+</td>
+</tr>
+</table>
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Ordered List Rule'''==
+</td>
+</tr>
+</table>
+Executes child rules in order once this rule starts
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:-25:171>'''
+*'''Built-in Rule'''
+*'''Parent Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    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|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
+: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|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child on the second run, etc
+*'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule
+*'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously
+*'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''[[How to Use Parent and Child Rules]]'''
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Ordered_List</span>'''
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Progressive List Rule'''==
+</td>
+</tr>
+</table>
+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|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:-25:754>'''
+*'''Built-in Rule'''
+*'''Parent Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+   '''After last child has been executed ...'''
+   '''''<successive runs will do nothing/the first child is chosen again>''''' - click to select one
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order
+*'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule
+*'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously
+*'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''[[How to Use Parent and Child Rules]]'''
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Progressive_List</span>'''
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Random List Rule'''==
+</td>
+</tr>
+</table>
+Executes ONE randomly selected child rule once only. The rule will not repeat to randomly select another child rule
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:-25:758>'''
+*'''Built-in Rule'''
+*'''Parent Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''None'''
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order
+*'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child rule on the second run, etc
+*'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously
+*'''[[#Simultaneous List Rule|Simultaneous List Rule]]''' - executes all child rules simultaneously
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''[[How to Use Parent and Child Rules]]'''
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Random_List</span>'''
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Reset List Rule'''==
+</td>
+</tr>
+</table>
+Executes ALL child rules continuously in an ongoing infinite cycle
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:-25:762>'''
+*'''Built-in Rule'''
+*'''Parent Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''None'''
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#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:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''[[How to Use Parent and Child Rules]]'''
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Reset_List</span>'''
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Simultaneous List Rule'''==
+</td>
+</tr>
+</table>
+Executes child rules simultaneously once this rule starts
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:-25:1048>'''
+*'''Built-in Rule'''
+*'''Parent Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''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'''''
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#Ordered List Rule|Ordered List Rule]]''' - executes child rules in order
+*'''[[#Progressive List Rule|Progressive List Rule]]''' - executes the first child rule on the first run, the second child on the second run, etc
+*'''[[#Random List Rule|Random List Rule]]''' - executes ONE randomly selected child rule
+*'''[[#Reset List Rule|Reset List Rule]]''' - executes all child rules continuously
+[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+*'''[[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]]
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Simultaneous_List</span>'''
+<br>
+<table width="100%" bgcolor=#ffff88>
+<tr>
+<td>
+'''[[#top|Back to Top]]'''
+</td>
+</tr>
+</table>
+<table width="100%" bgcolor=#ffff88>
+<tr>
+<td>
+='''Speed Rules'''=
+</td>
+</tr>
+</table>
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''ATP Speed Limiter Rule'''==
+</td>
+</tr>
+</table>
+Limits allowable speed over set limit
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid2:321959:1000:1>'''
+*'''Built-in Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''Limits the speed to ''<value>'' mph over the set limit''' - enter speed value in mph
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#AWS Configuration Rule|AWS Configuration Rule]]''' - configures the Trainz implementation of the Automatic Warning System when approaching signals
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Speeding Check Rule'''==
+</td>
+</tr>
+</table>
+Executes child rules if player controlled trains are over the local speed limit or over a set (custom) speed
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid2:60850:89004:3>'''
+*'''Built-in Rule'''
+*'''Parent Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    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'''
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''[[How to Use Parent and Child Rules]]'''
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''MaxPermittedSpeed Rule'''==
+</td>
+</tr>
+</table>
+Sets the maximum permitted speed of locomotives under AI control
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid2:60850:89000:7>'''
+*'''Built-in Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''None'''
+[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+: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
+<br>
+<table width="100%" bgcolor=#ffff88>
+<tr>
+<td>
+'''[[#top|Back to Top]]'''
+</td>
+</tr>
+</table>
+<table width="100%" bgcolor=#ffff88>
+<tr>
+<td>
+='''Startup and Termination Rules'''=
+</td>
+</tr>
+</table>
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''End Session Rule'''==
+</td>
+</tr>
+</table>
+End the Session with a fade out.
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:-25:482>'''
+*'''Built-in Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''Fade out over ''<value>'' seconds''' - enter number of seconds for fade out.
+[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+:Seconds are Trainz clock time, not real time.
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#Session Complete Rule|Session Complete Rule]]''' - set the session to a percentage of completion
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Multiplayer Rule'''==
+</td>
+</tr>
+</table>
+Enables the session to be taken online in a Multiplayer environment.
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:447264:1045>'''
+*'''Built-in Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''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
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Randomize Rule'''==
+</td>
+</tr>
+</table>
+Generates a different set of random numbers each time the session is run.
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:169301:100129>'''
+*'''DLS Rule''' by '''Terry_Wagstaff'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''None'''
+[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+: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|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#Variable Random|Variable Random]]''' - sets a variable to a random integer value.
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Session Complete Rule'''==
+</td>
+</tr>
+</table>
+Set session to a percentage of completion.
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:447264:1011>'''
+*'''Base Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''Set session to percent complete ''<value>''''' - enter number as a percentage
+    '''[x] Separate achievements for completion''' - check to set
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#End Session Rule|End Session Rule]]''' - end the Session with a fade out.
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Startup Options Rule'''==
+</td>
+</tr>
+</table>
+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|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:-16:10212>'''
+*'''Base Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''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|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+:Times are Trainz clock time, not real time
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#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
+<br>
+<table width="100%" bgcolor=#ffff88>
+<tr>
+<td>
+'''[[#top|Back to Top]]'''
+</td>
+</tr>
+</table>
+<table width="100%" bgcolor=#ffff88>
+<tr>
+<td>
+='''Time Rules'''=
+</td>
+</tr>
+</table>
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Clock Rule'''==
+</td>
+</tr>
+</table>
+Rule needed for animated clocks.
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid2:62310:30041:2>'''
+*'''Built-in Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''None'''
+[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+: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.
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Time and Rate Rule'''==
+</td>
+</tr>
+</table>
+Sets the session start time and the rate at which time passes.
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:-25:889>'''
+*'''Built-in Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''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|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#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.
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Timecheck Rule'''==
+</td>
+</tr>
+</table>
+Executes child rules at a set time.
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid2:122381:10008:3>'''
+*'''Built-in Rule'''
+*'''Parent Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''''<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|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
+: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|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+:Times and days are Trainz clock times not real time.
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#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|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''[[How to Use Parent and Child Rules]]'''
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Wait Rule'''==
+</td>
+</tr>
+</table>
+Executes child rules after waiting for set number of seconds
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid2:122381:10016:2>'''
+*'''Built-in Rule'''
+*'''Parent Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''''<click to set>''''' - enter the number of seconds for the wait delay
+[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+:Seconds is in Trainz clock time, not real time
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#Timecheck Rule|Timecheck Rule]]''' - executes child rules at a set time.
+[[file:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+*'''[[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]]
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''[[How to Use Parent and Child Rules]]'''
+<br>
+<table width="100%" bgcolor=#ffff88>
+<tr>
+<td>
+'''[[#top|Back to Top]]'''
+</td>
+</tr>
+</table>
+<table width="100%" bgcolor=#ffff88>
+<tr>
+<td>
+='''Variable Rules'''=
+</td>
+</tr>
+</table>
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Quick Session Variables Rule'''==
+</td>
+</tr>
+</table>
+Allows the editing of session variables
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid2:61392:5003:30>'''
+*'''DLS Rule''' by '''pguy'''
+*'''Legacy Rule''' (use '''Variable Modify Rule''')
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''''<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|link=]] <span style="text-decoration: underline; font-weight: 700;">Known Issues:</span>
+:Rule creator, '''pguy''', has indicated that the future of this rule is uncertain as parts of it have been devalued in the latest releases of Trainz.
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#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.
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Variable Check Rule'''==
+</td>
+</tr>
+</table>
+Executes child rules when a specific variable matches set conditions
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:-25:1049>'''
+*'''Built-in Rule'''
+*'''Parent Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''''<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|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#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:Ex.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Examples of Use:</span>
+*'''[[How to Use Variables in Sessions (Examples)]]
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''[[How to Use Parent and Child Rules]]'''
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Variable Modify Continuous Rule'''==
+</td>
+</tr>
+</table>
+Adds, subtracts or sets a value to a specified variable every second.
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:-25:1051>'''
+*'''Built-in Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+   '''''<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|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#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.
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Variable Modify Rule'''==
+</td>
+</tr>
+</table>
+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|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:-25:1050>'''
+*'''Built-in Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''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|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#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:Ex.PNG|link=]] '''<u>Examples of Use:</u>'''
+*'''[[How to Use Variables in Sessions (Examples)]]
+[[file:WikiLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Trainz Wiki Links:</span>
+*'''<span class="plainlinks">http://online.ts2009.com/mediaWiki/index.php/Variable_Modify_Rule</span>'''
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Variable Random Rule'''==
+</td>
+</tr>
+</table>
+Assigns a random integer value to a variable.
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:400260:100606>'''
+*'''DLS Rule''' by '''tram_'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+    '''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|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#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:Ex.PNG|link=]] '''<u>Examples of Use:</u>'''
+*'''[[How to Use Variables in Sessions (Examples)]]
+<br>
+<table width=100% width=100% bgcolor=#ffffcc>
+<tr>
+<td>
+=='''Variable Show Rule'''==
+</td>
+</tr>
+</table>
+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|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
+*'''<kuid:-25:971>'''
+*'''Built-in Rule'''
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
+   '''[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|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
+*'''[[#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:Ex.PNG|link=]] '''<u>Examples of Use:</u>'''
+*'''[[How to Use Variables in Sessions (Examples)]]
+<br>
+<table width="100%" bgcolor=#ffff88>
+<tr>
+<td>
+'''[[#top|Back to Top]]'''
+</td>
+</tr>
+</table>
+<table width="100%" bgcolor=#ffff88>
+<tr>
+<td>
+='''Weather Rules'''=
+</td>
+</tr>
+</table>
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Run Around'''==
+=='''EIRS Weather Rule NE USA Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Customize random weather rule relative to the North East Region of the United States.
-<tr valign="top">
-<td>[[file:CMD_RunAround.png|50px|link=]]</td>
-<td>Uncouples the locomotive (plus tender if present) from the train, navigates to the other end of the train and couples to the last wagon.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''<kuid:-3:10083> Run Around'''
+*'''<kuid2:487222:1037:3>'''
-*'''Base Command'''
+*'''Built-in Rule'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
- '''None'''
+    '''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|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
-#There must be a path for the locomotive to follow from one end of the train to the other.
+:Minutes are Trainz clock times, not real times
-#The locomotive must have sufficient clear space, free of track switches and signals, at both ends of the train to perform this movement.
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-*'''[[#Run Around Ex|Run Around Ex]]''' - performs the run around only if there is no loco already in position at the other end
+*'''[[#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
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''Run Around Ex'''==
+=='''Random Weather Rule v2'''==
 </td>
 </tr>
 </table>
-<table>
+Randomly changes the weather conditions between set values over a set duration.
-<tr valign="top">
-<td>[[file:CMD_RunAroundEx.png|50px|link=]]</td>
-<td>Uncouples the locomotive(s) (plus tender if present) from the train, navigates to the other end of the train and couples to the last wagon but ONLY if the other end of the train does not already have a locomotive in place.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''<kuid2:117667:83:3> Run Around Ex'''
+*'''<kuid:169301:100132>'''
-*'''DLS Command''' by '''nicroman'''
+*'''DLS Rule''' by '''terry_wagstaff'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
- '''None'''
+    '''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|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
-#There must be a path for the locomotive to follow from one end of the train to the other.
+: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.
-#The locomotive must have sufficient clear space, free of track switches and signals, at both ends of the train to perform this movement.
-#There must be no locomotive already coupled to the destination end of the train.
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
-*'''[[#Run Around|Run Around]]''' - unconditionally performs the run around
-<br>
-<table width=100% bgcolor=#d7ffc9>
-<tr>
-<td>
-=='''Uncouplez'''==
-</td>
-</tr>
-</table>
-<table>
-<tr valign="top">
-<td>[[file:CMD_Uncouplez.png|50px|link=]]</td>
-<td>Uncouples the locomotive (plus tender if present) from the train.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
-*'''<kuid2:66277:80000:1> UnCouplez'''
-*'''Built-in Command''' by '''smileyman'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
- '''None'''
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-*'''[[#Couple|Couple]]''' - couples wagons in a consist
+*'''[[#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
-*'''[[#Couple At Trackmark|Couple At Trackmark]]''' - couples to the wagon closest to a specified trackmark
+*'''[[#Startup Options Rule|Startup Options Rule]]''' - sets the weather conditions at the start of a Session
-*'''[[#Decouple|Decouple]]''' - decouples a consist at a specific place (does not work in the '''Driver Setup Rule''')
+*'''[[#Weather Rule|Weather Rule]]''' - changes the weather conditions during Session play
-*'''[[#Decouple DLX|Decouple DLX]]''' - decouples a consist at a specific, or a random, place. Upto 99 wagons
-*'''[[#Decouple Head N|Decouple Head N]]''' - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
-*'''[[#Decouple Number #|Decouple Number #]]''' - decouples a consist at a specific place. Upto 40 wagons
-*'''[[#UncouplezFrom|UncouplezFrom]]''' - decouples a consist at a specific place. Upto 20 wagons
 <br>
-<table width=100% bgcolor=#d7ffc9>
+<table width=100% width=100% bgcolor=#ffffcc>
 <tr>
 <td>
-=='''UncouplezFrom'''==
+=='''Weather Rule'''==
 </td>
 </tr>
 </table>
-<table>
+Changes the weather conditions during Session play.
-<tr valign="top">
-<td>[[file:CMD_Uncouplez.png|50px|link=]]</td>
-<td>Uncouples the train at the wagon specified.</td>
-</tr>
-</table>
-[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Properties:</span>
-*'''<kuid2:66277:80005:2> UnCouplezFrom'''
+[[file:Properties.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Properties:</span>
-*'''Built-in Command''' by '''smileyman'''
+*'''<kuid:-25:960>'''
-[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Command Settings:</span>
+*'''Built-in Rule'''
-   '''''<number>''''' - select a wagon number (0-20) to decouple from.
+[[file:Settings.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Rule Settings:</span>
-[[file:Notes.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Notes:</span>
+    '''Set weather to ''<select mode>'' with ''<select frequency>'' changeability''' - select
-#The first wagon '''after''' the locomotive (or the locomotive and tender) is #0, the second wagon is #1, etc.
+       '''Weather mode:''' - select one of:-
-#The main problem with using decoupling commands in the '''Driver Setup Rule''' is that the number and identity of the wagons in a consist may not be known when the command is added to a driver's command list.
+          '''''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
-[[file:PageLink2.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Commands:</span>
+[[file:PageLink.PNG|link=]] <span style="text-decoration: underline; font-weight: 700;">Related Rules:</span>
-*'''[[#Couple|Couple]]''' - couples wagons in a consist
+*'''[[#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
-*'''[[#Couple At Trackmark|Couple At Trackmark]]''' - couples to the wagon closest to a specified trackmark
+*'''[[#Random Weather Rule v2|Random Weather Rule v2]]''' - randomly changes the weather according to entered parameters
-*'''[[#Decouple|Decouple]]''' - decouples a consist at a specific place (does not work in the '''Driver Setup Rule''')
+*'''[[#Startup Options Rule|Startup Options Rule]]''' - sets the weather conditions at the start of a Session
-*'''[[#Decouple DLX|Decouple DLX]]''' - decouples a consist at a specific, or a random, place. Upto 99 wagons
-*'''[[#Decouple Head N|Decouple Head N]]''' - decouples a consist to leave set number (N) of wagons in the consist. Upto 75 wagons
-*'''[[#Decouple Number #|Decouple Number #]]''' - decouples a consist at a specific place. Upto 40 wagons
-*'''[[#Uncouplez|Uncouplez]]''' - decouples the locomotive (or locomotive + tender) from a consist
 <br>
-<table bgcolor=#a8ff8a>
+<table width="100%" bgcolor=#ffff88>
 <tr>
 <td>
@@ Line 3,431: / Line 6,052: @@
 <span style="font-size: 17px; font-weight: 700;">More Tutorials and Guides to Using Trainz</span><br>
 *'''<span class="plainlinks">[http://online.ts2009.com/mediaWiki/index.php/HowTo How to Guides]</span>'''
+*'''[[Driver Commands List]]'''
 *'''[[Session Rule List with Parameters|Session Rules List (Alphabetical) with Parameters]]'''
-*'''[[Session Rules By Categories With Properties|Session Rules List (Categories) With Parameters]]'''
 </td>
 </tr>
 </table>
 [[Category:How-to_guides|HowTo Guides]]
+[[Category:Rules]]

Driver Commands List: Difference between revisions

Pware (talk | contribs)

Revision as of 21:35, 1 November 2019

Achievement Rules

Achievement Check Rule

Consist Check Rule

Multiple Resource Check Rule

Objective Add Rule

Objective Check Rule

Objective Update Rule

Ranked Session Begin Rule

Ranked Session Complete Rule

Resource Check Rule

Resource Verify Rule (fixed)

Station Visited Check Rule

Camera Rules

Cinematic Camera Rule

Focus Camera Rule

Set Camera Rule

Wait for Camera View Mode Rule

Danger, Derailment and Safety Rules

ATP Speed Limiter Rule

AWS Configuration Rule

Clean Up Derailed Trains Rule

Coupler Breakage Check Rule

Coupler Breakage HUD Rule

Junction Derailment Prevention Rule

Replace Missing Vehicles Rule

Safety System Engaged Check Rule

Safety System Isolated Check Rule

Set Coupler Masks Rule

Signal Passed At Danger Check Rule

Speeding Check Rule

Vehicle Physics Rule

Wait for Derailment Rule

Driver Rules

AI Start Rule

AI Stop Rule

Control Check Rule

Control Type Rule

Disallow AI Rule

Driver Command Check Rule

Driver Command Rule

Driver Main Menu Options Rule

Driver Schedule Rule

Driver Setup Rule

Enable/Disable Driver Commands Rule

JTG Correct Vehicle Lights

QuickDrive Rule

ScheduleAtTrackside Rule

Schedule Library Rule

Schedule Rule

Wait for Driver On/Off Train Rule

Wait for Driver/Train to be Locally Owned Rule

HUD (Heads Up Display) Rules

Cab Controls HUD Rule

Coupler Breakage HUD Rule

Display Custom HUD Rule

Flash HUD Icon Rule

mc Display Custom HUD V2 Rule (SP2 and later)

Quick CustomHud Manager Rule (SP2 and later)

Show/Hide HUD Panel Rule

Variable Show Rule

Wait for Click on HUD Icon Rule

Industry Rules

Advanced Industry Load Configuration Rule

Disable/Enable Industry Rule

ExTrainz Manager Rule - TANE SP2

Multiple Resource Check Rule

Power Station Rule

Resource Check Rule

Resource Verify Rule (fixed)

Station Visited Check Rule

Interlocking Tower, Junction and Signal Rules

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

Junction Derailment Prevention Rule