Session Rules By Categories With Properties
From TrainzOnline
This page is under construction
TRAINZ A New Era SP2-List of Trainz Session Rules by Categories with Properties. All rules are the Copyright of N3V Games
See also Session Rule List (Alphabetical Order)
kuid numbers are for the current versions of each rule at the time of writing. These numbers can change as rules are updated.
Achievement Rules
Achievement Check Rule
This rule allows you to customize session gameplay based on whether the player has received an achievement. If the rule is satisfied then it will execute any following child rules.
<kuid:401543:1190> Built-in Rule
Properties:
<Not configured, click here to select an achievement asset> - click to select an Achievement Asset from those installed
When an Achievement Asset has been selected, the following will appear:-
Achievement KUID: <selected asset name> - 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
Advanced Industry Load Configuration Rule
Locks train controls when loading/unloading at an industry, overrides time settings for begin load and begin unload operations
<kuid:30501:100007> Base Rule
Properties: Target object <select> - select industry object from session list [Check Box] Lock the train's controls during a stopped load/unload operation - check to disable driver controls while train is stopped and loading/unloading [Check Box] Override 'begin load' and 'begin unload' durations to <value> seconds - if checked enter number of seconds to override
Note: Times are Trainz clock time, not real time
Arrival and Departure Score [TANE] Rule
Awards points for arriving and departing stations at the correct times and penalties for lateness. Use a rule such as the Trackside Check Rule to detect the arrival of the train at a timed station and immediately follow it with this rule as a child rule with the parameters set for the particular station.
<kuid:169301:100138> DLS Rule by terry_wagstaff
Properties:
For station <to be set> - select station name from session list
Check arrival time <Yes/No> - click to select Yes or No
Due to arrive - <hh:mm> - set scheduled arrival time in clock hours and minutes
Bonus for early arrival: <points> - enter points
Score for being on time: <points> - enter points
Penalty for late arrival: <points> per second - enter points to be deducted per second
Check departure time <Yes/No> - click to select Yes or No
Minimum wait: <seconds> - enter number of seconds for minimum wait time at platform
Maximum wait: <seconds> - enter number of seconds for maximum wait time at platform
Due to depart - <hh:mm> - set scheduled departure time in clock hours and minutes
Penalty for early departure of moving before guards signal: <points> - enter points
Score for departing on time: <points> - enter points
Penalty for late departure: <points> per second - enter points to be deducted per second
Sound guards whistle <Yes/No> - click to select Yes or No
Notes: Times are Trainz clock times, not real times. The variable "Ranking Points" is modified by this rule.
Consist Check Rule
Waits for a consist to exist that matches a description then executes any following child rules. The order of the vehicles in the consist is not important.
<kuid:-25:1068> Built-in Rule
Properties:
[Check Box] Enforce strict exclusive testing - check to only accept an exact match with no unspecified vehicles in the consist.
- leave unchecked to accept any consist that contains the specified vehicles.
Select one of two option buttons:-
( ) Rule disabled - select to disable the operation of this rule
( ) Complete whenever a train matching the description exists - When selected, enter the consist description:-
Specific vehicle - identify the specific vehicle(s) that will trigger the rule
+ - click to add a specific vehicle from the session list
x - click to remove the specific vehicle from the rule
Vehicle types - identify the type of vehicle(s) that will trigger the rule
+ - click to add a type of vehicle from the session list
x - click to remove the type of vehicle from the rule
Drivers - identify the driver(s) that will trigger the rule
+ - click to add a driver from the session list
x - click to remove a driver from the rule
Note: This rule will continue to check all consists all the time even after it has been triggered. To disable this feature add another copy of the rule with the Rule disabled option selected as one of its child rules.
Multiple Resource Check Rule
If specified resources in a selected industries or vehicles reaches set levels, then executes any following child rules. This rule replaces the older Resource Check Rule
<kuid:-25:656> Built-in Rule
Properties:
<Product Level> - click to select a product test from two choices:-
Reach/Exceed - sets an upper limit for the resources being monitored.
For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon reaches or exceeds a specified level.
The initial level in the object must be below the set upper limit.
Fall below - sets a lower limit for the resources being monitored.
For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon falls below a specified level.
The initial level in the object must be above the set lower limit.
To test when a resource level reaches zero (i.e. is empty) set the lower limit to a very low value but not zero as the level can never fall below zero.
<value> - enter required quantity value
<select> - select a product from session list of products
<Add object> - click to select a source or target object. Multiple objects and their queues can be added to the rule.
ALL the entered products must reach/exceed or fall below the specified value for the rule to be triggered.
For each object:-
<Object> - click to select session active industry or product enabled rail vehicle
<Queue> - select product queue (there may be only one available)
<Remove> - removes the object and its product queue from the rule
Related Rules: Resource Check Rule - Checks the level of resources in a target object, then executes any following child rules.
Objective Add Rule
Sets up a game Objective with ID and display Name
<kuid:401543:2001> Base Rule
Properties:
Priority <Select> - select one of:-
Above Normal
Below Normal
Normal
Optional
Urgent
Completion Target Number <value> - to set Completion Target Number
Icon <select> - to select Icon from list
Display Name <enter> - to insert Name
Unique Objective ID <enter> - enter a unique objective ID
Custom Message <Text Box> - insert typed message in text area
Related Rules: Objective Check Rule - checks if an objective is complete Objective Update Rule - changes the progress of a game objective
Objective Check Rule
Checks if an objective created with the Objective Add Rule is complete, then executes any following child rules
<kuid:401543:2003> Base Rule
Properties:
Unique Objective ID <value> - enter the unique ID created with the Objective Add Rule
Mode <select> - select one of three option buttons:-
Wait for completion
Wait for failure
Wait for progress
Related Rules: Objective Add Rule - sets up a game objective Objective Update Rule - changes the progress of a game objective
Objective Update Rule
Changes progress of an objective outcome created with the Objective Add Rule according to Property choices
<kuid:401543:2002> Base Rule
Properties:
Unique Objective ID <value> - enter the unique ID created with the Objective Add Rule
Mode <select> - select one from the following options
Decrement progress
Increment progress
Reset Objective
Set objects as complete
Set objects as failed
Set progress
Set progress only if greater
Amount <value> - click to enter a value
Related Rules: Objective Add Rule - sets up a game objective Objective Check Rule - checks if an objective is complete
Power Station Rule
Sets up a Power Station and its electricity consumers
<kuid:-25:746> Base Rule
Properties:
Power station <select> - select a Power Station from the session list.
Consumers:
<add object> - add power consumers from the session list
Ranked Session Begin Rule
Begins a ranked Session
<kuid:401543:2031> Base Rule
Properties:
Countdown Starting Value <value>
hrs:
min:
sec:
1 through 5 stars, points for each star <value> - enter number of points for each star rating
Session timer mode: - select one of three option buttons:-
( ) Timer
( ) Countdown Starting value <value> - enter time hh:mm:ss
( ) None
Note: Times are Trainz clock time, not real time
Related Rules: Ranked Session Complete Rule - completes the active ranked Session
Ranked Session Complete Rule
Completes the active ranked Session
<kuid:401543:2032> Base Rule
Properties:
Set the active ranked session as: - select one of two option buttons:-
( ) Complete
( ) Failed
[Check Box] Customize the completion message <text> - enter a text message
Related Rules: Ranked Session Begin Rule - begins a ranked Session
Resource Check Rule
Checks the level of resources in a target object, then executes any following child rules. This rule has been superseded by the Multiple Resource Check Rule
<kuid:-25:1067> Built-in Rule
Properties:
Select one of two option buttons:-
( ) Watch industry queue
Target Object <select> - select an industry from the session list
Queue <select> - select a product queue from the selected industry
Product <select> - select a product from the selected queue
Amount <value> - enter a quantity
Select one of two option buttons:-
( ) Complete when designated queue equals or exceeds required amount
( ) Complete when designated queue falls below required amount
( ) Watch vehicle
Target Object <select> - select a rolling stock asset from the session list
Queue <select> - select a product queue from the selected rolling stock
Product <select> - select a product from the selected queue
Amount <value> - enter a quantity
Select one of two option buttons:-
( ) Complete when designated queue equals or exceeds required amount
( ) Complete when designated queue falls below required amount
Related Rules: Multiple Resource Check Rule - checks specified resources in a selected industries or vehicles reaches set levels, then executes any following child rules.
Station Visited Check Rule
Waits for a designated train or any train to call at one of the designated stations or industries, then executes any following child rules
<kuid2:60850:89005:3> Built-in Rule
Properties:
Trigger: <select> - click to select one of the following
Never - stopping at the selected industries will never trigger the rule.
Once only - the rule is triggered on the first visit only to any one of the selected industries
Once per industry - the rule is triggered on the first visit to each industry with each individual product
Once per visit - the rule is triggered on the first visit to each industry regardless of the product
Once per vehicle - each vehicle can only trigger the rule once.
<select industry> - select industry or industries from session list
Select one of two option buttons:-
( ) click to accept all trains
( ) click to accept trains matching specific criteria
Selecting the second option will produce the following selection controls:-
Specific vehicle - identify the specific vehicle or set of specific vehicles that will trigger the rule
+ - click to add a specific vehicle from the session list
x - click to remove the specific vehicle from the rule
Vehicle types - identify the type of vehicle or a set of vehicle types that will trigger the rule
+ - click to add a type of vehicle from the session list
x - click to remove the type of vehicle from the rule
Drivers - identify the drivers that will trigger the rule
+ - click to add a driver from the session list
x - click to remove a driver from the rule
Camera Rules
Cinematic Camera Rule
Provides several different cinematic style cameras with animations
<kuid2:401543:1166:3> Built-in Rule
Properties:
[Check Box] Lock camera controls for the duration - if checked user cannot alter camera view
[Check Box] Prevent train control for duration - if checked user cannot control train
Camera target: <click to select> - click to select the object from the session list that will be the camera target
Camera mode: - select one of three option buttons:-
( ) Stationary
( ) Circle targeted object
( ) Move from one point to another (zoom, pan, etc)
Initial camera values:
[Check Box] Pitch: <value> - check to select then click value to enter a pitch value
[Check Box] Yaw: <value> - check to select then click value to enter a yaw value
[Check Box] Zoom: <value> - check to select then click value to enter a zoom value
Total time to animate: <value> - enter an animation time in seconds
Note: Times are Trainz clock times, not real times
Related Rules: Focus Camera Rule - sets the initial camera view and starting vehicle for a session Set Camera Rule - sets the target object and properties of the camera Wait for Camera View Mode Rule - waits for the camera to be changed to the designated view, then executes any following child rules
Focus Camera Rule
Sets the initial camera view and starting vehicle for a session.
<kuid2:122381:10014:1> DLS Rule by mizi
Properties:
Focus camera to: - select one of two option buttons
( ) Map object
( ) Vehicle
Named <?????> - enter name of object or vehicle from session list
Additionally:
[Check Box] set view mode to - check to select one of four option buttons
( ) Internal view
( ) External view
( ) Tracking view
( ) Roaming view
[Check Box] restrict user to manipulate the camera - check to set user limits on camera controls
[Check Box] allow internal view
[Check Box] allow external view
[Check Box] allow tracking view
[Check Box] allow roaming view
[Check Box] allow change of view mode
[Check Box] allow change vehicle in train
[Check Box] allow change trains
[Check Box] allow adjust camera viewpoint
[Check Box] set camera angles - check to set the initial camera view point
Yaw (90 = look at front of train): <value> degrees - enter yaw angle
Pitch (-90 = down, 90 = up): <value> degrees - enter pitch angle
Distance from the focused object: <value> metres - enter distance from camera to object
Related Rules: Cinematic Camera Rule - provides several different cinematic style cameras with animations Set Camera Rule - sets the target object and properties of the camera Wait for Camera View Mode Rule - waits for the camera to be changed to the designated view, then executes any following child rules
Set Camera Rule
Sets the target object and properties of the camera.
<kuid:-25:179> Built-in Rule
Properties:
[Check Box] Set the target object of the camera to: - if checked, select one of three option buttons:-
( ) Vehicle <click to select> - select a vehicle from the Session list
( ) Junction <click to select> - select a junction from the Session list
( ) Map Object <click to select> - select a named map object from the Session list
[Check Box] Change the camera view mode to <click to select> - if checked, select one camera view mode from
Cab View
External View
Tracking View
Free Roaming
[Check Box] Set the camera flags to enable/disable user access to - if checked, select as many of the following check boxes as needed
[Check Box] Internal view mode - check to enable, uncheck to disable
[Check Box] External view mode - check to enable, uncheck to disable
[Check Box] Tracking view mode - check to enable, uncheck to disable
[Check Box] Roaming view mode - check to enable, uncheck to disable
[Check Box] View switching - check to enable, uncheck to disable
[Check Box] Vehicle view switching - check to enable, uncheck to disable
[Check Box] Train view switching - check to enable, uncheck to disable
[Check Box] Camera adjustments (pan, zoom, etc) - check to enable, uncheck to disable
Related Rules: Cinematic Camera Rule - provides several different cinematic style cameras with animations Focus Camera Rule - sets the initial camera view and starting vehicle for a session Wait for Camera View Mode Rule - waits for the camera to be changed to the designated view, then executes any following child rules
Wait for Camera View Mode Rule
Waits for the camera to be changed to the designated view, then executes any following child rules
<kuid:-25:192> Built-in Rule
Properties:
[Check Box] Trigger rule once - check to set
Wait for the camera to change to the <click to select> - select one camera view mode from:-
Cab View
External View
Tracking View
Free Roaming
[Check Box] Wait for the camera to target vehicle <click to select> - if checked, select a vehicle from the Session list
Related Rules: Cinematic Camera Rule - provides several different cinematic style cameras with animations Focus Camera Rule - sets the initial camera view and starting vehicle for a session Set Camera Rule - sets the target object and properties of the camera
Danger and Safety Rules
ATP Speed Limiter Rule
Limits allowable speed over set limit
<kuid2:321959:1000:1> Built-in Rule
Properties: Limits the speed to <value> mph over the set limit - enter speed value in mph
Related Rules: AWS Configuration Rule - configures the Trainz implementation of the Automatic Warning System when approaching signals
AWS Configuration Rule
This rule configures the Trainz implementation of the Automatic Warning System when approaching signals
<kuid2:60850:89002:3> Built-in Rule
Properties:
Select one of three option buttons:-
( ) Active
( ) Passive
( ) Passive with HUD hidden
[Check Box] Simulate AWS for unfitted cabs?
[Check Box] Use modern sound set for unfitted cabs?
Related Rules: ATP Speed Limiter Rule - limits allowable speed over set limit
Clean Up Derailed Trains Rule
Cleans up derailed train cars after a set time delay
<kuid2:60850:89003:1> Base Rule
Properties:
Set delay to clean up derailed traincars to
<h>: - click to enter the number of hours (0-23) to wait
<mm>: - click to enter the number of minutes (0-59) to wait
<ss>: - click to enter the number of seconds (0-59) to wait
Note: Time is Trainz clock time, not real time.
Related Rules: Replace Missing Vehicles Rule - creates a replacement train after a derailment Wait for Derailment Rule - executes child rules if a derailment occurs
Coupler Breakage Check Rule
Checks for breaking couplers and, if found, executes any following child rules.
<kuid2:447264:1017:1> Built-in Rule
Properties: None
Related Rules: Coupler Breakage HUD Rule - adds a coupler stress and breakage warning to the HUD Set Coupler Masks Rule - sets the coupling/decoupling masks on selected vehicles
Coupler Breakage HUD Rule
HUD displays warning about coupler stress and breakage
<kuid:-25:423> Built-in Rule
Properties:
Select one of two option buttons:-
( ) Show the Coupler Breakage Display
( ) Hide the Coupler Breakage Display
Related Rules: Coupler Breakage Check Rule - executes child rules when a breakage occurs Set Coupler Masks Rule - sets the coupling/decoupling masks on selected vehicles
Junction Derailment Prevention Rule
<kuid2:121843:100282:1> DLS Rule by pitkin
Sets opposing junctions ahead of a train to prevent derailments. Works with both AI and manually driven trains.
Properties: None
Note: Will not overrule a junction already locked by another AI train or locked against AI control using the Set Junctions Rule.
Related Rules: Set Junctions Rule - sets the selected junctions to a specific state (switch direction, locked/unlocked, allow/prevent AI control).
Replace Missing Vehicles Rule
Produces new trains to replace missing vehicles that have been removed from the session by the Clean Up Derailed Trains Rule
<kuid:447264:1214> Built-in Rule
Properties:
[Check Box] Respawn trains if they are abandoned for 10 minutes
If checked:-
Select one of two option buttons:-
( ) Respawn trains at their original locations
( ) Respawn trains from portals
<+ Add a new portal> - click to enter the name of a portal, there can be more than one portal.
Entered portal names that appear in red have not been found in the session
Related Rules: Clean Up Derailed Trains Rule - cleans up derailed train cars after a set time delay Wait for Derailment Rule - executes child rules if a derailment occurs
Safety System Engaged Check Rule
Checks for safety systems making penalty applications on users and, if found, then executes any following child rules.
<kuid:447264:1216> Built-in Rule
Properties: [Check Box] Trigger only once
Related Rules: Safety System Isolated Check Rule - executes child rules if safety systems have been isolated by user
Safety System Isolated Check Rule
Checks for safety systems being isolated by users and, if found, then executes any following child rules.
<kuid:447264:1217> Built-in Rule
Properties: [Check Box] Trigger only once
Related Rules: Safety System Engaged Check Rule - executes child rules if safety systems have been engaged by user
Set Coupler Masks Rule
Set the coupling/decoupling masks on the selected vehicles
<kuid:-25:980> Built-in Rule
Properties:
<Add vehicle> - click to select a vehicle from the session list
<Add All> - click to add all vehicles in the session list
<Delete All> - click to remove all added vehicles from this rule
For each selected vehicle:-
Coupling Mask
Front and Back - choose for each
Locked
Unlocked
Decoupling Mask
Front and Back - choose for each
Locked
Unlocked
<Remove> - click to remove this vehicle from the rule
Related Rules: Coupler Breakage Check Rule - executes child rules when a breakage occurs Coupler Breakage HUD Rule - adds a coupler stress and breakage warning to the HUD
Signal Passed At Danger Check Rule
Checks for Drivers passing signals at danger (stop) and, if found, then executes any following child rules.
<kuid2:60850:89007:2> Built-in Rule
Properties: [Check Box] Trigger only once
Speeding Check Rule
If player controlled trains are over the local speed limit or over a set (custom) speed, then executes any following child rules
<kuid2:60850:89004:3> Built-in Rule
Properties:
Select one of two options to set a speed limit to be observed
( ) Watch for trains travelling above the posted speed limit
<speed value> - click to enter a new overspeed tolerance value
<speed units> - click to select one from the list:-
Km/h - Kilometres per hour
MPH - Miles per hour
mps - metres per second
( ) Watch for trains travelling above a custom speed
<speed value> - click to enter a new custom speed value
<speed units> - click to select one from the list:-
Km/h - Kilometres per hour
MPH - Miles per hour
mps - metres per second
Warning: This option is very performance intensive and should only be used in sessions with few trains
Vehicle Physics Rule
Overrides the default vehicle physics properties for all vehicles or for those matching set criteria
<kuid:-25:1052> Built-in Rule
Properties:
Select one of two option buttons:-
( ) click to accept all trains
( ) click to accept trains matching specific criteria
Selecting the second option will produce the following selection controls:-
Specific vehicle - identify the specific vehicle or set of specific vehicles that will trigger the rule
+ - click to add a specific vehicle from the session list
x - click to remove the specific vehicle from the rule
Vehicle types - identify the type of vehicle or a set of vehicle types that will trigger the rule
+ - click to add a type of vehicle from the session list
x - click to remove the type of vehicle from the rule
Drivers - identify the drivers that will trigger the rule
+ - click to add a driver from the session list
x - click to remove a driver from the rule
Coupler Parameters:
Couplers break at <value> kN expansion force - enter force value
Couplers break at when coupling above <value> kph - enter speed value
[Check Box] Show coupler breakage in HUD - check to display breakage in on-screen HUD
Wheelslip Parameters:
Maximum tractive effort adjusted by <value> % - enter adjustment as a %
Traction is reduced to <value> % while wheelslipping - enter value as a %
Traction boost is <value> % while sanding - enter value as a %
Sway Parameters:
Cab sway level is set to <value> % - enter value as a %
Wait for Derailment Rule
Waits for a derailment to occur, then executes any following child rules
<kuid:-25:1053> Built-in Rule
Properties: [Check Box] Trigger derailment watch once - check to execute the rule once only
Related Rules: Clean UP Derailed Trains Rule - cleans up derailed train cars after a set time delay Replace Missing Vehicles Rule - creates a replacement train after a derailment
Driver Rules
ConsistDataHandler Rule
Used by the QuickDrive Rule to place consists onto a route.
<kuid:401543:1180> Base Rule
Note: This rule is used by the QuickDrive Rule and has no independent functions.
Related Rules: QuickDrive Rule - changes session settings and adds consists in Driver
Control Check Rule
Checks if the control method changes, then executes any following child rules
<kuid:401543:1191> Built-in Rule
Properties:
Execute child rules when: - select one of two option buttons:-
( ) DCC mode is Selected
( ) Cab mode is Selected
Execute child rules: - select one of two option buttons:-
( ) Every time control method is set
( ) Once only
Related Rules: Control Type Rule - sets the control method
Control Type Rule
Sets the control method
<kuid:-16:2030> Base Rule
Properties:
Current control method is: <select> - click to select one of
Easy Mode
Ask User
Realistic Mode
Related Rules: Control Check Rule - checks if the control method changes, then executes any following child rules
CPC: Emit Train on Trigger Rule
Emits a train from a Portal or an Unportal after a triggered event.
<kuid2:117746:1044:12> DLS Rule by sforget
Properties: Portal index from CPC <value> - click to enter (Un)Portal Index Use UnPortal <select> - click to select Yes or No Delay from Trigger to Emit <seconds> - click to set number of seconds Add Trigger <select> - click to add Trigger from Session List
Note: Times are Trainz clock time, not real time
Disable/Enable Industry Rule
Disables vehicle load/unload for industry
<kuid2:401543:1171:1> Built-in Rule
Properties:
Load/unload <Disable/Enable> - click to set to Disable or Enable
Which Industry? <select> - click to set Industry from Session List
Which Vehicles: - select one of two option buttons:-
( ) Apply to every vehicle in the session
( ) Apply only to a specific vehicles from Session List
Driver Command Rule
Specifies which commands will be available for the drivers
<kuid:-3:10057> Base Rule
Properties:: For each installed Driver Command:- [Check Box] Name of Diver Command and Description (if available) - check to make that command available to the driver
Related Rules: Driver Command Check Rule - checks the driver commands then executes any following child rules Enable/Disable Driver Commands Rule - enable/disable specific driver commands on certain drivers
Driver Command Check Rule
Verifies the driver commands of a driver character, then executes any following child rules
<kuid:-25:447> Built-in Rule
Properties:
[Check Box] Trigger rule once - check to allow the rule to execute only once
Driver character to watch the command list of <select> - select a driver name from the Session List
Wait for driver character to have a command list that matches this:
<add driver command> - add a driver command from the session list. More commands can be added. Commands can be deleted.
<add all> - adds ALL driver commands in the session list. Individual commands can be removed.
<delete all> - deletes all entered driver commands from the session rule
Related Rules: Driver Command Rule - specifies which commands will be available for the drivers Enable/Disable Driver Commands Rule - enable/disable specific driver commands on certain drivers
Driver Main Menu Options Rule
Show/Hide the Driver Main Menu Bar
<kuid:-25:448> Built-in Rule
Properties: <Show/Hide> the Driver Main Menu Bar - click Show or Hide to select
Driver Schedule Rule
Sets up a list of basic scheduled commands
<kuid2:82445:90001:9> Built-in Rule
Properties:
Driver Schedule Assigned to name of driver <icon> - click icon to select a driver from those assigned in the Driver Setup Rule
Next commands, will be executed
>> - click to enter driver commands from those specified in the Driver Command Rule
Style: - select one of four option buttons:-
( ) Classic style: If there is a schedule do not emit a new schedule - any currently assigned set of driver commands will not be replaced
( ) Killer style: If there is a schedule clean it and emit a new one - replace any currently assigned driver commands with the new commands
( ) Cooperative style: If there is a schedule append the new one - add the new driver commands to the end of any existing commands
( ) Active style: Emit a new schedule, only if already a schedule running - only add the new commands if commands are currently running
Driver Setup Rule
Creates the list of drivers for this session and assign them their orders
<kuid:-16:2025> Base Rule
Properties:
<driver icon> - click to select a new driver from the list of installed and built in drivers
<loco> - click to select a new locomotive from the session list and assign it to this driver. Locos displayed in red have not been found in the session list
<driver name> - click to enter a new name for the selected driver
<driver mode> - click to select one of:-
Autodetect - the program will detect the driver mode to be used. For example, if driver commands have been entered for this driver
then the AI driver mode will be selected
First Human Player - the driver will wait until he/she has been selected by the player
AI driver - the AI will be given control even if no commands are present
Multiplayer Driver - the driver will be assigned to a multiplayer user
<remove> - this driver will be removed from the rule
>> - click to enter driver commands from those specified in the Driver Command Rule
--> Scroll down to the bottom of the list of entered drivers for more options
<Add another driver> - click to add another driver
[Check Box] Remove all existing Drivers first
[Check Box] Generate new Drivers for empty Trains
Enable/Disable Driver Commands Rule
Enable/Disable specific driver commands on certain drivers. Multiple copies of the rule can be used to give different drivers or consists different command lists
<kuid:-25:480> Built-in Rule
Properties:
<Enable/Disable> the following driver commands ... - click to select Enable or Disable
For each driver command:-
[Check Box] command name - check to enable or disable
[Check Box] command name - check to enable or disable
[Check Box] command name - check to enable or disable
etc
Select one of two option buttons:-
( ) click to accept all trains
( ) click to accept trains matching specific criteria
Selecting the second option will produce the following selection controls:-
Specific vehicle - identify the specific vehicle or set of specific vehicles that will trigger the rule
+ - click to add a specific vehicle from the session list
x - click to remove the specific vehicle from the rule
Vehicle types - identify the type of vehicle or a set of vehicle types that will trigger the rule
+ - click to add a type of vehicle from the session list
x - click to remove the type of vehicle from the rule
Drivers - identify the drivers that will trigger the rule
+ - click to add a driver from the session list
x - click to remove a driver from the rule
Related Rules: Driver Command Rule - specifies which commands will be available for the drivers Driver Command Check Rule - checks the driver commands then executes any following child rules
MaxPermittedSpeed Rule
Controls AI behavior. When active AI Trains only go as fast as permitted
<kuid2:60850:89000:7> Built-in Rule
Note: This rule cannot be configured from the Session Rules list. It must be configured in the config.txt file of each locomotive. Instructions with an example are shown in the rule Properties
QuickDrive Rule
Change the Session settings and add consists in Driver
<kuid:401543:1184> Base Rule
Properties:
Open QuickDrive window when session is started [Check Box] - check to set
Set time to <hours:minutes> with a rate of <speed x> - set start time and rate at which time advances
Enable gameplay Session Mode [Check Box] - check to set. Gameplay mode restricts the players options
Enable in game help by default [Check Box] - check to allow help options to be displayed
Set the default Control method to: - select one of two option buttons:-
( ) Easy Mode
( ) Realistic Mode
[Check Box] Prevent player from changing this setting - check to set
Realistic mode requires achievement: <text> in asset <asset name> - enter achievement name and select an asset from Aurans Achievements
Set the default derailment realism to: - select one of three option buttons:-
( ) None
( ) Arcade
( ) Realistic
[Check Box] Prevent player from changing this setting - check to set
Set the default units to: - select one of three option buttons:-
( ) Imperial
( ) Metric
( ) Default
Wait for Driver On/Off Train Rule
Waits for a Driver to get off of a train, then executes any following child rules
<kuid:-25:953> Built-in Rule
Properties:
[Check Box] Trigger Rule Once - click to set
Wait for a driver character to get <On/Off> a train that matches the following criteria - select On or Off
Select one of two option buttons:-
( ) click to accept all trains
( ) click to accept trains matching specific criteria
Selecting the second option will produce the following selection controls:-
Specific vehicle - identify the specific vehicle or set of specific vehicles that will trigger the rule
+ - click to add a specific vehicle from the session list
x - click to remove the specific vehicle from the rule
Vehicle types - identify the type of vehicle or a set of vehicle types that will trigger the rule
+ - click to add a type of vehicle from the session list
x - click to remove the type of vehicle from the rule
Drivers - identify the drivers that will trigger the rule
+ - click to add a driver from the session list
x - click to remove a driver from the rule
Wait for Driver/Train to be Locally Owned Rule
Waits for a specific driver or train car to be locally owned, then executes any following child rules. If the driver/train car becomes unowned again the child rules are paused
<kuid2:401543:1173:1> Built-in Rule
Properties:
Assets Ownership: - select one of two option buttons:-
( ) Wait for ownership of a specific Driver
( ) Wait for ownership of Driver
Driver or Vehicle <select> - choose from session list
Message Rules
Close Message Popup Rule
Closes open message popups
<kuid:447264:1526> Built-in Rule
Properties: None
Known Issues: This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule
Related Rule: Message Popup Rule - displays a pop-up browser window and waits for it to be closed.
Custom Script Rule
No description
<kuid:447264:1526> Built-in Rule
Properties: None.
Display Custom HUD Rule
Show or hide the Custom Heads Up Display.
<kuid:-3:10206> Base Rule
Properties:
Show or Hide the Custom Heads up Display - select one of two option buttons:-
( ) Show the Custom Heads up Display
( ) Hide the Custom Heads up Display
Related Rules: Flash HUD Icon Rule - flashes a HUD panel icon for a set duration. Show/Hide HUD Panel Rule - shows or hides a HUD panel. Variable Show Rule - adds or removes a specified variable and a descriptive label to the custom HUD. Wait for Click on HUD Icon Rule - waits for a click on the HUD Icon, then executes any following child rules.
Display HTML Pages Rule
Creates a browser to display the listed HTML files in order as a navigable sequence of pages. This rule has been superseded by the Message Popup Rule
<kuid:-25:442> Base Rule
Properties:
<Add Page> - adds the HTML page index.html from the selected HTML asset
<index.html> - click to change the page name. The extension .html is optional
<Add All> - adds all HTML pages from the session list (this appears to be disabled in TANE)
<Delete All> - delete all HTML pages from this property list
[Check Box] Prevent user from exiting browser until all pages viewed
[Check Box] Disable closing of browser window by user
[Check Box] Disable browser window scrolling
[Check Box] Make browser window invisible
[Check Box] Set position-Under Construction!!! - not implemented
[Check Box] Set size-Under Construction!!! - not implemented
Use the page <index.html> from asset <select> as the hidden button - the link buttons at the bottom of the page will be taken from the selected page in the selected HTML asset
Related Rules: Close Message Popup Rule - closes a displayed pop-up browser window. Message Popup Rule - displays a pop-up browser window and waits for it to be closed. Set HTML Page Rule - sets parameters for the Display HTML Pages Rule Timed Limited Display HTML Rule (SP2 and later) - displays a HTML page in a browser window for a set time.
Display Video Rule
Displays a page containing a video clip from a HTML asset in a browser window.
<kuid:-25:138> Built-in Rule
Properties:
Display page <index.html> of html asset <click to select> in a new browser window
index.html - enter the filename of a HTML page in the selected HTML asset. The .html is optional in the filename.
<click to select> - select the HTML asset from those installed.
Note: video must be in a valid web format.
Fade in/out Rule
Fade in or out within seconds, using specified color and opacity values.
<kuid2:190611:200000:2> Built-in Rule
Properties: Red percentage: <value> - enter the final % of red (0 = none, 100 = maximum) Green percentage: <value> - enter the final % of green Blue percentage: <value> - enter the final % of blue Alpha percentage (opacity): <value> - enter the final % of opacity (0 = invisible, 100 = solid) Fading duration: <value> - enter the number of seconds required for the fade <help> - click to bring up help instructions
Flash HUD Icon Rule
Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.
<kuid:-25:968> Built-in Rule
Properties:
Select one of two option buttons:-
( ) Flash the <click to select> icon on the <click to select> HUD panel for a period of <value> seconds
TIP: Select the HUD panel first (the second <click to select> link).
Available HUD panels are (select one):-
Bottom Right Menu
Camera Controls
DCC Controls
Driver Main Menu
Available icons will depend on the HUD panel selected.
( ) <Start/Stop> flashing the <click to select> icon on the <click to select> HUD panel
TIP: Select the HUD panel first (the second <click to select> link).
Available HUD panels are (select one):-
Bottom Right Menu
Camera Controls
DCC Controls
Driver Main Menu
Available icons will depend on the HUD panel selected.
Related Rules: Display Custom HUD Rule - show or hide the Custom Heads Up Display. Show/Hide HUD Panel Rule - shows or hides a HUD panel. Variable Show Rule - adds or removes a specified variable and a descriptive label to the custom HUD. Wait for Click on HUD Icon Rule - waits for a click on the HUD Icon, then executes any following child rules.
InputTable Rule
Creates a list of message names to be used for various purposes.
<kuid2:131986:1012:1> Built-in
Properties:
Message Popup Rule
Displays a pop-up browser window and waits for it to be closed. Closure can be manual (by the user) or by another rule.
<kuid:-25:1003> Built-in Rule
Properties:
[Check Box] Pause game while message is displayed - stops the game until this message is closed
[Check Box] Close previous popup windows - closes any Message Popups currently displayed before this message is shown
Message location <Top Left/Top Right/Bottom Left/Bottom Right> - select one to position the browser window on the screen
Message Source: - select one of three option buttons:-
( ) Custom text - the simplest and easiest option
Icon <Click here to set> - (optional) select an icon to be displayed with the message from a list of icons.
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 more graphics, use the A predefined HTML page option.
( ) A predefined HTML page - requires a working knowledge of HTML
<HTML Asset> - select the name of the HTML asset that contains the required HTML page from the list shown.
<HTML Page> - enter the filename of the HTML page to be displayed. The page must be in the HTML asset identified above.
Filename is not case sensitive. Extension ".html" is optional.
<HTML Wave> - (optional) select the name of the HTML file containing the wave file to be played.
The page must be in the HTML asset identified above. Filename is not case sensitive. Extension ".html" is optional.
<Wave Name> - (optional) enter the name of a wave (.wav) sound file to be played.
The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension ".wav" is optional
[Check Box] Autoplay Wave: - plays the .wav sound file as soon as message is displayed.
If unchecked sound will not be played.
( ) A predefined string-table entry from a HTML asset
<HTML Asset> - select the name of the HTML asset from those installed that contains the required string-table.
<String Table Token> - <function unknown at present>
<HTML Wave> - (optional) select the name of the HTML file containing the wave file to be played.
The page must be in the HTML asset identified above. Filename is not case sensitive. Extension ".html" is optional.
<Wave Name> - (optional) enter the name of a wave (.wav) sound file to be played.
The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension ".wav" is optional
[Check Box] Autoplay Wave: - plays the .wav sound file as soon as message is displayed.
If unchecked sound will not be played.
Related Rules: Close Message Popup Rule - closes a displayed pop-up browser window.
Minimap Options Rule
Sets the display options for the minimap.
<kuid:-25:636> Built-in Rule
Properties: Default values - all checked [Check Box] Map Textures [Check Box] Gradients [Check Box] Junctions [Check Box] Signals [Check Box] Triggers [Check Box] Markers [Check Box] Trackside Labels [Check Box] Terrain Objects [Check Box] Industrial Names [Check Box] Named Objects [Check Box] Consists
Related Rules: Show/Hide Minimap Rule - shows the minimap window in Driver.
Play Sound Rule
Plays a wav sound file.
<kuid:-25:1045> Built-in Rule
Properties:
Default HTML <Click> - click to to enter Sound File Name
HTML Assets <Click> - click to select HTML asset
Rule Completes <Click> - to select one of:-
sound has just started
sound has finished playing
Session Metadata Rule
Sets session metadata in the config file. Info can be read by other systems and displayed to the player.
<kuid:401543:2036> Base Rule
Properties:
Type <Click> - click to select one of:-
Simulation
Challenge
Length <value> - to enter number of minutes, default is 30 minutes
Difficulty <Click> - click to select one of:-
Normal - default
Tutorial
Easy
Hard
Expert
Note: Time is Trainz clock time, not real time
Set Helper Icon Size Rule
Sets the size of helper icons such as the junction lever arrows.
<kuid:-25:791> Built-in Rule
Properties: Junction Arrows Size <Click> - to set scale ratio smaller than default, default is 100%
Set HTML Pages Rule
Instructs the Display HTML Pages rule to perform specific operations. This rule has been superseded by the Message Popup Rule
<kuid:-25:792> Built-in
Properties:
Operations to preform on the display HTML pages sequence browser
Select one of six option buttons:-
( ) to instruct the sequence browser to <select> - to choose page operations
( ) to instruct the sequence browser to open the page <select> - enter the HTML page name
( ) to set browser parameters <select> - choose one of:-
to Enable/Disable closing of the browser window by the user
to Enable/Disable scrolling on the sequence browser window
to Show/Hide the sequence browser window
( ) Set the following flag for the page named <select> - enter the HTML page name
[Check Box] Hide/Close window on 'done' action
[Check Box] Window has no 'done' button
[Check Box] Disable scrolling(not implemented yet)
[Check Box] Spare setting 1
[Check Box] Spare setting 2
[Check Box] Spare setting 3
[Check Box] Spare setting 4
[Check Box] Spare setting 5
( ) Use the page <select> (enter HTML page name) from the HTML asset <select> (select HTML asset)
( ) Use the string table entry <select> (enter Index) from the HTML asset <select> (select HTML asset)
Related Rules: Display HTML Pages Rule - displays HTML pages in a browser window. Timed Limited Display HTML Rule (SP2 and later) - displays a HTML page in a browser window for a set time.
Show/Hide HUD Panel Rule
Shows or hides a HUD panel.
<kuid:-25:1047> Built-in Rule
Properties: <Show/Hide> the <click to select> HUD panel - select Show or Hide and then select the HUD panel
Related Rules: Display Custom HUD Rule - show or hide the Custom Heads Up Display. Flash HUD Icon Rule - flashes a HUD panel icon for a set duration. Variable Show Rule - adds or removes a specified variable and a descriptive label to the custom HUD. Wait for Click on HUD Icon Rule - waits for a click on the HUD Icon, then executes any following child rules.
Show/Hide Layer Rule
Shows or hides a layer from Driver.
<kuid2:401543:1170:1> Built-in
Properties:
<visibility> - select one of two options
Show - select to make the layer visible
Hide - select to make the layer invisible
<click here to set> - enter name of layer. Name is case sensitive.
Known Bugs: Layers set to Hide when a game is saved will be Shown when the game is reloaded
Known Issues: Rule will NOT check to see if the named layer exists or not
Show/Hide Minimap Rule
Shows the minimap window in Driver.
<kuid:-25:794> Built-in Rule
Properties: <Show/Hide> the driver Minimap Window - click to switch between Show and Hide.
Related Rules: Minimap Options Rule - sets the display options for the minimap.
Show/Hide On-screen Help Rule
Shows or hides On-screen help in Driver.
<kuid:401543:2020> Built-in Rule
Properties:
On screen help (junction overlays, etc) - select one of three option buttons:-
( ) Show
( ) Hide
( ) Leave Unchanged
On Screen Vehicle Names: - - select one of three option buttons:-
( ) Show
( ) Hide
( ) Leave Unchanged
Timed limited display HTML Rule (SP2 and later)
Displays an HTML browser window for a limited time.
<kuid2:61392:2005:32> DLS Rule by pguy
Properties: HTML Asset Name : <[Click to select HTML asset]> - click to select an HTML asset from those installed Page filename : <value> - click to enter the filename of the HTML page in the selected HTML asset. The .html filename extension is optional. Play duration (SessVar or duration in seconds) : <value> - enter a SessVar name or the number of seconds. Browser left position (SessVar or position) : <value> - enter a SessVar name or the number of pixels from the left screen edge. Browser top position (SessVar or position) : <value> - enter a SessVar name or the number of pixels from the top screen edge. Browser width (SessVar or position) : <value> - enter a SessVar name or the width in pixels. Browser height (SessVar or position) : <value> - enter a SessVar name or the browser height. [Check Box] <Alert is not reshowable on request/Alert is showable on request> - check or click to allow or prevent the user viewing the page again.
Note: Seconds are Trainz clock time, not real time.
Related Rules: Close Message Popup Rule - closes open message popups Display HTML Pages Rule - displays HTML pages in a browser window. Message Popup Rule - displays a pop-up browser window and waits for it to be closed. Set HTML Page Rule - sets parameters for the Display HTML Pages Rule
Wait for Click on HUD Icon Rule
Waits for a click on the HUD Icon, then executes any following child rules
<kuid:-25:951> <kuid:-25:970> Built-in - two versions built-in with different kuids, both have the same properties
Properties:
[Check Box] Trigger Once
HUD Panel <Click> - click choose from list:-
Bottom Right Menu
Camera Controls
DCC Controls
Icon <Click> - click to choose from list. Selections depends on HUD Panel chosen
Related Rules: Display Custom HUD Rule - show or hide the Custom Heads Up Display. Flash HUD Icon Rule - flashes a HUD panel icon for a set duration. Show/Hide HUD Panel Rule - shows or hides a HUD panel. Variable Show Rule - adds or removes a specified variable and a descriptive label to the custom HUD.
Wait on Waybill Screen/Main Screen Rule
Waits for the Waybill window to be opened or closed, then executes any following child rules
<kuid:-25:957> Built-in Rule
Properties: [Check Box] Trigger rule once - check to trigger the rule once only Wait for the Waybill window to be <opened/closed> - select either opened or closed.
DestSign Table Rule
Creates a list of destination names for a destination sign
<kuid2:206816:99004:2> Built-in Rule
Properties: <add destination> - enter a destination name to be added to the destination sign roll <import destinations from texture-group> - select a list of destination names from session [Check Box] Enable industries/stations as destination - check to set [Check Box] Enable Track Marks as destinations - check to set [Check Box] Enable table of destinations - check to set
Interlocking Tower Configure Path
Alters settings on an interlocking tower path
<kuid:401543:3205> Base Rule
Properties: Interlocking Tower <select> - to set Name and Objects
Related Rules: Interlocking Tower Path Selection UI - automatically reacts to messages from Interlocking Towers and displays a path selection dialog to the player. Interlocking Tower Set Path Rule - sets the state of an interlocking tower path for a train Interlocking Tower Enhanced Manager Rule (SP2 and later) - more management and control options for interlocking towers.
Interlocking Tower Path Selection UI
Will automatically react to messages from Interlocking Towers and display a path selection dialog to the player. Disable by removing rule from session
<kuid:401543:3203> Base Rule
Properties: [Checkbox] Show path activation message in Driver
Related Rules: Interlocking Tower Configure Path - alters the settings on an interlocking tower path Interlocking Tower Set Path Rule - sets the state of an interlocking tower path for a train Interlocking Tower Enhanced Manager Rule (SP2 and later) - more management and control options for interlocking towers.
Interlocking Tower Set Path Rule
Will set the state of an interlocking tower path for a train
<kuid:401543:3204> Base Rule
Properties: Interlocking Tower <select> - to set Name and Objects
Related Rules: Interlocking Tower Configure Path - alters the settings on an interlocking tower path Interlocking Tower Path Selection UI - automatically reacts to messages from Interlocking Towers and displays a path selection dialog to the player. Interlocking Tower Enhanced Manager Rule (SP2 and later) - more management and control options for interlocking towers.
Interlocking Tower Enhanced Manager Rule (SP2 and later)
Provides more management and control options for interlocking towers.
<kuid2:61392:8130:41> DLS Rule by pguy
Properties:
<towers> - click to select interlocking towers from the session list
<do full check again> - click to run an error check on all interlocking towers
List of all available interlocking towers - for each tower:-
<view details> - click to view and edit the tower properties
<copy from> - click to copy properties from another tower selected from the session list
<debug log> - click to set the debug log properties
Related Rules: Interlocking Tower Configure Path - alters the settings on an interlocking tower path Interlocking Tower Path Selection UI - automatically reacts to messages from Interlocking Towers and displays a path selection dialog to the player. Interlocking Tower Set Path Rule - sets the state of an interlocking tower path for a train
Multiple Junction Alignment Check Rule
Checks junctions are set or in alignment, then executes any following child rules.
<kuid:-25:168> Built-in Rule
Properties:
Wait until <selection> - select from:-
any one - any of the junctions in the rule list (below) is set correctly
all - ALL of the junctions in the rule list are set correctly
<Add junction> - click to select a junction from the session list
<Add all> - click to select ALL junctions in the session list
<Delete all> - click to delete ALL selected junctions from the rule list
For each selected junction:-
<setting> - click to select one switch direction from:-
Left
Right
Center
Any
<remove> - to delete this junction from the rule list
Related Rules: Set Junctions Rule - sets junctions to specific directions, locks and unlocks junctions, allows or denies AI control.
Creates a set of navigation points. Multiple sets can be created by adding additional copies of this rule. This rule creates the navigation set, it does not display it.
<kuid2:401543:1161:1> Base Rule
Properties:
Unique set ID: <click here to set> - enter a unique name for the navigation set. Name must be in lowercase and have no spaces.
Train (optional): <click here to set> - select a rolling stock asset from the session list shown.
Select one of three option buttons:-
( ) All points must be completed in sequence:
- the first uncompleted navigation point will be shown and must be completed next.
- the next point (if any) will also be shown but at a lower opacity.
( ) Points will be completed in sequence, but can be skipped:
- navigation points can be skipped but must be completed in order.
- you cannot go back to complete a missed point.
( ) All points must be completed, but in any order:
- all uncompleted navigation points will be shown.
- you may complete them in any order.
For each navigation point:
<Click here to set> - select an item (trigger, trackmark, track object, rolling stock) from the session list to become the navigation point.
<Display text> - enter a text message to display with the navigation point. You are limited to 25 characters.
Icon <icon list> - select an icon for the navigation point.
<Style> - click to select one from three choices
Automatic - the navigation point will be completed as soon as the consist reaches the point.
Manual - the navigation point must be set as complete by using the Navigation point complete rule or the Navigation set clear rule.
The Manual style option allows you to execute other rules (e.g. consist check, wait, etc) before completing the navigation point.
Require Stop - the navigation point will be completed when the consist comes to a complete stop on the point.
Related Rules: Navigation Set Hide/Show rule - makes a navigation set visible/invisible. Navigation Set Check Rule - checks if a navigation set is complete or incomplete. Navigation Set Clear Rule - completes (terminates) a navigation set. Navigation Point Complete Rule - manually completes (terminates) a specific navigation point in a set. Wait on Navigation Point Rule - checks if a specific navigation point in a set has been completed.
Manually completes a navigation point in a set
<kuid:401543:1167> Base Rule
Properties: Mark navigation point <click here to set> - enter the navigation point number to be completed complete in set <click here to set> - enter the unique name for the navigation set created using the Navigation Display Rule. Name must be in lowercase and have no spaces.
Known Issues: The rule will NOT check to see if the named navigation set and point exists or not.
Related Rules: Navigation Display Rule - creates a set of navigation points. Navigation Set Hide/Show rule - makes a navigation set visible/invisible. Navigation Set Check Rule - checks if a navigation set is complete or incomplete. Navigation Set Clear Rule - completes (terminates) a navigation set. Wait on Navigation Point Rule - checks if a specific navigation point in a set has been completed.
Checks if a navigation set is complete or incomplete, then executes any following child rules
<kuid:401543:1165> Base Rule
Properties: Checks if navigation point set <name>: - enter the unique name for the navigation set created using the Navigation Display Rule. Name must be in lowercase and have no spaces. is <Complete/Incomplete> - click to select one
Known Issues: The rule will NOT check to see if the named navigation set exists or not.
Related Rules: Navigation Display Rule - creates a set of navigation points. Navigation Set Hide/Show rule - makes a navigation set visible/invisible. Navigation Set Clear Rule - completes (terminates) a navigation set. Navigation Point Complete Rule - manually completes (terminates) a specific navigation point in a set. Wait on Navigation Point Rule - checks if a specific navigation point in a set has been completed.
Clears a navigation set removing any uncompleted navigation points
<kuid:401543:1164> Base Rule
Properties: <Click here to set> - enter the unique name for the navigation set created using the Navigation Display Rule. Name must be in lowercase and have no spaces.
Known Issues: The rule will NOT check to see if the named navigation set exists or not.
Related Rules: Navigation Display Rule - creates a set of navigation points. Navigation Set Hide/Show rule - makes a navigation set visible/invisible. Navigation Set Check Rule - checks if a navigation set is complete or incomplete. Navigation Point Complete Rule - manually completes (terminates) a specific navigation point in a set. Wait on Navigation Point Rule - checks if a specific navigation point in a set has been completed.
Shows and hides navigation sets. You can have multiple sets visible and hidden at the same time.
<kuid:401543:1163> Base rule
Properties:
<visibility> - click to select one
Hide - select to make the navigation set invisible
Show - select to make the navigation set visible
<click here to set> - enter the unique name for the navigation set created using the Navigation Display Rule.
Name must be in lowercase and have no spaces.
Known Issues: The rule will NOT check to see if the named navigation set exists or not.
Related Rules: Navigation Display Rule - creates a set of navigation points. Navigation Set Check Rule - checks if a navigation set is complete or incomplete. Navigation Set Clear Rule - completes (terminates) a navigation set. Navigation Point Complete Rule - manually completes (terminates) a specific navigation point in a set. Wait on Navigation Point Rule - checks if a specific navigation point in a set has been completed.
Schedule Rule
Allows a schedule of timed events to be applied to a train
<kuid:-3:10185> Base Rule
Properties:
Insert track mark <select> - select a track mark from the Session List
Arrival and Departure Time <Select> - set time
hh:mm:ss - in hours/minutes/seconds
Current Train <select> - select from session list
Insert destination <select> - select from session list
Note: Times are Trainz clock times, not real time
Set Junctions Rule
Sets the selected junctions to a specific state Warning: not compatible with Interlocking Tower Assets
<kuid:-25:1065> Built-in Rule
Properties:
Add Junction - click to select a junction from the session junction list
Add All - click to add ALL junctions in the session junction list
Delete All - click to remove ALL entered junctions from the rule
Junction Options: - for each selected junction:-
<direction> - click to select the junction direction
Left
Center
Right
Don't change
<user control> - click to select a user control option
Locked - the junction setting cannot be changed by the user
Unlocked - the junction setting can be changed by the user
<AI control> - click to select AI control
Allows AI control - an AI train can switch the junction
Blocks AI control - an AI train cannot switch the junction
Remove - click to remove this junction from the rule list
Related Rules: Junction Derailment Prevention Rule - sets opposing junctions ahead of a train to prevent derailments Multiple Junction Alignment Check Rule - checks junctions are set or in alignment, then executes any following child rules
Set Signal Extended Rule
Sets the state of a selected signal Warning: not compatible with Interlocking Tower Assets
<kuid2:47662:20002:4> Built-in Rule
Properties:
<Select signal> to <signal state> - click to select a signal from the session list and click to select a state from the list -
Automatic
Stop
Stop then Continue
Caution Left
Caution Right
Caution
Advance Caution Left
Advance Caution Right
Advance Caution
Proceed Left
Proceed Right
Proceed
Slow
Medium
Note: The signal must support the state selected otherwise there will be no change in the signal
Trackside Check Rule
Similar to the Trigger Check Rule but provides other options. If the rule is satisfied then it will execute any following child rules
<kuid2:46162:100207:1> DLS Rule by Josefpav
Properties:
Applies to: - select one of three option buttons:-
( ) Junction
( ) Trigger
( ) Trackmark
Trackside object name: <specify> - select object name from session list
Wait for train to: - select one of three option buttons:-
( ) Enter
( ) Stop at
( ) Leave
[Check Box] Auto reset this rule - check to execute the rule continuously
Applies to train containing:
<Add vehicle> - click to select a rail vehicle from the session list
del - click to remove a selected vehicle from the rule
Related Rules: Trigger Check Rule - waits for a specific train or any train to enter one of the designated triggers, then executes any following child rules.
Trigger Check Rule
Waits for a specific train or any train to enter one of the designated triggers, then executes any following child rules. This rule replaces the older and less versatile "Trigger Rule".
<kuid:-25:1071> Built-in Rule
Properties:
[Check Box] Trigger only once
[Check Box] Wait for child rules to complete even if no trains are present in rule trigger
[Check Box] Only activate when the entering vehicle of the train is heading <select direction> into the trigger - select one of two directions:-
forward
backward
Triggers List
<add trigger> - select a trigger from the session list
<delete trigger> - delete a selected trigger from the rule
Select one of two option buttons:-
( ) click to accept all trains
( ) click to accept trains matching specific criteria
Selecting the second option will produce the following selection controls:-
Specific vehicle - identify the specific vehicle(s) that will trigger the rule
+ - click to add a specific vehicle from the session list
x - click to remove the specific vehicle from the rule
Vehicle types - identify the type of vehicle(s) that will trigger the rule
+ - click to add a type of vehicle from the session list
x - click to remove the type of vehicle from the rule
Drivers - identify the driver(s) that will trigger the rule
+ - click to add a driver from the session list
x - click to remove a driver from the rule
Related Rules: Trackside Check Rule - similar but provides other options.
Waits for a navigation point to be completed, then executes any following child rules
<kuid:401543:1168> Base Rule
Properties: navigation point <click here to set> - enter the number of the navigation point to be completed in set <click here to set> - enter the unique name for the navigation set created using the Navigation Display Rule. Name must be in lowercase and have no spaces.
Known Issues: The rule will NOT check to see if the named navigation set and point exists or not.
Related Rules: Navigation Display Rule - creates a set of navigation points. Navigation Set Hide/Show rule - makes a navigation set visible/invisible. Navigation Set Check Rule - checks if a navigation set is complete or incomplete. Navigation Set Clear Rule - completes (terminates) a navigation set. Navigation Point Complete Rule - manually completes (terminates) a specific navigation point in a set.
Wait on Train Stop/Start Rule
Wait for a train to stop or start, then executes any following child rules
<kuid:-25:1069> Built-in Rule
Properties:
[Check Box] Trigger rule once
Wait for a train that matches the following criteria to <select> - select one of:-
start moving
stop moving
Select one of two option buttons:-
( ) click to accept all trains
( ) click to accept trains matching specific criteria
Selecting the second option will produce the following selection controls:-
Specific vehicle - identify the specific vehicle or set of specific vehicles that will trigger the rule
+ - click to add a specific vehicle from the session list
x - click to remove the specific vehicle from the rule
Vehicle types - identify the type of vehicle or a set of vehicle types that will trigger the rule
+ - click to add a type of vehicle from the session list
x - click to remove the type of vehicle from the rule
Drivers - identify the drivers that will trigger the rule
+ - click to add a driver from the session list
x - click to remove a driver from the rule
Session Debug Rules
Generic TreeNode Debug Window Rule
No description.
<kuid:30501:1042> Base Rule
Properties: Note: I have been unable to find any references to this rule in Trainz except for the fact that it exists as a session rule.
Related Rules: Session Debug Rule - executes the first child if debug mode is selected, otherwise the second child rule is executed
Session Debug Rule
Executes the first child if Debug mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.
<kuid:30501:100180> Built-in Rule
Properties: None
Note: When a session starts with this rule enabled, the player will be given the choice of running the session in Debug or Normal mode. Selecting Debug will execute the first child rule. Selecting Normal will execute the second child rule.
Related Rules: Generic TreeNode Debug Window Rule - no description
Session Sequence Rules
Ordered List Rule
Child rules will be executed in order once this rule starts
<kuid:-25:171> Built-in Rule
Properties: Select one of two option buttons:- ( ) This process will repeat <value> time(s) - enter the number of times this rule is to be repeated ( ) This process will repeat forever
Related Rules: Progressive List Rule - first child rule will be executed on the first run of this rule, the second child executed on the second run, etc Random List Rule - one of the child rules will be randomly selected and executed Reset List Rule - Resets and starts all child rules Simultaneous List Rule - all child rules are executed simultaneously
Progressive List Rule
The first child rule will be executed on the first run of this rule, the second child executed on the second run, etc.
<kuid:-25:754> Built-in Rule
Properties: After last child has been executed ... <successive runs will do nothing/the first child is chosen again> - click to select one
Related Rules: Ordered List Rule - child rules will be executed in order Random List Rule - one of the child rules will be randomly selected and executed Reset List Rule - Resets and starts all child rules Simultaneous List Rule - all child rules are executed simultaneously
Random List Rule
One of the child rules will be randomly selected and executed. The rule will not repeat to randomly select another child rule
<kuid:-25:758> Built-in Rule
Properties: None
Related Rules: Ordered List Rule - child rules will be executed in order Progressive List Rule - first child rule will be executed on the first run of this rule, the second child executed on the second run, etc Reset List Rule - Resets and starts all child rules Simultaneous List Rule - all child rules are executed simultaneously
Reset List Rule
Resets and starts all child rules in an ongoing infinite cycle
<kuid:-25:762> Built-in Rule
Properties: None
Related Rules: Ordered List Rule - child rules will be executed in order Progressive List Rule - first child rule will be executed on the first run of this rule, the second child executed on the second run, etc Random List Rule - one of the child rules will be randomly selected and executed
Simultaneous List Rule
Child rules are executed simultaneously once this rule starts
<kuid:-25:1048> Built-in Rule
Properties:
Rule completes when ... - click to chose one of the following:-
one of the child rules has completed
all child rules have reached a completed state
all child rules have reached a "was completed" state
Related Rules: Ordered List Rule - child rules will be executed in order Progressive List Rule - first child rule will be executed on the first run of this rule, the second child executed on the second run, etc Random List Rule - one of the child rules will be randomly selected and executed Reset List Rule - Resets and starts all child rules
Startup and Termination Rules
End Session Rule
End the Session with a fade out.
<kuid:-25:482> Built-in Rule
Properties: Fade out over <value> seconds - enter number of seconds for fade out.
Note: Seconds are Trainz clock time, not real time.
Related Rules: Session Complete Rule - set the session to a percentage of completion
Multiplayer Rule
Enables the session to be taken online in a Multiplayer environment.
<kuid:447264:1045> Built-in Rule
Properties: Suggested maximum number of players for this session <value> - enter a number Maximum number of drivers per player <value> - enter a number Players are permitted to claim drivers [Check Box] - check to allow players to select a driver Players can see each other's driver orders [Check Box] - check to allow players to view orders for other players Automatically target an available train on clients [Check Box] - automatically assign a driver to each player
Randomize Rule
Generates a different set of random numbers each time the session is run.
<kuid:169301:100129> DLS Rule by Terry_Wagstaff
Properties: None
Note: Place this rule near the top of the Session Rules list and ensure that there is at least 5 seconds before the call to a Random function.
Related Rules: Variable Random - sets a variable to a random value.
Session Complete Rule
Set session to a percentage of completion.
<kuid:447264:1011> Base Rule
Properties: Set session to percent complete <value> - enter number as a percentage [Check Box] Separate achievements for completion - check to set
Related Rules: End Session Rule - end the Session with a fade out.
Startup Options Rule
Specifies the starting options for the session. The weather settings will set the initial conditions, including the variability. To manually change the weather during play, use the Weather Rule.
<kuid:-16:10212> Base Rule
Properties:
Current control method is <select> - select one from:-
Easy Mode - standard keyboard control
Ask User - let the user decide
Realistic Mode - on screen levers, throttles, buttons, etc
Set weather to <select mode> with <select frequency> changeability - select
Weather mode: - select one of:-
Clear
Cloudy
Drizzle
Rain
Stormy
Light Snow
Medium Snow
Heavy Snow
Changeability: - select one of:-
Off - the weather will not change from the mode selected above
Periodic - slow gradual changes to the weather
Extreme - rapid and extreme changes to the weather
Set time to <hours>:<minutes> with a rate of <select speed> - set the starting time and the speed at which the Trainz clock will run
Set derailment realism to <select reality level> - select one of:-
None - no train derailments will occur
Arcade - train derailments will be exaggerated (beyond normal)
Realistic - train derailments will occur as realistically as possible
[Check Box] Show in game help - check to switch on help options
Use <select measurement system> units in Driver - select one of:-
Metric - kilometres, metres. This will override the default settings in a session
Imperial - miles, feet. This will override the default settings in a session
Default - uses the measurement system specified in the session
Note: Times are Trainz clock time, not real time
Related Rules: Time and Rate Rule - sets the session start time and the rate at which time passes. Weather Rule - changes weather conditions during Session play
Time Rules
Clock Rule
Rule needed for animated clocks.
<kuid2:62310:30041:2> Built-in Rule
Properties: Note: Apply this rule to your session to make use of the animated clocks. See the forum for code to include in your clock object to work with this rule.
Time and Rate Rule
Sets the session start time and the rate at which time passes.
<kuid:-25:889> Built-in Rule
Properties: 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)
Note: Time is Trainz clock times not real time.
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.
<kuid2:122381:10008:3> Built-in Rule
Properties: <hh:mm:ss> - enter execution time as hours (0-23), minutes (0-59) and seconds (0-59). [Check Box] Execution time is on the day after the start time - when checked delays execution until the following day.
Note: Times and days are Trainz clock times not real time.
Related Rules: Time and Rate Rule - sets the session start time and the rate at which time passes.
Wait Rule
Wait for number of seconds before executing any following child rules
<kuid2:122381:10016:2> Built-in Rule
Properties: <click to set> - enter the number of seconds for the wait delay
Note: Seconds is in Trainz clock time, not real time
Variable Rules
Variable Check Rule
If the specified variable matches the specified conditions then the child rules will be executed in order.
<kuid:-25:1049> Built-in Rule
Properties:
<variable-name> - enter a variable-name. Variable name is case sensitive.
Mathematical relationship, select one of:-
is less than - enter a <value> to test against
is less than or equal to - enter a <value> to test against
is equal to - enter a <value> to test against
is greater than or equal to - enter a <value> to test against
is greater than - enter a <value> to test against
is not equal to - enter a <value> to test against
is between x and y - enter a minimum <x-value> and a maximum <y-value>
Evaluation type. Select one from:-
<This condition will be evaluated only once ...> - any changes to the variable that occur after
it has been checked will not change the result of this rule
<This condition will be evaluated once every second> - the rule will be rerun and the variable
rechecked every second
Related Rules: Variable Modify Rule - changes the value of a specified variable. Variable Modify Continuous Rule - continuously changes the value of a specified variable. Variable Random Rule - assigns a random value to a variable. Variable Show Rule - adds or removes a specified variable and a descriptive label to the custom HUD.
Variable Modify Rule
Change the value of a specified variable. This rule can also used to create a new variable and set its initial value by using the "Change variable" option.
<kuid:-25:1050> Built-in Rule
Properties:
Change <Add to variable/Subtract from variable/Change variable> - click to select one from:-
Add to variable
Add <value> to variable <variable-name> - enter value to add to variable, enter variable-name. Variable-name is case sensitive.
<Do not undo the alteration if the rule is stopped/Undo the alteration if the rule is stopped> - click to select one.
Subtract from variable
Subtract <value> from variable <variable-name> - enter value to subtract from variable, enter variable-name.
Variable-name is case sensitive.
<Do not undo the alteration if the rule is stopped/Undo the alteration if the rule is stopped> - click to select one.
Change variable
Change variable <variable-name> to <value> - enter variable-name, enter new value.
Variable-name is case sensitive. This change cannot be undone if the rule is stopped.
[Check Box] (optional) Set the minimum value of <variable-name> to <value> - enter variable-name
(this will already be set by the change option) and a value. Variable-name is case sensitive.
[Check Box] (optional) Set the maximum value of <variable-name> to <value> - enter variable-name
(this will already be set by the change option) and a value. Variable-name is case sensitive.
Related Rules: Variable Check Rule - tests the value of a specified variable. Variable Modify Continuous Rule - continuously changes the value of a specified variable. Variable Random Rule - assigns a random value to a variable. Variable Show Rule - adds or removes a specified variable and a descriptive label to the custom HUD.
Variable Modify Continuous Rule
Adds, subtracts or sets a value to a specified variable every second.
<kuid:-25:1051> Built-in Rule
Properties:
<Add/Subtract/Change variable to> - select one.
<value> - enter value to add, subtract or apply to <variable-name>
<variable-name> - enter variable-name. Variable-name is case sensitive.
Related Rules: Variable Check Rule - tests the value of a specified variable. Variable Modify Rule - changes the value of a specified variable. Variable Random Rule - assigns a random value to a variable. Variable Show Rule - adds or removes a specified variable and a descriptive label to the custom HUD
Variable Random Rule
Assigns a random value to a variable.
<kuid:400260:100606> DLS Rule by tram_
Properties: Random variable <name> in minimum to maximum interval - enter name of variable. Variable-name is case sensitive. The minimum possible value of variable_name is <value> - enter the minimum value The maximum possible value of variable_name is <value> - enter the maximum value
Related Rules: Randomize - creates a different set of random numbers for each session run. Variable Check Rule - tests the value of a specified variable. Variable Modify Rule - changes the value of a specified variable. Variable Modify Continuous Rule - continuously changes the value of a specified variable. Variable Show Rule - adds or removes a specified variable and a descriptive label to the custom HUD.
Variable Show Rule
Adds or removes a specified variable and a descriptive label to the custom HUD. This rule does not make the custom HUD appear on the screen.
<kuid:-25:971> Built-in Rule
Properties:
[Check Box] Add
<variable-name> - enter variable-name to add to HUD. Variable-name is case sensitive.
<label> - (optional) enter a short label to be displayed on the HUD in front of the variable value.
[Check Box] Remove
<variable-name> - enter variable-name to remove from HUD. Variable-name is case sensitive.
Related Rules: Variable Check Rule - tests the value of a specified variable. Variable Modify Rule - changes the value of a specified variable. Variable Modify Continuous Rule - continuously changes the value of a specified variable. Variable Random Rule - assigns a random value to a variable.
Weather Rules
EIRS Weather Rule NE USA Rule
Customize random weather rule relative to the North East Region of the United States.
<kuid2:487222:1037:3> Built-in Rule
Properties:
Season <select> - select one of:-
Summer
Fall
Winter
Spring
Random Changeability (minutes) <value> - select one of:-
2/5/10/15/20/30/45/60 - minutes
Environment Settings <select> - select one of:-
Disable/Enable
Note: Minutes are Trainz clock times, not real times
Related Rules: Startup Options Rule - sets the weather conditions at the start of a Session Weather Rule - changes the weather conditions during Session play
Weather Rule
Changes the weather conditions during Session play.
<kuid:-25:960> Built-in Rule
Properties:
Set weather to <select mode> with <select frequency> changeability - select
Weather mode: - select one of:-
Clear
Cloudy
Drizzle
Rain
Stormy
Light Snow
Medium Snow
Heavy Snow
Changeability: - select one of:-
Off - the weather will not change from the mode selected above
Periodic - slow gradual changes to the weather
Extreme - rapid and extreme changes to the weather
Related Rules: EIRS Weather Rule NE USA Rule - customize random weather rule relative to the North East Region of the United States Startup Options Rule - sets the weather conditions at the start of a Session
