Session Rules By Categories With Properties
Train Railroad Simulator 2019 (TRS19) and TRAINZ A New Era (TANE) SP3. List of Trainz Session Rules in Alphabetical Order with Properties. All rules are the Copyright of N3V Games
This page is always under construction. As new rules appear and are tested they will be added to this list. Current Rule Count: 128 |
Only rules supplied with TRS19/TANE or on the DLS are covered in this document.
The rules listed in this page are all accessible in Trainz Surveyor from the Edit Session option in the Main Menu. Those rules that are identified as DLS Rule must be downloaded and installed from the Trainz DLS first. For some examples see the Wiki page Parent and Child Rules (Session Editor) |
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 TRS19/TANE.
- Parent Rule will execute child rules if it returns a true result.
- Obsolete Rule is no longer required (explanation given).
- Legacy Rule has been replaced by another rule (new rule will be identified).
- Rules that are named TANE SP2 or TANE SP3 will work in TRS19.
Achievement Rules |
Achievement Check Rule |
Executes child rules when achievement conditions have been met
- <kuid:401543:1190>
- Built-in Rule
- Parent Rule
<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
Consist Check Rule |
Executes child rules when a matching consist is found. The order of the vehicles in the consists is not important.
- <kuid:-25:1068>
- Built-in Rule
- Parent Rule
[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
- 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.
Multiple Resource Check Rule |
Executes child rules if industries or vehicles reach set commodity levels. This rule replaces the older Resource Check Rule
- <kuid:-25:656>
- Built-in Rule
- Parent Rule
<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
- This rule only checks for changing commodity levels during loading and unloading operations. It cannot be used to test, for example, if a vehicle is full or empty.
- Resource 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
Objective Add Rule |
Sets up a game Objective with ID and display Name
- <kuid:401543:2001>
- Base Rule
Priority <Select> - select one of:- Above Normal Below Normal Normal Optional Urgent Completion Target Number <value> - to set Completion Target Number Icon <select> - to select Icon from list Display Name <enter> - to insert Name Unique Objective ID <enter> - enter a unique objective ID Custom Message <Text Box> - insert typed message in text area
- Objective Check Rule - executes child rules if an objective 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.
- <kuid:401543:2003>
- Base Rule
- Parent Rule
Unique Objective ID <value> - enter the unique ID created with the Objective Add Rule Mode <select> - select one of three:- Wait for completion Wait for failure Wait for progress
- Objective Add Rule - sets up a game objective
- Objective Update Rule - changes the progress of a game objective
Objective Update Rule |
Changes progress of an objective outcome created with the Objective Add Rule according to Property choices
- <kuid:401543:2002>
- Base Rule
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
- 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
- <kuid:401543:2031>
- Base Rule
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
- Times are Trainz clock time, not real time
- Ranked Session Complete Rule - completes the active ranked Session
Ranked Session Complete Rule |
Completes the active ranked Session
- <kuid:401543:2032>
- Base Rule
Set the active ranked session as: - select one of two option buttons:- ( ) Complete ( ) Failed [x] Customize the completion message <text> - enter a text message
- 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
- <kuid:-25:1067>
- Legacy Rule (replaced by Multiple Resource Check Rule)
- Built-in Rule
- Parent Rule
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
- 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.
- 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
Resource Verify Rule (fixed) |
Executes child rules if a selected industry or vehicle reaches a set commodity level. The rule resets when all child rules have completed.
- <kuid:160293:10060>
- DLS Rule by trev999
- Parent Rule
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
- 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.
- 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
Station Visited Check Rule |
Executes child rules if specific trains call at set stations or industries
- <kuid2:60850:89005:3>
- Built-in Rule
- Parent Rule
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
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.
- <kuid2:401543:1166:3>
- Built-in Rule
[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
- Times are Trainz clock times, not real times
- 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.
- <kuid2:122381:10014:1>
- DLS Rule by mizi
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
- 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.
- <kuid:-25:179>
- Built-in Rule
[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
- 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
- <kuid:-25:192>
- Built-in Rule
- Parent Rule
[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
- 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
Danger, Derailment and Safety Rules |
ATP Speed Limiter Rule |
Limits allowable speed over set limit
- <kuid2:321959:1000:1>
- Built-in Rule
Limits the speed to <value> mph over the set limit - enter speed value in mph
- AWS Configuration Rule - configures the Trainz implementation of the Automatic Warning System when approaching signals
AWS Configuration Rule |
This rule configures the Trainz implementation of the Automatic Warning System when approaching signals
- <kuid2:60850:89002:3>
- Built-in Rule
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
- <kuid2:60850:89003:1>
- Base Rule
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
- Time is Trainz clock time, not real time.
- Replace Missing Vehicles Rule - creates a replacement train after a derailment
- Wait for Derailment Rule - executes child rules when a derailment occurs
Coupler Breakage Check Rule |
Executes child rules if there is a coupler breakage
- <kuid2:447264:1017:1>
- Built-in Rule
- Parent Rule
None
- Coupler Breakage HUD Rule - adds a coupler stress and breakage warning to the HUD
- Set Coupler Masks Rule - sets the coupling/decoupling masks on selected vehicles
Coupler Breakage HUD Rule |
HUD displays warning about coupler stress and breakage
- <kuid:-25:423>
- Built-in Rule
Select one of two option buttons:- ( ) Show the Coupler Breakage Display ( ) Hide the Coupler Breakage Display
- 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.
- <kuid2:121843:100282:1>
- DLS Rule by pitkin
None
- This rule will not overrule a junction already locked by another AI train or locked against AI control using the Set Junctions Rule.
- 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
- <kuid:447264:1214>
- Built-in Rule
[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
- 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.
- <kuid:447264:1216>
- Built-in Rule
- Parent Rule
[x] Trigger only once
- Safety System Isolated Check Rule - executes child rules if safety systems have been isolated
Safety System Isolated Check Rule |
Executes child rules if safety systems are isolated (disengaged).
- <kuid:447264:1217>
- Built-in Rule
- Parent Rule
[x] Trigger only once
- Safety System Engaged Check Rule - executes child rules if safety systems have been engaged
Set Coupler Masks Rule |
Set the coupling/decoupling masks on the selected vehicles
- <kuid:-25:980>
- Built-in Rule
<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
- 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).
- <kuid2:60850:89007:2>
- Built-in Rule
- Parent Rule
[x] Trigger only once
Speeding Check Rule |
Executes child rules if player controlled trains are over the local speed limit or over a set (custom) speed
- <kuid2:60850:89004:3>
- Built-in Rule
- Parent Rule
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
Vehicle Physics Rule |
Overrides the default vehicle physics properties for all vehicles or for those matching set criteria
- <kuid:-25:1052>
- Built-in Rule
Select one of two option buttons:- ( ) click to accept all trains ( ) click to accept trains matching specific criteria Selecting the second option will produce the following selection controls:- Specific vehicle - identify the specific vehicle or set of specific vehicles that will trigger the rule + - 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
- <kuid:-25:1053>
- Built-in Rule
- Parent Rule
[x] Trigger derailment watch once - check to execute the rule once only
- 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
Driver Rules |
AI Start Rule |
Restarts all halted AI controlled trains. Drivers will continue with the commands in their driver command list.
- <kuid2:400048:100981:1>
- DLS Rule by callavsg
None
- 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.
- <kuid2:400048:100980:1>
- DLS Rule by callavsg
None
- 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.
- <kuid:401543:1191>
- Built-in Rule
- Parent Rule
Execute child rules when: - select one of two option buttons:- ( ) DCC mode is Selected ( ) Cab mode is Selected Execute child rules: - select one of two option buttons:- ( ) Every time control method is set ( ) Once only
- Control Type Rule - sets the control method
Control Type Rule |
Sets the control method
- <kuid:-16:2030>
- Base Rule
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)
- 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
- <kuid:400048:100603>
- DLS Rule by callavsg
None
- 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.
- <kuid:-25:447>
- Built-in Rule
- Parent Rule
[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
- 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 - allows a schedule of timed events to be applied to a train
Driver Command Rule |
Specifies which commands will be available for the drivers
- <kuid:-3:10057>
- Base Rule
For each installed Driver Command:- [x] Name of Driver Command and Description (if available) - check to make that command available to the drivers
- Some Driver Commands that have been checked will not appear in the Command Lists for drivers if there is no target for their action. For example:
- The Wait For Trigger command will not be available to any drivers if there are no triggers set.
- The Call At command will not be available to any drivers if there are no industry active assets or passenger enabled stations.
- Driver 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 Rule - allows a schedule of timed events to be applied to a train
Driver Main Menu Options Rule |
Show/Hide the Driver Main Menu Bar
- <kuid:-25:448>
- Built-in Rule
<Show/Hide> the Driver Main Menu Bar - click Show or Hide to select
Driver Schedule Rule |
Sets up a list of basic scheduled commands
- <kuid2:82445:90001:9>
- Built-in Rule
Driver Schedule Assigned to name of driver <icon> - click icon to select a driver from those assigned in the Driver Setup Rule Next commands, will be executed >> - click to enter driver commands from those specified in the Driver Command Rule Style: - select one of four option buttons:- ( ) Classic style: If there is a schedule do not emit a new schedule - any currently assigned set of driver commands will not be replaced ( ) Killer style: If there is a schedule clean it and emit a new one - replace any currently assigned driver commands with the new commands ( ) Cooperative style: If there is a schedule append the new one - add the new driver commands to the end of any existing commands ( ) Active style: Emit a new schedule, only if already a schedule running - only add the new commands if commands are currently running
- Driver 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 Rule - allows a schedule of timed events to be applied to a train
Driver Setup Rule |
Creates the list of drivers for this session and assigns them their orders
- <kuid:-16:2025>
- Base Rule
<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
- The Remove all existing Drivers first option does not appear to work in TANE (but works in TRS19)
- 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
- 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 Rule - allows a schedule of timed events to be applied to a train
Enable/Disable Driver Commands Rule |
Enable/Disable specific driver commands on certain drivers. Multiple copies of the rule can be used to give different drivers or consists different command lists
- <kuid:-25:480>
- Built-in Rule
<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
- 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 Rule - allows a schedule of timed events to be applied to a train
JTG Correct Vehicle Lights |
Corrects the brightness of vehicle headlights. Now obsolete.
- <kuid2:478657:999103:1>
- DLS Rule by jtg-trainz
- Obsolete Rule (function is now built into TANE Driver Additional Tools Menu)
None
QuickDrive Rule |
Changes the Session settings.
- <kuid:401543:1184>
- Base Rule
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
ScheduleAtTrackside Rule |
Allows a set of driver commands to be given to a train when it reaches a trackmark or trigger.
- <kuid2:61392:2001:6>
- DLS Rule by pguy
<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
- 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 Rule - allows a schedule of timed events to be applied to a train
Schedule Rule |
Allows a schedule of timed events to be applied to a train
- <kuid:-3:10185>
- Base Rule
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
- There are reports that this rule does not work correctly particularly if a train arrives late or early.
- Times are Trainz clock times, not real time
- 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
Wait for Driver On/Off Train Rule |
Executes child rules when a driver gets on or off a train
- <kuid:-25:953>
- Built-in Rule
- Parent Rule
[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
- Wait for Driver/Train to be Locally Owned Rule - executes child rules when a vehicle or driver changes ownership
Wait for Driver/Train to be Locally Owned Rule |
Executes child rules when a specific driver or vehicle is locally owned. If the driver/vehicle becomes unowned again the child rules are paused
- <kuid2:401543:1173:1>
- Built-in Rule
- Parent Rule
Assets Ownership: - select one of two option buttons:- ( ) Wait for ownership of a specific Driver ( ) Wait for ownership of Driver Driver or Vehicle <select> - choose from session list
- Wait for Driver On/Off Train Rule - executes child rules when a driver gets on or off a train
HUD (Heads Up Display) Rules |
Cab Controls HUD Rule |
Was used to provide the HUD controls for the cabin view. Now obsolete.
- <kuid:-16:287428>
- Base Rule
- Obsolete Rule (function is now built into TANE)
None
Coupler Breakage HUD Rule |
HUD displays warning about coupler stress and breakage
- <kuid:-25:423>
- Built-in Rule
Select one of two option buttons:- ( ) Show the Coupler Breakage Display ( ) Hide the Coupler Breakage Display
- 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.
- <kuid:-3:10206>
- Base Rule
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
- 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
Flash HUD Icon Rule |
Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.
- <kuid:-25:968>
- Built-in Rule
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.
- 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)
- <kuid2:61392:1072:10>
- Legacy Rule (replaced by Quick CustomHUD Manager Rule (SP2 and later))
- DLS Rule by pguy
Show or Hide the Custom Heads up Display - select one of two option buttons:- ( ) Show the Custom Heads up Display ( ) Hide the Custom Heads up Display
- Display 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)
- <kuid2:61392:5020:47>
- DLS Rule by pguy
<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
- 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 rule must be added to the Session for the following Driver Commands to work
- 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.
- <kuid:-25:1047>
- Built-in Rule
<Show/Hide> the <click to select> HUD panel - select Show or Hide and then select the HUD panel
- 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.
- <kuid:-25:971>
- Built-in Rule
[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.
- 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.
Wait for Click on HUD Icon Rule |
Executes child rules when the user clicks on a selected HUD icon
- <kuid:-25:951> <kuid:-25:970> - two versions built-in with different kuids, both have the same properties
- Built-in Rule
- Parent Rule
[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
- 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.
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
- <kuid:30501:100007>
- Base Rule
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
- Times are Trainz clock time, not real time
Disable/Enable Industry Rule |
Enables/Disables vehicle load/unload for industry
- <kuid2:401543:1171:1>
- Built-in Rule
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.
- <kuid:160293:10029>
- DLS Rule by trev999
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.
- This rule is NOT compatible with all industries.
- 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.
Executes child rules if industries or vehicles reach set commodity levels. This rule replaces the older Resource Check Rule
<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
Sets up a Power Station and its electricity consumers
Power station <select> - select a Power Station from the session list. Consumers: <add object> - add power consumers from the session list
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
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
Executes child rules if a selected industry or vehicle reaches a set commodity level. The rule resets when all child rules have completed.
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
Executes child rules if specific trains call at set stations or industries
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
Sets the path for selected trains
<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
Alters settings on an interlocking tower path
Interlocking Tower <select> - to set Name and Objects
Will automatically react to messages from Interlocking Towers and display a path selection dialog to the player. Disable by removing rule from session
[Checkbox] Show path activation message in Driver
Will set the state of an interlocking tower path for a train
Interlocking Tower <select> - to set Name and Objects
Provides more management and control options for interlocking towers.
<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
Sets opposing (trailing) junctions ahead of a train to prevent derailments. Works with both AI and manually driven trains.
None
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.
None
Enables the addition, editing and management of Mission Codes used to auto select paths in Interlocking Towers.
Refer to the detailed instructions in the Trainz Wiki Links shown below.
Enables the creation, editing and management of stop zones and timetables for trains following a path defined using mission codes.
Refer to the detailed instructions in the Trainz Wiki Links shown below.
Executes child rules if specific junctions are set.
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
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
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
Sets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control). Warning: not compatible with Interlocking Tower Assets
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
Sets the state of a selected signal Warning: not compatible with Interlocking Tower Assets
<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
Sets selected signals to DANGER (STOP) when selected triggers are activated. Signals will be at AUTOMATIC when the triggers are not activated.
<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.
Closes open message popups
None
Creates a list of destination names for a destination sign
<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
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
<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
Displays a page containing a video clip from a HTML asset in a browser window.
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.
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.
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.
|