TrainzOnline - User contributions [en]

Talk:Session Rules By Categories With Properties

2017-11-04T22:03:52Z

Coop2:

Pware thanks for your input with this project!

coop2 thanks Pware for all the work he has done on this project! When this is done everyone can actually understand and know how Session Rules work.

Session Rules By Categories With Properties

2017-10-20T14:37:01Z

Coop2:

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

=='''Achievement Rules'''==

'''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement

'''Properties:'''
None

'''Advanced Industry Load Configuration Rule:''' Locks train controls when loading/unloading at an industry, overrides time settings for begin load and begin unload operations

'''Properties:'''
'''Target object ''<click to 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

'''Multiple Resource Check Rule:''' If specified resources in a selected industries or vehicles reaches set levels, then executes any following child rules

'''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
'''''<Click to 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

'''Objective Add Rule:''' Sets up a game Objective with ID and display Name

'''Properties:'''
'''Priority <Click to 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:''' Checks if an objective created with the '''Objective Add Rule''' is complete, then executes any following child rules

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

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

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

'''Power Station Rule:''' Sets up a Power Station and its electricity consumers

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

'''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 <Option buttons>''' - select one of three options:-
'''( ) Timer'''
'''( ) Countdown Starting value ''<value>''''' - enter time ''hh:mm:ss''
'''( ) None'''
'''Note:''' Times are Trainz clock time, not real time

'''Ranked Session Complete Rule:''' Completes the active ranked Session

'''Properties:'''
'''Set the active ranked session as <Option buttons>''' - select one of two options:-
'''( ) Complete'''
'''( ) Failed'''
'''[Check box] Customize the completion message ''<text>''''' - enter a text message

'''Resource Check Rule:''' Check the progress of the amount of a resource and target object, then executes any following child rules. This rule has been superseded by the '''Multiple Resource Check Rule'''

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

'''Session Complete Rule:''' Set session to a percentage of completion

'''Properties:'''
'''Set session to percent complete ''<value>''''' - enter number as a percentage
'''[Check box] Separate achievements for completion''' - check to set

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

'''Properties:'''
'''Trigger: ''<selection>''''' - 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
'''<Option buttons>''' - select one of two options:-
'''( ) Accept all trains''' - all trains will trigger the rule
'''( ) Accept trains matching specific criteria''' - only specific vehicles, specific vehicle types, specific drivers will trigger the rule

=='''Danger Rules'''==

'''ATP Speed Limiter Rule:''' Limits speed over set limit

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

'''AWS Configuration Rule:''' This rule configures the Trainz implementation of the Automatic Warning System when approaching signals

'''Properties:'''
'''<Option buttons>''' - select one of three options:-
'''( ) Active'''
'''( ) Passive'''
'''( ) Passive with HUD hidden'''
'''[Check Box] Simulate AWS for unfitted cabs?'''
'''[Check Box] Use modern sound set for unfitted cabs?'''

'''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars after a set time delay

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

'''Coupler Breakage Check Rule:''' Checks for breaking couplers and, if found, then executes any following child rules.

'''Properties:'''
'''None'''

'''Coupler Breakage HUD Rule:''' HUD displays warning about coupler stress and breakage

'''Properties:'''
'''<Option buttons>''' - select one of two options:-
'''( ) Show the Coupler Breakage Display'''
'''( ) Hide the Coupler Breakage Display'''

'''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule

'''Properties:'''
'''[Check box] Respawn trains if they are abandoned for 10 minutes'''
If checked:-
'''<Option buttons>''' - select one of two options:-
'''( ) 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

'''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users and, if found, then executes any following child rules.

'''Properties:'''
'''[Check box] Trigger only once'''

'''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users and, if found, then executes any following child rules.

'''Properties:'''
'''[Check box] Trigger only once'''

'''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles

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

'''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger (stop) and, if found, then executes any following child rules.

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

'''Properties:'''
'''<Option buttons>''' - 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

'''Properties:'''
'''<Option buttons>''' - select one of two options:-
'''( ) Accept all trains'''
'''( ) Accept trains matching specific criteria from list of train assets '''
'''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

'''Properties:'''
'''[Check Box] Trigger derailment, Watch Once'''

=='''Navigation Rules'''==

'''DestSignTable Rule:''' Creates a list of destination names for a destination sign

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

'''Properties'''
'''Interlocking Tower ''<select>''''' - to set Name and Objects

'''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
'''Properties'''
'''[Checkbox] Show path activation message in Driver'''

'''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train

'''Properties:'''
'''Interlocking Tower ''<select>''''' - to set Name and Objects

'''Interlocking Tower Enhanced Manager Rule (SP2 and later):''' rule by '''pguy'''. Provides more management and control options for interlocking towers.

'''Properties:'''

'''Multiple Junction Alignment Check Rule''' Checks junctions are set or in alignment, then executes any following child rules

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

'''Navigation Display Rule:''' Creates a set of navigation points. Multiple sets can be created by adding additional copies of this rule. This rule creates the navigation set, it does not display it. Use the '''Navigation set hide/show rule''' to make a set visible. Navigation sets can be completed (terminated) by the '''Navigation Set Clear Rule''', individual navigation points can be ''manually'' completed by the '''Navigation Point Complete Rule'''. Click the help icon at the top of the properties box for in game instructions.

'''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.
'''<Option buttons>''' - select one of three options:-
'''( ) 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.

'''Navigation Point Complete Rule:''' Manually completes a navigation point in a set

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

'''Navigation Set Check Rule:''' Checks if a navigation set is complete or incomplete, then executes any following child rules

'''Properties:'''
'''Checks if navigation point set ''<click to select>'':''' - 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.

'''Navigation Set Clear Rule:''' Clears a navigation set removing any uncompleted navigation points

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

'''Navigation Set Hide/Show:''' Shows and hides navigation sets. You can have multiple sets visible and hidden at the same time.

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

'''Schedule Rule:''' Allows a schedule of timed events to be applied to a train

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

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

'''Set Signal Extended Rule:''' Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''Properties:'''
'''''Select signal''''' - click to select a signal from the session list
'''''<signal state>''''' - click to select a state from the list

'''Trigger Check Rule:''' - Waits for 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".

'''Properties:'''
'''<Option buttons>''' - select one of two options:-
'''( )click to accept all trains'''
'''( )click to accept trains matching specific criteria and choose from session Assets list'''
'''''<select>''''' - select a trigger from the session list'
'''[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 '''
'''''<Click>'' Train Heading''' - choose '''forward''' or '''backward'''

'''Wait on Navigation Point Rule:''' Waits for a navigation point to be completed, then executes any following child rules

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

'''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start, then executes any following child rules

'''Properties:'''
'''[Check box] Trigger rule once'''
'''Wait for a train that matches the following criteria to ''<select>''''' - select one of:-
'''''start moving'''''
'''''stop moving'''''
'''<Option buttons>''' - select one of two options:-
'''( ) click to accept all trains'''
'''( ) click to accept trains matching specific criteria''' - choose from session lists of drivers, vehicles and vehicle types

=='''Driver Rules'''==

'''Control Check Rule:''' Checks if the control method changes, then executes any following child rules

'''Properties:'''
'''Execute child rules when: <Option buttons>''' - select one of two options:-
'''( ) DCC mode is Selected'''
'''( ) Cab mode is Selected'''
'''Execute child rules: <Option buttons>''' - select one of two options:-
'''( ) Every time control method is set'''
'''( ) Once only'''

'''Control Type Rule''' Sets control type

'''Properties:'''
'''Current control method is: ''<select>''''' - click to select one of
'''Easy Mode'''
'''Ask User'''
'''Realistic Mode'''

'''CPC Rule:''' Emit Train On Trigger. Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule

'''Properties:'''
'''Portal index from PCP ''<value>''''' - click to enter (Un)Portal Index
'''Use UnPortal ''<Yes/No>''''' - 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

'''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry

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

'''Driver Command Rule:''' Specify which commands will be available for the drivers

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

'''Driver Command Check Rule:''' Verifies the driver commands of a driver character, then executes any following child rules

'''Properties'''
'''[Check box] Trigger rule once''' - check to allow the rule to execute only once
'''Driver character to watch the command list of ''<click to 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 Main Menu Options Rule:''' Show/Hide the Driver Main Menu Bar

'''Properties'''
'''''<select>'' the Driver Main Menu Bar''' - click to choose one of:-
'''Show'''
'''Hide'''

'''Driver Schedule Rule''' Execution of basic scheduled commands

'''Properties:'''
'''Driver Schedule Rule assigned to <Click>
''-to name driver from Session List''
'''Commands <Click>'''
''-to insert driver commands in Drive Schedule''
'''Style: <Option Buttons>'''
''-Classic style: If there is a schedule do not emit a new schedule''
''-Killer style: If there is a schedule clean it and emit a new one''
''-Cooperative style: If there is a schedule append the new one''
''-Active style: Emit a new schedule, only if already a schedule running''

'''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders

'''Properties'''
'''The following drivers will be available <click>'''
''-To add Driver, Driver Commands, Assets, Type of Engineer, or Remove Driver''
'''Remove all existing Drivers first <Check Box>'''
''-to set''
'''Generate new Drivers for empty Trains <Check Box>'''
''-to set''

'''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers

'''Properties'''
'''Driver Commands <Click>'''
''-to select Enable or Disable''
'''Driver Command criteria to match <Check Box>
''-to select each Driver Command''
'''Trains to use <Option Buttons>'''
''-Accept all trains''
''-Accept trains matching above criteria''

'''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted

'''Properties'''
Config/txt file tag 'max_permitted_speed-60850 in mph or kph
Add to config.txt and kuid-table for value <KUID2:60850:88000:4
Note: Old root level config tag will

'''QuickDrive Rule:''' Change the Session settings and add consists in Driver

'''Properties'''
'''Set Time <Click>'''
''-insert time''
'''QuickDrive Consist Option List by'''
'''Rate of Change ''<value>''''' - insert rate as number times
'''[Check Box] Enable gameplay Session Mode'''
''-to set''
'''[Check Box] Enable in game help by default'''
'''Set the default Control method to <Option buttons>''' - select one of two options:-
'''( ) Easy Mode'''
'''( ) Realistic Mode'''
Prevent player from changing this check
Realistic mode requires achievement add Achievement's Name
In Asset choose Auran achievements
Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic
Prevent player from changing 10.0 check
Set the default units to fill-in choose: Imperial, Metric, Default
Open QuickDriver Window when check

'''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train, then executes any following child rules

'''Properties'''
'''Trigger Rule Once [Check Box]'''
''-to set''
'''Accept trains <Option buttons>''' - select one of two options:-
'''( ) matching specific criteria, select from session list'''
'''( ) all trains'''
'''Wait for a driver character to get '''<select>''''' - select '''On''' or '''Off'''

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

'''Properties'''
'''Assets Ownership <Option buttons>''' - select one of two options:-
'''( ) Wait for ownership of a specific Driver'''
'''( ) Wait for ownership of Driver'''
'''Driver or Vehicle ''<select>''''' - choose from session list

=='''Arrangement of Session Rules:'''==

'''Ordered List Rule:''' Child rules will be executed in order once this rule starts

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

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

'''Properties'''
'''After last child has been executed ...'''
'''''<successive runs will do nothing/the first child is chosen again>''''' - click to select one

'''Random List Rule:''' One of the child rules indented under this rule will be randomly selected and executed. The rule will not repeat to randomly select another child rule

'''Properties'''
None

'''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle

'''Properties'''
None

'''Simultaneous List Rule:''' Child rules are executed simultaneously once this rule starts

'''Properties'''
'''Rule completes when ...'''
'''''<one of the child rules has completed/all child rules have reached a completed state/all child rules have reached a "was completed" state>''''' - click to select one

=='''Camera Rules:'''==

'''Cinematic Camera Rule:''' Provides several different cinematic style cameras

'''Properties'''
Lock camera controls for the duration check
Prevent rain control for duration check
Camera target: name any of the many objects in session
Camera mode: Stationary, Circle fill-in
Initial camera values: Pitch, Yaw, Zoom value
Total time to animate: seconds value

'''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties

'''Properties'''
Change the camera view mode to check to choose: Cab View, External View, Tracking
View, Free Roaming
Vehicle fill-in choose from session vehicles
Set the camera flags to enable/disable check to choose different properties from list
Junction fill-in choose from session junctions
Set the target objet of the camera to check
Map object fill-in choose from map objects

'''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view, then executes any following child rules

'''Properties'''
'''Trigger rule once'''[Check Box]'''
'' to set''
'''Wait for the camera to change to the ? <Click>'''
''to choose: Cab View, External View, Tracking View, Free Roaming View''
'''Wait for the camera to target vehicle ? <Click>'''
''to choose from session list''

=='''Message Rules:'''==

'''Close Message Popup Rule:''' Closes open message popups

'''Properties:'''
None
'''Known Issues:'''
This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule

'''Custom Script Rule:'''

'''Properties'''
None.

'''Display Custom HUD Rule:''' Show or hide the Custom Heads Up Display.

'''Properties'''
'''Custom Heads up Display (Option Button)
''()to Show''
''()to Hide''

'''Wait for Click on HUD Icon Rule:''' Waits for the HUD to be clicked, then executes any following child rules

'''Properties'''
'''Trigger rule once <Check>'''
''to choose''
'''HUD Panel <Click>'''
''to choose from list''
'''Wait for <Click>'''
''to choose; choice depends on HUD Panel chosen''

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

'''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 ''<click to 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

'''Timed limited display HTML Rule:''' Displays an HTML browser window for a limited time.

'''Properties'''
HTML Asset Name-

'''Display Video Rule:''' Displays a page from a HTML assets in a browser window.

'''Properties'''

'''End Session Rule:''' End Session without saving.

'''Properties'''

'''Fade in/out Rule:''' Fade in or out within seconds, color and opacity considered.

'''Properties'''

'''Flash HUD Icon Rule:''' Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.

'''Properties'''

'''Generic Tree Node Debug Window Rule:''' No description.

'''Properties'''

'''InputTable Rule:''' Creating a list of message names to be used for various purposes.

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

'''Properties'''
'''[Check Box] Pause game while message is displayed''' - stops the game until this message is switched off
'''[Check Box] Close previous popup windows''' - closes any Message Popups currently displayed
'''Message location ''<Top Left/Top Right/Bottom Left/Bottom Right>''''' - select one to position the browser window on the screen
'''Message Source: <Option buttons>''' - select one of three options:-
'''( ) Custom text''' - the simplest and easiest option
'''Icon ''<Click here to set>''''' - shows a list of message icons. Select one to be displayed with the message
'''Icon ''<Clear icon>''''' - clears any currently displayed message icon
'''Custom text box''' Enter text to be displayed. You will be limited to about 6 lines of text.
For longer messages or to include graphics, use the '''A predefined HTML page''' option.
'''( ) 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.

'''Minimap Options Rule:''' Sets the display options for the minimap.

'''Properties''' ''Default: all checked''
'''Map Textures [Check Box]'''
''Check to select''
'''Gradients [Check Box]'''
''Check to select''
'''Junctions [Check Box]'''
''Check to select''
'''Signals [Check Box]'''
''Check to select''
'''Triggers [Check Box]'''
''Check to select''
'''Markers [Check Box]'''
''Check to select''
'''Trackside Labels [Check Box]'''
''Check to select''
'''Terrain Objects [Check Box]'''
''Check to select''
'''Industrial Names [Check Box]'''
''Check to select''
'''Named Objects [Check Box]'''
''Check to select''
'''Consists [Check Box]
''Check to select''

'''Play Sound Rule:''' Plays a wav sound file.

'''Properties'''
'''Default HTML <Click>'''
''to enter Sound File Name''
'''HTML Assets <Click>'''
''to select HTML asset''
'''Rule Completes <Click>'''
''to select 'sound has just started''
''to select 'sound has finished playing''

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

'''Properties'''
'''None'''

'''Session Metadata Rule:''' Sets session metadata in the config file. Info can be read by other systems and displayed to the player.

'''Properties'''
'''Type <Click>'''
''to select simulation''
''to select Challenge''
'''Length <Click>'''
''to enter number of minutes, default 30 minutes''
'''Difficulty <Click>'''
''to choose Normal(default), Tutorial, Easy, Hard, Expert''

'''Set Helper Icon Size Rule:''' Sets the size of helper icons such as the junction lever arrows.

'''Properties'''
'''Junction Arrows Size <Click>'''
''to set scale ratio smaller than default, default 100%''

'''Set HTML Page Rule:''' Instructs the Display HTML Pages rule to perform specific operations. This rule has been superseded by the '''Message Popup''' Rule

'''Properties'''
'''Operations to preform on the display HTML pages sequence browser'''
'''<Option buttons>''' - select one of five options:-
'''( ) 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)

'''Show/Hide HUD Panel Rule:''' Shows or hides a HUD panel.

'''Properties'''

'''Show/Hide Layer Rule:''' Shows or hides a layer from Driver.

'''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:'''
TANE (all versions) - layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded

'''Show/Hide Minimap Rule:''' Shows the Driver the minimap window.

'''Properties'''
'''Minimap Window'''-click to choose Show,Hide

'''Show/hide on-screen help Rule:''' Shows or hides On-screen help in Driver.

'''Properties'''
'''Junction Overlays:''' - fill-in to choose: Show, Hide, Leave unchanged. by default one is chosen
'''On Screen Vehicle Name:''' - Fill-in to choose: Show, Hide, Leave unchanged. By default one is chosen

'''Wait for Click on HUD Icon Rule:''' Waits for a click on the HUD Icon, then executes any following child rules

'''Properties'''
''' Trigger Once [Check Box]'''
''to choose''
'''HUD Panel <Click>'''
''to choose from list: Bottom Right Menu, Camera Controls, DCC Controls''
'''Icon <Click>'''
''to choose from list. Selections depends on HUD Panel chosen''

'''Wait on Waybill Screen/Main Screen Rule:''' Waits for the Waybill window to be opened, then executes any following child rules

'''Properties'''

=='''Startup Rules:'''==

'''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.

'''Properties'''

'''Startup Options Rule''' Specifies the starting options for the session.

'''Properties'''

=='''Time Rules:'''==

'''Clock Rule:''' Rule needed for animated clocks, you need to apply this rule to your session to make use of the animated clocks, see forum for code to include in you clock object to work with this rule.

'''Properties'''

'''Timecheck Rule:''' Executes child rules at a set time.

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

'''Timing Check Rule:''' Triggers sub rules if called within the time window specified.

'''Properties'''

'''Wait Rule:''' Wait for number of seconds before executing any following child rules

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

'''Properties'''
'''''<variable-name>''''' - enter a variable-name. Variable name is case sensitive.
'''''<is less than/is less than or equal to/is equal to/is greater than or equal to/is greater than/is not equal to/is between x and y>''''' - select one
'''''<This condition will be evaluated only once .../This condition will be evaluated once every second>''''' - click to select one
'''Test condition option: is between x and y''' - Enter minimum (x) and maximum (y) test values
'''Test condition option: (all other options)''' - Enter test value
'''Evaluation option: 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
'''Evaluation option: This condition will be evaluated evaluated once every second''' - the rule will be rerun and the variable rechecked every second

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

'''Properties'''
'''Change ''<Add to variable/Subtract from variable/Change variable>''''' - select one
'''[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.
'''Change option: 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.
'''Change option: 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 option: 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.

'''Variable Modify Continuous Rule:''' Adds, subtracts or sets a value to a specified variable every second.

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

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

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

Variables are saved in the session file and persist from one saved game to another.
They can be accessed/modified by the following '''driver commands''':

'''Driver Commands by trev999:'''
'''Set S-Variable driver command: '''
'''Skip if session-variable driver command: '''
'''Wait until S-variable driver command: '''

'''Driver Commands by atilabarut'''
'''ChangeSVariables driver command: '''
'''WaitUntilSVariable driver command: '''

=='''Weather Rules:'''==

'''EIRS Weather Rule NE USA Rule: Customize random weather rule relative to the North East Region of the United States.'''
'''Sets Summer at 70% Clear, 20% T-Storms, 10% Drizzle

'''Properties'''
'''Season <Click>'''
''set to Summer/Fall/Winter/Spring''
'''Random Changeability(minutes) <Click>'''
''to choose 2/5/10/15/20/30/45/60 minutes''
'''Environment Settings <Click>'''
''set to Disable/Enable''

'''Weather Rule:''' Set the weather conditions.

'''Properties'''
'''Set weather <Click>'''
''to set to Clear/Cloudy/Drizzle/Rain/Stormy/Light Snow/Medium Snow/Heavy Snow''
'''Changeability <Click>'''
''to set to No/Periodic/Extreme''

Session Rules By Categories With Properties

2017-10-12T16:32:52Z

Coop2:

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

=='''Achievement Rules'''==

'''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement

'''Properties:'''
None

'''Advanced Industry Load Configuration Rule:''' Locks train controls when loading/unloading at an industry, overrides time settings for begin load and begin unload operations

'''Properties:'''
'''Target object ''<click to 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

'''Multiple Resource Check Rule:''' If specified resources in a selected industries or vehicles reaches set levels, then executes any following child rules

'''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
'''''<Click to 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

'''Objective Add Rule:''' Sets up a game Objective with ID and display Name

'''Properties:'''
'''Priority <Click to 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:''' Checks if an objective created with the '''Objective Add Rule''' is complete, then executes any following child rules

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

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

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

'''Power Station Rule:''' Sets up a Power Station and its electricity consumers

'''Properties:'''
'''''<select>''''' - add a Power Station from session list.
'''''<select>''''' - add power consumers from session list

'''Ranked Session Begin Rule:''' Begins a ranked Session

'''Properties:'''
'''Countdown Starting Value ''<value>'''''
'''''hrs:'''''
'''''min:'''''
'''''sec:'''''
'''1 through 5 stars, points for each star ''<value>''''' - enter number of points
'''Session timer mode (Option Buttons)''' - select one of three options:-
'''() Timer'''
'''() Countdown'''
'''() None'''
'''Note:''' Times are Trainz clock time, not real time

'''Ranked Session Complete Rule:''' Completes the active ranked Session

'''Properties:'''
'''Set the active ranked session as (Option Buttons)''' - select one of two options:-
'''() Complete'''
'''() Failed'''
'''Customize the completion message ''<Text Box>''''' - insert text message

'''Resource Check Rule:''' Check the progress of the amount of a resource and target object, then executes any following child rules

'''Properties:'''
'''(Option Buttons)''' - select one from two options:-
'''() Watch industry queue'''
'''() Watch vehicle'''
'''Note:''' Both have: '''Target Object, Queue:'''
'''Complete when designated queue (Option Buttons)''' - select one from two options:-
'''() equals or exceeds required amount'''
'''() falls below required amount'''

'''Session Complete Rule:''' Set session to a percentage of completion

'''Properties:'''
'''Set session to percent complete ''<value>''''' - enter number as a percentage
'''[Check box] Separate achievements for completion''' - check to set

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

'''Properties:'''
'''Trigger: ''<selection>''''' - 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
'''(Option buttons)''' - select one option from the following two:-
'''() Accept all trains''' - all trains will trigger the rule
'''() Accept trains matching specific criteria''' - only specific vehicles, specific vehicle types, specific drivers will trigger the rule

=='''Danger Rules'''==

'''ATP Speed Limiter Rule:''' Limits speed over set limit

'''Properties:'''
'''Speed limit over the set limit <Click>
''-to set mph''

'''AWS Configuration Rule:''' This rule configures the Trainz implementation of the Automatic Warning System when approaching signals

'''Properties:'''
''' <Check Box> Use modern sound set for unfitted cabs?'''
''check to set''
'''<Check Box> Simulate AWS for unfitted cabs?'''
''-check to set''
'''Passive with HUD hidden <Option Buttons> one of the two'''
''()Active''
''()Passive''

'''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars after a set time delay

'''Properties:'''
'''''<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.

'''Coupler Breakage Check Rule:''' Checks for breaking couplers and, if found, then executes any following child rules.

'''Properties:'''
'''None'''

'''Coupler Breakage HUD Rule:''' HUD displays warning about coupler stress and breakage

'''Properties:'''
'''(Option buttons)''' - select one of two options
'''( ) Show the Coupler Breakage Display'''
'''( ) Hide the Coupler Breakage Display'''

'''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule

'''Properties:'''
'''[Check box] Respawn trains if they are abandoned for 10 minutes'''
If checked:-
'''(Option buttons)''' - select one of two options:-
'''( ) 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

'''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users and, if found, then executes any following child rules.

'''Properties:'''
'''[Check box] Trigger only once'''

'''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users and, if found, then executes any following child rules.

'''Properties:'''
'''[Check box] Trigger only once'''

'''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles

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

'''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger (stop) and, if found, then executes any following child rules.

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

'''Properties:'''
'''(Option buttons)''' - 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

'''Properties:'''
'''<Option Button> accept all trains'''
'''<Click> to insert percent of Cab sway'''
'''<Click>to insert percent of boost while sanding '''
'''<Click> to set percentage of traction reduction'''
'''<Click> to insert percent of Maximum tractive effort adjustment
'''<Click> Show coupler breakage in HUD Rule '''
'''<Click> to set Couplers to break when coupling above set speed '''
'''(Option Button) Accept trains matching specific criteria from list of train assets '''
'''<Click> to insert amount of force in KN units that the Couplers break'''

'''Wait for Derailment Rule:''' Waits for a derailment to occur, then executes any following child rules

'''Properties:'''
'''[Check Box] Trigger derailment, Watch Once'''

=='''Navigation Rules'''==

'''DestSignTable Rule:''' Creates a list of destination names for a destination sign

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

'''Properties'''
'''Interlocking Tower <Click>'''
''-to set Name and Objects''

'''Interlocking Tower Path Selection UI <CheckBox>''' Will automatically react to messages from Interlocking Towers and display a path selection dialog to the player. Disable by removing rule from session
''-Check(default) to Show path activation message in Driver''

'''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train

'''Properties:'''
'''Interlocking Tower <Click>'''
''-to set Names and Objects''

'''Multiple Junction Alignment Check Rule''' Checks junctions are set or in alignment, then executes any following child rules

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

'''Navigation Display Rule:''' Creates a set of navigation points. Multiple sets can be created by adding additional copies of this rule. This rule creates the navigation set, it does not display it. Use the '''Navigation set hide/show rule''' to make a set visible. Navigation sets can be completed (terminated) by the '''Navigation Set Clear Rule''', individual navigation points can be ''manually'' completed by the '''Navigation Point Complete Rule'''. Click the help icon at the top of the properties box for in game instructions.

'''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.
'''(Option buttons)''' - select one of three options
'''( ) 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.

'''Navigation Point Complete Rule:''' Manually completes a navigation point in a set

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

'''Navigation Set Check Rule:''' Checks if a navigation set is complete or incomplete, then executes any following child rules

'''Properties:'''
'''Checks if navigation point set ''<click to select>'':''' - 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.

'''Navigation Set Clear Rule:''' Clears a navigation set removing any uncompleted navigation points

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

'''Navigation Set Hide/Show:''' Shows and hides navigation sets. You can have multiple sets visible and hidden at the same time.

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

'''Schedule Rule:''' Allows a schedule of timed events to be applied to a train

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

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

'''Set Signal Extended Rule:''' Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''Properties:'''
'''''Select signal''''' - click to select a signal from the session list
'''''<signal state>''''' - click to select a state from the list

'''Trigger Check Rule:''' - Waits for 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".

'''Properties:'''
'''(Option Buttons) Accept all trains '''
'''()click to accept all trains'''
'''()click to accept trains matching specific criteria and choose from session Assets list'''
'''<Click> Add Trigger from session list'''
'''[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 '''
'''<Click> Train Heading choose forward/backward'''

'''Wait on Navigation Point Rule:''' Waits for a navigation point to be completed, then executes any following child rules

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

'''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start, then executes any following child rules

'''Properties:'''
'''[Check box] Trigger rule once'''
'''<Click> Wait for a train that matches the following criteria to start moving/stop moving'''
'''(Option Buttons) Acceptable trains '''
'''()click to accept all trains'''
'''()click to accept trains matching specific criteria and choose from session list'''

=='''Driver Rules'''==

'''Control Check Rule:''' Checks if the control method changes, then executes any following child rules

'''Properties:'''
'''Execute child rules when: (Option Buttons)''' - select one from
'''() DCC mode is Selected'''
'''() Cab mode is Selected'''
'''Execute child rules: (Option Buttons)''' - select one from
'''() Every time control method is set'''
'''() Once only'''

'''Control Type Rule''' Sets control type

'''Properties:'''
'''Current control method is: ''<select>''''' - click to select one of
'''Easy Mode'''
'''Ask User'''
'''Realistic Mode'''

'''CPC Rule:''' Emit Train On Trigger. Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule

'''Properties:'''
'''Portal index from PCP ''<value>''''' - click to enter (Un)Portal Index
'''Use UnPortal ''<Yes/No>''''' - 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

'''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry

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

'''Driver Command Rule:''' Specify which commands will be available for the drivers

'''Properties''':
Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.
Navigate To TrackMarkList V2- No description.
Navigate To Station V2- No description.
Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.
Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.
Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.
Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.
Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.
Drive To Station V2- No description.
Drive To Track mark List V2- No description.
Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.
Drive To Industry- Drive to a specific industry.
Change Destination Sign-Changes the destination signs of a train.

WaitFor- Pauses the driver's schedule for a set duration of time.
Wait For Random- TRS2008: Wait for specified or optionally random period of time.
Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).
WaitUntil- No description.

VR Set Train Lamps-Driver command that sets the train lamps.
Notify- Notifies the player of schedule progress/completion.
Reverse Tram- Reverse a tram(max 2 cars).
Couple- Couple train to designate vehicle.
Decouple- Decouples the train at the specified vehicle.
UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).
Halt Train- Brings the train to a complete stop.
Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.
Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger
station before using this command.
Cab: Wait-Maintains current control state until some condition is met.
Delete Train- Causes the train and its driver to be deleted from the session.
Hornz- Driver sounds the train horn.
Cab: Set Control-Sets a cab mode control.
Headlights On/Off-Allows the driver to to switch the headlights on and off.
Interior Lights Command- Driver command to switch interior lights on or off for the current train.
Set Max Speed To- No description.

Release Junction - Lets a driver release the junction they have been holding.
Move Turntable- TRS2008: Move turntable to a stop point .

Load- Loads the train's vehicles at the industry the driver is currently at with the train.
Unload- Unload train vehicles at current industry location.
Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.
Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.
Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.

'''Driver Command Check Rule:''' Verifies the driver commands of a driver character, then executes any following child rules

'''Properties'''
'''Trigger rule once <Click>'''
''-to set''
'''Driver character to watch the command list of <Click.'''
''to select Driver from Session List''
'''Wait for driver character to have a command list that matches this:''' add driver, all, delete all
'''Add Driver Command <Select>'''
''-to add a Driver Command''
'''Add all <Click>'''
''Click to add all Driver Commands''
'''Delete all <Click>'''
''-to delete Driver Command List''

'''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar

'''Properties'''
'''The Driver Main Bar <Click>'''
''-to Show or Hide''

'''Driver Schedule Rule''' Execution of basic scheduled commands

'''Properties:'''
'''Driver Schedule Rule assigned to <Click>
''-to name driver from Session List''
'''Commands <Click>'''
''-to insert driver commands in Drive Schedule''
'''Style: <Option Buttons>'''
''-Classic style: If there is a schedule do not emit a new schedule''
''-Killer style: If there is a schedule clean it and emit a new one''
''-Cooperative style: If there is a schedule append the new one''
''-Active style: Emit a new schedule, only if already a schedule running''

'''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders

'''Properties'''
'''The following drivers will be available <click>'''
''-To add Driver, Driver Commands, Assets, Type of Engineer, or Remove Driver''
'''Remove all existing Drivers first <Check Box>'''
''-to set''
'''Generate new Drivers for empty Trains <Check Box>'''
''-to set''

'''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers

'''Properties'''
'''Driver Commands <Click>'''
''-to select Enable or Disable''
'''Driver Command criteria to match <Check Box>
''-to select each Driver Command''
'''Trains to use <Option Buttons>'''
''-Accept all trains''
''-Accept trains matching above criteria''

'''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted

'''Properties'''
Config/txt file tag 'max_permitted_speed-60850 in mph or kph
Add to config.txt and kuid-table for value <KUID2:60850:88000:4
Note: Old root level config tag will

'''QuickDrive Rule:''' Change the Session settings and add consists in Driver

'''Properties'''
'''Set Time <Click>'''
''-insert time''
'''QuickDrive Consist Option List by'''
'''Rate of Change <Click>
''-insert rate as number times''
'''Enable gameplay Session Mode [Check Box]'''
''-to set''
'''Enable in game help by default [Check Box]
''-to set''
'''Set the default Control method to (Option Button)'''
''-Easy Mode''
''-Realistic Mode''
Prevent player from changing this check
Realistic mode requires achievement add Achievement's Name
In Asset choose Auran achievements
Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic
Prevent player from changing 10.0 check
Set the default units to fill-in choose: Imperial, Metric, Default
Open QuickDriver Window when check

'''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train, then executes any following child rules

'''Properties'''
'''Trigger Rule Once [Check Box]'''
''-to set''
'''Accept trains (Option Button)'''
''-matching specific criteria, select from session list''
''-all trains''
'''Wait for a driver character to get <Click>
''-to select: On, Off''

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

'''Properties'''
'''Assets Ownership (Option Button)'''
''-Wait for ownership of a specific Driver''
''-Wait for ownership of Driver''
'''Driver or Vehicle <click>
''-to choose from session lists''

=='''Arrangement of Session Rules:'''==

'''Ordered List Rule:''' Child rules will be executed in order once this rule starts

'''Properties'''
One of the following options must be chosen
'''(Option button) This process will repeat ''<value>'' time(s)''' - enter the number of times this rule is to be repeated
'''(Option button) This process will repeat forever'''

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

'''Properties'''
'''After last child has been executed ...'''
'''''<successive runs will do nothing/the first child is chosen again>''''' - click to select one

'''Random List Rule:''' One of the child rules indented under this rule will be randomly selected and executed. The rule will not repeat to randomly select another child rule

'''Properties'''
None

'''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle

'''Properties'''
None

'''Simultaneous List Rule:''' Child rules are executed simultaneously once this rule starts

'''Properties'''
'''Rule completes when ...'''
'''''<one of the child rules has completed/all child rules have reached a completed state/all child rules have reached a "was completed" state>''''' - click to select one

=='''Camera Rules:'''==

'''Cinematic Camera Rule:''' Provides several different cinematic style cameras

'''Properties'''
Lock camera controls for the duration check
Prevent rain control for duration check
Camera target: name any of the many objects in session
Camera mode: Stationary, Circle fill-in
Initial camera values: Pitch, Yaw, Zoom value
Total time to animate: seconds value

'''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties

'''Properties'''
Change the camera view mode to check to choose: Cab View, External View, Tracking
View, Free Roaming
Vehicle fill-in choose from session vehicles
Set the camera flags to enable/disable check to choose different properties from list
Junction fill-in choose from session junctions
Set the target objet of the camera to check
Map object fill-in choose from map objects

'''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view, then executes any following child rules

'''Properties'''
Trigger rule once check to set
Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking
View, Free Roaming View
Wait for the camera to target vehicle ? click to choose form session list

=='''Message Rules:'''==

'''Close Message Popup Rule:''' Closes open message popups

'''Properties:'''
None
'''Known Issues:'''
This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule

'''Custom Script Rule:'''

'''Properties'''
None.

'''Display Custom HUD Rule:''' Show or hide the Custom Heads Up Display.

'''Properties'''
Show the Custom Heads up Display- fill-in to choose.
Hide the Custom Heads up Display- fill-in to choose.
Note: One or the other will be chosen by default.

'''Wait for Click on HUD Icon Rule:''' Waits for the HUD to be clicked, then executes any following child rules

'''Properties'''
Trigger rule once-check to choose.
HUD Panel- click to choose from list.
Wait for click on- click to choose; choice depends on HUD Panel chosen.

'''Display HTML Pages Rule:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.

'''Properties'''
Add Page- click on to choose from list; click to Add Page Name or Remove.
Add All- click to add all files from the designated assets.
Delete All- delete all files from this property list.
Prevent user from exiting browser until all pages viewed- check to choose.
Disable closing of browser window by user- check to choose.
Disable browser window scrolling- check to choose.
Make browser window invisible- check to choose.
Set position-Under Construction!!!- check to choose.
Set size-Under Construction!!!- check to choose.
Use the page- click to choose Insert Page Name.
From asset HTML- click to choose from list.

'''Timed limited display HTML Rule:''' Displays an HTML browser window for a limited time.

'''Properties'''
HTML Asset Name-

'''Display Video Rule:''' Displays a page from a HTML assets in a browser window.

'''Properties'''

'''End Session Rule:''' End Session without saving.

'''Properties'''

'''Fade in/out Rule:''' Fade in or out within seconds, color and opacity considered.

'''Properties'''

'''Flash HUD Icon Rule:''' Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.

'''Properties'''

'''Generic Tree Node Debug Window Rule:''' No description.

'''Properties'''

'''InputTable Rule:''' Creating a list of message names to be used for various purposes.

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

'''Properties'''
'''[Check Box] Pause game while message is displayed''' - stops the game until this message is switched off
'''[Check Box] Close previous popup windows''' - closes any Message Popups currently displayed
'''Message location ''<Top Left/Top Right/Bottom Left/Bottom Right>''''' - select one to position the browser window on the screen
'''Message Source: (Option Buttons)''' - select one of three options
'''( ) Custom text''' - the simplest and easiest option
'''Icon ''<Click here to set>''''' - shows a list of message icons. Select one to be displayed with the message
'''Icon ''<Clear icon>''''' - clears any currently displayed message icon
'''Custom text box''' Enter text to be displayed. You will be limited to about 6 lines of text.
For longer messages or to include graphics, use the '''A predefined HTML page''' option.
'''( ) 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.

'''Minimap Options Rule:''' Sets the display options for the minimap.

'''Properties''' ''Default: all checked''
'''Map Textures [Check Box]'''
''Check to select''
'''Gradients [Check Box]'''
''Check to select''
'''Junctions [Check Box]'''
''Check to select''
'''Signals [Check Box]'''
''Check to select''
'''Triggers [Check Box]'''
''Check to select''
'''Markers [Check Box]'''
''Check to select''
'''Trackside Labels [Check Box]'''
''Check to select''
'''Terrain Objects [Check Box]'''
''Check to select''
'''Industrial Names [Check Box]'''
''Check to select''
'''Named Objects [Check Box]'''
''Check to select''
'''Consists [Check Box]
''Check to select''

'''Play Sound Rule:''' Plays a wav sound file.

'''Properties'''
'''Default HTML <Click>'''
''to enter Sound File Name''
'''HTML Assets <Click>'''
''to select HTML asset''
'''Rule Completes <Click>'''
''to select 'sound has just started''
''to select 'sound has finished playing''

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

'''Properties'''
'''None'''

'''Session Metadata Rule:''' Sets session metadata in the config file. Info can be read by other systems and displayed to the player.

'''Properties'''
'''Type <Click>'''
''to select simulation''
''to select Challenge''
'''Length <Click>'''
''to enter number of minutes, default 30 minutes''
'''Difficulty <Click>'''
''to choose Normal(default), Tutorial, Easy, Hard, Expert''

'''Set Helper Icon Size Rule:''' Sets the size of helper icons such as the junction lever arrows.

'''Properties'''
'''Junction Arrows Size <Click>'''
''to set scale ratio smaller than default, default 100%''

'''Set HTML Page Rule:''' Instructs the Display HTML Pages rule to perform specific operations

'''Properties'''
'''Operations to preform on the display HTML pages sequence browser'''
''(Option Button, default) to instruct the sequence browser to <Click>''
''to choose page operations''
''(Option Button) to instruct the sequence browser to open the page <Click>''
''to enter the HTML page name''
''(Option Button) to set browser parameters <Click>''
''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''
''(Option Button) Set the following flag for the page named <click> to enter 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''
''(Option Button) Use the page <Click> to enter HTML page name from the HTML asset <Click> to select HTML assets for a pop-up message box''
''(Option Button) Use the string table entry <Click> to enter Index from the HTML asset <Click> to select HTML assets as the contents for a pop-up message box''

'''Show/Hide HUD Panel Rule:''' Shows or hides a HUD panel.

'''Properties'''

'''Show/Hide Layer Rule:''' Shows or hides a layer from Driver.

'''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:'''
TANE (all versions) - layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded

'''Show/Hide Minimap Rule:''' Shows the Driver the minimap window.

'''Properties'''
'''Minimap Window'''-click to choose Show,Hide

'''Show/hide on-screen help Rule:''' Shows or hides On-screen help in Driver.

'''Properties'''
'''Junction Overlays:''' - fill-in to choose: Show, Hide, Leave unchanged. by default one is chosen
'''On Screen Vehicle Name:''' - Fill-in to choose: Show, Hide, Leave unchanged. By default one is chosen

'''Wait for Click on HUD Icon Rule:''' Waits for a click on the HUD Icon, then executes any following child rules

'''Properties'''
'''(Check Box) Trigger Once:''' -to choose
'''HUD Panel:''' - Click to choose from list: Bottom Right Menu, Camera Controls, DCC Controls
'''Icon:''' - Choose from list. Selections depends on HUD Panel chosen

'''Wait on Waybill Screen/Main Screen Rule:''' Waits for the Waybill window to be opened, then executes any following child rules

'''Properties'''

=='''Startup Rules:'''==

'''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.

'''Properties'''

'''Startup Options Rule''' Specifies the starting options for the session.

'''Properties'''

=='''Time Rules:'''==

'''Clock Rule:''' Rule needed for animated clocks, you need to apply this rule to your session to make use of the animated clocks, see forum for code to include in you clock object to work with this rule.

'''Properties'''

'''Timecheck Rule:''' Executes child rules at a set time.

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

'''Timing Check Rule:''' Triggers sub rules if called within the time window specified.

'''Properties'''

'''Wait Rule:''' Wait for number of seconds before executing any following child rules

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

'''Properties'''
'''''<variable-name>''''' - enter a variable-name. Variable name is case sensitive.
'''''<is less than/is less than or equal to/is equal to/is greater than or equal to/is greater than/is not equal to/is between x and y>''''' - select one
'''''<This condition will be evaluated only once .../This condition will be evaluated once every second>''''' - click to select one
'''Test condition option: is between x and y''' - Enter minimum (x) and maximum (y) test values
'''Test condition option: (all other options)''' - Enter test value
'''Evaluation option: 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
'''Evaluation option: This condition will be evaluated evaluated once every second''' - the rule will be rerun and the variable rechecked every second

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

'''Properties'''
'''Change ''<Add to variable/Subtract from variable/Change variable>''''' - select one
'''[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.
'''Change option: 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.
'''Change option: 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 option: 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.

'''Variable Modify Continuous Rule:''' Adds, subtracts or sets a value to a specified variable every second.

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

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

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

Variables are saved in the session file and persist from one saved game to another.
They can be accessed/modified by the following '''driver commands''':

'''Driver Commands by trev999:'''
'''Set S-Variable driver command: '''
'''Skip if session-variable driver command: '''
'''Wait until S-variable driver command: '''

'''Driver Commands by atilabarut'''
'''ChangeSVariables driver command: '''
'''WaitUntilSVariable driver command: '''

=='''Weather Rules:'''==

'''EIRS Weather Rule NE USA Rule:''' Customize random weather rule relative to the North East Region of the United States.

'''Properties'''

'''Weather Rule:''' Set the weather conditions.

'''Properties'''

Session Rules By Categories With Properties

2017-10-12T16:17:36Z

Coop2:

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

=='''Achievement Rules'''==

'''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement

'''Properties:'''
None

'''Advanced Industry Load Configuration Rule:''' Locks train controls when loading/unloading at an industry, overrides time settings for begin load and begin unload operations

'''Properties:'''
'''Target object ''<click to 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

'''Multiple Resource Check Rule:''' If specified resources in a selected industries or vehicles reaches set levels, then executes any following child rules

'''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
'''''<Click to 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

'''Objective Add Rule:''' Sets up a game Objective with ID and display Name

'''Properties:'''
'''Priority <Click to 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:''' Checks if an objective created with the '''Objective Add Rule''' is complete, then executes any following child rules

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

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

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

'''Power Station Rule:''' Sets up a Power Station and its electricity consumers

'''Properties:'''
'''''<select>''''' - add a Power Station from session list.
'''''<select>''''' - add power consumers from session list

'''Ranked Session Begin Rule:''' Begins a ranked Session

'''Properties:'''
'''Countdown Starting Value ''<value>'''''
'''''hrs:'''''
'''''min:'''''
'''''sec:'''''
'''1 through 5 stars, points for each star ''<value>''''' - enter number of points
'''Session timer mode (Option Buttons)''' - select one of three options:-
'''() Timer'''
'''() Countdown'''
'''() None'''
'''Note:''' Times are Trainz clock time, not real time

'''Ranked Session Complete Rule:''' Completes the active ranked Session

'''Properties:'''
'''Set the active ranked session as (Option Buttons)''' - select one of two options:-
'''() Complete'''
'''() Failed'''
'''Customize the completion message ''<Text Box>''''' - insert text message

'''Resource Check Rule:''' Check the progress of the amount of a resource and target object, then executes any following child rules

'''Properties:'''
'''(Option Buttons)''' - select one from two options:-
'''() Watch industry queue'''
'''() Watch vehicle'''
'''Note:''' Both have: '''Target Object, Queue:'''
'''Complete when designated queue (Option Buttons)''' - select one from two options:-
'''() equals or exceeds required amount'''
'''() falls below required amount'''

'''Session Complete Rule:''' Set session to a percentage of completion

'''Properties:'''
'''Set session to percent complete ''<value>''''' - enter number as a percentage
'''[Check box] Separate achievements for completion''' - check to set

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

'''Properties:'''
'''Trigger: ''<selection>''''' - 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
'''(Option buttons)''' - select one option from the following two:-
'''() Accept all trains''' - all trains will trigger the rule
'''() Accept trains matching specific criteria''' - only specific vehicles, specific vehicle types, specific drivers will trigger the rule

=='''Danger Rules'''==

'''ATP Speed Limiter Rule:''' Limits speed over set limit

'''Properties:'''
'''Speed limit over the set limit <Click>
''-to set mph''

'''AWS Configuration Rule:''' This rule configures the Trainz implementation of the Automatic Warning System when approaching signals

'''Properties:'''
''' <Check Box> Use modern sound set for unfitted cabs?'''
''check to set''
'''<Check Box> Simulate AWS for unfitted cabs?'''
''-check to set''
'''Passive with HUD hidden <Option Buttons> one of the two'''
''()Active''
''()Passive''

'''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars after a set time delay

'''Properties:'''
'''''<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.

'''Coupler Breakage Check Rule:''' Checks for breaking couplers and, if found, then executes any following child rules.

'''Properties:'''
'''None'''

'''Coupler Breakage HUD Rule:''' HUD displays warning about coupler stress and breakage

'''Properties:'''
'''(Option buttons)''' - select one of two options
'''( ) Show the Coupler Breakage Display'''
'''( ) Hide the Coupler Breakage Display'''

'''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule

'''Properties:'''
'''[Check box] Respawn trains if they are abandoned for 10 minutes'''
If checked:-
'''(Option buttons)''' - select one of two options:-
'''( ) 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

'''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users and, if found, then executes any following child rules.

'''Properties:'''
'''[Check box] Trigger only once'''

'''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users and, if found, then executes any following child rules.

'''Properties:'''
'''[Check box] Trigger only once'''

'''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles

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

'''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger (stop) and, if found, then executes any following child rules.

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

'''Properties:'''
'''(Option buttons)''' - 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

'''Properties:'''
'''<Option Button> accept all trains'''
'''<Click> to insert percent of Cab sway'''
'''<Click>to insert percent of boost while sanding '''
'''<Click> to set percentage of traction reduction'''
'''<Click> to insert percent of Maximum tractive effort adjustment
'''<Click> Show coupler breakage in HUD Rule '''
'''<Click> to set Couplers to break when coupling above set speed '''
'''(Option Button) Accept trains matching specific criteria from list of train assets '''
'''<Click> to insert amount of force in KN units that the Couplers break'''

'''Wait for Derailment Rule:''' Waits for a derailment to occur, then executes any following child rules

'''Properties:'''
'''[Check Box] Trigger derailment, Watch Once'''

=='''Navigation Rules'''==

'''DestSignTable Rule:''' Creates a list of destination names for a destination sign

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

'''Properties'''
'''Interlocking Tower <Click>'''
''-to set Name and Objects''

'''Interlocking Tower Path Selection UI <CheckBox>''' Will automatically react to messages from Interlocking Towers and display a path selection dialog to the player. Disable by removing rule from session
''-Check(default) to Show path activation message in Driver''

'''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train

'''Properties:'''
'''Interlocking Tower <Click>'''
''-to set Names and Objects''

'''Multiple Junction Alignment Check Rule''' Checks junctions are set or in alignment, then executes any following child rules

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

'''Navigation Display Rule:''' Creates a set of navigation points. Multiple sets can be created by adding additional copies of this rule. This rule creates the navigation set, it does not display it. Use the '''Navigation set hide/show rule''' to make a set visible. Navigation sets can be completed (terminated) by the '''Navigation Set Clear Rule''', individual navigation points can be ''manually'' completed by the '''Navigation Point Complete Rule'''. Click the help icon at the top of the properties box for in game instructions.

'''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.
'''(Option buttons)''' - select one of three options
'''( ) 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.

'''Navigation Point Complete Rule:''' Manually completes a navigation point in a set

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

'''Navigation Set Check Rule:''' Checks if a navigation set is complete or incomplete, then executes any following child rules

'''Properties:'''
'''Checks if navigation point set ''<click to select>'':''' - 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.

'''Navigation Set Clear Rule:''' Clears a navigation set removing any uncompleted navigation points

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

'''Navigation Set Hide/Show:''' Shows and hides navigation sets. You can have multiple sets visible and hidden at the same time.

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

'''Schedule Rule:''' Allows a schedule of timed events to be applied to a train

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

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

'''Set Signal Extended Rule:''' Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''Properties:'''
'''''Select signal''''' - click to select a signal from the session list
'''''<signal state>''''' - click to select a state from the list

'''Trigger Check Rule:''' - Waits for 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".

'''Properties:'''
'''Accept all trains <Option Buttons>'''
''-click to accept all trains
''-click to accept trains matching specific criteria and choose from session Assets list''
'''Add Trigger <Click>'''
''-to choose from session list''
'''Trigger only once <Check Box>'''
''-check to set''
'''Wait for child rules to complete even if no trains are present in rule trigger <Checkbox>'''
''-check to set''
'''Only activate when the entering vehicle of the train <Check Box>'''
''click to set''
'''Train Heading <Click>'''
''-to set to forward''
''-to set to backward''

'''Wait on Navigation Point Rule:''' Waits for a navigation point to be completed, then executes any following child rules

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

'''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start, then executes any following child rules

'''Properties:'''
'''[Check box] Trigger rule once''' - check to set
'''Wait for a train that matches the following criteria to <Click>'''
''-to set start moving''
''-to to stop moving''
'''Accept all trains <Option Buttons>'''
''-click to accept all trains''
''-click to accept trains matching specific criteria and choose from session list''

=='''Driver Rules'''==

'''Control Check Rule:''' Checks if the control method changes, then executes any following child rules

'''Properties:'''
'''Execute child rules when: (Option Buttons)''' - select one from
'''() DCC mode is Selected'''
'''() Cab mode is Selected'''
'''Execute child rules: (Option Buttons)''' - select one from
'''() Every time control method is set'''
'''() Once only'''

'''Control Type Rule''' Sets control type

'''Properties:'''
'''Current control method is: ''<select>''''' - click to select one of
'''Easy Mode'''
'''Ask User'''
'''Realistic Mode'''

'''CPC Rule:''' Emit Train On Trigger. Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule

'''Properties:'''
'''Portal index from PCP ''<value>''''' - click to enter (Un)Portal Index
'''Use UnPortal ''<Yes/No>''''' - 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

'''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry

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

'''Driver Command Rule:''' Specify which commands will be available for the drivers

'''Properties''':
Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.
Navigate To TrackMarkList V2- No description.
Navigate To Station V2- No description.
Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.
Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.
Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.
Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.
Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.
Drive To Station V2- No description.
Drive To Track mark List V2- No description.
Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.
Drive To Industry- Drive to a specific industry.
Change Destination Sign-Changes the destination signs of a train.

WaitFor- Pauses the driver's schedule for a set duration of time.
Wait For Random- TRS2008: Wait for specified or optionally random period of time.
Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).
WaitUntil- No description.

VR Set Train Lamps-Driver command that sets the train lamps.
Notify- Notifies the player of schedule progress/completion.
Reverse Tram- Reverse a tram(max 2 cars).
Couple- Couple train to designate vehicle.
Decouple- Decouples the train at the specified vehicle.
UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).
Halt Train- Brings the train to a complete stop.
Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.
Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger
station before using this command.
Cab: Wait-Maintains current control state until some condition is met.
Delete Train- Causes the train and its driver to be deleted from the session.
Hornz- Driver sounds the train horn.
Cab: Set Control-Sets a cab mode control.
Headlights On/Off-Allows the driver to to switch the headlights on and off.
Interior Lights Command- Driver command to switch interior lights on or off for the current train.
Set Max Speed To- No description.

Release Junction - Lets a driver release the junction they have been holding.
Move Turntable- TRS2008: Move turntable to a stop point .

Load- Loads the train's vehicles at the industry the driver is currently at with the train.
Unload- Unload train vehicles at current industry location.
Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.
Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.
Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.

'''Driver Command Check Rule:''' Verifies the driver commands of a driver character, then executes any following child rules

'''Properties'''
'''Trigger rule once <Click>'''
''-to set''
'''Driver character to watch the command list of <Click.'''
''to select Driver from Session List''
'''Wait for driver character to have a command list that matches this:''' add driver, all, delete all
'''Add Driver Command <Select>'''
''-to add a Driver Command''
'''Add all <Click>'''
''Click to add all Driver Commands''
'''Delete all <Click>'''
''-to delete Driver Command List''

'''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar

'''Properties'''
'''The Driver Main Bar <Click>'''
''-to Show or Hide''

'''Driver Schedule Rule''' Execution of basic scheduled commands

'''Properties:'''
'''Driver Schedule Rule assigned to <Click>
''-to name driver from Session List''
'''Commands <Click>'''
''-to insert driver commands in Drive Schedule''
'''Style: <Option Buttons>'''
''-Classic style: If there is a schedule do not emit a new schedule''
''-Killer style: If there is a schedule clean it and emit a new one''
''-Cooperative style: If there is a schedule append the new one''
''-Active style: Emit a new schedule, only if already a schedule running''

'''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders

'''Properties'''
'''The following drivers will be available <click>'''
''-To add Driver, Driver Commands, Assets, Type of Engineer, or Remove Driver''
'''Remove all existing Drivers first <Check Box>'''
''-to set''
'''Generate new Drivers for empty Trains <Check Box>'''
''-to set''

'''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers

'''Properties'''
'''Driver Commands <Click>'''
''-to select Enable or Disable''
'''Driver Command criteria to match <Check Box>
''-to select each Driver Command''
'''Trains to use <Option Buttons>'''
''-Accept all trains''
''-Accept trains matching above criteria''

'''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted

'''Properties'''
Config/txt file tag 'max_permitted_speed-60850 in mph or kph
Add to config.txt and kuid-table for value <KUID2:60850:88000:4
Note: Old root level config tag will

'''QuickDrive Rule:''' Change the Session settings and add consists in Driver

'''Properties'''
'''Set Time <Click>'''
''-insert time''
'''QuickDrive Consist Option List by'''
'''Rate of Change <Click>
''-insert rate as number times''
'''Enable gameplay Session Mode [Check Box]'''
''-to set''
'''Enable in game help by default [Check Box]
''-to set''
'''Set the default Control method to (Option Button)'''
''-Easy Mode''
''-Realistic Mode''
Prevent player from changing this check
Realistic mode requires achievement add Achievement's Name
In Asset choose Auran achievements
Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic
Prevent player from changing 10.0 check
Set the default units to fill-in choose: Imperial, Metric, Default
Open QuickDriver Window when check

'''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train, then executes any following child rules

'''Properties'''
'''Trigger Rule Once [Check Box]'''
''-to set''
'''Accept trains (Option Button)'''
''-matching specific criteria, select from session list''
''-all trains''
'''Wait for a driver character to get <Click>
''-to select: On, Off''

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

'''Properties'''
'''Assets Ownership (Option Button)'''
''-Wait for ownership of a specific Driver''
''-Wait for ownership of Driver''
'''Driver or Vehicle <click>
''-to choose from session lists''

=='''Arrangement of Session Rules:'''==

'''Ordered List Rule:''' Child rules will be executed in order once this rule starts

'''Properties'''
One of the following options must be chosen
'''(Option button) This process will repeat ''<value>'' time(s)''' - enter the number of times this rule is to be repeated
'''(Option button) This process will repeat forever'''

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

'''Properties'''
'''After last child has been executed ...'''
'''''<successive runs will do nothing/the first child is chosen again>''''' - click to select one

'''Random List Rule:''' One of the child rules indented under this rule will be randomly selected and executed. The rule will not repeat to randomly select another child rule

'''Properties'''
None

'''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle

'''Properties'''
None

'''Simultaneous List Rule:''' Child rules are executed simultaneously once this rule starts

'''Properties'''
'''Rule completes when ...'''
'''''<one of the child rules has completed/all child rules have reached a completed state/all child rules have reached a "was completed" state>''''' - click to select one

=='''Camera Rules:'''==

'''Cinematic Camera Rule:''' Provides several different cinematic style cameras

'''Properties'''
Lock camera controls for the duration check
Prevent rain control for duration check
Camera target: name any of the many objects in session
Camera mode: Stationary, Circle fill-in
Initial camera values: Pitch, Yaw, Zoom value
Total time to animate: seconds value

'''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties

'''Properties'''
Change the camera view mode to check to choose: Cab View, External View, Tracking
View, Free Roaming
Vehicle fill-in choose from session vehicles
Set the camera flags to enable/disable check to choose different properties from list
Junction fill-in choose from session junctions
Set the target objet of the camera to check
Map object fill-in choose from map objects

'''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view, then executes any following child rules

'''Properties'''
Trigger rule once check to set
Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking
View, Free Roaming View
Wait for the camera to target vehicle ? click to choose form session list

=='''Message Rules:'''==

'''Close Message Popup Rule:''' Closes open message popups

'''Properties:'''
None
'''Known Issues:'''
This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule

'''Custom Script Rule:'''

'''Properties'''
None.

'''Display Custom HUD Rule:''' Show or hide the Custom Heads Up Display.

'''Properties'''
Show the Custom Heads up Display- fill-in to choose.
Hide the Custom Heads up Display- fill-in to choose.
Note: One or the other will be chosen by default.

'''Wait for Click on HUD Icon Rule:''' Waits for the HUD to be clicked, then executes any following child rules

'''Properties'''
Trigger rule once-check to choose.
HUD Panel- click to choose from list.
Wait for click on- click to choose; choice depends on HUD Panel chosen.

'''Display HTML Pages Rule:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.

'''Properties'''
Add Page- click on to choose from list; click to Add Page Name or Remove.
Add All- click to add all files from the designated assets.
Delete All- delete all files from this property list.
Prevent user from exiting browser until all pages viewed- check to choose.
Disable closing of browser window by user- check to choose.
Disable browser window scrolling- check to choose.
Make browser window invisible- check to choose.
Set position-Under Construction!!!- check to choose.
Set size-Under Construction!!!- check to choose.
Use the page- click to choose Insert Page Name.
From asset HTML- click to choose from list.

'''Timed limited display HTML Rule:''' Displays an HTML browser window for a limited time.

'''Properties'''
HTML Asset Name-

'''Display Video Rule:''' Displays a page from a HTML assets in a browser window.

'''Properties'''

'''End Session Rule:''' End Session without saving.

'''Properties'''

'''Fade in/out Rule:''' Fade in or out within seconds, color and opacity considered.

'''Properties'''

'''Flash HUD Icon Rule:''' Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.

'''Properties'''

'''Generic Tree Node Debug Window Rule:''' No description.

'''Properties'''

'''InputTable Rule:''' Creating a list of message names to be used for various purposes.

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

'''Properties'''
'''[Check Box] Pause game while message is displayed''' - stops the game until this message is switched off
'''[Check Box] Close previous popup windows''' - closes any Message Popups currently displayed
'''Message location ''<Top Left/Top Right/Bottom Left/Bottom Right>''''' - select one to position the browser window on the screen
'''Message Source: (Option Buttons)''' - select one of three options
'''( ) Custom text''' - the simplest and easiest option
'''Icon ''<Click here to set>''''' - shows a list of message icons. Select one to be displayed with the message
'''Icon ''<Clear icon>''''' - clears any currently displayed message icon
'''Custom text box''' Enter text to be displayed. You will be limited to about 6 lines of text.
For longer messages or to include graphics, use the '''A predefined HTML page''' option.
'''( ) 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.

'''Minimap Options Rule:''' Sets the display options for the minimap.

'''Properties''' ''Default: all checked''
'''Map Textures [Check Box]'''
''Check to select''
'''Gradients [Check Box]'''
''Check to select''
'''Junctions [Check Box]'''
''Check to select''
'''Signals [Check Box]'''
''Check to select''
'''Triggers [Check Box]'''
''Check to select''
'''Markers [Check Box]'''
''Check to select''
'''Trackside Labels [Check Box]'''
''Check to select''
'''Terrain Objects [Check Box]'''
''Check to select''
'''Industrial Names [Check Box]'''
''Check to select''
'''Named Objects [Check Box]'''
''Check to select''
'''Consists [Check Box]
''Check to select''

'''Play Sound Rule:''' Plays a wav sound file.

'''Properties'''
'''Default HTML <Click>'''
''to enter Sound File Name''
'''HTML Assets <Click>'''
''to select HTML asset''
'''Rule Completes <Click>'''
''to select 'sound has just started''
''to select 'sound has finished playing''

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

'''Properties'''
'''None'''

'''Session Metadata Rule:''' Sets session metadata in the config file. Info can be read by other systems and displayed to the player.

'''Properties'''
'''Type <Click>'''
''to select simulation''
''to select Challenge''
'''Length <Click>'''
''to enter number of minutes, default 30 minutes''
'''Difficulty <Click>'''
''to choose Normal(default), Tutorial, Easy, Hard, Expert''

'''Set Helper Icon Size Rule:''' Sets the size of helper icons such as the junction lever arrows.

'''Properties'''
'''Junction Arrows Size <Click>'''
''to set scale ratio smaller than default, default 100%''

'''Set HTML Page Rule:''' Instructs the Display HTML Pages rule to perform specific operations

'''Properties'''
'''Operations to preform on the display HTML pages sequence browser'''
''(Option Button, default) to instruct the sequence browser to <Click>''
''to choose page operations''
''(Option Button) to instruct the sequence browser to open the page <Click>''
''to enter the HTML page name''
''(Option Button) to set browser parameters <Click>''
''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''
''(Option Button) Set the following flag for the page named <click> to enter 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''
''(Option Button) Use the page <Click> to enter HTML page name from the HTML asset <Click> to select HTML assets for a pop-up message box''
''(Option Button) Use the string table entry <Click> to enter Index from the HTML asset <Click> to select HTML assets as the contents for a pop-up message box''

'''Show/Hide HUD Panel Rule:''' Shows or hides a HUD panel.

'''Properties'''

'''Show/Hide Layer Rule:''' Shows or hides a layer from Driver.

'''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:'''
TANE (all versions) - layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded

'''Show/Hide Minimap Rule:''' Shows the Driver the minimap window.

'''Properties'''
'''Minimap Window'''-click to choose Show,Hide

'''Show/hide on-screen help Rule:''' Shows or hides On-screen help in Driver.

'''Properties'''
'''Junction Overlays:''' - fill-in to choose: Show, Hide, Leave unchanged. by default one is chosen
'''On Screen Vehicle Name:''' - Fill-in to choose: Show, Hide, Leave unchanged. By default one is chosen

'''Wait for Click on HUD Icon Rule:''' Waits for a click on the HUD Icon, then executes any following child rules

'''Properties'''
'''(Check Box) Trigger Once:''' -to choose
'''HUD Panel:''' - Click to choose from list: Bottom Right Menu, Camera Controls, DCC Controls
'''Icon:''' - Choose from list. Selections depends on HUD Panel chosen

'''Wait on Waybill Screen/Main Screen Rule:''' Waits for the Waybill window to be opened, then executes any following child rules

'''Properties'''

=='''Startup Rules:'''==

'''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.

'''Properties'''

'''Startup Options Rule''' Specifies the starting options for the session.

'''Properties'''

=='''Time Rules:'''==

'''Clock Rule:''' Rule needed for animated clocks, you need to apply this rule to your session to make use of the animated clocks, see forum for code to include in you clock object to work with this rule.

'''Properties'''

'''Timecheck Rule:''' Executes child rules at a set time.

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

'''Timing Check Rule:''' Triggers sub rules if called within the time window specified.

'''Properties'''

'''Wait Rule:''' Wait for number of seconds before executing any following child rules

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

'''Properties'''
'''''<variable-name>''''' - enter a variable-name. Variable name is case sensitive.
'''''<is less than/is less than or equal to/is equal to/is greater than or equal to/is greater than/is not equal to/is between x and y>''''' - select one
'''''<This condition will be evaluated only once .../This condition will be evaluated once every second>''''' - click to select one
'''Test condition option: is between x and y''' - Enter minimum (x) and maximum (y) test values
'''Test condition option: (all other options)''' - Enter test value
'''Evaluation option: 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
'''Evaluation option: This condition will be evaluated evaluated once every second''' - the rule will be rerun and the variable rechecked every second

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

'''Properties'''
'''Change ''<Add to variable/Subtract from variable/Change variable>''''' - select one
'''[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.
'''Change option: 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.
'''Change option: 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 option: 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.

'''Variable Modify Continuous Rule:''' Adds, subtracts or sets a value to a specified variable every second.

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

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

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

Variables are saved in the session file and persist from one saved game to another.
They can be accessed/modified by the following '''driver commands''':

'''Driver Commands by trev999:'''
'''Set S-Variable driver command: '''
'''Skip if session-variable driver command: '''
'''Wait until S-variable driver command: '''

'''Driver Commands by atilabarut'''
'''ChangeSVariables driver command: '''
'''WaitUntilSVariable driver command: '''

=='''Weather Rules:'''==

'''EIRS Weather Rule NE USA Rule:''' Customize random weather rule relative to the North East Region of the United States.

'''Properties'''

'''Weather Rule:''' Set the weather conditions.

'''Properties'''

Session Rules By Categories With Properties

2017-10-12T15:42:39Z

Coop2:

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

=='''Achievement Rules'''==

'''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement

'''Properties:'''
None

'''Advanced Industry Load Configuration Rule:''' Locks train controls when loading/unloading at an industry, overrides time settings for begin load and begin unload operations

'''Properties:'''
'''Target object ''<click to 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

'''Multiple Resource Check Rule:''' If specified resources in a selected industries or vehicles reaches set levels, then executes any following child rules

'''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
'''''<Click to 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

'''Objective Add Rule:''' Sets up a game Objective with ID and display Name

'''Properties:'''
'''Priority <Click to 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:''' Checks if an objective created with the '''Objective Add Rule''' is complete, then executes any following child rules

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

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

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

'''Power Station Rule:''' Sets up a Power Station and its electricity consumers

'''Properties:'''
'''''<select>''''' - add a Power Station from session list.
'''''<select>''''' - add power consumers from session list

'''Ranked Session Begin Rule:''' Begins a ranked Session

'''Properties:'''
'''Countdown Starting Value ''<value>'''''
'''''hrs:'''''
'''''min:'''''
'''''sec:'''''
'''1 through 5 stars, points for each star ''<value>''''' - enter number of points
'''Session timer mode (Option Buttons)''' - select one of three options:-
'''() Timer'''
'''() Countdown'''
'''() None'''
'''Note:''' Times are Trainz clock time, not real time

'''Ranked Session Complete Rule:''' Completes the active ranked Session

'''Properties:'''
'''Set the active ranked session as (Option Buttons)''' - select one of two options:-
'''() Complete'''
'''() Failed'''
'''Customize the completion message ''<Text Box>''''' - insert text message

'''Resource Check Rule:''' Check the progress of the amount of a resource and target object, then executes any following child rules

'''Properties:'''
'''(Option Buttons)''' - select one from two options:-
'''() Watch industry queue'''
'''() Watch vehicle'''
'''Note:''' Both have: '''Target Object, Queue:'''
'''Complete when designated queue (Option Buttons)''' - select one from two options:-
'''() equals or exceeds required amount'''
'''() falls below required amount'''

'''Session Complete Rule:''' Set session to a percentage of completion

'''Properties:'''
'''Set session to percent complete ''<value>''''' - enter number as a percentage
'''[Check box] Separate achievements for completion''' - check to set

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

'''Properties:'''
'''Trigger: ''<selection>''''' - 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
'''(Option buttons)''' - select one option from the following two:-
'''() Accept all trains''' - all trains will trigger the rule
'''() Accept trains matching specific criteria''' - only specific vehicles, specific vehicle types, specific drivers will trigger the rule

=='''Danger Rules'''==

'''ATP Speed Limiter Rule:''' Limits speed over set limit

'''Properties:'''
'''Speed limit over the set limit <Click>
''-to set mph''

'''AWS Configuration Rule:''' This rule configures the Trainz implementation of the Automatic Warning System when approaching signals

'''Properties:'''
'''Use modern sound set for unfitted cabs? <Check Box>'''
''check to set''
'''Simulate AWS for unfitted cabs? <Check Box>'''
''-check to set''
'''Passive with HUD hidden <Option Buttons>'''
''-Active''
''-Passive''

'''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars after a set time delay

'''Properties:'''
'''''<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.

'''Coupler Breakage Check Rule:''' Checks for breaking couplers and, if found, then executes any following child rules.

'''Properties:'''
'''None'''

'''Coupler Breakage HUD Rule:''' HUD displays warning about coupler stress and breakage

'''Properties:'''
'''(Option buttons)''' - select one of two options
'''( ) Show the Coupler Breakage Display'''
'''( ) Hide the Coupler Breakage Display'''

'''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule

'''Properties:'''
'''[Check box] Respawn trains if they are abandoned for 10 minutes'''
If checked:-
'''(Option buttons)''' - select one of two options:-
'''( ) 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

'''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users and, if found, then executes any following child rules.

'''Properties:'''
'''[Check box] Trigger only once'''

'''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users and, if found, then executes any following child rules.

'''Properties:'''
'''[Check box] Trigger only once'''

'''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles

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

'''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger (stop) and, if found, then executes any following child rules.

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

'''Properties:'''
'''(Option buttons)''' - 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

'''Properties:'''
'''Accept all trains <Option Button>'''
''-click to set''
'''Cab sway level is <Click>'''
''-to set insert percent of sway''
'''Traction boost is <Click>'''
''-to insert percent of boost while sanding''
'''Traction reduced to <Click>'''
''-to set traction percent''
'''Maximum tractive effort adjusted by <Click>
''-to insert percent amount''
'''Show coupler breakage in HUD Rule <Click>'''
''-to set''
'''Couplers break when coupling above <Click>'''
''-to set speed''
'''Accept trains matching specific criteria <Radio Button>'''
''-set to insert specific train assets''
'''Couplers break at <Click>'''
''-to insert amount of force in kN units''

'''Wait for Derailment Rule:''' Waits for a derailment to occur, then executes any following child rules

'''Properties:'''
'''Trigger derailment, Watch Once <Check Box>
''-check to set

=='''Navigation Rules'''==

'''DestSignTable Rule:''' Creates a list of destination names for a destination sign

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

'''Properties'''
'''Interlocking Tower <Click>'''
''-to set Name and Objects''

'''Interlocking Tower Path Selection UI <CheckBox>''' Will automatically react to messages from Interlocking Towers and display a path selection dialog to the player. Disable by removing rule from session
''-Check(default) to Show path activation message in Driver''

'''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train

'''Properties:'''
'''Interlocking Tower <Click>'''
''-to set Names and Objects''

'''Multiple Junction Alignment Check Rule''' Checks junctions are set or in alignment, then executes any following child rules

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

'''Navigation Display Rule:''' Creates a set of navigation points. Multiple sets can be created by adding additional copies of this rule. This rule creates the navigation set, it does not display it. Use the '''Navigation set hide/show rule''' to make a set visible. Navigation sets can be completed (terminated) by the '''Navigation Set Clear Rule''', individual navigation points can be ''manually'' completed by the '''Navigation Point Complete Rule'''. Click the help icon at the top of the properties box for in game instructions.

'''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.
'''(Option buttons)''' - select one of three options
'''( ) 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.

'''Navigation Point Complete Rule:''' Manually completes a navigation point in a set

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

'''Navigation Set Check Rule:''' Checks if a navigation set is complete or incomplete, then executes any following child rules

'''Properties:'''
'''Checks if navigation point set ''<click to select>'':''' - 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.

'''Navigation Set Clear Rule:''' Clears a navigation set removing any uncompleted navigation points

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

'''Navigation Set Hide/Show:''' Shows and hides navigation sets. You can have multiple sets visible and hidden at the same time.

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

'''Schedule Rule:''' Allows a schedule of timed events to be applied to a train

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

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

'''Set Signal Extended Rule:''' Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''Properties:'''
'''''Select signal''''' - click to select a signal from the session list
'''''<signal state>''''' - click to select a state from the list

'''Trigger Check Rule:''' - Waits for 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".

'''Properties:'''
'''Accept all trains <Option Buttons>'''
''-click to accept all trains
''-click to accept trains matching specific criteria and choose from session Assets list''
'''Add Trigger <Click>'''
''-to choose from session list''
'''Trigger only once <Check Box>'''
''-check to set''
'''Wait for child rules to complete even if no trains are present in rule trigger <Checkbox>'''
''-check to set''
'''Only activate when the entering vehicle of the train <Check Box>'''
''click to set''
'''Train Heading <Click>'''
''-to set to forward''
''-to set to backward''

'''Wait on Navigation Point Rule:''' Waits for a navigation point to be completed, then executes any following child rules

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

'''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start, then executes any following child rules

'''Properties:'''
'''[Check box] Trigger rule once''' - check to set
'''Wait for a train that matches the following criteria to <Click>'''
''-to set start moving''
''-to to stop moving''
'''Accept all trains <Option Buttons>'''
''-click to accept all trains''
''-click to accept trains matching specific criteria and choose from session list''

=='''Driver Rules'''==

'''Control Check Rule:''' Checks if the control method changes, then executes any following child rules

'''Properties:'''
'''Execute child rules when: (Option Buttons)''' - select one from
'''() DCC mode is Selected'''
'''() Cab mode is Selected'''
'''Execute child rules: (Option Buttons)''' - select one from
'''() Every time control method is set'''
'''() Once only'''

'''Control Type Rule''' Sets control type

'''Properties:'''
'''Current control method is: ''<select>''''' - click to select one of
'''Easy Mode'''
'''Ask User'''
'''Realistic Mode'''

'''CPC Rule:''' Emit Train On Trigger. Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule

'''Properties:'''
'''Portal index from PCP ''<value>''''' - click to enter (Un)Portal Index
'''Use UnPortal ''<Yes/No>''''' - 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

'''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry

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

'''Driver Command Rule:''' Specify which commands will be available for the drivers

'''Properties''':
Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.
Navigate To TrackMarkList V2- No description.
Navigate To Station V2- No description.
Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.
Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.
Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.
Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.
Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.
Drive To Station V2- No description.
Drive To Track mark List V2- No description.
Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.
Drive To Industry- Drive to a specific industry.
Change Destination Sign-Changes the destination signs of a train.

WaitFor- Pauses the driver's schedule for a set duration of time.
Wait For Random- TRS2008: Wait for specified or optionally random period of time.
Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).
WaitUntil- No description.

VR Set Train Lamps-Driver command that sets the train lamps.
Notify- Notifies the player of schedule progress/completion.
Reverse Tram- Reverse a tram(max 2 cars).
Couple- Couple train to designate vehicle.
Decouple- Decouples the train at the specified vehicle.
UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).
Halt Train- Brings the train to a complete stop.
Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.
Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger
station before using this command.
Cab: Wait-Maintains current control state until some condition is met.
Delete Train- Causes the train and its driver to be deleted from the session.
Hornz- Driver sounds the train horn.
Cab: Set Control-Sets a cab mode control.
Headlights On/Off-Allows the driver to to switch the headlights on and off.
Interior Lights Command- Driver command to switch interior lights on or off for the current train.
Set Max Speed To- No description.

Release Junction - Lets a driver release the junction they have been holding.
Move Turntable- TRS2008: Move turntable to a stop point .

Load- Loads the train's vehicles at the industry the driver is currently at with the train.
Unload- Unload train vehicles at current industry location.
Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.
Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.
Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.

'''Driver Command Check Rule:''' Verifies the driver commands of a driver character, then executes any following child rules

'''Properties'''
'''Trigger rule once <Click>'''
''-to set''
'''Driver character to watch the command list of <Click.'''
''to select Driver from Session List''
'''Wait for driver character to have a command list that matches this:''' add driver, all, delete all
'''Add Driver Command <Select>'''
''-to add a Driver Command''
'''Add all <Click>'''
''Click to add all Driver Commands''
'''Delete all <Click>'''
''-to delete Driver Command List''

'''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar

'''Properties'''
'''The Driver Main Bar <Click>'''
''-to Show or Hide''

'''Driver Schedule Rule''' Execution of basic scheduled commands

'''Properties:'''
'''Driver Schedule Rule assigned to <Click>
''-to name driver from Session List''
'''Commands <Click>'''
''-to insert driver commands in Drive Schedule''
'''Style: <Option Buttons>'''
''-Classic style: If there is a schedule do not emit a new schedule''
''-Killer style: If there is a schedule clean it and emit a new one''
''-Cooperative style: If there is a schedule append the new one''
''-Active style: Emit a new schedule, only if already a schedule running''

'''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders

'''Properties'''
'''The following drivers will be available <click>'''
''-To add Driver, Driver Commands, Assets, Type of Engineer, or Remove Driver''
'''Remove all existing Drivers first <Check Box>'''
''-to set''
'''Generate new Drivers for empty Trains <Check Box>'''
''-to set''

'''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers

'''Properties'''
'''Driver Commands <Click>'''
''-to select Enable or Disable''
'''Driver Command criteria to match <Check Box>
''-to select each Driver Command''
'''Trains to use <Option Buttons>'''
''-Accept all trains''
''-Accept trains matching above criteria''

'''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted

'''Properties'''
Config/txt file tag 'max_permitted_speed-60850 in mph or kph
Add to config.txt and kuid-table for value <KUID2:60850:88000:4
Note: Old root level config tag will

'''QuickDrive Rule:''' Change the Session settings and add consists in Driver

'''Properties'''
'''Set Time <Click>'''
''-insert time''
'''QuickDrive Consist Option List by'''
'''Rate of Change <Click>
''-insert rate as number times''
'''Enable gameplay Session Mode [Check Box]'''
''-to set''
'''Enable in game help by default [Check Box]
''-to set''
'''Set the default Control method to (Option Button)'''
''-Easy Mode''
''-Realistic Mode''
Prevent player from changing this check
Realistic mode requires achievement add Achievement's Name
In Asset choose Auran achievements
Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic
Prevent player from changing 10.0 check
Set the default units to fill-in choose: Imperial, Metric, Default
Open QuickDriver Window when check

'''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train, then executes any following child rules

'''Properties'''
'''Trigger Rule Once [Check Box]'''
''-to set''
'''Accept trains (Option Button)'''
''-matching specific criteria, select from session list''
''-all trains''
'''Wait for a driver character to get <Click>
''-to select: On, Off''

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

'''Properties'''
'''Assets Ownership (Option Button)'''
''-Wait for ownership of a specific Driver''
''-Wait for ownership of Driver''
'''Driver or Vehicle <click>
''-to choose from session lists''

=='''Arrangement of Session Rules:'''==

'''Ordered List Rule:''' Child rules will be executed in order once this rule starts

'''Properties'''
One of the following options must be chosen
'''(Option button) This process will repeat ''<value>'' time(s)''' - enter the number of times this rule is to be repeated
'''(Option button) This process will repeat forever'''

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

'''Properties'''
'''After last child has been executed ...'''
'''''<successive runs will do nothing/the first child is chosen again>''''' - click to select one

'''Random List Rule:''' One of the child rules indented under this rule will be randomly selected and executed. The rule will not repeat to randomly select another child rule

'''Properties'''
None

'''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle

'''Properties'''
None

'''Simultaneous List Rule:''' Child rules are executed simultaneously once this rule starts

'''Properties'''
'''Rule completes when ...'''
'''''<one of the child rules has completed/all child rules have reached a completed state/all child rules have reached a "was completed" state>''''' - click to select one

=='''Camera Rules:'''==

'''Cinematic Camera Rule:''' Provides several different cinematic style cameras

'''Properties'''
Lock camera controls for the duration check
Prevent rain control for duration check
Camera target: name any of the many objects in session
Camera mode: Stationary, Circle fill-in
Initial camera values: Pitch, Yaw, Zoom value
Total time to animate: seconds value

'''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties

'''Properties'''
Change the camera view mode to check to choose: Cab View, External View, Tracking
View, Free Roaming
Vehicle fill-in choose from session vehicles
Set the camera flags to enable/disable check to choose different properties from list
Junction fill-in choose from session junctions
Set the target objet of the camera to check
Map object fill-in choose from map objects

'''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view, then executes any following child rules

'''Properties'''
Trigger rule once check to set
Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking
View, Free Roaming View
Wait for the camera to target vehicle ? click to choose form session list

=='''Message Rules:'''==

'''Close Message Popup Rule:''' Closes open message popups

'''Properties:'''
None
'''Known Issues:'''
This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule

'''Custom Script Rule:'''

'''Properties'''
None.

'''Display Custom HUD Rule:''' Show or hide the Custom Heads Up Display.

'''Properties'''
Show the Custom Heads up Display- fill-in to choose.
Hide the Custom Heads up Display- fill-in to choose.
Note: One or the other will be chosen by default.

'''Wait for Click on HUD Icon Rule:''' Waits for the HUD to be clicked, then executes any following child rules

'''Properties'''
Trigger rule once-check to choose.
HUD Panel- click to choose from list.
Wait for click on- click to choose; choice depends on HUD Panel chosen.

'''Display HTML Pages Rule:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.

'''Properties'''
Add Page- click on to choose from list; click to Add Page Name or Remove.
Add All- click to add all files from the designated assets.
Delete All- delete all files from this property list.
Prevent user from exiting browser until all pages viewed- check to choose.
Disable closing of browser window by user- check to choose.
Disable browser window scrolling- check to choose.
Make browser window invisible- check to choose.
Set position-Under Construction!!!- check to choose.
Set size-Under Construction!!!- check to choose.
Use the page- click to choose Insert Page Name.
From asset HTML- click to choose from list.

'''Timed limited display HTML Rule:''' Displays an HTML browser window for a limited time.

'''Properties'''
HTML Asset Name-

'''Display Video Rule:''' Displays a page from a HTML assets in a browser window.

'''Properties'''

'''End Session Rule:''' End Session without saving.

'''Properties'''

'''Fade in/out Rule:''' Fade in or out within seconds, color and opacity considered.

'''Properties'''

'''Flash HUD Icon Rule:''' Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.

'''Properties'''

'''Generic Tree Node Debug Window Rule:''' No description.

'''Properties'''

'''InputTable Rule:''' Creating a list of message names to be used for various purposes.

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

'''Properties'''
'''[Check Box] Pause game while message is displayed''' - stops the game until this message is switched off
'''[Check Box] Close previous popup windows''' - closes any Message Popups currently displayed
'''Message location ''<Top Left/Top Right/Bottom Left/Bottom Right>''''' - select one to position the browser window on the screen
'''Message Source: (Option Buttons)''' - select one of three options
'''( ) Custom text''' - the simplest and easiest option
'''Icon ''<Click here to set>''''' - shows a list of message icons. Select one to be displayed with the message
'''Icon ''<Clear icon>''''' - clears any currently displayed message icon
'''Custom text box''' Enter text to be displayed. You will be limited to about 6 lines of text.
For longer messages or to include graphics, use the '''A predefined HTML page''' option.
'''( ) 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.

'''Minimap Options Rule:''' Sets the display options for the minimap.

'''Properties''' ''Default: all checked''
'''Map Textures [Check Box]'''
''Check to select''
'''Gradients [Check Box]'''
''Check to select''
'''Junctions [Check Box]'''
''Check to select''
'''Signals [Check Box]'''
''Check to select''
'''Triggers [Check Box]'''
''Check to select''
'''Markers [Check Box]'''
''Check to select''
'''Trackside Labels [Check Box]'''
''Check to select''
'''Terrain Objects [Check Box]'''
''Check to select''
'''Industrial Names [Check Box]'''
''Check to select''
'''Named Objects [Check Box]'''
''Check to select''
'''Consists [Check Box]
''Check to select''

'''Play Sound Rule:''' Plays a wav sound file.

'''Properties'''
'''Default HTML <Click>'''
''to enter Sound File Name''
'''HTML Assets <Click>'''
''to select HTML asset''
'''Rule Completes <Click>'''
''to select 'sound has just started''
''to select 'sound has finished playing''

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

'''Properties'''
'''None'''

'''Session Metadata Rule:''' Sets session metadata in the config file. Info can be read by other systems and displayed to the player.

'''Properties'''
'''Type <Click>'''
''to select simulation''
''to select Challenge''
'''Length <Click>'''
''to enter number of minutes, default 30 minutes''
'''Difficulty <Click>'''
''to choose Normal(default), Tutorial, Easy, Hard, Expert''

'''Set Helper Icon Size Rule:''' Sets the size of helper icons such as the junction lever arrows.

'''Properties'''
'''Junction Arrows Size <Click>'''
''to set scale ratio smaller than default, default 100%''

'''Set HTML Page Rule:''' Instructs the Display HTML Pages rule to perform specific operations

'''Properties'''
'''Operations to preform on the display HTML pages sequence browser'''
''(Option Button, default) to instruct the sequence browser to <Click>''
''to choose page operations''
''(Option Button) to instruct the sequence browser to open the page <Click>''
''to enter the HTML page name''
''(Option Button) to set browser parameters <Click>''
''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''
''(Option Button) Set the following flag for the page named <click> to enter 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''
''(Option Button) Use the page <Click> to enter HTML page name from the HTML asset <Click> to select HTML assets for a pop-up message box''
''(Option Button) Use the string table entry <Click> to enter Index from the HTML asset <Click> to select HTML assets as the contents for a pop-up message box''

'''Show/Hide HUD Panel Rule:''' Shows or hides a HUD panel.

'''Properties'''

'''Show/Hide Layer Rule:''' Shows or hides a layer from Driver.

'''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:'''
TANE (all versions) - layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded

'''Show/Hide Minimap Rule:''' Shows the Driver the minimap window.

'''Properties'''
'''Minimap Window'''-click to choose Show,Hide

'''Show/hide on-screen help Rule:''' Shows or hides On-screen help in Driver.

'''Properties'''
'''Junction Overlays:''' - fill-in to choose: Show, Hide, Leave unchanged. by default one is chosen
'''On Screen Vehicle Name:''' - Fill-in to choose: Show, Hide, Leave unchanged. By default one is chosen

'''Wait for Click on HUD Icon Rule:''' Waits for a click on the HUD Icon, then executes any following child rules

'''Properties'''
'''(Check Box) Trigger Once:''' -to choose
'''HUD Panel:''' - Click to choose from list: Bottom Right Menu, Camera Controls, DCC Controls
'''Icon:''' - Choose from list. Selections depends on HUD Panel chosen

'''Wait on Waybill Screen/Main Screen Rule:''' Waits for the Waybill window to be opened, then executes any following child rules

'''Properties'''

=='''Startup Rules:'''==

'''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.

'''Properties'''

'''Startup Options Rule''' Specifies the starting options for the session.

'''Properties'''

=='''Time Rules:'''==

'''Clock Rule:''' Rule needed for animated clocks, you need to apply this rule to your session to make use of the animated clocks, see forum for code to include in you clock object to work with this rule.

'''Properties'''

'''Timecheck Rule:''' Executes child rules at a set time.

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

'''Timing Check Rule:''' Triggers sub rules if called within the time window specified.

'''Properties'''

'''Wait Rule:''' Wait for number of seconds before executing any following child rules

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

'''Properties'''
'''''<variable-name>''''' - enter a variable-name. Variable name is case sensitive.
'''''<is less than/is less than or equal to/is equal to/is greater than or equal to/is greater than/is not equal to/is between x and y>''''' - select one
'''''<This condition will be evaluated only once .../This condition will be evaluated once every second>''''' - click to select one
'''Test condition option: is between x and y''' - Enter minimum (x) and maximum (y) test values
'''Test condition option: (all other options)''' - Enter test value
'''Evaluation option: 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
'''Evaluation option: This condition will be evaluated evaluated once every second''' - the rule will be rerun and the variable rechecked every second

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

'''Properties'''
'''Change ''<Add to variable/Subtract from variable/Change variable>''''' - select one
'''[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.
'''Change option: 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.
'''Change option: 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 option: 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.

'''Variable Modify Continuous Rule:''' Adds, subtracts or sets a value to a specified variable every second.

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

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

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

Variables are saved in the session file and persist from one saved game to another.
They can be accessed/modified by the following '''driver commands''':

'''Driver Commands by trev999:'''
'''Set S-Variable driver command: '''
'''Skip if session-variable driver command: '''
'''Wait until S-variable driver command: '''

'''Driver Commands by atilabarut'''
'''ChangeSVariables driver command: '''
'''WaitUntilSVariable driver command: '''

=='''Weather Rules:'''==

'''EIRS Weather Rule NE USA Rule:''' Customize random weather rule relative to the North East Region of the United States.

'''Properties'''

'''Weather Rule:''' Set the weather conditions.

'''Properties'''

Session Rules By Categories With Properties

2017-10-05T23:31:19Z

Coop2:

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

=='''Achievement Rules'''==

'''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement

'''Properties:'''
None

'''Advanced Industry Load Configuration Rule:''' Locks train controls when loading/unloading at an industry, overrides time settings for begin load and begin unload operations

'''Properties:'''
'''Target object ''<click to 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''' - check and enter number of seconds to override

'''Station Visited Check Rule:''' Waits for a designated train or any train to call at one of the designated stations or industries, then executes the following child rules

'''Properties:'''
'''Trigger: ''<selection>''''' - 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.
'''''<Add Industry>''''' - select industry or industries from session list
'''(Option buttons)''' - select one option from the following two:-
'''() Accept all trains''' - all trains will trigger the rule
'''() Accept trains matching specific criteria''' - only specific vehicles, specific vehicle types, specific drivers will trigger the rule

'''Power Station Rule:''' Sets up Station and Consumers

'''Properties:'''
'''<Click to Select>'''- from Session Stations.
'''<Click to Select>'''- Consumers (Add Object) choose from Session List

'''Resource Check Rule:''' Check the progress of the amount of a resource and target object

'''Properties:'''
'''(Option Buttons)''' - choose one from two options:-
'''() Watch industry queue'''
'''() Watch vehicle'''
'''Note:''' Both have: Target Object, Queue:'''
'''Complete when designated queue <Option Buttons>'''
'''() equals or exceeds required amount'''
'''() falls below required amount'''

'''Multiple Resource Check Rule:''' If specified resources in a selected industries or vehicles reaches set levels, then any following child rules will be executed

'''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: t he 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
'''''<Click to 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

'''Objective Add Rule:''' Sets up a game Objective with ID and display Name

'''Properties:'''
'''Priority <Click to Select>''' - select one of:-
'''Above Normal:'''
'''Below Normal:'''
'''Normal:'''
'''Optional:'''
'''Urgent:'''
'''Completion Target Number <Click>''' - to set Completion Target Number
'''Icon <Click>''' - to select Icon from list
'''Display Name <Click>''' - to insert Name
'''Unique Objective ID <Click>''' - to set ID
'''Custom Message <Text Box>''' - insert typed message in text area

'''Objective Check Rule:''' Executes child rules when objective is complete

'''Properties:'''
'''Unique Objective ID <Click>''' - insert ID number
'''Mode <click>''' - select one of the following options
'''Wait for completion'''
'''Wait for failure'''
'''Wait for progress'''

'''Objective Update Rule:''' Changes progress outcome according to Property choices

'''Properties:'''
'''Unique Objective ID <Click>'''
''-set ID number''
'''Mode <Click to Set Objective>'''
''-Decrement progress''
''-Increment progress''
''-Reset Objective''
''-Set objects as complete''
''-Set objects as failed''
''-Set progress''
''-Set progress only if greater''
'''Amount <Click>'''
''-insert number''

'''Ranked Session Begin Rule:''' Begins a ranked Session

'''Properties:'''
'''Countdown Starting Value <Click to insert>'''
''-hrs''
''-min''
''sec''
'''1 through 5 stars, points for each star <Click>
-insert number of points
'''Session timer mode <Option Buttons>'''
''-Timer''
''-Countdown''
''-None''

'''Ranked Session Complete Rule:''' Completes the active ranked Session

'''Properties:'''
'''Set the active ranked session as <Option Buttons>'''
''-Complete''
''-Failed''
'''Customize the completion message <Text Box>'''
''-insert text message''

'''Session Complete Rule:''' Set session to a percentage of completion

'''Properties:'''
'''Set session to percent complete <Click>'''
''to insert number in percent''
'''Separate achievements for completion <Check Box>
''-check to set''

=='''Danger Rules'''==

'''ATP Speed Limiter Rule:''' Limits speed over set limit

'''Properties:'''
'''Speed limit over the set limit <Click>
''-to set mph''

'''Speeding Check Rule:''' If player controlled trains are over the local speed limit or over a set (custom) speed, then the following child rules will be executed

'''Properties:'''
'''(Option buttons)''' - 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'''

'''AWS Configuration Rule:''' This rule configures the Trainz implementation of the Automatic Warning System when approaching signals

'''Properties:'''
'''Use modern sound set for unfitted cabs? <Check Box>'''
''check to set''
'''Simulate AWS for unfitted cabs? <Check Box>'''
''-check to set''
'''Passive with HUD hidden <Option Buttons>'''
''-Active''
''-Passive''

'''Wait for Derailment Rule:''' Waits for a derailment to occur

'''Properties:'''
'''Trigger derailment, Watch Once <Check Box>
''-check to set

'''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars after a set time delay

'''Properties:'''
'''''<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.

'''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule

'''Properties:'''
'''[Check box] Respawn trains if they are abandoned for 10 minutes'''
If checked:-
'''(Option buttons)''' - select one of two options:-
'''( ) 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

'''Coupler Breakage Check Rule:''' Checks for breaking couplers and, if found, then executes any following child rules.

'''Properties:'''
'''None'''

'''Coupler Breakage HUD Rule:''' HUD displays warning about coupler stress and breakage

'''Properties:'''
'''(Option buttons)''' - select one of two options
'''( ) Show the Coupler Breakage Display'''
'''( ) Hide the Coupler Breakage Display'''

'''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles

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

'''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users and, if found, then executes any following child rules.

'''Properties:'''
'''[Check box] Trigger only once'''

'''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users and, if found, then executes any following child rules.

'''Properties:'''
'''[Check box] Trigger only once'''

'''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger (stop) and, if found, then executes any following child rules.

'''Properties:'''
'''[Check box] Trigger only once'''

'''Vehicle Physics Rule:''' Overrides the default vehicle physics properties

'''Properties:'''
'''Accept all trains <Option Button>'''
''-click to set''
'''Cab sway level is <Click>'''
''-to set insert percent of sway''
'''Traction boost is <Click>'''
''-to insert percent of boost while sanding''
'''Traction reduced to <Click>'''
''-to set traction percent''
'''Maximum tractive effort adjusted by <Click>
''-to insert percent amount''
'''Show coupler breakage in HUD Rule <Click>'''
''-to set''
'''Couplers break when coupling above <Click>'''
''-to set speed''
'''Accept trains matching specific criteria <Radio Button>'''
''-set to insert specific train assets''
'''Couplers break at <Click>'''
''-to insert amount of force in kN units''

=='''Navigation Rules'''==

'''DestSignTable Rule:''' Creates a list of destination names for a destination sign

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

'''Properties'''
'''Interlocking Tower <Click>'''
''-to set Name and Objects''

'''Interlocking Tower Path Selection UI <CheckBox>''' Will automatically react to messages from Interlocking Towers and display a path selection dialog to the player. Disable by removing rule from session
''-Check(default) to Show path activation message in Driver''

'''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train

'''Properties:'''
'''Interlocking Tower <Click>'''
''-to set Names and Objects''

'''Multiple Junction Alignment Check Rule''' Checks junctions are set or in alignment then executes any following child rules

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

'''Navigation Display Rule:''' Creates a set of navigation points. Multiple sets can be created by adding additional copies of this rule. This rule creates the navigation set, it does not display it. Use the '''Navigation set hide/show rule''' to make a set visible. Navigation sets can be completed (terminated) by the '''Navigation Set Clear Rule''', individual navigation points can be ''manually'' completed by the '''Navigation Point Complete Rule'''. Click the help icon at the top of the properties box for in game instructions.

'''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.
'''(Option buttons)''' - select one of three options
'''( ) 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.

'''Navigation Point Complete Rule:''' Manually completes a navigation point in a set

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

'''Navigation Set Check Rule:''' Checks if a navigation set is complete or incomplete, if so then the following child rules will be executed

'''Properties:'''
'''Checks if navigation point set ''<click to select>'':''' - 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.

'''Navigation Set Clear Rule:''' Clears a navigation set removing any uncompleted navigation points

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

'''Navigation Set Hide/Show:''' Shows and hides navigation sets. You can have multiple sets visible and hidden at the same time.

'''Properties:'''
'''''<visibility>''''' - click to select one
'''Hide''' - select to make the navigation set invisible
'''Chow''' - 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.

'''Schedule Rule:''' Allows a schedule of timed events to be applied to a train

'''Properties:'''
'''Insert track mark <Click>'''
''-to select from Session List''
'''Arrival and Departure Time <Select>'''
''-set time in hr:min:sec''
'''Current Train <Click>'''
''to select from session list''
'''Insert destination <Click>'''
''to select from session list''

'''Set Junctions Rule:''' Sets the selected junctions to a specific state '''''Warning:'' not compatible with Interlocking Tower Assets'''

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

'''Set Signal Extended Rule:''' Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''Properties:'''
'''''Select signal''''' - click to select a signal from the session list
'''''<signal state>''''' - click to select a state from the list

'''Trigger Check Rule:''' - Waits for any train to enter one of the designated triggers. This rule replaces the older and less versatile "Trigger Rule".

'''Properties:'''
'''Accept all trains <Option Buttons>'''
''-click to accept all trains
''-click to accept trains matching specific criteria and choose from session Assets list''
'''Add Trigger <Click>'''
''-to choose from session list''
'''Trigger only once <Check Box>'''
''-check to set''
'''Wait for child rules to complete even if no trains are present in rule trigger <Checkbox>'''
''-check to set''
'''Only activate when the entering vehicle of the train <Check Box>'''
''click to set''
'''Train Heading <Click>'''
''-to set to forward''
''-to set to backward''

'''Wait on Navigation Point Rule:''' Waits for a navigation point to be completed then the following child rules will be executed

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

'''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start

'''Properties:'''
'''[Check box] Trigger rule once''' - check to set
'''Wait for a train that matches the following criteria to <Click>'''
''-to set start moving''
''-to to stop moving''
'''Accept all trains <Option Buttons>'''
''-click to accept all trains''
''-click to accept trains matching specific criteria and choose from session list''

=='''Driver Rules'''==

'''Control Type Rule''' Sets control type

'''Properties:'''
'''Current control method is: <Click>'''
''-to set to Easy Mode, Ask User, or Realistic Mode''

'''Control Check Rule:''' Activates child rules based on the control method changes

'''Properties:'''
'''Excite child rules when: <Option Buttons>'''
''-DCC mode is Selected''
''-Cab mode is Selected''
'''Execute child rules: <Option Buttons>'''
''-Every time control method is set''
''-Once only''

'''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule

'''Properties:'''
'''Portal index from PCP <Click>'''
''-to enter (Un)Portal Index''
'''Use UnPortal <Click>'''
''-to select Yes or No''
'''Delay from Trigger to Emit <Click>'''
''-to set number of seconds''
'''Add Trigger <Click>'''
''-to add Trigger from Session List''

'''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry

'''Properties:'''
'''Load/unload <click>'''
''-to set to Disable or enable''
'''Which Industry? <click>'''
''-to set Industry from Session List''
'''Which Vehicles <Option Buttons>'''
-''Apply to every vehicle in the session''
-''Apply only to a specific vehicles from Session List''

'''Driver Command Rule:''' Specify which commands will be available for the drivers

'''Properties''':
Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.
Navigate To TrackMarkList V2- No description.
Navigate To Station V2- No description.
Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.
Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.
Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.
Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.
Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.
Drive To Station V2- No description.
Drive To Track mark List V2- No description.
Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.
Drive To Industry- Drive to a specific industry.
Change Destination Sign-Changes the destination signs of a train.

WaitFor- Pauses the driver's schedule for a set duration of time.
Wait For Random- TRS2008: Wait for specified or optionally random period of time.
Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).
WaitUntil- No description.

VR Set Train Lamps-Driver command that sets the train lamps.
Notify- Notifies the player of schedule progress/completion.
Reverse Tram- Reverse a tram(max 2 cars).
Couple- Couple train to designate vehicle.
Decouple- Decouples the train at the specified vehicle.
UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).
Halt Train- Brings the train to a complete stop.
Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.
Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger
station before using this command.
Cab: Wait-Maintains current control state until some condition is met.
Delete Train- Causes the train and its driver to be deleted from the session.
Hornz- Driver sounds the train horn.
Cab: Set Control-Sets a cab mode control.
Headlights On/Off-Allows the driver to to switch the headlights on and off.
Interior Lights Command- Driver command to switch interior lights on or off for the current train.
Set Max Speed To- No description.

Release Junction - Lets a driver release the junction they have been holding.
Move Turntable- TRS2008: Move turntable to a stop point .

Load- Loads the train's vehicles at the industry the driver is currently at with the train.
Unload- Unload train vehicles at current industry location.
Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.
Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.
Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.

'''Driver Command Check Rule:''' Verifies the driver commands of a driver character

'''Properties'''
'''Trigger rule once <Click>'''
''-to set''
'''Driver character to watch the command list of <Click.'''
''to select Driver from Session List''
'''Wait for driver character to have a command list that matches this:''' add driver, all, delete all
'''Add Driver Command <Select>'''
''-to add a Driver Command''
'''Add all <Click>'''
''Click to add all Driver Commands''
'''Delete all <Click>'''
''-to delete Driver Command List''

'''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar

'''Properties'''
'''The Driver Main Bar <Click>'''
''-to Show or Hide''

'''Driver Schedule Rule''' Execution of basic scheduled commands

'''Properties:'''
'''Driver Schedule Rule assigned to <Click>
''-to name driver from Session List''
'''Commands <Click>'''
''-to insert driver commands in Drive Schedule''
'''Style: <Option Buttons>'''
''-Classic style: If there is a schedule do not emit a new schedule''
''-Killer style: If there is a schedule clean it and emit a new one''
''-Cooperative style: If there is a schedule append the new one''
''-Active style: Emit a new schedule, only if already a schedule running''

'''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders

'''Properties'''
'''The following drivers will be available <click>'''
''-To add Driver, Driver Commands, Assets, Type of Engineer, or Remove Driver''
'''Remove all existing Drivers first <Check Box>'''
''-to set''
'''Generate new Drivers for empty Trains <Check Box>'''
''-to set''

'''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers

'''Properties'''
'''Driver Commands <Click>'''
''-to select Enable or Disable''
'''Driver Command criteria to match <Check Box>
''-to select each Driver Command''
'''Trains to use <Option Buttons>'''
''-Accept all trains''
''-Accept trains matching above criteria''

'''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted

'''Properties'''
Config/txt file tag 'max_permitted_speed-60850 in mph or kph
Add to config.txt and kuid-table for value <KUID2:60850:88000:4
Note: Old root level config tag will

'''QuickDrive Rule:''' Change the Session settings and add consists in Driver

'''Properties'''
'''Set Time <Click>'''
''-insert time''
'''QuickDrive Consist Option List by'''
'''Rate of Change <Click>
''-insert rate as number times''
'''Enable gameplay Session Mode [Check Box]'''
''-to set''
'''Enable in game help by default [Check Box]
''-to set''
'''Set the default Control method to (Option Button)'''
''-Easy Mode''
''-Realistic Mode''
Prevent player from changing this check
Realistic mode requires achievement add Achievement's Name
In Asset choose Auran achievements
Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic
Prevent player from changing 10.0 check
Set the default units to fill-in choose: Imperial, Metric, Default
Open QuickDriver Window when check

'''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train

'''Properties'''
'''Trigger Rule Once [Check Box]'''
''-to set''
'''Accept trains (Option Button)'''
''-matching specific criteria, select from session list''
''-all trains''
'''Wait for a driver character to get <Click>
''-to select: On, Off''

'''Wait for Driver/Train to be Locally Owned Rule:''' Waits for a specific driver or train car to be locally owned, Owned then executes child rules. If the driver/train car becomes unowned again the child rules are paused

'''Properties'''
'''Assets Ownership (Option Button)'''
''-Wait for ownership of a specific Driver''
''-Wait for ownership of Driver''
'''Driver or Vehicle <click>
''-to choose from session lists''

=='''Arrangement of Session Rules:'''==

'''Ordered List Rule:''' Child rules will be executed in order once this rule starts

'''Properties'''
One of the following options must be chosen
'''(Option button) This process will repeat ''<value>'' time(s)''' - enter the number of times this rule is to be repeated
'''(Option button) This process will repeat forever'''

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

'''Properties'''
'''After last child has been executed ...'''
'''''<successive runs will do nothing/the first child is chosen again>''''' - click to select one

'''Random List Rule:''' One of the child rules indented under this rule will be randomly selected and executed. The rule will not repeat to randomly select another child rule

'''Properties'''
None

'''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle

'''Properties'''
None

'''Simultaneous List Rule:''' Child rules are executed simultaneously once this rule starts

'''Properties'''
'''Rule completes when ...'''
'''''<one of the child rules has completed/all child rules have reached a completed state/all child rules have reached a "was completed" state>''''' - click to select one

=='''Camera Rules:'''==

'''Cinematic Camera Rule:''' Provides several different cinematic style cameras

'''Properties'''
Lock camera controls for the duration check
Prevent rain control for duration check
Camera target: name any of the many objects in session
Camera mode: Stationary, Circle fill-in
Initial camera values: Pitch, Yaw, Zoom value
Total time to animate: seconds value

'''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties

'''Properties'''
Change the camera view mode to check to choose: Cab View, External View, Tracking
View, Free Roaming
Vehicle fill-in choose from session vehicles
Set the camera flags to enable/disable check to choose different properties from list
Junction fill-in choose from session junctions
Set the target objet of the camera to check
Map object fill-in choose from map objects

'''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view

'''Properties'''
Trigger rule once check to set
Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking
View, Free Roaming View
Wait for the camera to target vehicle ? click to choose form session list

=='''Message Rules:'''==

'''Close Message Popup Rule:''' Closes open message popups

'''Properties:'''
None
'''Known Issues:'''
This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule

'''Custom Script Rule:'''

'''Properties'''
None.

'''Display Custom HUD Rule:''' Show or hide the Custom Heads Up Display.

'''Properties'''
Show the Custom Heads up Display- fill-in to choose.
Hide the Custom Heads up Display- fill-in to choose.
Note: One or the other will be chosen by default.

'''Wait for Click on HUD Icon Rule:'''

'''Properties'''
Trigger rule once-check to choose.
HUD Panel- click to choose from list.
Wait for click on- click to choose; choice depends on HUD Panel chosen.

'''Display HTML Pages Rule:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.

'''Properties'''
Add Page- click on to choose from list; click to Add Page Name or Remove.
Add All- click to add all files from the designated assets.
Delete All- delete all files from this property list.
Prevent user from exiting browser until all pages viewed- check to choose.
Disable closing of browser window by user- check to choose.
Disable browser window scrolling- check to choose.
Make browser window invisible- check to choose.
Set position-Under Construction!!!- check to choose.
Set size-Under Construction!!!- check to choose.
Use the page- click to choose Insert Page Name.
From asset HTML- click to choose from list.

'''Timed limited display HTML Rule:''' Displays an html browser window for a limited time.

'''Properties'''
HTML Asset Name-

'''Display Video Rule:''' Displays a page from a HTML assets in a browser window.

'''Properties'''

'''End Session Rule:''' End Session without saving.

'''Properties'''

'''Fade in/out Rule:''' Fade in or out within seconds, color and opacity considered.

'''Properties'''

'''Flash HUD Icon Rule:''' Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.

'''Properties'''

'''Generic Tree Node Debug Window Rule:''' No description.

'''Properties'''

'''InputTable Rule:''' Creating a list of message names to be used for various purposes.

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

'''Properties'''
'''[Check Box] Pause game while message is displayed''' - stops the game until this message is switched off
'''[Check Box] Close previous popup windows''' - closes any Message Popups currently displayed
'''Message location ''<Top Left/Top Right/Bottom Left/Bottom Right>''''' - select one to position the browser window on the screen
'''Message Source: (Option Buttons)''' - select one of three options
'''( ) Custom text''' - the simplest and easiest option
'''Icon ''<Click here to set>''''' - shows a list of message icons. Select one to be displayed with the message
'''Icon ''<Clear icon>''''' - clears any currently displayed message icon
'''Custom text box''' Enter text to be displayed. You will be limited to about 6 lines of text.
For longer messages or to include graphics, use the '''A predefined HTML page''' option.
'''( ) 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.

'''Minimap Options Rule:''' Sets the display options for the minimap.

'''Properties'''

'''Play Sound Rule:''' Plays a wav sound file.

'''Properties'''

'''Session Debug Rule Rule:''' Executes the first child if debug mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.

'''Properties'''

'''Session Metadata Rule:''' Sets session metadata in the config file. Info can be read by other systems and displayed to the player.

'''Properties'''

'''Set Helper Icon Size Rule:''' Sets the size of helper icons such as the junction lever arrows.

'''Properties'''

'''Set HTML Page Rule:''' Instructs the Display HTML Pages rule to perform specific operations

'''Properties'''

'''Show/Hide HUD Panel Rule:''' Shows or hides a HUD panel.

'''Properties'''

'''Show/Hide Layer Rule:''' Shows or hides a layer from Driver.

'''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:'''
TANE (all versions) - layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded

'''Show/Hide Minimap Rule:''' Shows the Driver the minimap window.

'''Properties'''
'''Minimap Window'''-click to choose Show,Hide

'''Show/hide on-screen help Rule:''' Shows or hides On-screen help in Driver.

'''Properties'''
'''Junction Overlays:''' - fill-in to choose: Show, Hide, Leave unchanged. by default one is chosen
'''On Screen Vehicle Name:''' - Fill-in to choose: Show, Hide, Leave unchanged. By default one is chosen

'''Wait for Click on HUD Icon Rule:''' Waits for a click on the HUD Icon.

'''Properties'''
'''(Check Box) Trigger Once:''' -to choose
'''HUD Panel:''' - Click to choose from list: Bottom Right Menu, Camera Controls, DCC Controls
'''Icon:''' - Choose from list. Selections depends on HUD Panel chosen

'''Wait on Waybill Screen/Main Screen Rule:''' Waits for the Waybill window to be opened.

'''Properties'''

=='''Startup Rules:'''==

'''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.

'''Properties'''

'''Startup Options Rule''' Specifies the starting options for the session.

'''Properties'''

=='''Time Rules:'''==

'''Clock Rule:''' Rule needed for animated clocks, you need to apply this rule to your session to make use of the animated clocks, see forum for code to include in you clock object to work with this rule.

'''Properties'''

'''Timecheck Rule:''' Executes child rules at a set time.

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

'''Timing Check Rule:''' Triggers sub rules if called within the time window specified.

'''Properties'''

'''Wait Rule:''' Wait for number of seconds'

'''Properties'''

=='''Variable Rules:'''==

'''Variable Check Rule:''' If the specified variable matches the specified conditions then the child rules will be executed in order.

'''Properties'''
'''''<variable-name>''''' - enter a variable-name. Variable name is case sensitive.
'''''<is less than/is less than or equal to/is equal to/is greater than or equal to/is greater than/is not equal to/is between x and y>''''' - select one
'''''<This condition will be evaluated only once .../This condition will be evaluated once every second>''''' - click to select one
'''Test condition option: is between x and y''' - Enter minimum (x) and maximum (y) test values
'''Test condition option: (all other options)''' - Enter test value
'''Evaluation option: 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
'''Evaluation option: This condition will be evaluated evaluated once every second''' - the rule will be rerun and the variable rechecked every second

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

'''Properties'''
'''Change ''<Add to variable/Subtract from variable/Change variable>''''' - select one
'''[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.
'''Change option: 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.
'''Change option: 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 option: 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.

'''Variable Modify Continuous Rule:''' Adds, subtracts or sets a value to a specified variable every second.

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

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

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

Variables are saved in the session file and persist from one saved game to another.
They can be accessed/modified by the following '''driver commands''':

'''Driver Commands by trev999:'''
'''Set S-Variable driver command: '''
'''Skip if session-variable driver command: '''
'''Wait until S-variable driver command: '''

'''Driver Commands by atilabarut'''
'''ChangeSVariables driver command: '''
'''WaitUntilSVariable driver command: '''

=='''Weather Rules:'''==

'''EIRS Weather Rule NE USA Rule:''' Customize random weather rule relative to the North East Region of the United States.

'''Properties'''

'''Weather Rule:''' Set the weather conditions.

'''Properties'''

Session Rules By Categories With Properties

2017-09-29T20:51:15Z

Coop2:

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

=='''Achievement Rules'''==

'''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement

'''Properties:'''
None

'''Advanced Industry Load Configuration Rule:''' Locks train controls when loading/unloading at an industry, overrides time settings for begin load and begin unload operations

'''Properties:'''
'''Target object ''<click to 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''' - check and enter number of seconds to override

'''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations

'''Properties:'''
'''<Click to Select>'''- Trigger from Session List.
'''<Click to Select>'''- Industry from Session List
'''<Option Buttons>'''
-Choose to accept all trains.
-Accept trains matching specific criteria of Assets from Session List

'''Power Station Rule:''' Sets up Station and Consumers

'''Properties:'''
'''<Click to Select>'''- from Session Stations.
'''<Click to Select>'''- Consumers(Add Object) choose from Session List

'''Resource Check Rule:''' Check the progress of the amount of a resource and target object

'''Properties:'''
'''<Option Buttons>'''
-Watch industry queue
-Watch vehicle
'''Note:''' Both have: Target Object, Queue:'''
'''Complete when designated queue <Option Buttons>'''
''-equals or exceeds required amount''
''-falls below required amount''

'''Multiple Resource Check Rule:''' If specified resources in a selected industry or vehicle reaches set levels, then the following child rules will be executed

'''Properties:'''
'''''<Reach-Exceed/Fall below>''''' - click to select one
'''''<value>'':''' - enter required quantity value
'''''<Click to 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. For each object:-
'''''<Object>''''' - click to select session active industry or product enabled rail vehicle
'''''<Queue>''''' - select product queue (there may be only one available)
'''''<Remove''>''' - removes the object and its product queue from the rule
'''Notes:'''
'''''Reach/Exceed''''' - sets an upper limit for the resource 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 resource 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.

'''Objective Add Rule:''' Sets up a game Objective with ID and display Name

'''Properties:'''
'''Priority <Click to Select>'''
''-Above Normal:''
''-Below Normal:''
''-Normal:''
''-Optional:''
''-Urgent:''
'''Completion Target Number <Click>'''
''-to set Completion Target Number''
'''Icon <Click>'''
''-to select Icon from list''
'''Display Name <Click>'''
''-to insert Name''
'''Unique Objective ID <Click>'''
''-to set ID''
'''Custom Message <Text Box>'''
''-insert typed message in text area''

'''Objective Check Rule:''' Executes child rules when objective is complete

'''Properties:'''
'''Unique Objective ID <Click>'''
''insert ID number''
'''Mode <click>'''
''-Wait for completion''
''-Wait for failure''
''-Wait for progress''

'''Objective Update Rule:''' Changes progress outcome according to Property choices

'''Properties:'''
'''Unique Objective ID <Click>'''
''-set ID number''
'''Mode <Click to Set Objective>'''
''-Decrement progress''
''-Increment progress''
''-Reset Objective''
''-Set objects as complete''
''-Set objects as failed''
''-Set progress''
''-Set progress only if greater''
'''Amount <Click>'''
''-insert number''

'''Ranked Session Begin Rule:''' Begins a ranked Session

'''Properties:'''
'''Countdown Starting Value <Click to insert>'''
''-hrs''
''-min''
''sec''
'''1 through 5 stars, points for each star <Click>
-insert number of points
'''Session timer mode <Option Buttons>'''
''-Timer''
''-Countdown''
''-None''

'''Ranked Session Complete Rule:''' Completes the active ranked Session

'''Properties:'''
'''Set the active ranked session as <Option Buttons>'''
''-Complete''
''-Failed''
'''Customize the completion message <Text Box>'''
''-insert text message''

'''Session Complete Rule:''' Set session to a percentage of completion

'''Properties:'''
'''Set session to percent complete <Click>'''
''to insert number in percent''
'''Separate achievements for completion <Check Box>
''-check to set''

=='''Danger Rules'''==

'''ATP Speed Limiter Rule:''' Limits speed over set limit

'''Properties:'''
'''Speed limit over the set limit <Click>
''-to set mph''

'''Speeding Check Rule:''' If player controlled trains are over the local speed limit or over a set (custom) speed, then the following child rules will be executed

'''Properties:'''
'''(Option button) Watch for trains travelling above the posted speed limit'''
'''''<speed value>''''' - click to enter a new overspeed tolerance value
'''''<Kmph/MPH/mps>''''' - click to select one
'''(Option button) Watch for trains travelling above a custom speed'''
'''''<speed value>''''' - click to enter a new custom speed value
'''''<Kmph/MPH/mps>''''' - click to select one
'''Warning: This option is very performance intensive and should only be used in sessions with few trains'''

'''AWS Configuration Rule:''' This rule configures the Trainz implementation of the Automatic Warning System when approaching signals

'''Properties:'''
'''Use modern sound set for unfitted cabs? <Check Box>'''
''check to set''
'''Simulate AWS for unfitted cabs? <Check Box>'''
''-check to set''
'''Passive with HUD hidden <Option Buttons>'''
''-Active''
''-Passive''

'''Wait for Derailment Rule:''' Waits for a derailment to occur

'''Properties:'''
'''Trigger derailment, Watch Once <Check Box>
''-check to set

'''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars after a set time delay

'''Properties:'''
'''''<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.

'''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule

'''Properties:'''
'''[Check box] Respawn trains if they are abandoned for 10 minutes'''
If checked:-
'''(Option button) Respawn trains at their original locations'''
'''(Option button) Respawn trains from portals'''
If '''Respawn trains from portals''' is selected, then:-
'''''<+ Add a new portal>''''' - click to enter the name of a portal, there can be more than one portal.
Entered names that appear in red have not been found in the session

'''Coupler Breakage Check Rule:''' Checks for breaking couplers and, if found, then executes any following child rules.

'''Properties:'''
'''None'''

'''Coupler Breakage HUD Rule:''' HUD displays warning about coupler stress and breakage

'''Properties:'''
'''(Option button) Show the Coupler Breakage Display'''
'''(Option button) Hide the Coupler Breakage Display'''

'''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles

'''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 ''<Locked/Unlocked>''''' - click to select
'''Back ''<Locked/Unlocked>''''' - click to select
'''Decoupling Mask:'''
'''Front ''<Locked/Unlocked>''''' - click to select
'''Back ''<Locked/Unlocked>''''' - click to select
'''''<Remove>''''' - click to remove that vehicle from the rule

'''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users and, if found, then executes any following child rules.

'''Properties:'''
'''[Check box] Trigger only once'''

'''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users and, if found, then executes any following child rules.

'''Properties:'''
'''[Check box] Trigger only once'''

'''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger (stop) and, if found, then executes any following child rules.

'''Properties:'''
'''[Check box] Trigger only once'''

'''Vehicle Physics Rule:''' Overrides the default vehicle physics properties

'''Properties:'''
'''Accept all trains <Option Button>'''
''-click to set''
'''Cab sway level is <Click>'''
''-to set insert percent of sway''
'''Traction boost is <Click>'''
''-to insert percent of boost while sanding''
'''Traction reduced to <Click>'''
''-to set traction percent''
'''Maximum tractive effort adjusted by <Click>
''-to insert percent amount''
'''Show coupler breakage in HUD Rule <Click>'''
''-to set''
'''Couplers break when coupling above <Click>'''
''-to set speed''
'''Accept trains matching specific criteria <Radio Button>'''
''-set to insert specific train assets''
'''Couplers break at <Click>'''
''-to insert amount of force in kN units''

=='''Navigation Rules'''==

'''DestSignTable Rule:''' Table for creating a table of destination signs

'''Properties:'''
'''Enable Track Marks as destinations <Check Box>'''
''-check to set''
'''Enable table of destinations <Check Box>'''
''-check to set''
'''Import destination from texture-group <Text Box>'''
''-insert name''
'''Enable industries/stations as destination <Check Box>
''-check to set''

'''Interlocking Tower Configure Path''' Alters settings on an interlocking tower path

'''Properties'''
'''Interlocking Tower <Click>'''
''-to set Name and Objects''

'''Interlocking Tower Path Selection UI <CheckBox>''' Will automatically react to messages from Interlocking Towers and display a path selection dialog to the player. Disable by removing rule from session
''-Check(default) to Show path activation message in Driver''

'''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train

'''Properties:'''
'''Interlocking Tower <Click>'''
''-to set Names and Objects''

'''Multiple Junction Alignment Check Rule''' Checks multiple junctions are in alignment

'''Properties:'''
'''Wait until the following junctions are set to its corresponding set state <Click>'''
''-to set to all''
''-set to anyone''
'''Add junction <click>'''
''-to add junction from session list''
'''Add all <Click>'''
''-to all junctions from session list''
'''Delete all <Click>'''
''-to delete all junctions from rule list''

'''Navigation Display Rule:''' Creates a set of navigation points. Multiple sets can be created by adding additional copies of this rule. This rule creates the navigation set, it does not display it. Use the '''Navigation set hide/show rule''' to make a set visible. Navigation sets can be completed (terminated) by the '''Navigation Set Clear Rule''', individual navigation points can be ''manually'' completed by the '''Navigation Point Complete Rule'''. Click the help icon at the top of the properties box for in game instructions.

'''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.
'''Navigation mode:''' - select one option
'''(Option button) 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.
'''(Option button) 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.
'''(Option button) 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 (a trigger, trackmark, track object or rolling stock asset) 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'' ''<Automatic/Manual/Require Stop>''''' - click to select one
'''''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''' 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.

'''Navigation Point Complete Rule:''' Manually completes a navigation point in a set

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

'''Navigation Set Check Rule:''' Checks if a navigation set is complete or incomplete, if so then the following child rules will be executed

'''Properties:'''
'''Checks if navigation point set ''<click to select>'':''' - 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.

'''Navigation Set Clear Rule:''' Clears a navigation set removing any uncompleted navigation points

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

'''Navigation Set Hide/Show:''' Shows and hides navigation sets. You can have multiple sets visible and hidden at the same time.

'''Properties:'''
'''''<Hide/Show>''''' - click to select one
'''''<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.

'''Schedule Rule:''' Allows a schedule of timed events to be applied to a train

'''Properties:'''
'''Insert track mark <Click>'''
''-to select from Session List''
'''Arrival and Departure Time <Select>'''
''-set time in hr:min:sec''
'''Current Train <Click>'''
''to select from session list''
'''Insert destination <Click>'''
''to select from session list''

'''Set Junctions Rule:''' Sets the selected junctions to a specific state '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''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:-
'''''<Left/Center/Right/Don't change>''''' - click to set the junction direction
'''''<Locked/Unlocked>''''' - click to select. '''Locked''' means the junction setting cannot be changed by the user
'''''<Allows AI control/Blocks AI control>''''' - click to select
'''''Remove''''' - click to remove that junction from the rule list

'''Set Signal Extended Rule:''' Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''Properties:'''
'''''Select signal''''' - click to select a signal from the session list
'''''<signal state>''''' - click to select a state from the list

'''Trigger Check Rule:''' - Waits for any train to enter one of the designated triggers. This rule replaces the older and less versatile "Trigger Rule".

'''Properties:'''
'''Accept all trains <Option Buttons>'''
''-click to accept all trains
''-click to accept trains matching specific criteria and choose from session Assets list''
'''Add Trigger <Click>'''
''-to choose from session list''
'''Trigger only once <Check Box>'''
''-check to set''
'''Wait for child rules to complete even if no trains are present in rule trigger <Checkbox>'''
''-check to set''
'''Only activate when the entering vehicle of the train <Check Box>'''
''click to set''
'''Train Heading <Click>'''
''-to set to forward''
''-to set to backward''

'''Wait on Navigation Point Rule:''' Waits for a navigation point to be completed then the following child rules will be executed

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

'''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start

'''Properties:'''
'''Trigger rule once <Check Box>'''
''-check to set''
'''Wait for a train that matches the following criteria to <Click>'''
''-to set start moving''
''-to to stop moving''
'''Accept all trains <Option Buttons>'''
''-click to accept all trains''
''-click to accept trains matching specific criteria and choose from session list''

=='''Driver Rules'''==

'''Control Type Rule''' Sets control type

'''Properties:'''
'''Current control method is: <Click>'''
''-to set to Easy Mode, Ask User, or Realistic Mode''

'''Control Check Rule:''' Activates child rules based on the control method changes

'''Properties:'''
'''Excite child rules when: <Option Buttons>'''
''-DCC mode is Selected''
''-Cab mode is Selected''
'''Execute child rules: <Option Buttons>'''
''-Every time control method is set''
''-Once only''

'''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule

'''Properties:'''
'''Portal index from PCP <Click>'''
''-to enter (Un)Portal Index''
'''Use UnPortal <Click>'''
''-to select Yes or No''
'''Delay from Trigger to Emit <Click>'''
''-to set number of seconds''
'''Add Trigger <Click>'''
''-to add Trigger from Session List''

'''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry

'''Properties:'''
'''Load/unload <click>'''
''-to set to Disable or enable''
'''Which Industry? <click>'''
''-to set Industry from Session List''
'''Which Vehicles <Option Buttons>'''
-''Apply to every vehicle in the session''
-''Apply only to a specific vehicles from Session List''

'''Driver Command Rule:''' Specify which commands will be available for the drivers

'''Properties''':
Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.
Navigate To TrackMarkList V2- No description.
Navigate To Station V2- No description.
Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.
Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.
Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.
Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.
Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.
Drive To Station V2- No description.
Drive To Track mark List V2- No description.
Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.
Drive To Industry- Drive to a specific industry.
Change Destination Sign-Changes the destination signs of a train.

WaitFor- Pauses the driver's schedule for a set duration of time.
Wait For Random- TRS2008: Wait for specified or optionally random period of time.
Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).
WaitUntil- No description.

VR Set Train Lamps-Driver command that sets the train lamps.
Notify- Notifies the player of schedule progress/completion.
Reverse Tram- Reverse a tram(max 2 cars).
Couple- Couple train to designate vehicle.
Decouple- Decouples the train at the specified vehicle.
UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).
Halt Train- Brings the train to a complete stop.
Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.
Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger
station before using this command.
Cab: Wait-Maintains current control state until some condition is met.
Delete Train- Causes the train and its driver to be deleted from the session.
Hornz- Driver sounds the train horn.
Cab: Set Control-Sets a cab mode control.
Headlights On/Off-Allows the driver to to switch the headlights on and off.
Interior Lights Command- Driver command to switch interior lights on or off for the current train.
Set Max Speed To- No description.

Release Junction - Lets a driver release the junction they have been holding.
Move Turntable- TRS2008: Move turntable to a stop point .

Load- Loads the train's vehicles at the industry the driver is currently at with the train.
Unload- Unload train vehicles at current industry location.
Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.
Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.
Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.

'''Driver Command Check Rule:''' Verifies the driver commands of a driver character

'''Properties'''
'''Trigger rule once <Click>'''
''-to set''
'''Driver character to watch the command list of <Click.'''
''to select Driver from Session List''
'''Wait for driver character to have a command list that matches this:''' add driver, all, delete all
'''Add Driver Command <Select>'''
''-to add a Driver Command''
'''Add all <Click>'''
''Click to add all Driver Commands''
'''Delete all <Click>'''
''-to delete Driver Command List''

'''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar

'''Properties'''
'''The Driver Main Bar <Click>'''
''-to Show or Hide''

'''Driver Schedule Rule''' Execution of basic scheduled commands

'''Properties:'''
'''Driver Schedule Rule assigned to <Click>
''-to name driver from Session List''
'''Commands <Click>'''
''-to insert driver commands in Drive Schedule''
'''Style: <Option Buttons>'''
''-Classic style: If there is a schedule do not emit a new schedule''
''-Killer style: If there is a schedule clean it and emit a new one''
''-Cooperative style: If there is a schedule append the new one''
''-Active style: Emit a new schedule, only if already a schedule running''

'''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders

'''Properties'''
'''The following drivers will be available <click>'''
''-To add Driver, Driver Commands, Assets, Type of Engineer, or Remove Driver''
'''Remove all existing Drivers first <Check Box>'''
''-to set''
'''Generate new Drivers for empty Trains <Check Box>'''
''-to set''

'''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers

'''Properties'''
'''Driver Commands <Click>'''
''-to select Enable or Disable''
'''Driver Command criteria to match <Check Box>
''-to select each Driver Command''
'''Trains to use <Option Buttons>'''
''-Accept all trains''
''-Accept trains matching above criteria''

'''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted

'''Properties'''
Config/txt file tag 'max_permitted_speed-60850 in mph or kph
Add to config.txt and kuid-table for value <KUID2:60850:88000:4
Note: Old root level config tag will

'''QuickDrive Rule:''' Change the Session settings and add consists in Driver

'''Properties'''
Set Time to insert time
QuickDrive Consist Option List by
Rate of Change insert rate as number times
Enable gameplay Session Mode check
Enable in game help by default check
Set the default Control method to fill-in choose: Easy Mode, Realistic Mode
Prevent player from changing this check
Realistic mode requires achievement add Achievement's Name
In Asset choose Auran achievements
Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic
Prevent player from changing 10.0 check
Set the default units to fill-in choose: Imperial, Metric, Default
Open QuickDriver Window when check

'''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train

'''Properties'''
Note: One or the other fill-ins must be
Accept trains matching specific criteria fill-in to select from session list
Accept all trains fill-in to set
Trigger rule once check to set
Wait for a driver character to get ? a click to select: On, Off

'''Wait for Driver/Train to be Locally Owned Rule:''' Waits for a specific driver or train car to be locally owned, Owned then executes child rules. If the driver/train car becomes unowned again the child rules are paused

'''Properties'''
Wait for ownership of a specific Driver fill-in to set
Wait for ownership of Driver fill-in to set
Note: One or the other fill-in must be
Driver or Vehicle click to choose from session lists

=='''Arrangement of Session Rules:'''==

'''Ordered List Rule:''' Child rules will be executed in order once this rule starts

'''Properties'''
One of the following options must be chosen
'''(Option button) This process will repeat ''<value>'' time(s)''' - enter the number of times this rule is to be repeated
'''(Option button) This process will repeat forever'''

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

'''Properties'''
'''After last child has been executed ...'''
'''''<successive runs will do nothing/the first child is chosen again>''''' - click to select one

'''Random List Rule:''' One of the child rules indented under this rule will be randomly selected and executed. The rule will not repeat to randomly select another child rule

'''Properties'''
None

'''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle

'''Properties'''
None

'''Simultaneous List Rule:''' Child rules are executed simultaneously once this rule starts

'''Properties'''
'''Rule completes when ...'''
'''''<one of the child rules has completed/all child rules have reached a completed state/all child rules have reached a "was completed" state>''''' - click to select one

=='''Camera Rules:'''==

'''Cinematic Camera Rule:''' Provides several different cinematic style cameras

'''Properties'''
Lock camera controls for the duration check
Prevent rain control for duration check
Camera target: name any of the many objects in session
Camera mode: Stationary, Circle fill-in
Initial camera values: Pitch, Yaw, Zoom value
Total time to animate: seconds value

'''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties

'''Properties'''
Change the camera view mode to check to choose: Cab View, External View, Tracking
View, Free Roaming
Vehicle fill-in choose from session vehicles
Set the camera flags to enable/disable check to choose different properties from list
Junction fill-in choose from session junctions
Set the target objet of the camera to check
Map object fill-in choose from map objects

'''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view

'''Properties'''
Trigger rule once check to set
Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking
View, Free Roaming View
Wait for the camera to target vehicle ? click to choose form session list

=='''Message Rules:'''==

'''Close Message Popup Rule:''' Closes open message popups

'''Properties:'''
None
'''Known Issues:'''
This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule

'''Custom Script Rule:'''

'''Properties'''
None.

'''Display Custom HUD Rule:''' Show or hide the Custom Heads Up Display.

'''Properties'''
Show the Custom Heads up Display- fill-in to choose.
Hide the Custom Heads up Display- fill-in to choose.
Note: One or the other will be chosen by default.

'''Wait for Click on HUD Icon Rule:'''

'''Properties'''
Trigger rule once-check to choose.
HUD Panel- click to choose from list.
Wait for click on- click to choose; choice depends on HUD Panel chosen.

'''Display HTML Pages Rule:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.

'''Properties'''
Add Page- click on to choose from list; click to Add Page Name or Remove.
Add All- click to add all files from the designated assets.
Delete All- delete all files from this property list.
Prevent user from exiting browser until all pages viewed- check to choose.
Disable closing of browser window by user- check to choose.
Disable browser window scrolling- check to choose.
Make browser window invisible- check to choose.
Set position-Under Construction!!!- check to choose.
Set size-Under Construction!!!- check to choose.
Use the page- click to choose Insert Page Name.
From asset HTML- click to choose from list.

'''Timed limited display HTML Rule:''' Displays an html browser window for a limited time.

'''Properties'''
HTML Asset Name-

'''Display Video Rule:''' Displays a page from a HTML assets in a browser window.

'''Properties'''

'''End Session Rule:''' End Session without saving.

'''Properties'''

'''Fade in/out Rule:''' Fade in or out within seconds, color and opacity considered.

'''Properties'''

'''Flash HUD Icon Rule:''' Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.

'''Properties'''

'''Generic Tree Node Debug Window Rule:''' No description.

'''Properties'''

'''InputTable Rule:''' Creating a list of message names to be used for various purposes.

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

'''Properties'''
'''[Check Box] Pause game while message is displayed''' - stops the game until this message is switched off
'''[Check Box] Close previous popup windows''' - closes any Message Popups currently displayed
'''Message location ''<Top Left/Top Right/Bottom Left/Bottom Right>''''' - select one to position the browser window on the screen
'''Message Source'''
'''(Option button) Custom text''' - the simplest and easiest option
'''Icon ''<Click here to set>''''' - shows a list of message icons. Select one to be displayed with the message
'''Icon ''<Clear icon>''''' - clears any currently displayed message icon
'''Custom text box''' Enter text to be displayed. You will be limited to about 6 lines of text.
For longer messages or to include graphics, use the '''A predefined HTML page''' option.
'''(Option button) 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.
'''(Option button) 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.

'''Minimap Options Rule:''' Sets the display options for the minimap.

'''Properties'''

'''Play Sound Rule:''' Plays a wav sound file.

'''Properties'''

'''Session Debug Rule Rule:''' Executes the first child if debug mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.

'''Properties'''

'''Session Metadata Rule:''' Sets session metadata in the config file. Info can be read by other systems and displayed to the player.

'''Properties'''

'''Set Helper Icon Size Rule:''' Sets the size of helper icons such as the junction lever arrows.

'''Properties'''

'''Set HTML Page Rule:''' Instructs the Display HTML Pages rule to perform specific operations

'''Properties'''

'''Show/Hide HUD Panel Rule:''' Shows or hides a HUD panel.

'''Properties'''

'''Show/Hide Layer Rule:''' Shows or hides a layer from Driver.

'''Properties:'''
'''Show/Hide''' - select one
'''click here to set''' - enter name of layer. Name is case sensitive.

'''Known Bugs:'''
TANE (all versions) - layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded

'''Show/Hide Minimap Rule:''' Shows the Driver the minimap window.

'''Properties'''
'''Minimap Window'''-click to choose Show,Hide

'''Show/hide on-screen help Rule:''' Shows or hides On-screen help in Driver.

'''Properties'''
'''Junction Overlays:''' - fill-in to choose: Show, Hide, Leave unchanged. by default one is chosen
'''On Screen Vehicle Name:''' - Fill-in to choose: Show, Hide, Leave unchanged. By default one is chosen

'''Wait for Click on HUD Icon Rule:''' Waits for a click on the HUD Icon.

'''Properties'''
'''(Check Box) Trigger Once:''' -to choose
'''HUD Panel:''' - Click to choose from list: Bottom Right Menu, Camera Controls, DCC Controls
'''Icon:''' - Choose from list. Selections depends on HUD Panel chosen

'''Wait on Waybill Screen/Main Screen Rule:''' Waits for the Waybill window to be opened.

'''Properties'''

=='''Startup Rules:'''==

'''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.

'''Properties'''

'''Startup Options Rule''' Specifies the starting options for the session.

'''Properties'''

=='''Time Rules:'''==

'''Clock Rule:''' Rule needed for animated clocks, you need to apply this rule to your session to make use of the animated clocks, see forum for code to include in you clock object to work with this rule.

'''Properties'''

'''Timecheck Rule:''' Executes child rules at a set time.

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

'''Timing Check Rule:''' Triggers sub rules if called within the time window specified.

'''Properties'''

'''Wait Rule:''' Wait for number of seconds'

'''Properties'''

=='''Variable Rules:'''==

'''Variable Check Rule:''' If the specified variable matches the specified conditions then the child rules will be executed in order.

'''Properties'''
'''''<variable-name>''''' - enter a variable-name. Variable name is case sensitive.
'''''<is less than/is less than or equal to/is equal to/is greater than or equal to/is greater than/is not equal to/is between x and y>''''' - select one
'''''<This condition will be evaluated only once .../This condition will be evaluated once every second>''''' - click to select one
'''Test condition option: is between x and y''' - Enter minimum (x) and maximum (y) test values
'''Test condition option: (all other options)''' - Enter test value
'''Evaluation option: 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
'''Evaluation option: This condition will be evaluated evaluated once every second''' - the rule will be rerun and the variable rechecked every second

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

'''Properties'''
'''Change ''<Add to variable/Subtract from variable/Change variable>''''' - select one
'''[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.
'''Change option: 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.
'''Change option: 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 option: 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.

'''Variable Modify Continuous Rule:''' Adds, subtracts or sets a value to a specified variable every second.

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

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

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

Variables are saved in the session file and persist from one saved game to another.
They can be accessed/modified by the following '''driver commands''':

'''Driver Commands by trev999:'''
'''Set S-Variable driver command: '''
'''Skip if session-variable driver command: '''
'''Wait until S-variable driver command: '''

'''Driver Commands by atilabarut'''
'''ChangeSVariables driver command: '''
'''WaitUntilSVariable driver command: '''

=='''Weather Rules:'''==

'''EIRS Weather Rule NE USA Rule:''' Customize random weather rule relative to the North East Region of the United States.

'''Properties'''

'''Weather Rule:''' Set the weather conditions.

'''Properties'''

Session Rules By Categories With Properties

2017-09-29T19:20:21Z

Coop2:

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

=='''Achievement Rules'''==

'''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement

'''Properties:'''
None

'''Advanced Industry Load Configuration Rule:''' Locks train controls when loading/unloading at an industry, overrides time settings for begin load and begin unload operations

'''Properties:'''
'''Target object ''<click to 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''' - check and enter number of seconds to override

'''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations

'''Properties:'''
'''<Click to Select>'''- Trigger from Session List.
'''<Click to Select>'''- Industry from Session List
'''<Option Buttons>'''
-Choose to accept all trains.
-Accept trains matching specific criteria of Assets from Session List

'''Power Station Rule:''' Sets up Station and Consumers

'''Properties:'''
'''<Click to Select>'''- from Session Stations.
'''<Click to Select>'''- Consumers(Add Object) choose from Session List

'''Resource Check Rule:''' Check the progress of the amount of a resource and target object

'''Properties:'''
'''<Option Buttons>'''
-Watch industry queue
-Watch vehicle
'''Note:''' Both have: Target Object, Queue:'''
'''Complete when designated queue <Option Buttons>'''
''-equals or exceeds required amount''
''-falls below required amount''

'''Multiple Resource Check Rule:''' If specified resources in a selected industry or vehicle reaches set levels, then the following child rules will be executed

'''Properties:'''
'''''<Reach-Exceed/Fall below>''''' - click to select one
'''''<value>'':''' - enter required quantity value
'''''<Click to 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. For each object:-
'''''<Object>''''' - click to select session active industry or product enabled rail vehicle
'''''<Queue>''''' - select product queue (there may be only one available)
'''''<Remove''>''' - removes the object and its product queue from the rule
'''Notes:'''
'''''Reach/Exceed''''' - sets an upper limit for the resource 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 resource 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.

'''Objective Add Rule:''' Sets up a game Objective with ID and display Name

'''Properties:'''
'''Priority <Click to Select>'''
''-Above Normal:''
''-Below Normal:''
''-Normal:''
''-Optional:''
''-Urgent:''
'''Completion Target Number <Click>'''
''-to set Completion Target Number''
'''Icon <Click>'''
''-to select Icon from list''
'''Display Name <Click>'''
''-to insert Name''
'''Unique Objective ID <Click>'''
''-to set ID''
'''Custom Message <Text Box>'''
''-insert typed message in text area''

'''Objective Check Rule:''' Executes child rules when objective is complete

'''Properties:'''
'''Unique Objective ID <Click>'''
''insert ID number''
'''Mode <click>'''
''-Wait for completion''
''-Wait for failure''
''-Wait for progress''

'''Objective Update Rule:''' Changes progress outcome according to Property choices

'''Properties:'''
'''Unique Objective ID <Click>'''
''-set ID number''
'''Mode <Click to Set Objective>'''
''-Decrement progress''
''-Increment progress''
''-Reset Objective''
''-Set objects as complete''
''-Set objects as failed''
''-Set progress''
''-Set progress only if greater''
'''Amount <Click>'''
''-insert number''

'''Ranked Session Begin Rule:''' Begins a ranked Session

'''Properties:'''
'''Countdown Starting Value <Click to insert>'''
''-hrs''
''-min''
''sec''
'''1 through 5 stars, points for each star <Click>
-insert number of points
'''Session timer mode <Option Buttons>'''
''-Timer''
''-Countdown''
''-None''

'''Ranked Session Complete Rule:''' Completes the active ranked Session

'''Properties:'''
'''Set the active ranked session as <Option Buttons>'''
''-Complete''
''-Failed''
'''Customize the completion message <Text Box>'''
''-insert text message''

'''Session Complete Rule:''' Set session to a percentage of completion

'''Properties:'''
'''Set session to percent complete <Click>'''
''to insert number in percent''
'''Separate achievements for completion <Check Box>
''-check to set''

=='''Danger Rules'''==

'''ATP Speed Limiter Rule:''' Limits speed over set limit

'''Properties:'''
'''Speed limit over the set limit <Click>
''-to set mph''

'''Speeding Check Rule:''' If player controlled trains are over the local speed limit or over a set (custom) speed, then the following child rules will be executed

'''Properties:'''
'''(Option button) Watch for trains travelling above the posted speed limit'''
'''''<speed value>''''' - click to enter a new overspeed tolerance value
'''''<Kmph/MPH/mps>''''' - click to select one
'''(Option button) Watch for trains travelling above a custom speed'''
'''''<speed value>''''' - click to enter a new custom speed value
'''''<Kmph/MPH/mps>''''' - click to select one
'''Warning: This option is very performance intensive and should only be used in sessions with few trains'''

'''AWS Configuration Rule:''' This rule configures the Trainz implementation of the Automatic Warning System when approaching signals

'''Properties:'''
'''Use modern sound set for unfitted cabs? <Check Box>'''
''check to set''
'''Simulate AWS for unfitted cabs? <Check Box>'''
''-check to set''
'''Passive with HUD hidden <Option Buttons>'''
''-Active''
''-Passive''

'''Wait for Derailment Rule:''' Waits for a derailment to occur

'''Properties:'''
'''Trigger derailment, Watch Once <Check Box>
''-check to set

'''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars after a set time delay

'''Properties:'''
'''''<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.

'''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule

'''Properties:'''
'''[Check box] Respawn trains if they are abandoned for 10 minutes'''
If checked:-
'''(Option button) Respawn trains at their original locations'''
'''(Option button) Respawn trains from portals'''
If '''Respawn trains from portals''' is selected, then:-
'''''<+ Add a new portal>''''' - click to enter the name of a portal, there can be more than one portal.
Entered names that appear in red have not been found in the session

'''Coupler Breakage Check Rule:''' Checks for breaking couplers and, if found, then executes any following child rules.

'''Properties:'''
'''None'''

'''Coupler Breakage HUD Rule:''' HUD displays warning about coupler stress and breakage

'''Properties:'''
'''(Option button) Show the Coupler Breakage Display'''
'''(Option button) Hide the Coupler Breakage Display'''

'''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles

'''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 ''<Locked/Unlocked>''''' - click to select
'''Back ''<Locked/Unlocked>''''' - click to select
'''Decoupling Mask:'''
'''Front ''<Locked/Unlocked>''''' - click to select
'''Back ''<Locked/Unlocked>''''' - click to select
'''''<Remove>''''' - click to remove that vehicle from the rule

'''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users and, if found, then executes any following child rules.

'''Properties:'''
'''[Check box] Trigger only once'''

'''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users and, if found, then executes any following child rules.

'''Properties:'''
'''[Check box] Trigger only once'''

'''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger (stop) and, if found, then executes any following child rules.

'''Properties:'''
'''[Check box] Trigger only once'''

'''Vehicle Physics Rule:''' Overrides the default vehicle physics properties

'''Properties:'''
'''Accept all trains <Option Button>'''
''-click to set''
'''Cab sway level is <Click>'''
''-to set insert percent of sway''
'''Traction boost is <Click>'''
''-to insert percent of boost while sanding''
'''Traction reduced to <Click>'''
''-to set traction percent''
'''Maximum tractive effort adjusted by <Click>
''-to insert percent amount''
'''Show coupler breakage in HUD Rule <Click>'''
''-to set''
'''Couplers break when coupling above <Click>'''
''-to set speed''
'''Accept trains matching specific criteria <Radio Button>'''
''-set to insert specific train assets''
'''Couplers break at <Click>'''
''-to insert amount of force in kN units''

=='''Navigation Rules'''==

'''DestSignTable Rule:''' Table for creating a table of destination signs

'''Properties:'''
'''Enable Track Marks as destinations <Check Box>'''
''-check to set''
'''Enable table of destinations <Check Box>'''
''-check to set''
'''Import destination from texture-group <Text Box>'''
''-insert name''
'''Enable industries/stations as destination <Check Box>
''-check to set''

'''Interlocking Tower Configure Path''' Alters settings on an interlocking tower path

'''Properties'''
'''Interlocking Tower <Click>'''
''-to set Name and Objects''

'''Interlocking Tower Path Selection UI <CheckBox>''' Will automatically react to messages from Interlocking Towers and display a path selection dialog to the player. Disable by removing rule from session
''-Check(default) to Show path activation message in Driver''

'''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train

'''Properties:'''
'''Interlocking Tower <Click>'''
''-to set Names and Objects''

'''Multiple Junction Alignment Check Rule''' Checks multiple junctions are in alignment

'''Properties:'''
'''Wait until the following junctions are set to its corresponding set state <Click>'''
''-to set to all''
''-set to anyone''
'''Add junction <click>'''
''-to add junction from session list''
'''Add all <Click>'''
''-to all junctions from session list''
'''Delete all <Click>'''
''-to delete all junctions from rule list''

'''Navigation Display Rule:''' Creates a set of navigation points. Multiple sets can be created by adding additional copies of this rule. This rule creates the navigation set, it does not display it. Use the '''Navigation set hide/show rule''' to make a set visible. Navigation sets can be completed (terminated) by the '''Navigation Set Clear Rule''', individual navigation points can be ''manually'' completed by the '''Navigation Point Complete Rule'''. Click the help icon at the top of the properties box for in game instructions.

'''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.
'''Navigation mode:''' - select one option
'''(Option button) 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.
'''(Option button) 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.
'''(Option button) 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 (a trigger, trackmark, track object or rolling stock asset) 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'' ''<Automatic/Manual/Require Stop>''''' - click to select one
'''''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''' 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.

'''Navigation Point Complete Rule:''' Manually completes a navigation point in a set

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

'''Navigation Set Check Rule:''' Checks if a navigation set is complete or incomplete, if so then the following child rules will be executed

'''Properties:'''
'''Checks if navigation point set ''<click to select>'':''' - 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.

'''Navigation Set Clear Rule:''' Clears a navigation set removing any uncompleted navigation points

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

'''Navigation Set Hide/Show:''' Shows and hides navigation sets. You can have multiple sets visible and hidden at the same time.

'''Properties:'''
'''''<Hide/Show>''''' - click to select one
'''''<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.

'''Schedule Rule:''' Allows a schedule of timed events to be applied to a train

'''Properties:'''
'''Insert track mark <Click>'''
''-to select from Session List''
'''Arrival and Departure Time <Select>'''
''-set time in hr:min:sec''
'''Current Train <Click>'''
''to select from session list''
'''Insert destination <Click>'''
''to select from session list''

'''Set Junctions Rule:''' Sets the selected junctions to a specific state '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''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:-
'''''<Left/Center/Right/Don't change>''''' - click to set the junction direction
'''''<Locked/Unlocked>''''' - click to select. '''Locked''' means the junction setting cannot be changed by the user
'''''<Allows AI control/Blocks AI control>''''' - click to select
'''''Remove''''' - click to remove that junction from the rule list

'''Set Signal Extended Rule:''' Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''Properties:'''
'''''Select signal''''' - click to select a signal from the session list
'''''<signal state>''''' - click to select a state from the list

'''Trigger Check Rule:''' - Waits for any train to enter one of the designated triggers. This rule replaces the older and less versatile "Trigger Rule".

'''Properties:'''
'''Accept all trains <Option Buttons>'''
''-click to accept all trains
''-click to accept trains matching specific criteria and choose from session Assets list''
'''Add Trigger <Click>'''
''-to choose from session list''
'''Trigger only once <Check Box>'''
''-check to set''
'''Wait for child rules to complete even if no trains are present in rule trigger <Checkbox>'''
''-check to set''
'''Only activate when the entering vehicle of the train <Check Box>'''
''click to set''
'''Train Heading <Click>'''
''-to set to forward''
''-to set to backward''

'''Wait on Navigation Point Rule:''' Waits for a navigation point to be completed then the following child rules will be executed

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

'''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start

'''Properties:'''
'''Trigger rule once <Check Box>'''
''-check to set''
'''Wait for a train that matches the following criteria to <Click>'''
''-to set start moving''
''-to to stop moving''
'''Accept all trains <Option Buttons>'''
''-click to accept all trains''
''-click to accept trains matching specific criteria and choose from session list''

=='''Driver Rules'''==

'''Control Type Rule''' Sets control type

'''Properties:'''
Current control method is: Easy Mode, Choice one of the three

'''Control Check Rule:''' Activates child rules based on the control method changes

'''Properties:'''
'''Excite child rules when: <Option Buttons>'''
''-DCC mode is Selected''
''-Cab mode is Selected''
'''Execute child rules: <Option Buttons>'''
''-Every time control method is set''
''-Once only''

'''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule

'''Properties:'''
'''Portal index from PCP <Click>'''
''-to enter (Un)Portal Index''
'''Use UnPortal <Click>'''
''-to select Yes or No''
'''Delay from Trigger to Emit <Click>'''
''-to set number of seconds''
'''Add Trigger <Click>'''
''-to add Trigger from Session List''

'''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry

'''Properties:'''
'''Load/unload <click>'''
''-to set to Disable or enable''
'''Which Industry? <click>'''
''-to set Industry from Session List''
'''Which Vehicles <Option Buttons>'''
-''Apply to every vehicle in the session''
-''Apply only to a specific vehicles from Session List''

'''Driver Command Rule:''' Specify which commands will be available for the drivers

'''Properties''':
Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.
Navigate To TrackMarkList V2- No description.
Navigate To Station V2- No description.
Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.
Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.
Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.
Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.
Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.
Drive To Station V2- No description.
Drive To Track mark List V2- No description.
Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.
Drive To Industry- Drive to a specific industry.
Change Destination Sign-Changes the destination signs of a train.

WaitFor- Pauses the driver's schedule for a set duration of time.
Wait For Random- TRS2008: Wait for specified or optionally random period of time.
Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).
WaitUntil- No description.

VR Set Train Lamps-Driver command that sets the train lamps.
Notify- Notifies the player of schedule progress/completion.
Reverse Tram- Reverse a tram(max 2 cars).
Couple- Couple train to designate vehicle.
Decouple- Decouples the train at the specified vehicle.
UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).
Halt Train- Brings the train to a complete stop.
Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.
Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger
station before using this command.
Cab: Wait-Maintains current control state until some condition is met.
Delete Train- Causes the train and its driver to be deleted from the session.
Hornz- Driver sounds the train horn.
Cab: Set Control-Sets a cab mode control.
Headlights On/Off-Allows the driver to to switch the headlights on and off.
Interior Lights Command- Driver command to switch interior lights on or off for the current train.
Set Max Speed To- No description.

Release Junction - Lets a driver release the junction they have been holding.
Move Turntable- TRS2008: Move turntable to a stop point .

Load- Loads the train's vehicles at the industry the driver is currently at with the train.
Unload- Unload train vehicles at current industry location.
Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.
Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.
Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.

'''Driver Command Check Rule:''' Verifies the driver commands of a driver character

'''Properties'''
'''Trigger rule once <Click>'''
''-to set''
'''Driver character to watch the command list of <Click.'''
''to select Driver from Session List''
'''Wait for driver character to have a command list that matches this:''' add driver, all, delete all
'''Add Driver Command <Select>'''
''-to add a Driver Command''
'''Add all <Click>'''
''Click to add all Driver Commands''
'''Delete all <Click>'''
''-to delete Driver Command List''

'''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar

'''Properties'''
'''The Driver Main Bar <Click>'''
''-to Show or Hide''

'''Driver Schedule Rule''' Execution of basic scheduled commands

'''Properties:'''
'''Driver Schedule Rule assigned to <Click>
''-to name driver from Session List''
'''Commands <Click>'''
''-to insert driver commands in Drive Schedule''
'''Style: <Option Buttons>'''
''-Classic style: If there is a schedule do not emit a new schedule''
''-Killer style: If there is a schedule clean it and emit a new one''
''-Cooperative style: If there is a schedule append the new one''
''-Active style: Emit a new schedule, only if already a schedule running''

'''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders

'''Properties'''
'''The following drivers will be available <click>'''
''-To add Driver, Driver Commands, Assets, Type of Engineer, or Remove Driver''
'''Remove all existing Drivers first <Check Box>'''
''-to set''
'''Generate new Drivers for empty Trains <Check Box>'''
''-to set''

'''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers

'''Properties'''

Train criteria fill in all trains
Train criteria list train only trains matching criteria

'''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted

'''Properties'''
Config/txt file tag 'max_permitted_speed-60850 in mph or kph
Add to config.txt and kuid-table for value <KUID2:60850:88000:4
Note: Old root level config tag will

'''QuickDrive Rule:''' Change the Session settings and add consists in Driver

'''Properties'''
Set Time to insert time
QuickDrive Consist Option List by
Rate of Change insert rate as number times
Enable gameplay Session Mode check
Enable in game help by default check
Set the default Control method to fill-in choose: Easy Mode, Realistic Mode
Prevent player from changing this check
Realistic mode requires achievement add Achievement's Name
In Asset choose Auran achievements
Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic
Prevent player from changing 10.0 check
Set the default units to fill-in choose: Imperial, Metric, Default
Open QuickDriver Window when check

'''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train

'''Properties'''
Note: One or the other fill-ins must be
Accept trains matching specific criteria fill-in to select from session list
Accept all trains fill-in to set
Trigger rule once check to set
Wait for a driver character to get ? a click to select: On, Off

'''Wait for Driver/Train to be Locally Owned Rule:''' Waits for a specific driver or train car to be locally owned, Owned then executes child rules. If the driver/train car becomes unowned again the child rules are paused

'''Properties'''
Wait for ownership of a specific Driver fill-in to set
Wait for ownership of Driver fill-in to set
Note: One or the other fill-in must be
Driver or Vehicle click to choose from session lists

=='''Arrangement of Session Rules:'''==

'''Ordered List Rule:''' Child rules will be executed in order once this rule starts

'''Properties'''
One of the following options must be chosen
'''(Option button) This process will repeat ''<value>'' time(s)''' - enter the number of times this rule is to be repeated
'''(Option button) This process will repeat forever'''

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

'''Properties'''
'''After last child has been executed ...'''
'''''<successive runs will do nothing/the first child is chosen again>''''' - click to select one

'''Random List Rule:''' One of the child rules indented under this rule will be randomly selected and executed. The rule will not repeat to randomly select another child rule

'''Properties'''
None

'''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle

'''Properties'''
None

'''Simultaneous List Rule:''' Child rules are executed simultaneously once this rule starts

'''Properties'''
'''Rule completes when ...'''
'''''<one of the child rules has completed/all child rules have reached a completed state/all child rules have reached a "was completed" state>''''' - click to select one

=='''Camera Rules:'''==

'''Cinematic Camera Rule:''' Provides several different cinematic style cameras

'''Properties'''
Lock camera controls for the duration check
Prevent rain control for duration check
Camera target: name any of the many objects in session
Camera mode: Stationary, Circle fill-in
Initial camera values: Pitch, Yaw, Zoom value
Total time to animate: seconds value

'''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties

'''Properties'''
Change the camera view mode to check to choose: Cab View, External View, Tracking
View, Free Roaming
Vehicle fill-in choose from session vehicles
Set the camera flags to enable/disable check to choose different properties from list
Junction fill-in choose from session junctions
Set the target objet of the camera to check
Map object fill-in choose from map objects

'''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view

'''Properties'''
Trigger rule once check to set
Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking
View, Free Roaming View
Wait for the camera to target vehicle ? click to choose form session list

=='''Message Rules:'''==

'''Close Message Popup Rule:''' Closes open message popups

'''Properties:'''
None
'''Known Issues:'''
This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule

'''Custom Script Rule:'''

'''Properties'''
None.

'''Display Custom HUD Rule:''' Show or hide the Custom Heads Up Display.

'''Properties'''
Show the Custom Heads up Display- fill-in to choose.
Hide the Custom Heads up Display- fill-in to choose.
Note: One or the other will be chosen by default.

'''Wait for Click on HUD Icon Rule:'''

'''Properties'''
Trigger rule once-check to choose.
HUD Panel- click to choose from list.
Wait for click on- click to choose; choice depends on HUD Panel chosen.

'''Display HTML Pages Rule:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.

'''Properties'''
Add Page- click on to choose from list; click to Add Page Name or Remove.
Add All- click to add all files from the designated assets.
Delete All- delete all files from this property list.
Prevent user from exiting browser until all pages viewed- check to choose.
Disable closing of browser window by user- check to choose.
Disable browser window scrolling- check to choose.
Make browser window invisible- check to choose.
Set position-Under Construction!!!- check to choose.
Set size-Under Construction!!!- check to choose.
Use the page- click to choose Insert Page Name.
From asset HTML- click to choose from list.

'''Timed limited display HTML Rule:''' Displays an html browser window for a limited time.

'''Properties'''
HTML Asset Name-

'''Display Video Rule:''' Displays a page from a HTML assets in a browser window.

'''Properties'''

'''End Session Rule:''' End Session without saving.

'''Properties'''

'''Fade in/out Rule:''' Fade in or out within seconds, color and opacity considered.

'''Properties'''

'''Flash HUD Icon Rule:''' Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.

'''Properties'''

'''Generic Tree Node Debug Window Rule:''' No description.

'''Properties'''

'''InputTable Rule:''' Creating a list of message names to be used for various purposes.

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

'''Properties'''
'''[Check Box] Pause game while message is displayed''' - stops the game until this message is switched off
'''[Check Box] Close previous popup windows''' - closes any Message Popups currently displayed
'''Message location ''<Top Left/Top Right/Bottom Left/Bottom Right>''''' - select one to position the browser window on the screen
'''Message Source'''
'''(Option button) Custom text''' - the simplest and easiest option
'''Icon ''<Click here to set>''''' - shows a list of message icons. Select one to be displayed with the message
'''Icon ''<Clear icon>''''' - clears any currently displayed message icon
'''Custom text box''' Enter text to be displayed. You will be limited to about 6 lines of text.
For longer messages or to include graphics, use the '''A predefined HTML page''' option.
'''(Option button) 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.
'''(Option button) 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.

'''Minimap Options Rule:''' Sets the display options for the minimap.

'''Properties'''

'''Play Sound Rule:''' Plays a wav sound file.

'''Properties'''

'''Session Debug Rule Rule:''' Executes the first child if debug mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.

'''Properties'''

'''Session Metadata Rule:''' Sets session metadata in the config file. Info can be read by other systems and displayed to the player.

'''Properties'''

'''Set Helper Icon Size Rule:''' Sets the size of helper icons such as the junction lever arrows.

'''Properties'''

'''Set HTML Page Rule:''' Instructs the Display HTML Pages rule to perform specific operations

'''Properties'''

'''Show/Hide HUD Panel Rule:''' Shows or hides a HUD panel.

'''Properties'''

'''Show/Hide Layer Rule:''' Shows or hides a layer from Driver.

'''Properties:'''
'''Show/Hide''' - select one
'''click here to set''' - enter name of layer. Name is case sensitive.

'''Known Bugs:'''
TANE (all versions) - layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded

'''Show/Hide Minimap Rule:''' Shows the Driver the minimap window.

'''Properties'''
'''Minimap Window'''-click to choose Show,Hide

'''Show/hide on-screen help Rule:''' Shows or hides On-screen help in Driver.

'''Properties'''
'''Junction Overlays:''' - fill-in to choose: Show, Hide, Leave unchanged. by default one is chosen
'''On Screen Vehicle Name:''' - Fill-in to choose: Show, Hide, Leave unchanged. By default one is chosen

'''Wait for Click on HUD Icon Rule:''' Waits for a click on the HUD Icon.

'''Properties'''
'''(Check Box) Trigger Once:''' -to choose
'''HUD Panel:''' - Click to choose from list: Bottom Right Menu, Camera Controls, DCC Controls
'''Icon:''' - Choose from list. Selections depends on HUD Panel chosen

'''Wait on Waybill Screen/Main Screen Rule:''' Waits for the Waybill window to be opened.

'''Properties'''

=='''Startup Rules:'''==

'''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.

'''Properties'''

'''Startup Options Rule''' Specifies the starting options for the session.

'''Properties'''

=='''Time Rules:'''==

'''Clock Rule:''' Rule needed for animated clocks, you need to apply this rule to your session to make use of the animated clocks, see forum for code to include in you clock object to work with this rule.

'''Properties'''

'''Timecheck Rule:''' Executes child rules at a set time.

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

'''Timing Check Rule:''' Triggers sub rules if called within the time window specified.

'''Properties'''

'''Wait Rule:''' Wait for number of seconds'

'''Properties'''

=='''Variable Rules:'''==

'''Variable Check Rule:''' If the specified variable matches the specified conditions then the child rules will be executed in order.

'''Properties'''
'''''<variable-name>''''' - enter a variable-name. Variable name is case sensitive.
'''''<is less than/is less than or equal to/is equal to/is greater than or equal to/is greater than/is not equal to/is between x and y>''''' - select one
'''''<This condition will be evaluated only once .../This condition will be evaluated once every second>''''' - click to select one
'''Test condition option: is between x and y''' - Enter minimum (x) and maximum (y) test values
'''Test condition option: (all other options)''' - Enter test value
'''Evaluation option: 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
'''Evaluation option: This condition will be evaluated evaluated once every second''' - the rule will be rerun and the variable rechecked every second

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

'''Properties'''
'''Change ''<Add to variable/Subtract from variable/Change variable>''''' - select one
'''[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.
'''Change option: 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.
'''Change option: 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 option: 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.

'''Variable Modify Continuous Rule:''' Adds, subtracts or sets a value to a specified variable every second.

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

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

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

Variables are saved in the session file and persist from one saved game to another.
They can be accessed/modified by the following '''driver commands''':

'''Driver Commands by trev999:'''
'''Set S-Variable driver command: '''
'''Skip if session-variable driver command: '''
'''Wait until S-variable driver command: '''

'''Driver Commands by atilabarut'''
'''ChangeSVariables driver command: '''
'''WaitUntilSVariable driver command: '''

=='''Weather Rules:'''==

'''EIRS Weather Rule NE USA Rule:''' Customize random weather rule relative to the North East Region of the United States.

'''Properties'''

'''Weather Rule:''' Set the weather conditions.

'''Properties'''

Session Rules By Categories With Properties

2017-09-28T16:33:38Z

Coop2:

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

=='''Achievement Rules'''==

'''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement

'''Properties:'''
None

'''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload

'''Properties:'''
'''Target object''' ?? name of object such as Power Station, Coal Pit or Portal
'''Lock train's controls'''- checked during a stopped load/unload operation
'''Override 'begin load' and 'begin unload' '''- checked # of seconds to override

'''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations

'''Properties:'''
'''<Click to Select>'''- Trigger from Session List.
'''<Click to Select>'''- Industry from Session List
'''<Option Buttons>'''
-Choose to accept all trains.
-Accept trains matching specific criteria of Assets from Session List

'''Power Station Rule:''' Sets up Station and Consumers

'''Properties:'''
'''<Click to Select>'''- from Session Stations.
'''<Click to Select>'''- Consumers(Add Object) choose from Session List

'''Resource Check Rule:''' Check the progress of the amount of a resource and target object

'''Properties:'''
'''<Option Buttons>'''
-Watch industry queue
-Watch vehicle
'''Note:''' Both have: Target Object, Queue:'''
'''Complete when designated queue <Option Buttons>'''
''-equals or exceeds required amount''
''-falls below required amount''

'''Multiple Resource Check Rule:''' If specified resources in a selected industry or vehicle reaches set levels, then the following child rules will be executed

'''Properties:'''
'''''<Reach-Exceed/Fall below>'':''' - click to select one
'''''<value>'':''' - enter required quantity value
'''''<Click to 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. For each object:-
'''''<Object>'':''' - click to select session active industry or product enabled rail vehicle
'''''<Queue>'':''' - select product queue (there may be only one available)
'''''<Remove''>:''' - removes the object and its product queue from the rule
'''Notes:'''
'''''Reach/Exceed''''' - sets an upper limit for the resource 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 resource 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.

'''Objective Add Rule:''' Sets up a game Objective with ID and display Name

'''Properties:'''
'''Priority <Click to Select>'''
''-Above Normal:''
''-Below Normal:''
''-Normal:''
''-Optional:''
''-Urgent:''
'''Completion Target Number <Click>'''
''-to set Completion Target Number''
'''Icon <Click>'''
''-to select Icon from list''
'''Display Name <Click>'''
''-to insert Name''
'''Unique Objective ID <Click>'''
''-to set ID''
'''Custom Message <Text Box>'''
''-insert typed message in text area''

'''Objective Check Rule:''' Executes child rules when objective is complete

'''Properties:'''
'''Unique Objective ID <Click>'''
''insert ID number''
'''Mode <click>'''
''-Wait for completion''
''-Wait for failure''
''-Wait for progress''

'''Objective Update Rule:''' Changes progress outcome according to Property choices

'''Properties:'''
'''Unique Objective ID <Click>'''
''-set ID number''
'''Mode <Click to Set Objective>'''
''-Decrement progress''
''-Increment progress''
''-Reset Objective''
''-Set objects as complete''
''-Set objects as failed''
''-Set progress''
''-Set progress only if greater''
'''Amount <Click>'''
''-insert number''

'''Ranked Session Begin Rule:''' Begins a ranked Session

'''Properties:'''
'''Countdown Starting Value <Click to insert>'''
''-hrs''
''-min''
''sec''
'''1 through 5 stars, points for each star <Click>
-insert number of points
'''Session timer mode <Option Buttons>'''
''-Timer''
''-Countdown''
''-None''

'''Ranked Session Complete Rule:''' Completes the active ranked Session

'''Properties:'''
'''Set the active ranked session as <Option Buttons>'''
''-Complete''
''-Failed''
'''Customize the completion message <Text Box>'''
''-insert text message''

'''Session Complete Rule:''' Set session to a percentage of completion

'''Properties:'''
'''Set session to percent complete <Click>'''
''to insert number in percent''
'''Separate achievements for completion <Check Box>
''-check to set''

=='''Danger Rules'''==

'''ATP Speed Limiter Rule:''' Limits speed over set limit

'''Properties:'''
'''Speed limit over the set limit <Click>
''-to set mph''

'''Speeding Check Rule:''' If player controlled trains are over the local speed limit or over a set (custom) speed, then the following child rules will be executed

'''Properties:'''
'''(Option button) Watch for trains travelling above the posted speed limit'''
'''''<speed value>'':''' - click to enter a new overspeed tolerance value
'''''<Kmph/MPH/mps>'':''' - click to select one
'''(Option button) Watch for trains travelling above a custom speed'''
'''''<speed value>'':''' - click to enter a new custom speed value
'''''<Kmph/MPH/mps>'':''' - click to select one
'''Warning: This option is very performance intensive and should only be used in sessions with few trains'''

'''AWS Configuration Rule:''' This rule configures the Trainz implementation of the Automatic Warning System when approaching signals

'''Properties:'''
'''Use modern sound set for unfitted cabs? <Check Box>'''
''check to set''
'''Simulate AWS for unfitted cabs? <Check Box>'''
''-check to set''
'''Passive with HUD hidden <Option Buttons>'''
''-Active''
''-Passive''

'''Wait for Derailment Rule:''' Waits for a derailment to occur

'''Properties:'''
'''Trigger derailment, Watch Once <Check Box>
''-check to set

'''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars after a set time delay

'''Properties:'''
'''''<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.

'''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule

'''Properties:'''
'''(Check box) Respawn trains if they are abandoned for 10 minutes'''
If checked:-
'''(Option button) Respawn trains at their original locations'''
'''(Option button) Respawn trains from portals'''
If '''Respawn trains from portals''' is selected, then:-
'''''<+ Add a new portal>''''' - click to enter the name of a portal, there can be more than one portal.
Entered names that appear in red have not been found in the session

'''Coupler Breakage Check Rule:''' Checks for breaking couplers and, if found, then executes any following child rules.

'''Properties:'''
'''None'''

'''Coupler Breakage HUD Rule:''' HUD displays warning about coupler stress and breakage

'''Properties:'''
'''(Option button) Show the Coupler Breakage Display'''
'''(Option button) Hide the Coupler Breakage Display'''

'''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles

'''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: ''<Locked/Unlocked>''''' - click to select
'''Back: ''<Locked/Unlocked>''''' - click to select
'''Decoupling Mask:'''
'''Front: ''<Locked/Unlocked>''''' - click to select
'''Back: ''<Locked/Unlocked>''''' - click to select
'''''<Remove>'':''' - click to remove that vehicle from the rule

'''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users and, if found, then executes any following child rules.

'''Properties:'''
'''(Check box) Trigger only once:'''

'''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users and, if found, then executes any following child rules.

'''Properties:'''
'''(Check box) Trigger only once:'''

'''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger (stop) and, if found, then executes any following child rules.

'''Properties:'''
'''(Check box) Trigger only once:'''

'''Vehicle Physics Rule:''' Overrides the default vehicle physics properties

'''Properties:'''
'''Accept all trains <Option Button>'''
''-click to set''
'''Cab sway level is <Click>'''
''-to set insert percent of sway''
'''Traction boost is <Click>'''
''-to insert percent of boost while sanding''
'''Traction reduced to <Click>'''
''-to set traction percent''
'''Maximum tractive effort adjusted by <Click>
''-to insert percent amount''
'''Show coupler breakage in HUD Rule <Click>'''
''-to set''
'''Couplers break when coupling above <Click>'''
''-to set speed''
'''Accept trains matching specific criteria <Radio Button>'''
''-set to insert specific train assets''
'''Couplers break at <Click>'''
''-to insert amount of force in kN units''

=='''Navigation Rules'''==

'''DestSignTable Rule:''' Table for creating a table of destination signs

'''Properties:'''
'''Enable Track Marks as destinations <Check Box>'''
''-check to set''
'''Enable table of destinations <Check Box>'''
''-check to set''
'''Import destination from texture-group <Text Box>'''
''-insert name''
'''Enable industries/stations as destination <Check Box>
''-check to set''

'''Interlocking Tower Configure Path''' Alters settings on an interlocking tower path

'''Properties'''
'''Interlocking Tower <Click>'''
''-to set Name and Objects''

'''Interlocking Tower Path Selection UI <CheckBox>''' Will automatically react to messages from Interlocking Towers and display a path selection dialog to the player. Disable by removing rule from session
''-Check(default) to Show path activation message in Driver''

'''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train

'''Properties:'''
'''Interlocking Tower <Click>'''
''-to set Names and Objects''

'''Multiple Junction Alignment Check Rule''' Checks multiple junctions are in alignment

'''Properties:'''
'''Wait until the following junctions are set to its corresponding set state <Click>'''
''-to set to all''
''-set to anyone''
'''Add junction <click>'''
''-to add junction from session list''
'''Add all <Click>'''
''-to all junctions from session list''
'''Delete all <Click>'''
''-to delete all junctions from rule list''

'''Navigation Display Rule:''' Creates a set of navigation points. Multiple sets can be created by adding additional copies of this rule. This rule creates the navigation set, it does not display it. Use the '''Navigation set hide/show rule''' to make a set visible. Navigation sets can be completed (terminated) by the '''Navigation Set Clear Rule''', individual navigation points can be ''manually'' completed by the '''Navigation Point Complete Rule'''. Click the help icon at the top of the properties box for in game instructions.

'''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.
'''Navigation mode:''' - select one option
'''(Option button) 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.
'''(Option button) 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.
'''(Option button) 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 (a trigger, trackmark, track object or rolling stock asset) 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'': ''<Automatic/Manual/Require Stop>''''' - click to select one
'''''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''' 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.

'''Navigation Point Complete Rule:''' Manually completes a navigation point in a set

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

'''Navigation Set Check Rule:''' Checks if a navigation set is complete or incomplete, if so then the following child rules will be executed

'''Properties:'''
'''Checks if navigation point set ''<click to select>'':''' - 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.

'''Navigation Set Clear Rule:''' Clears a navigation set removing any uncompleted navigation points

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

'''Navigation Set Hide/Show:''' Shows and hides navigation sets. You can have multiple sets visible and hidden at the same time.

'''Properties:'''
'''''<Hide/Show>'':''' - click to select one
'''''<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.

'''Schedule Rule:''' Allows a schedule of timed events to be applied to a train

'''Properties:'''
Insert track mark click to select from session list
Note: Both has an arrival and departure set time hr:min:sec
Current Train click to select from session list
Insert destination click to select from session list

'''Set Junctions Rule:''' Sets the selected junctions to a specific state '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''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:-
'''''<Left/Center/Right/Don't change>''''' - click to set the junction direction
'''''<Locked/Unlocked>''''' - click to select. '''Locked''' means the junction setting cannot be changed by the user
'''''<Allows AI control/Blocks AI control>''''' - click to select
'''''Remove''''' - click to remove that junction from the rule list

'''Set Signal Extended Rule:''' Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''Properties:'''
'''''Select signal''''' - click to select a signal from the session list
'''''<signal state>''''' - click to select a state from the list

'''Trigger Check Rule:''' - Waits for any train to enter one of the designated triggers. This rule replaces the older and less versatile "Trigger Rule".

'''Properties:'''
'''Accept all trains <Option Buttons>'''
''-click to accept all trains
''-click to accept trains matching specific criteria and choose from session Assets list''
'''Add Trigger <Click>'''
''-to choose from session list''
'''Trigger only once <Check Box>'''
''-check to set''
'''Wait for child rules to complete even if no trains are present in rule trigger <Checkbox>'''
''-check to set''
'''Only activate when the entering vehicle of the train <Check Box>'''
''click to set''
'''Train Heading <Click>'''
''-to set to forward''
''-to set to backward''

'''Wait on Navigation Point Rule:''' Waits for a navigation point to be completed then the following child rules will be executed

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

'''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start

'''Properties:'''
'''Trigger rule once <Check Box>'''
''-check to set''
'''Wait for a train that matches the following criteria to <Click>'''
''-to set start moving''
''-to to stop moving''
'''Accept all trains <Option Buttons>'''
''-click to accept all trains''
''-click to accept trains matching specific criteria and choose from session list''

=='''Driver Rules'''==

'''Control Type Rule''' Sets control type

'''Properties:'''
Current control method is: Easy Mode, Choice one of the three

'''Control Check Rule:''' Activates child rules based on the control method changes

'''Properties:'''
Excite child rules when: DCC mode is fill-in one or the other
Excite child rules: Every time control fill-in one or the other

'''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule

'''Properties:'''
Trigger add Trigger
Portal index from PCP value
Use UnPortal yes/no
Delay from Trigger to Emit: seconds value

'''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry

'''Properties:'''
Apply to every vehicle in the session fill-in
Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles
Note: One of the Applies will always be
Load/Unload for industry Disable/Enable choose Industry

'''Driver Command Rule:''' Specify which commands will be available for the drivers

'''Properties''':
Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.
Navigate To TrackMarkList V2- No description.
Navigate To Station V2- No description.
Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.
Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.
Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.
Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.
Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.
Drive To Station V2- No description.
Drive To Track mark List V2- No description.
Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.
Drive To Industry- Drive to a specific industry.
Change Destination Sign-Changes the destination signs of a train.

WaitFor- Pauses the driver's schedule for a set duration of time.
Wait For Random- TRS2008: Wait for specified or optionally random period of time.
Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).
WaitUntil- No description.

VR Set Train Lamps-Driver command that sets the train lamps.
Notify- Notifies the player of schedule progress/completion.
Reverse Tram- Reverse a tram(max 2 cars).
Couple- Couple train to designate vehicle.
Decouple- Decouples the train at the specified vehicle.
UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).
Halt Train- Brings the train to a complete stop.
Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.
Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger
station before using this command.
Cab: Wait-Maintains current control state until some condition is met.
Delete Train- Causes the train and its driver to be deleted from the session.
Hornz- Driver sounds the train horn.
Cab: Set Control-Sets a cab mode control.
Headlights On/Off-Allows the driver to to switch the headlights on and off.
Interior Lights Command- Driver command to switch interior lights on or off for the current train.
Set Max Speed To- No description.

Release Junction - Lets a driver release the junction they have been holding.
Move Turntable- TRS2008: Move turntable to a stop point .

Load- Loads the train's vehicles at the industry the driver is currently at with the train.
Unload- Unload train vehicles at current industry location.
Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.
Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.
Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.

'''Driver Command Check Rule:''' Verifies the driver commands of a driver character

'''Properties'''
Wait for driver character to have add driver, all, delete all
Trigger Rule once check
Driver character to watch the name driver

'''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar

'''Properties'''
The Driver Main Bar choice show/hide

'''Driver Schedule Rule''' Execution of basic scheduled commands

'''Properties:'''
Note: Only one of the fill-in can be
Driver Schedule Rule assigned to name driver
Commands insert driver commands in Drive Schedule
Classic style: If there is a schedule fill-in
Killer style: If there is a schedule fill-in
Cooperative style: If there is a schedule fill-in
Active style: Emit a new schedule, only fill-in

'''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders

'''Properties'''
Generate new Drivers for empty check
The following drivers will be available Driver's Name Add
Remove all existing Drivers first check

'''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers

'''Properties'''
Assign Driver commands check Driver Commands
Train criteria fill in all trains
Train criteria list train only trains matching criteria

'''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted

'''Properties'''
Config/txt file tag 'max_permitted_speed-60850 in mph or kph
Add to config.txt and kuid-table for value <KUID2:60850:88000:4
Note: Old root level config tag will

'''QuickDrive Rule:''' Change the Session settings and add consists in Driver

'''Properties'''
Set Time to insert time
QuickDrive Consist Option List by
Rate of Change insert rate as number times
Enable gameplay Session Mode check
Enable in game help by default check
Set the default Control method to fill-in choose: Easy Mode, Realistic Mode
Prevent player from changing this check
Realistic mode requires achievement add Achievement's Name
In Asset choose Auran achievements
Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic
Prevent player from changing 10.0 check
Set the default units to fill-in choose: Imperial, Metric, Default
Open QuickDriver Window when check

'''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train

'''Properties'''
Note: One or the other fill-ins must be
Accept trains matching specific criteria fill-in to select from session list
Accept all trains fill-in to set
Trigger rule once check to set
Wait for a driver character to get ? a click to select: On, Off

'''Wait for Driver/Train to be Locally Owned Rule:''' Waits for a specific driver or train car to be locally owned, Owned then executes child rules. If the driver/train car becomes unowned again the child rules are paused

'''Properties'''
Wait for ownership of a specific Driver fill-in to set
Wait for ownership of Driver fill-in to set
Note: One or the other fill-in must be
Driver or Vehicle click to choose from session lists

=='''Arrangement of Session Rules:'''==

'''Ordered List Rule:''' Child rules will be executed in order once this rule starts

'''Properties'''
Note: One of the two must be chosen
This process will repeat fill-in click to add number of repeats
This process will repeat forever fill-in

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

'''Properties'''
After last child run is executed click to choose: First child is chosen again, It will be
used for all successive runs, Successive runs will
do nothing

'''Random List Rule:''' One of the child rules indented under this rule will be randomly selected and executed

'''Properties'''
executed randomly
Once one of the child rule is ??

'''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle

'''Properties'''
None

'''Simultaneous List Rule:''' Child rules are executed simultaneously once this rule starts

'''Properties'''
Rules completes when click choose all rules have reached completed state,
was completed state

=='''Camera Rules:'''==

'''Cinematic Camera Rule:''' Provides several different cinematic style cameras

'''Properties'''
Lock camera controls for the duration check
Prevent rain control for duration check
Camera target: name any of the many objects in session
Camera mode: Stationary, Circle fill-in
Initial camera values: Pitch, Yaw, Zoom value
Total time to animate: seconds value

'''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties

'''Properties'''
Change the camera view mode to check to choose: Cab View, External View, Tracking
View, Free Roaming
Vehicle fill-in choose from session vehicles
Set the camera flags to enable/disable check to choose different properties from list
Junction fill-in choose from session junctions
Set the target objet of the camera to check
Map object fill-in choose from map objects

'''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view

'''Properties'''
Trigger rule once check to set
Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking
View, Free Roaming View
Wait for the camera to target vehicle ? click to choose form session list

=='''Message Rules:'''==

'''Close Message Popup Rule:''' Closes open message popups

'''Properties:'''
None
'''Known Issues:'''
This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule

'''Custom Script Rule:'''

'''Properties'''
None.

'''Display Custom HUD Rule:''' Show or hide the Custom Heads Up Display.

'''Properties'''
Show the Custom Heads up Display- fill-in to choose.
Hide the Custom Heads up Display- fill-in to choose.
Note: One or the other will be chosen by default.

'''Wait for Click on HUD Icon Rule:'''

'''Properties'''
Trigger rule once-check to choose.
HUD Panel- click to choose from list.
Wait for click on- click to choose; choice depends on HUD Panel chosen.

'''Display HTML Pages Rule:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.

'''Properties'''
Add Page- click on to choose from list; click to Add Page Name or Remove.
Add All- click to add all files from the designated assets.
Delete All- delete all files from this property list.
Prevent user from exiting browser until all pages viewed- check to choose.
Disable closing of browser window by user- check to choose.
Disable browser window scrolling- check to choose.
Make browser window invisible- check to choose.
Set position-Under Construction!!!- check to choose.
Set size-Under Construction!!!- check to choose.
Use the page- click to choose Insert Page Name.
From asset HTML- click to choose from list.

'''Timed limited display HTML Rule:''' Displays an html browser window for a limited time.

'''Properties'''
HTML Asset Name-

'''Display Video Rule:''' Displays a page from a HTML assets in a browser window.

'''Properties'''

'''End Session Rule:''' End Session without saving.

'''Properties'''

'''Fade in/out Rule:''' Fade in or out within seconds, color and opacity considered.

'''Properties'''

'''Flash HUD Icon Rule:''' Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.

'''Properties'''

'''Generic Tree Node Debug Window Rule:''' No description.

'''Properties'''

'''InputTable Rule:''' Creating a list of message names to be used for various purposes.

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

'''Properties'''
'''(Check Box) Pause game while message is displayed:''' - stops the game until this message is switched off
'''(Check Box) Close previous popup windows:''' - closes any Message Popups currently displayed
'''Message location: ''<Top Left/Top Right/Bottom Left/Bottom Right>''''' - select one to position the browser window on the screen
'''Message Source:'''
'''(Option button) Custom text:''' - the simplest and easiest option
'''Icon: ''<Click here to set>''''' - shows a list of message icons. Select one to be displayed with the message
'''Icon: ''<Clear icon>''''' - clears any currently displayed message icon
'''Custom text box:''' Enter text to be displayed. You will be limited to about 6 lines of text. For longer messages or to include graphics, use the '''A predefined HTML page''' option.
'''(Option button) 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.
'''(Option button) 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.

'''Minimap Options Rule:''' Sets the display options for the minimap.

'''Properties'''

'''Play Sound Rule:''' Plays a wav sound file.

'''Properties'''

'''Session Debug Rule Rule:''' Executes the first child if debug mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.

'''Properties'''

'''Session Metadata Rule:''' Sets session metadata in the config file. Info can be read by other systems and displayed to the player.

'''Properties'''

'''Set Helper Icon Size Rule:''' Sets the size of helper icons such as the junction lever arrows.

'''Properties'''

'''Set HTML Page Rule:''' Instructs the Display HTML Pages rule to perform specific operations

'''Properties'''

'''Show/Hide HUD Panel Rule:''' Shows or hides a HUD panel.

'''Properties'''

'''Show/Hide Layer Rule:''' Shows or hides a layer from Driver.

'''Properties:'''
'''Show/Hide''' - select one
'''click here to set''' - enter name of layer. Name is case sensitive.

'''Known Bugs:'''
TANE (all versions) - layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded

'''Show/Hide Minimap Rule:''' Shows the Driver the minimap window.

'''Properties'''
'''Minimap Window'''-click to choose Show,Hide

'''Show/hide on-screen help Rule:''' Shows or hides On-screen help in Driver.

'''Properties'''
'''Junction Overlays:''' - fill-in to choose: Show, Hide, Leave unchanged. by default one is chosen
'''On Screen Vehicle Name:''' - Fill-in to choose: Show, Hide, Leave unchanged. By default one is chosen

'''Wait for Click on HUD Icon Rule:''' Waits for a click on the HUD Icon.

'''Properties'''
'''(Check Box) Trigger Once:''' -to choose
'''HUD Panel:''' - Click to choose from list: Bottom Right Menu, Camera Controls, DCC Controls
'''Icon:''' - Choose from list. Selections depends on HUD Panel chosen

'''Wait on Waybill Screen/Main Screen Rule:''' Waits for the Waybill window to be opened.

'''Properties'''

=='''Startup Rules:'''==

'''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.

'''Properties'''

'''Startup Options Rule''' Specifies the starting options for the session.

'''Properties'''

=='''Time Rules:'''==

'''Clock Rule:''' Rule needed for animated clocks, you need to apply this rule to your session to make use of the animated clocks, see forum for code to include in you clock object to work with this rule.

'''Properties'''

'''Timecheck Rule:''' Executes child rules at a certain time.

'''Properties'''

'''Timing Check Rule:''' Triggers sub rules if called within the time window specified.

'''Properties'''

'''Wait Rule:''' Wait for number of seconds'

'''Properties'''

=='''Variable Rules:'''==

'''Variable Check Rule:''' If the specified variable matches the specified conditions then the child rules will be executed in order.

'''Properties'''
'''''<variable-name>''''' - enter a variable-name. Variable name is case sensitive.
'''''<test-condition>''''' - '''is less than/is less than or equal to/is equal to/is greater than or equal to/is greater than/is not equal to/is between x and y''' - select one
'''''This condition will be evaluated only once .../This condition will be evaluated once every second''''' - click to select one
'''Test condition option: is between x and y'''
Enter minimum (x) and maximum (y) test values

'''Test condition option: (all other options)'''
Enter test value

'''Evaluation option: 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

'''Evaluation option: This condition will be evaluated evaluated once every second''' - the rule will be run and the variable rechecked every second

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

'''Properties'''
'''Change: Add to variable/Subtract from variable/Change variable''' - select one
'''(optional check box) Set the minimum value''' of ''<variable-name>'' to ''<value>'' - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.
('''optional check box) Set the maximum value''' of ''<variable-name>'' to ''<value>'' - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.

'''Change option: 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.

'''Change option: 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 option: Change variable'''
'''Change variable ''<variable-name>'' to ''<value>''''' - enter variable-name, enter new value. This cannot be undone if the rule is stopped. Variable-name is case sensitive.

'''Variable Modify Continuous Rule:''' Adds, subtracts or sets a value to a specified variable every second.

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

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

'''Properties'''
'''Check box: Add'''
''<variable-name>'' - enter variable-name. 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. Variable-name is case sensitive.

Variables are saved in the session file and persist from one saved game to another.
They can be accessed/modified by the following '''driver commands''':

'''Driver Commands by trev999:'''
'''Set S-Variable driver command: '''
'''Skip if session-variable driver command: '''
'''Wait until S-variable driver command: '''

'''Driver Commands by atilabarut'''
'''ChangeSVariables driver command: '''
'''WaitUntilSVariable driver command: '''

=='''Weather Rules:'''==

'''EIRS Weather Rule NE USA Rule:''' Customize random weather rule relative to the North East Region of the United States.

'''Properties'''

'''Weather Rule:''' Set the weather conditions.

'''Properties'''

Session Rules By Categories With Properties

2017-09-28T15:57:42Z

Coop2:

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

=='''Achievement Rules'''==

'''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement

'''Properties:'''
None

'''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload

'''Properties:'''
'''Target object''' ?? name of object such as Power Station, Coal Pit or Portal
'''Lock train's controls'''- checked during a stopped load/unload operation
'''Override 'begin load' and 'begin unload' '''- checked # of seconds to override

'''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations

'''Properties:'''
'''<Click to Select>'''- Trigger from Session List.
'''<Click to Select>'''- Industry from Session List
'''<Radio Buttons>'''
-Choose to accept all trains.
-Accept trains matching specific criteria of Assets from Session List

'''Power Station Rule:''' Sets up Station and Consumers

'''Properties:'''
'''<Click to Select>'''- from Session Stations.
'''<Click to Select>'''- Consumers(Add Object) choose from Session List

'''Resource Check Rule:''' Check the progress of the amount of a resource and target object

'''Properties:'''
'''<Radio Buttons>'''
-Watch industry queue
-Watch vehicle
'''Note:''' Both have: Target Object, Queue: click to choose
'''<Radio Buttons>'''- Complete when designated queue
-equals or exceeds required amount
-falls below required amount

'''Multiple Resource Check Rule:''' If specified resources in a selected industry or vehicle reaches set levels, then the following child rules will be executed

'''Properties:'''
'''''<Reach-Exceed/Fall below>'':''' - click to select one
'''''<value>'':''' - enter required quantity value
'''''<Click to 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. For each object:-
'''''<Object>'':''' - click to select session active industry or product enabled rail vehicle
'''''<Queue>'':''' - select product queue (there may be only one available)
'''''<Remove''>:''' - removes the object and its product queue from the rule
'''Notes:'''
'''''Reach/Exceed''''' - sets an upper limit for the resource 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 resource 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.

'''Objective Add Rule:''' Sets up a game Objective with ID and display Name

'''Properties:'''
'''Priority <Click to Select>'''
''-Above Normal:''
''-Below Normal:''
''-Normal:''
''-Optional:''
''-Urgent:''
'''Completion Target Number <Click to Select>'''
''-sets Completion Target Number''
'''Icon <Click to Select>'''
''- select Icon from list''
'''Display Name <Click to Insert>'''
''-insert Name''
'''Unique Objective ID <Click to Set>'''
''-set ID''
'''Custom Message <Text Box>'''
''-insert typed message in text area''

'''Objective Check Rule:''' Executes child rules when objective is complete

'''Properties:'''
'''Unique Objective ID <Click>'''
''insert ID number''
'''Mode <click>'''
''-Wait for completion''
''-Wait for failure''
''-Wait for progress''

'''Objective Update Rule:''' Changes progress outcome according to Property choices

'''Properties:'''
'''Unique Objective ID <Click>'''
''-set ID number''
'''Mode <Click to Set Objective>'''
''-Decrement progress''
''-Increment progress''
''-Reset Objective''
''-Set objects as complete''
''-Set objects as failed''
''-Set progress''
''-Set progress only if greater''
'''Amount <Click>'''
''-insert number''

'''Ranked Session Begin Rule:''' Begins a ranked Session

'''Properties:'''
'''Countdown Starting Value <Click to insert>'''
''-hrs''
''-min''
''sec''
'''1 through 5 stars, points for each star <Click>
-insert number of points
'''Session timer mode <Radio Button>'''
''-Timer''
''-Countdown''
''-None''

'''Ranked Session Complete Rule:''' Completes the active ranked Session

'''Properties:'''
'''Set the active ranked session as <Radio Button>'''
''-Complete''
''-Failed''
'''Customize the completion message <Text Box>'''
''-insert text message''

'''Session Complete Rule:''' Set session to a percentage of completion

'''Properties:'''
'''Set session to percent complete <Click>'''
''insert number in percent''
'''Separate achievements for completion <Check Box>
''-check to set''

=='''Danger Rules'''==

'''ATP Speed Limiter Rule:''' Limits speed over set limit

'''Properties:'''
'''Speed limit over the set limit <Click>
''-to set mph''

'''Speeding Check Rule:''' If player controlled trains are over the local speed limit or over a set (custom) speed, then the following child rules will be executed

'''Properties:'''
'''(Option button) Watch for trains travelling above the posted speed limit'''
'''''<speed value>'':''' - click to enter a new overspeed tolerance value
'''''<Kmph/MPH/mps>'':''' - click to select one
'''(Option button) Watch for trains travelling above a custom speed'''
'''''<speed value>'':''' - click to enter a new custom speed value
'''''<Kmph/MPH/mps>'':''' - click to select one
'''Warning: This option is very performance intensive and should only be used in sessions with few trains'''

'''AWS Configuration Rule:''' This rule configures the Trainz implementation of the Automatic Warning System when approaching signals

'''Properties:'''
'''Use modern sound set for unfitted cabs? <Check Box>'''
''check to set''
'''Simulate AWS for unfitted cabs? <Check Box>'''
''-check to set''
'''Passive with HUD hidden <Radio Button>'''
''-Active''
''-Passive''

'''Wait for Derailment Rule:''' Waits for a derailment to occur

'''Properties:'''
'''Trigger derailment, Watch Once <Check Box>
''-check to set

'''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars after a set time delay

'''Properties:'''
'''''<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.

'''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule

'''Properties:'''
'''(Check box) Respawn trains if they are abandoned for 10 minutes'''
If checked:-
'''(Option button) Respawn trains at their original locations'''
'''(Option button) Respawn trains from portals'''
If '''Respawn trains from portals''' is selected, then:-
'''''<+ Add a new portal>''''' - click to enter the name of a portal, there can be more than one portal.
Entered names that appear in red have not been found in the session

'''Coupler Breakage Check Rule:''' Checks for breaking couplers and, if found, then executes any following child rules.

'''Properties:'''
'''None'''

'''Coupler Breakage HUD Rule:''' HUD displays warning about coupler stress and breakage

'''Properties:'''
'''(Option button) Show the Coupler Breakage Display'''
'''(Option button) Hide the Coupler Breakage Display'''

'''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles

'''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: ''<Locked/Unlocked>''''' - click to select
'''Back: ''<Locked/Unlocked>''''' - click to select
'''Decoupling Mask:'''
'''Front: ''<Locked/Unlocked>''''' - click to select
'''Back: ''<Locked/Unlocked>''''' - click to select
'''''<Remove>'':''' - click to remove that vehicle from the rule

'''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users and, if found, then executes any following child rules.

'''Properties:'''
'''(Check box) Trigger only once:'''

'''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users and, if found, then executes any following child rules.

'''Properties:'''
'''(Check box) Trigger only once:'''

'''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger (stop) and, if found, then executes any following child rules.

'''Properties:'''
'''(Check box) Trigger only once:'''

'''Vehicle Physics Rule:''' Overrides the default vehicle physics properties

'''Properties:'''
'''Accept all trains <Radio Button>'''
''-click to set''
'''Cab sway level is <Click>'''
''-to set insert percent of sway''
'''Traction boost is <Click>'''
''-to insert percent of boost while sanding''
'''Traction reduced to <Click>'''
''-to set traction percent''
'''Maximum tractive effort adjusted by <Click>
''-to insert percent amount''
'''Show coupler breakage in HUD Rule <Click>'''
''-to set''
'''Couplers break when coupling above <Click>'''
''-to set speed''
'''Accept trains matching specific criteria <Radio Button>'''
''-set to insert specific train assets''
'''Couplers break at <Click>'''
''-to insert amount of force in kN units''

=='''Navigation Rules'''==

'''DestSignTable Rule:''' Table for creating a table of destination signs

'''Properties:'''
'''Enable Track Marks as destinations <Check Box>'''
''-check to set''
'''Enable table of destinations <Check Box>'''
''-check to set''
'''Import destination from texture-group <Text Box>'''
''-insert name''
'''Enable industries/stations as destination <Check Box>
''-check to set''

'''Interlocking Tower Configure Path''' Alters settings on an interlocking tower path

'''Properties'''
'''Interlocking Tower <Click>'''
''-to set Name and Objects''

'''Interlocking Tower Path Selection UI <CheckBox>''' Will automatically react to messages from Interlocking Towers and display a path selection dialog to the player. Disable by removing rule from session
''-Check(default) to Show path activation message in Driver''

'''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train

'''Properties:'''
'''Interlocking Tower <Click>'''
''-to set Names and Objects''

'''Multiple Junction Alignment Check Rule''' Checks multiple junctions are in alignment

'''Properties:'''
'''Wait until the following junctions are set to its corresponding set state <Click>'''
''-to set to all''
''-set to anyone''
'''Add junction <click>'''
''-to add junction from session list''
'''Add all <Click>'''
''-to all junctions from session list''
'''Delete all <Click>'''
''-to delete all junctions from rule list''

'''Navigation Display Rule:''' Creates a set of navigation points. Multiple sets can be created by adding additional copies of this rule. This rule creates the navigation set, it does not display it. Use the '''Navigation set hide/show rule''' to make a set visible. Navigation sets can be completed (terminated) by the '''Navigation Set Clear Rule''', individual navigation points can be ''manually'' completed by the '''Navigation Point Complete Rule'''. Click the help icon at the top of the properties box for in game instructions.

'''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.
'''Navigation mode:''' - select one option
'''(Option button) 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.
'''(Option button) 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.
'''(Option button) 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 (a trigger, trackmark, track object or rolling stock asset) 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'': ''<Automatic/Manual/Require Stop>''''' - click to select one
'''''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''' 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.

'''Navigation Point Complete Rule:''' Manually completes a navigation point in a set

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

'''Navigation Set Check Rule:''' Checks if a navigation set is complete or incomplete, if so then the following child rules will be executed

'''Properties:'''
'''Checks if navigation point set ''<click to select>'':''' - 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.

'''Navigation Set Clear Rule:''' Clears a navigation set removing any uncompleted navigation points

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

'''Navigation Set Hide/Show:''' Shows and hides navigation sets. You can have multiple sets visible and hidden at the same time.

'''Properties:'''
'''''<Hide/Show>'':''' - click to select one
'''''<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.

'''Schedule Rule:''' Allows a schedule of timed events to be applied to a train

'''Properties:'''
Insert track mark click to select from session list
Note: Both has an arrival and departure set time hr:min:sec
Current Train click to select from session list
Insert destination click to select from session list

'''Set Junctions Rule:''' Sets the selected junctions to a specific state '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''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:-
'''''<Left/Center/Right/Don't change>''''' - click to set the junction direction
'''''<Locked/Unlocked>''''' - click to select. '''Locked''' means the junction setting cannot be changed by the user
'''''<Allows AI control/Blocks AI control>''''' - click to select
'''''Remove''''' - click to remove that junction from the rule list

'''Set Signal Extended Rule:''' Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''Properties:'''
'''''Select signal''''' - click to select a signal from the session list
'''''<signal state>''''' - click to select a state from the list

'''Trigger Check Rule:''' - Waits for any train to enter one of the designated triggers. This rule replaces the older and less versatile "Trigger Rule".

'''Properties:'''
'''Accept all trains <Radio Button>'''
''-click to accept all trains
''-click to accept trains matching specific criteria and choose from session Assets list''
'''Add Trigger <Click>'''
''-to choose from session list''
'''Trigger only once <Checkbox>'''
''-check to set''
'''Wait for child rules to complete even if no trains are present in rule trigger <Checkbox>'''
''-check to set''
'''Only activate when the entering vehicle of the train <Checkbox>'''
''click to set''
'''Train Heading <Click>'''
''-to set to forward''
''-to set to backward''

'''Wait on Navigation Point Rule:''' Waits for a navigation point to be completed then the following child rules will be executed

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

'''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start

'''Properties:'''
'''Accept all trains <Radio Button>'''
''-click to accept all trains''
''-click to accept trains matching specific criteria and choose from session list''
'''Wait for a train that matches the following criteria to <Click>'''
''-to set start moving''
''-to to stop moving''
Trigger rule once check to set
Note: One or the other fill-ins must be

=='''Driver Rules'''==

'''Control Type Rule''' Sets control type

'''Properties:'''
Current control method is: Easy Mode, Choice one of the three

'''Control Check Rule:''' Activates child rules based on the control method changes

'''Properties:'''
Excite child rules when: DCC mode is fill-in one or the other
Excite child rules: Every time control fill-in one or the other

'''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule

'''Properties:'''
Trigger add Trigger
Portal index from PCP value
Use UnPortal yes/no
Delay from Trigger to Emit: seconds value

'''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry

'''Properties:'''
Apply to every vehicle in the session fill-in
Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles
Note: One of the Applies will always be
Load/Unload for industry Disable/Enable choose Industry

'''Driver Command Rule:''' Specify which commands will be available for the drivers

'''Properties''':
Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.
Navigate To TrackMarkList V2- No description.
Navigate To Station V2- No description.
Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.
Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.
Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.
Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.
Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.
Drive To Station V2- No description.
Drive To Track mark List V2- No description.
Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.
Drive To Industry- Drive to a specific industry.
Change Destination Sign-Changes the destination signs of a train.

WaitFor- Pauses the driver's schedule for a set duration of time.
Wait For Random- TRS2008: Wait for specified or optionally random period of time.
Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).
WaitUntil- No description.

VR Set Train Lamps-Driver command that sets the train lamps.
Notify- Notifies the player of schedule progress/completion.
Reverse Tram- Reverse a tram(max 2 cars).
Couple- Couple train to designate vehicle.
Decouple- Decouples the train at the specified vehicle.
UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).
Halt Train- Brings the train to a complete stop.
Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.
Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger
station before using this command.
Cab: Wait-Maintains current control state until some condition is met.
Delete Train- Causes the train and its driver to be deleted from the session.
Hornz- Driver sounds the train horn.
Cab: Set Control-Sets a cab mode control.
Headlights On/Off-Allows the driver to to switch the headlights on and off.
Interior Lights Command- Driver command to switch interior lights on or off for the current train.
Set Max Speed To- No description.

Release Junction - Lets a driver release the junction they have been holding.
Move Turntable- TRS2008: Move turntable to a stop point .

Load- Loads the train's vehicles at the industry the driver is currently at with the train.
Unload- Unload train vehicles at current industry location.
Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.
Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.
Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.

'''Driver Command Check Rule:''' Verifies the driver commands of a driver character

'''Properties'''
Wait for driver character to have add driver, all, delete all
Trigger Rule once check
Driver character to watch the name driver

'''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar

'''Properties'''
The Driver Main Bar choice show/hide

'''Driver Schedule Rule''' Execution of basic scheduled commands

'''Properties:'''
Note: Only one of the fill-in can be
Driver Schedule Rule assigned to name driver
Commands insert driver commands in Drive Schedule
Classic style: If there is a schedule fill-in
Killer style: If there is a schedule fill-in
Cooperative style: If there is a schedule fill-in
Active style: Emit a new schedule, only fill-in

'''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders

'''Properties'''
Generate new Drivers for empty check
The following drivers will be available Driver's Name Add
Remove all existing Drivers first check

'''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers

'''Properties'''
Assign Driver commands check Driver Commands
Train criteria fill in all trains
Train criteria list train only trains matching criteria

'''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted

'''Properties'''
Config/txt file tag 'max_permitted_speed-60850 in mph or kph
Add to config.txt and kuid-table for value <KUID2:60850:88000:4
Note: Old root level config tag will

'''QuickDrive Rule:''' Change the Session settings and add consists in Driver

'''Properties'''
Set Time to insert time
QuickDrive Consist Option List by
Rate of Change insert rate as number times
Enable gameplay Session Mode check
Enable in game help by default check
Set the default Control method to fill-in choose: Easy Mode, Realistic Mode
Prevent player from changing this check
Realistic mode requires achievement add Achievement's Name
In Asset choose Auran achievements
Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic
Prevent player from changing 10.0 check
Set the default units to fill-in choose: Imperial, Metric, Default
Open QuickDriver Window when check

'''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train

'''Properties'''
Note: One or the other fill-ins must be
Accept trains matching specific criteria fill-in to select from session list
Accept all trains fill-in to set
Trigger rule once check to set
Wait for a driver character to get ? a click to select: On, Off

'''Wait for Driver/Train to be Locally Owned Rule:''' Waits for a specific driver or train car to be locally owned, Owned then executes child rules. If the driver/train car becomes unowned again the child rules are paused

'''Properties'''
Wait for ownership of a specific Driver fill-in to set
Wait for ownership of Driver fill-in to set
Note: One or the other fill-in must be
Driver or Vehicle click to choose from session lists

=='''Arrangement of Session Rules:'''==

'''Ordered List Rule:''' Child rules will be executed in order once this rule starts

'''Properties'''
Note: One of the two must be chosen
This process will repeat fill-in click to add number of repeats
This process will repeat forever fill-in

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

'''Properties'''
After last child run is executed click to choose: First child is chosen again, It will be
used for all successive runs, Successive runs will
do nothing

'''Random List Rule:''' One of the child rules indented under this rule will be randomly selected and executed

'''Properties'''
executed randomly
Once one of the child rule is ??

'''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle

'''Properties'''
None

'''Simultaneous List Rule:''' Child rules are executed simultaneously once this rule starts

'''Properties'''
Rules completes when click choose all rules have reached completed state,
was completed state

=='''Camera Rules:'''==

'''Cinematic Camera Rule:''' Provides several different cinematic style cameras

'''Properties'''
Lock camera controls for the duration check
Prevent rain control for duration check
Camera target: name any of the many objects in session
Camera mode: Stationary, Circle fill-in
Initial camera values: Pitch, Yaw, Zoom value
Total time to animate: seconds value

'''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties

'''Properties'''
Change the camera view mode to check to choose: Cab View, External View, Tracking
View, Free Roaming
Vehicle fill-in choose from session vehicles
Set the camera flags to enable/disable check to choose different properties from list
Junction fill-in choose from session junctions
Set the target objet of the camera to check
Map object fill-in choose from map objects

'''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view

'''Properties'''
Trigger rule once check to set
Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking
View, Free Roaming View
Wait for the camera to target vehicle ? click to choose form session list

=='''Message Rules:'''==

'''Close Message Popup Rule:''' Closes open message popups

'''Properties:'''
None
'''Known Issues:'''
This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule

'''Custom Script Rule:'''

'''Properties'''
None.

'''Display Custom HUD Rule:''' Show or hide the Custom Heads Up Display.

'''Properties'''
Show the Custom Heads up Display- fill-in to choose.
Hide the Custom Heads up Display- fill-in to choose.
Note: One or the other will be chosen by default.

'''Wait for Click on HUD Icon Rule:'''

'''Properties'''
Trigger rule once-check to choose.
HUD Panel- click to choose from list.
Wait for click on- click to choose; choice depends on HUD Panel chosen.

'''Display HTML Pages Rule:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.

'''Properties'''
Add Page- click on to choose from list; click to Add Page Name or Remove.
Add All- click to add all files from the designated assets.
Delete All- delete all files from this property list.
Prevent user from exiting browser until all pages viewed- check to choose.
Disable closing of browser window by user- check to choose.
Disable browser window scrolling- check to choose.
Make browser window invisible- check to choose.
Set position-Under Construction!!!- check to choose.
Set size-Under Construction!!!- check to choose.
Use the page- click to choose Insert Page Name.
From asset HTML- click to choose from list.

'''Timed limited display HTML Rule:''' Displays an html browser window for a limited time.

'''Properties'''
HTML Asset Name-

'''Display Video Rule:''' Displays a page from a HTML assets in a browser window.

'''Properties'''

'''End Session Rule:''' End Session without saving.

'''Properties'''

'''Fade in/out Rule:''' Fade in or out within seconds, color and opacity considered.

'''Properties'''

'''Flash HUD Icon Rule:''' Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.

'''Properties'''

'''Generic Tree Node Debug Window Rule:''' No description.

'''Properties'''

'''InputTable Rule:''' Creating a list of message names to be used for various purposes.

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

'''Properties'''
'''(Check Box) Pause game while message is displayed:''' - stops the game until this message is switched off
'''(Check Box) Close previous popup windows:''' - closes any Message Popups currently displayed
'''Message location: ''<Top Left/Top Right/Bottom Left/Bottom Right>''''' - select one to position the browser window on the screen
'''Message Source:'''
'''(Option button) Custom text:''' - the simplest and easiest option
'''Icon: ''<Click here to set>''''' - shows a list of message icons. Select one to be displayed with the message
'''Icon: ''<Clear icon>''''' - clears any currently displayed message icon
'''Custom text box:''' Enter text to be displayed. You will be limited to about 6 lines of text. For longer messages or to include graphics, use the '''A predefined HTML page''' option.
'''(Option button) 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.
'''(Option button) 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.

'''Minimap Options Rule:''' Sets the display options for the minimap.

'''Properties'''

'''Play Sound Rule:''' Plays a wav sound file.

'''Properties'''

'''Session Debug Rule Rule:''' Executes the first child if debug mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.

'''Properties'''

'''Session Metadata Rule:''' Sets session metadata in the config file. Info can be read by other systems and displayed to the player.

'''Properties'''

'''Set Helper Icon Size Rule:''' Sets the size of helper icons such as the junction lever arrows.

'''Properties'''

'''Set HTML Page Rule:''' Instructs the Display HTML Pages rule to perform specific operations

'''Properties'''

'''Show/Hide HUD Panel Rule:''' Shows or hides a HUD panel.

'''Properties'''

'''Show/Hide Layer Rule:''' Shows or hides a layer from Driver.

'''Properties:'''
'''Show/Hide''' - select one
'''click here to set''' - enter name of layer. Name is case sensitive.

'''Known Bugs:'''
TANE (all versions) - layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded

'''Show/Hide Minimap Rule:''' Shows the Driver the minimap window.

'''Properties'''
'''Minimap Window'''-click to choose Show,Hide

'''Show/hide on-screen help Rule:''' Shows or hides On-screen help in Driver.

'''Properties'''
'''Junction Overlays:''' - fill-in to choose: Show, Hide, Leave unchanged. by default one is chosen
'''On Screen Vehicle Name:''' - Fill-in to choose: Show, Hide, Leave unchanged. By default one is chosen

'''Wait for Click on HUD Icon Rule:''' Waits for a click on the HUD Icon.

'''Properties'''
'''(Check Box) Trigger Once:''' -to choose
'''HUD Panel:''' - Click to choose from list: Bottom Right Menu, Camera Controls, DCC Controls
'''Icon:''' - Choose from list. Selections depends on HUD Panel chosen

'''Wait on Waybill Screen/Main Screen Rule:''' Waits for the Waybill window to be opened.

'''Properties'''

=='''Startup Rules:'''==

'''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.

'''Properties'''

'''Startup Options Rule''' Specifies the starting options for the session.

'''Properties'''

=='''Time Rules:'''==

'''Clock Rule:''' Rule needed for animated clocks, you need to apply this rule to your session to make use of the animated clocks, see forum for code to include in you clock object to work with this rule.

'''Properties'''

'''Timecheck Rule:''' Executes child rules at a certain time.

'''Properties'''

'''Timing Check Rule:''' Triggers sub rules if called within the time window specified.

'''Properties'''

'''Wait Rule:''' Wait for number of seconds'

'''Properties'''

=='''Variable Rules:'''==

'''Variable Check Rule:''' If the specified variable matches the specified conditions then the child rules will be executed in order.

'''Properties'''
'''''<variable-name>''''' - enter a variable-name. Variable name is case sensitive.
'''''<test-condition>''''' - '''is less than/is less than or equal to/is equal to/is greater than or equal to/is greater than/is not equal to/is between x and y''' - select one
'''''This condition will be evaluated only once .../This condition will be evaluated once every second''''' - click to select one
'''Test condition option: is between x and y'''
Enter minimum (x) and maximum (y) test values

'''Test condition option: (all other options)'''
Enter test value

'''Evaluation option: 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

'''Evaluation option: This condition will be evaluated evaluated once every second''' - the rule will be run and the variable rechecked every second

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

'''Properties'''
'''Change: Add to variable/Subtract from variable/Change variable''' - select one
'''(optional check box) Set the minimum value''' of ''<variable-name>'' to ''<value>'' - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.
('''optional check box) Set the maximum value''' of ''<variable-name>'' to ''<value>'' - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.

'''Change option: 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.

'''Change option: 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 option: Change variable'''
'''Change variable ''<variable-name>'' to ''<value>''''' - enter variable-name, enter new value. This cannot be undone if the rule is stopped. Variable-name is case sensitive.

'''Variable Modify Continuous Rule:''' Adds, subtracts or sets a value to a specified variable every second.

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

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

'''Properties'''
'''Check box: Add'''
''<variable-name>'' - enter variable-name. 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. Variable-name is case sensitive.

Variables are saved in the session file and persist from one saved game to another.
They can be accessed/modified by the following '''driver commands''':

'''Driver Commands by trev999:'''
'''Set S-Variable driver command: '''
'''Skip if session-variable driver command: '''
'''Wait until S-variable driver command: '''

'''Driver Commands by atilabarut'''
'''ChangeSVariables driver command: '''
'''WaitUntilSVariable driver command: '''

=='''Weather Rules:'''==

'''EIRS Weather Rule NE USA Rule:''' Customize random weather rule relative to the North East Region of the United States.

'''Properties'''

'''Weather Rule:''' Set the weather conditions.

'''Properties'''

Session Rules By Categories With Properties

2017-09-28T14:09:53Z

Coop2:

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

=='''Achievement Rules'''==

'''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement

'''Properties:'''
None

'''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload

'''Properties:'''
'''Target object''' ?? name of object such as Power Station, Coal Pit or Portal
'''Lock train's controls'''- checked during a stopped load/unload operation
'''Override 'begin load' and 'begin unload' '''- checked # of seconds to override

'''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations

'''Properties:'''
'''<Click to Select>'''- Trigger from Session List.
'''<Click to Select>'''- Industry from Session List
'''<Radio Buttons>'''
-Choose to accept all trains.
-Accept trains matching specific criteria of Assets from Session List

'''Power Station Rule:''' Sets up Station and Consumers

'''Properties:'''
'''<Click to Select>'''- from Session Stations.
'''<Click to Select>'''- Consumers(Add Object) choose from Session List

'''Resource Check Rule:''' Check the progress of the amount of a resource and target object

'''Properties:'''
'''<Radio Buttons>'''
-Watch industry queue
-Watch vehicle
'''Note:''' Both have: Target Object, Queue: click to choose
'''<Radio Buttons>'''- Complete when designated queue
-equals or exceeds required amount
-falls below required amount

'''Multiple Resource Check Rule:''' If specified resources in a selected industry or vehicle reaches set levels, then the following child rules will be executed

'''Properties:'''
'''''<Reach-Exceed/Fall below>'':''' - click to select one
'''''<value>'':''' - enter required quantity value
'''''<Click to 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. For each object:-
'''''<Object>'':''' - click to select session active industry or product enabled rail vehicle
'''''<Queue>'':''' - select product queue (there may be only one available)
'''''<Remove''>:''' - removes the object and its product queue from the rule
'''Notes:'''
'''''Reach/Exceed''''' - sets an upper limit for the resource 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 resource 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.

'''Objective Add Rule:''' Sets up a game Objective with ID and display Name

'''Properties:'''
'''Priority <Click to Select>'''
''-Above Normal:''
''-Below Normal:''
''-Normal:''
''-Optional:''
''-Urgent:''
'''Completion Target Number <Click to Select>'''
''-sets Completion Target Number''
'''Icon <Click to Select>'''
''- select Icon from list''
'''Display Name <Click to Insert>'''
''-insert Name''
'''Unique Objective ID <Click to Set>'''
''-set ID''
'''Custom Message <Text Box>'''
''-insert typed message in text area''

'''Objective Check Rule:''' Executes child rules when objective is complete

'''Properties:'''
'''Unique Objective ID <Click>'''
''insert ID number''
'''Mode <click>'''
''-Wait for completion''
''-Wait for failure''
''-Wait for progress''

'''Objective Update Rule:''' Changes progress outcome according to Property choices

'''Properties:'''
'''Unique Objective ID <Click>'''
''-set ID number''
'''Mode <Click to Set Objective>'''
''-Decrement progress''
''-Increment progress''
''-Reset Objective''
''-Set objects as complete''
''-Set objects as failed''
''-Set progress''
''-Set progress only if greater''
'''Amount <Click>'''
''-insert number''

'''Ranked Session Begin Rule:''' Begins a ranked Session

'''Properties:'''
'''Countdown Starting Value <Click to insert>'''
''-hrs''
''-min''
''sec''
'''1 through 5 stars, points for each star <Click>
-insert number of points
'''Session timer mode <Radio Button>'''
''-Timer''
''-Countdown''
''-None''

'''Ranked Session Complete Rule:''' Completes the active ranked Session

'''Properties:'''
Set the active ranked session as fill-in choose: Complete, Failed
Customize the completion message check insert text message

'''Session Complete Rule:''' Set session to a percentage of completion

'''Properties:'''
Set session to percent complete click to insert number in percent
Separate achievements for completion check

=='''Danger Rules'''==

'''ATP Speed Limiter Rule:''' Limits speed over set limit

'''Properties:'''
speed limit over the set limit mph

'''Speeding Check Rule:''' If player controlled trains are over the local speed limit or over a set (custom) speed, then the following child rules will be executed

'''Properties:'''
'''(Option button) Watch for trains travelling above the posted speed limit'''
'''''<speed value>'':''' - click to enter a new overspeed tolerance value
'''''<Kmph/MPH/mps>'':''' - click to select one
'''(Option button) Watch for trains travelling above a custom speed'''
'''''<speed value>'':''' - click to enter a new custom speed value
'''''<Kmph/MPH/mps>'':''' - click to select one
'''Warning: This option is very performance intensive and should only be used in sessions with few trains'''

'''AWS Configuration Rule:''' This rule configures the Trainz implementation of the Automatic Warning System when approaching signals

'''Properties:'''
Use modern sound set for unfitted cabs? check
Simulate AWS for unfitted cabs? check
Passive with HUD hidden fill-in
Active fill-in
Passive fill-in

'''Wait for Derailment Rule:''' Waits for a derailment to occur

'''Properties:'''
Trigger derailment watch once check to set

'''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars after a set time delay

'''Properties:'''
'''''<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.

'''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule

'''Properties:'''
'''(Check box) Respawn trains if they are abandoned for 10 minutes'''
If checked:-
'''(Option button) Respawn trains at their original locations'''
'''(Option button) Respawn trains from portals'''
If '''Respawn trains from portals''' is selected, then:-
'''''<+ Add a new portal>''''' - click to enter the name of a portal, there can be more than one portal.
Entered names that appear in red have not been found in the session

'''Coupler Breakage Check Rule:''' Checks for breaking couplers and, if found, then executes any following child rules.

'''Properties:'''
None

'''Coupler Breakage HUD Rule:''' HUD displays warning about coupler stress and breakage

'''Properties:'''
'''(Option button) Show the Coupler Breakage Display'''
'''(Option button) Hide the Coupler Breakage Display'''

'''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles

'''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: ''<Locked/Unlocked>''''' - click to select
'''Back: ''<Locked/Unlocked>''''' - click to select
'''Decoupling Mask:'''
'''Front: ''<Locked/Unlocked>''''' - click to select
'''Back: ''<Locked/Unlocked>''''' - click to select
'''''<Remove>'':''' - click to remove that vehicle from the rule

'''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users and, if found, then executes any following child rules.

'''Properties:'''
'''(Check box) Trigger only once:'''

'''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users and, if found, then executes any following child rules.

'''Properties:'''
'''(Check box) Trigger only once:'''

'''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger (stop) and, if found, then executes any following child rules.

'''Properties:'''
'''(Check box) Trigger only once:'''

'''Vehicle Physics Rule:''' Overrides the default vehicle physics properties

'''Properties:'''
Accept all trains fill-in
Cab sway level is set ? % click to insert percent of sway
Traction boost is % ? while sanding click to insert percent of boost
Tractions reduced to ? % while click to set traction percent
Maximum tractive effort adjusted by ? click to insert percent amount
Show coupler breakage in HUD Rule check to set
Couplers break when coupling above ? click to set speed
Accept trains matching specific criteria fill-in to insert specific trains
Couplers break at ? kN check to insert amount of force

=='''Navigation Rules'''==

'''DestSignTable Rule:''' Table for creating a table of destination signs

'''Properties:'''
Enable Track Marks as destinations check
Enable table of destinations check
Import destination from texture-group. name
Destination Name name
Enable industries/stations as check
Interlocking Tower Configure Path Alters settings on an interlocking tower path
Interlocking Tower choose Name and Objects
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
Show path activation message in Driver check

'''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train

'''Properties:'''
Interlocking Tower choose Names and Objects
Multiple Junction Alignment Check Checks multiple junctions are in alignment
Wait until the following junctions are choose all or anyone
Add junction click add junction from session list
Add all click add all junctions from session list
Delete all click deletes all junctions from rule list

'''Navigation Display Rule:''' Creates a set of navigation points. Multiple sets can be created by adding additional copies of this rule. This rule creates the navigation set, it does not display it. Use the '''Navigation set hide/show rule''' to make a set visible. Navigation sets can be completed (terminated) by the '''Navigation Set Clear Rule''', individual navigation points can be ''manually'' completed by the '''Navigation Point Complete Rule'''. Click the help icon at the top of the properties box for in game instructions.

'''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.
'''Navigation mode:''' - select one option
'''(Option button) 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.
'''(Option button) 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.
'''(Option button) 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 (a trigger, trackmark, track object or rolling stock asset) 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'': ''<Automatic/Manual/Require Stop>''''' - click to select one
'''''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''' 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.

'''Navigation Point Complete Rule:''' Manually completes a navigation point in a set

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

'''Navigation Set Check Rule:''' Checks if a navigation set is complete or incomplete, if so then the following child rules will be executed

'''Properties:'''
'''Checks if navigation point set ''<click to select>'':''' - 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.

'''Navigation Set Clear Rule:''' Clears a navigation set removing any uncompleted navigation points

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

'''Navigation Set Hide/Show:''' Shows and hides navigation sets. You can have multiple sets visible and hidden at the same time.

'''Properties:'''
'''''<Hide/Show>'':''' - click to select one
'''''<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.

'''Schedule Rule:''' Allows a schedule of timed events to be applied to a train

'''Properties:'''
Insert track mark click to select from session list
Note: Both has an arrival and departure set time hr:min:sec
Current Train click to select from session list
Insert destination click to select from session list

'''Set Junctions Rule:''' Sets the selected junctions to a specific state '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''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:-
'''''<Left/Center/Right/Don't change>''''' - click to set the junction direction
'''''<Locked/Unlocked>''''' - click to select. '''Locked''' means the junction setting cannot be changed by the user
'''''<Allows AI control/Blocks AI control>''''' - click to select
'''''Remove''''' - click to remove that junction from the rule list

'''Set Signal Extended Rule:''' Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''Properties:'''
'''''Select signal''''' - click to select a signal from the session list
'''''<signal state>''''' - click to select a state from the list

'''Trigger Check Rule:''' - Waits for any train to enter one of the designated triggers. This rule replaces the older and less versatile "Trigger Rule".

'''Properties:'''
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list
Add Trigger click to choose from session list
Trigger only once check to set
Wait for child rules to complete even if check to set
Only activate when the entering click to choose forward, backward

'''Wait on Navigation Point Rule:''' Waits for a navigation point to be completed then the following child rules will be executed

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

'''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start

'''Properties:'''
Accept all trains fill-in to set
Accept trains matching specific criteria fill-in to set and choose from session list
Wait for a train that matches the click to choose: start moving, stop moving
Trigger rule once check to set
Note: One or the other fill-ins must be

=='''Driver Rules'''==

'''Control Type Rule''' Sets control type

'''Properties:'''
Current control method is: Easy Mode, Choice one of the three

'''Control Check Rule:''' Activates child rules based on the control method changes

'''Properties:'''
Excite child rules when: DCC mode is fill-in one or the other
Excite child rules: Every time control fill-in one or the other

'''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule

'''Properties:'''
Trigger add Trigger
Portal index from PCP value
Use UnPortal yes/no
Delay from Trigger to Emit: seconds value

'''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry

'''Properties:'''
Apply to every vehicle in the session fill-in
Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles
Note: One of the Applies will always be
Load/Unload for industry Disable/Enable choose Industry

'''Driver Command Rule:''' Specify which commands will be available for the drivers

'''Properties''':
Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.
Navigate To TrackMarkList V2- No description.
Navigate To Station V2- No description.
Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.
Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.
Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.
Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.
Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.
Drive To Station V2- No description.
Drive To Track mark List V2- No description.
Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.
Drive To Industry- Drive to a specific industry.
Change Destination Sign-Changes the destination signs of a train.

WaitFor- Pauses the driver's schedule for a set duration of time.
Wait For Random- TRS2008: Wait for specified or optionally random period of time.
Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).
WaitUntil- No description.

VR Set Train Lamps-Driver command that sets the train lamps.
Notify- Notifies the player of schedule progress/completion.
Reverse Tram- Reverse a tram(max 2 cars).
Couple- Couple train to designate vehicle.
Decouple- Decouples the train at the specified vehicle.
UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).
Halt Train- Brings the train to a complete stop.
Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.
Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger
station before using this command.
Cab: Wait-Maintains current control state until some condition is met.
Delete Train- Causes the train and its driver to be deleted from the session.
Hornz- Driver sounds the train horn.
Cab: Set Control-Sets a cab mode control.
Headlights On/Off-Allows the driver to to switch the headlights on and off.
Interior Lights Command- Driver command to switch interior lights on or off for the current train.
Set Max Speed To- No description.

Release Junction - Lets a driver release the junction they have been holding.
Move Turntable- TRS2008: Move turntable to a stop point .

Load- Loads the train's vehicles at the industry the driver is currently at with the train.
Unload- Unload train vehicles at current industry location.
Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.
Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.
Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.

'''Driver Command Check Rule:''' Verifies the driver commands of a driver character

'''Properties'''
Wait for driver character to have add driver, all, delete all
Trigger Rule once check
Driver character to watch the name driver

'''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar

'''Properties'''
The Driver Main Bar choice show/hide

'''Driver Schedule Rule''' Execution of basic scheduled commands

'''Properties:'''
Note: Only one of the fill-in can be
Driver Schedule Rule assigned to name driver
Commands insert driver commands in Drive Schedule
Classic style: If there is a schedule fill-in
Killer style: If there is a schedule fill-in
Cooperative style: If there is a schedule fill-in
Active style: Emit a new schedule, only fill-in

'''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders

'''Properties'''
Generate new Drivers for empty check
The following drivers will be available Driver's Name Add
Remove all existing Drivers first check

'''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers

'''Properties'''
Assign Driver commands check Driver Commands
Train criteria fill in all trains
Train criteria list train only trains matching criteria

'''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted

'''Properties'''
Config/txt file tag 'max_permitted_speed-60850 in mph or kph
Add to config.txt and kuid-table for value <KUID2:60850:88000:4
Note: Old root level config tag will

'''QuickDrive Rule:''' Change the Session settings and add consists in Driver

'''Properties'''
Set Time to insert time
QuickDrive Consist Option List by
Rate of Change insert rate as number times
Enable gameplay Session Mode check
Enable in game help by default check
Set the default Control method to fill-in choose: Easy Mode, Realistic Mode
Prevent player from changing this check
Realistic mode requires achievement add Achievement's Name
In Asset choose Auran achievements
Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic
Prevent player from changing 10.0 check
Set the default units to fill-in choose: Imperial, Metric, Default
Open QuickDriver Window when check

'''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train

'''Properties'''
Note: One or the other fill-ins must be
Accept trains matching specific criteria fill-in to select from session list
Accept all trains fill-in to set
Trigger rule once check to set
Wait for a driver character to get ? a click to select: On, Off

'''Wait for Driver/Train to be Locally Owned Rule:''' Waits for a specific driver or train car to be locally owned, Owned then executes child rules. If the driver/train car becomes unowned again the child rules are paused

'''Properties'''
Wait for ownership of a specific Driver fill-in to set
Wait for ownership of Driver fill-in to set
Note: One or the other fill-in must be
Driver or Vehicle click to choose from session lists

=='''Arrangement of Session Rules:'''==

'''Ordered List Rule:''' Child rules will be executed in order once this rule starts

'''Properties'''
Note: One of the two must be chosen
This process will repeat fill-in click to add number of repeats
This process will repeat forever fill-in

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

'''Properties'''
After last child run is executed click to choose: First child is chosen again, It will be
used for all successive runs, Successive runs will
do nothing

'''Random List Rule:''' One of the child rules indented under this rule will be randomly selected and executed

'''Properties'''
executed randomly
Once one of the child rule is ??

'''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle

'''Properties'''
None

'''Simultaneous List Rule:''' Child rules are executed simultaneously once this rule starts

'''Properties'''
Rules completes when click choose all rules have reached completed state,
was completed state

=='''Camera Rules:'''==

'''Cinematic Camera Rule:''' Provides several different cinematic style cameras

'''Properties'''
Lock camera controls for the duration check
Prevent rain control for duration check
Camera target: name any of the many objects in session
Camera mode: Stationary, Circle fill-in
Initial camera values: Pitch, Yaw, Zoom value
Total time to animate: seconds value

'''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties

'''Properties'''
Change the camera view mode to check to choose: Cab View, External View, Tracking
View, Free Roaming
Vehicle fill-in choose from session vehicles
Set the camera flags to enable/disable check to choose different properties from list
Junction fill-in choose from session junctions
Set the target objet of the camera to check
Map object fill-in choose from map objects

'''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view

'''Properties'''
Trigger rule once check to set
Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking
View, Free Roaming View
Wait for the camera to target vehicle ? click to choose form session list

=='''Message Rules:'''==

'''Close Message Popup Rule:''' Closes open message popups

'''Properties:'''
None
'''Known Issues:'''
This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule

'''Custom Script Rule:'''

'''Properties'''
None.

'''Display Custom HUD Rule:''' Show or hide the Custom Heads Up Display.

'''Properties'''
Show the Custom Heads up Display- fill-in to choose.
Hide the Custom Heads up Display- fill-in to choose.
Note: One or the other will be chosen by default.

'''Wait for Click on HUD Icon Rule:'''

'''Properties'''
Trigger rule once-check to choose.
HUD Panel- click to choose from list.
Wait for click on- click to choose; choice depends on HUD Panel chosen.

'''Display HTML Pages Rule:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.

'''Properties'''
Add Page- click on to choose from list; click to Add Page Name or Remove.
Add All- click to add all files from the designated assets.
Delete All- delete all files from this property list.
Prevent user from exiting browser until all pages viewed- check to choose.
Disable closing of browser window by user- check to choose.
Disable browser window scrolling- check to choose.
Make browser window invisible- check to choose.
Set position-Under Construction!!!- check to choose.
Set size-Under Construction!!!- check to choose.
Use the page- click to choose Insert Page Name.
From asset HTML- click to choose from list.

'''Timed limited display HTML Rule:''' Displays an html browser window for a limited time.

'''Properties'''
HTML Asset Name-

'''Display Video Rule:''' Displays a page from a HTML assets in a browser window.

'''Properties'''

'''End Session Rule:''' End Session without saving.

'''Properties'''

'''Fade in/out Rule:''' Fade in or out within seconds, color and opacity considered.

'''Properties'''

'''Flash HUD Icon Rule:''' Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.

'''Properties'''

'''Generic Tree Node Debug Window Rule:''' No description.

'''Properties'''

'''InputTable Rule:''' Creating a list of message names to be used for various purposes.

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

'''Properties'''
'''(Check Box) Pause game while message is displayed:''' - stops the game until this message is switched off
'''(Check Box) Close previous popup windows:''' - closes any Message Popups currently displayed
'''Message location: ''<Top Left/Top Right/Bottom Left/Bottom Right>''''' - select one to position the browser window on the screen
'''Message Source:'''
'''(Option button) Custom text:''' - the simplest and easiest option
'''Icon: ''<Click here to set>''''' - shows a list of message icons. Select one to be displayed with the message
'''Icon: ''<Clear icon>''''' - clears any currently displayed message icon
'''Custom text box:''' Enter text to be displayed. You will be limited to about 6 lines of text. For longer messages or to include graphics, use the '''A predefined HTML page''' option.
'''(Option button) 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.
'''(Option button) 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.

'''Minimap Options Rule:''' Sets the display options for the minimap.

'''Properties'''

'''Play Sound Rule:''' Plays a wav sound file.

'''Properties'''

'''Session Debug Rule Rule:''' Executes the first child if debug mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.

'''Properties'''

'''Session Metadata Rule:''' Sets session metadata in the config file. Info can be read by other systems and displayed to the player.

'''Properties'''

'''Set Helper Icon Size Rule:''' Sets the size of helper icons such as the junction lever arrows.

'''Properties'''

'''Set HTML Page Rule:''' Instructs the Display HTML Pages rule to perform specific operations

'''Properties'''

'''Show/Hide HUD Panel Rule:''' Shows or hides a HUD panel.

'''Properties'''

'''Show/Hide Layer Rule:''' Shows or hides a layer from Driver.

'''Properties:'''
'''Show/Hide''' - select one
'''click here to set''' - enter name of layer. Name is case sensitive.

'''Known Bugs:'''
TANE (all versions) - layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded

'''Show/Hide Minimap Rule:''' Shows the Driver the minimap window.

'''Properties'''
'''Minimap Window'''-click to choose Show,Hide

'''Show/hide on-screen help Rule:''' Shows or hides On-screen help in Driver.

'''Properties'''
'''Junction Overlays:''' - fill-in to choose: Show, Hide, Leave unchanged. by default one is chosen
'''On Screen Vehicle Name:''' - Fill-in to choose: Show, Hide, Leave unchanged. By default one is chosen

'''Wait for Click on HUD Icon Rule:''' Waits for a click on the HUD Icon.

'''Properties'''
'''(Check Box) Trigger Once:''' -to choose
'''HUD Panel:''' - Click to choose from list: Bottom Right Menu, Camera Controls, DCC Controls
'''Icon:''' - Choose from list. Selections depends on HUD Panel chosen

'''Wait on Waybill Screen/Main Screen Rule:''' Waits for the Waybill window to be opened.

'''Properties'''

=='''Startup Rules:'''==

'''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.

'''Properties'''

'''Startup Options Rule''' Specifies the starting options for the session.

'''Properties'''

=='''Time Rules:'''==

'''Clock Rule:''' Rule needed for animated clocks, you need to apply this rule to your session to make use of the animated clocks, see forum for code to include in you clock object to work with this rule.

'''Properties'''

'''Timecheck Rule:''' Executes child rules at a certain time.

'''Properties'''

'''Timing Check Rule:''' Triggers sub rules if called within the time window specified.

'''Properties'''

'''Wait Rule:''' Wait for number of seconds'

'''Properties'''

=='''Variable Rules:'''==

'''Variable Check Rule:''' If the specified variable matches the specified conditions then the child rules will be executed in order.

'''Properties'''
'''''<variable-name>''''' - enter a variable-name. Variable name is case sensitive.
'''''<test-condition>''''' - '''is less than/is less than or equal to/is equal to/is greater than or equal to/is greater than/is not equal to/is between x and y''' - select one
'''''This condition will be evaluated only once .../This condition will be evaluated once every second''''' - click to select one
'''Test condition option: is between x and y'''
Enter minimum (x) and maximum (y) test values

'''Test condition option: (all other options)'''
Enter test value

'''Evaluation option: 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

'''Evaluation option: This condition will be evaluated evaluated once every second''' - the rule will be run and the variable rechecked every second

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

'''Properties'''
'''Change: Add to variable/Subtract from variable/Change variable''' - select one
'''(optional check box) Set the minimum value''' of ''<variable-name>'' to ''<value>'' - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.
('''optional check box) Set the maximum value''' of ''<variable-name>'' to ''<value>'' - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.

'''Change option: 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.

'''Change option: 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 option: Change variable'''
'''Change variable ''<variable-name>'' to ''<value>''''' - enter variable-name, enter new value. This cannot be undone if the rule is stopped. Variable-name is case sensitive.

'''Variable Modify Continuous Rule:''' Adds, subtracts or sets a value to a specified variable every second.

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

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

'''Properties'''
'''Check box: Add'''
''<variable-name>'' - enter variable-name. 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. Variable-name is case sensitive.

Variables are saved in the session file and persist from one saved game to another.
They can be accessed/modified by the following '''driver commands''':

'''Driver Commands by trev999:'''
'''Set S-Variable driver command: '''
'''Skip if session-variable driver command: '''
'''Wait until S-variable driver command: '''

'''Driver Commands by atilabarut'''
'''ChangeSVariables driver command: '''
'''WaitUntilSVariable driver command: '''

=='''Weather Rules:'''==

'''EIRS Weather Rule NE USA Rule:''' Customize random weather rule relative to the North East Region of the United States.

'''Properties'''

'''Weather Rule:''' Set the weather conditions.

'''Properties'''

Session Rules By Categories With Properties

2017-09-28T13:46:45Z

Coop2:

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

=='''Achievement Rules'''==

'''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement

'''Properties:'''
None

'''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload

'''Properties:'''
'''Target object''' ?? name of object such as Power Station, Coal Pit or Portal
'''Lock train's controls'''- checked during a stopped load/unload operation
'''Override 'begin load' and 'begin unload' '''- checked # of seconds to override

'''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations

'''Properties:'''
'''<Click to Select>'''- Trigger from Session List.
'''<Click to Select>'''- Industry from Session List
'''<Radio Buttons>'''
-Choose to accept all trains.
-Accept trains matching specific criteria of Assets from Session List

'''Power Station Rule:''' Sets up Station and Consumers

'''Properties:'''
'''<Click to Select>'''- from Session Stations.
'''<Click to Select>'''- Consumers(Add Object) choose from Session List

'''Resource Check Rule:''' Check the progress of the amount of a resource and target object

'''Properties:'''
'''<Radio Buttons>'''
-Watch industry queue
-Watch vehicle
'''Note:''' Both have: Target Object, Queue: click to choose
'''<Radio Buttons>'''- Complete when designated queue
-equals or exceeds required amount
-falls below required amount

'''Multiple Resource Check Rule:''' If specified resources in a selected industry or vehicle reaches set levels, then the following child rules will be executed

'''Properties:'''
'''''<Reach-Exceed/Fall below>'':''' - click to select one
'''''<value>'':''' - enter required quantity value
'''''<Click to 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. For each object:-
'''''<Object>'':''' - click to select session active industry or product enabled rail vehicle
'''''<Queue>'':''' - select product queue (there may be only one available)
'''''<Remove''>:''' - removes the object and its product queue from the rule
'''Notes:'''
'''''Reach/Exceed''''' - sets an upper limit for the resource 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 resource 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.

'''Objective Add Rule:''' Sets up a game Objective with ID and display Name

'''Properties:'''
'''Priority <Click to Select>'''
''-Above Normal:''
''-Below Normal:''
''-Normal:''
''-Optional:''
''-Urgent:''
'''Completion Target Number <Click to Select>'''
''-sets Completion Target Number''
'''Icon <Click to Select>'''
''- select Icon from list''
'''Display Name <Click to Insert>'''
''-insert Name''
'''Unique Objective ID <Click to Set>'''
''-set ID''
'''Custom Message <Text Box>'''
''-insert typed message in text area''

'''Objective Check Rule:''' Executes child rules when objective is complete

'''Properties:'''
Unique Objective ID click insert ID number
Mode click choose Wait for completion, Wait for failure, Wait for progress

'''Objective Update Rule:''' Changes progress outcome according to Property choices

'''Properties:'''
Unique Objective ID click to set ID number
Mode click Set objective as Decrement progress/Increment progress/Reset objective/Set objects as complete/Set objects as failed/Set progress/Set progress only if greater
Amount click insert number

'''Ranked Session Begin Rule:''' Begins a ranked Session

'''Properties:'''
Countdown requires a Starting Value insert hrs., min,sec
1 through 5 stars, points for each star insert number of points
Session timer mode fill-in chooses: Timer, Countdown, None

'''Ranked Session Complete Rule:''' Completes the active ranked Session

'''Properties:'''
Set the active ranked session as fill-in choose: Complete, Failed
Customize the completion message check insert text message

'''Session Complete Rule:''' Set session to a percentage of completion

'''Properties:'''
Set session to percent complete click to insert number in percent
Separate achievements for completion check

=='''Danger Rules'''==

'''ATP Speed Limiter Rule:''' Limits speed over set limit

'''Properties:'''
speed limit over the set limit mph

'''Speeding Check Rule:''' If player controlled trains are over the local speed limit or over a set (custom) speed, then the following child rules will be executed

'''Properties:'''
'''(Option button) Watch for trains travelling above the posted speed limit'''
'''''<speed value>'':''' - click to enter a new overspeed tolerance value
'''''<Kmph/MPH/mps>'':''' - click to select one
'''(Option button) Watch for trains travelling above a custom speed'''
'''''<speed value>'':''' - click to enter a new custom speed value
'''''<Kmph/MPH/mps>'':''' - click to select one
'''Warning: This option is very performance intensive and should only be used in sessions with few trains'''

'''AWS Configuration Rule:''' This rule configures the Trainz implementation of the Automatic Warning System when approaching signals

'''Properties:'''
Use modern sound set for unfitted cabs? check
Simulate AWS for unfitted cabs? check
Passive with HUD hidden fill-in
Active fill-in
Passive fill-in

'''Wait for Derailment Rule:''' Waits for a derailment to occur

'''Properties:'''
Trigger derailment watch once check to set

'''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars after a set time delay

'''Properties:'''
'''''<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.

'''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule

'''Properties:'''
'''(Check box) Respawn trains if they are abandoned for 10 minutes'''
If checked:-
'''(Option button) Respawn trains at their original locations'''
'''(Option button) Respawn trains from portals'''
If '''Respawn trains from portals''' is selected, then:-
'''''<+ Add a new portal>''''' - click to enter the name of a portal, there can be more than one portal.
Entered names that appear in red have not been found in the session

'''Coupler Breakage Check Rule:''' Checks for breaking couplers and, if found, then executes any following child rules.

'''Properties:'''
None

'''Coupler Breakage HUD Rule:''' HUD displays warning about coupler stress and breakage

'''Properties:'''
'''(Option button) Show the Coupler Breakage Display'''
'''(Option button) Hide the Coupler Breakage Display'''

'''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles

'''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: ''<Locked/Unlocked>''''' - click to select
'''Back: ''<Locked/Unlocked>''''' - click to select
'''Decoupling Mask:'''
'''Front: ''<Locked/Unlocked>''''' - click to select
'''Back: ''<Locked/Unlocked>''''' - click to select
'''''<Remove>'':''' - click to remove that vehicle from the rule

'''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users and, if found, then executes any following child rules.

'''Properties:'''
'''(Check box) Trigger only once:'''

'''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users and, if found, then executes any following child rules.

'''Properties:'''
'''(Check box) Trigger only once:'''

'''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger (stop) and, if found, then executes any following child rules.

'''Properties:'''
'''(Check box) Trigger only once:'''

'''Vehicle Physics Rule:''' Overrides the default vehicle physics properties

'''Properties:'''
Accept all trains fill-in
Cab sway level is set ? % click to insert percent of sway
Traction boost is % ? while sanding click to insert percent of boost
Tractions reduced to ? % while click to set traction percent
Maximum tractive effort adjusted by ? click to insert percent amount
Show coupler breakage in HUD Rule check to set
Couplers break when coupling above ? click to set speed
Accept trains matching specific criteria fill-in to insert specific trains
Couplers break at ? kN check to insert amount of force

=='''Navigation Rules'''==

'''DestSignTable Rule:''' Table for creating a table of destination signs

'''Properties:'''
Enable Track Marks as destinations check
Enable table of destinations check
Import destination from texture-group. name
Destination Name name
Enable industries/stations as check
Interlocking Tower Configure Path Alters settings on an interlocking tower path
Interlocking Tower choose Name and Objects
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
Show path activation message in Driver check

'''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train

'''Properties:'''
Interlocking Tower choose Names and Objects
Multiple Junction Alignment Check Checks multiple junctions are in alignment
Wait until the following junctions are choose all or anyone
Add junction click add junction from session list
Add all click add all junctions from session list
Delete all click deletes all junctions from rule list

'''Navigation Display Rule:''' Creates a set of navigation points. Multiple sets can be created by adding additional copies of this rule. This rule creates the navigation set, it does not display it. Use the '''Navigation set hide/show rule''' to make a set visible. Navigation sets can be completed (terminated) by the '''Navigation Set Clear Rule''', individual navigation points can be ''manually'' completed by the '''Navigation Point Complete Rule'''. Click the help icon at the top of the properties box for in game instructions.

'''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.
'''Navigation mode:''' - select one option
'''(Option button) 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.
'''(Option button) 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.
'''(Option button) 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 (a trigger, trackmark, track object or rolling stock asset) 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'': ''<Automatic/Manual/Require Stop>''''' - click to select one
'''''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''' 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.

'''Navigation Point Complete Rule:''' Manually completes a navigation point in a set

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

'''Navigation Set Check Rule:''' Checks if a navigation set is complete or incomplete, if so then the following child rules will be executed

'''Properties:'''
'''Checks if navigation point set ''<click to select>'':''' - 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.

'''Navigation Set Clear Rule:''' Clears a navigation set removing any uncompleted navigation points

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

'''Navigation Set Hide/Show:''' Shows and hides navigation sets. You can have multiple sets visible and hidden at the same time.

'''Properties:'''
'''''<Hide/Show>'':''' - click to select one
'''''<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.

'''Schedule Rule:''' Allows a schedule of timed events to be applied to a train

'''Properties:'''
Insert track mark click to select from session list
Note: Both has an arrival and departure set time hr:min:sec
Current Train click to select from session list
Insert destination click to select from session list

'''Set Junctions Rule:''' Sets the selected junctions to a specific state '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''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:-
'''''<Left/Center/Right/Don't change>''''' - click to set the junction direction
'''''<Locked/Unlocked>''''' - click to select. '''Locked''' means the junction setting cannot be changed by the user
'''''<Allows AI control/Blocks AI control>''''' - click to select
'''''Remove''''' - click to remove that junction from the rule list

'''Set Signal Extended Rule:''' Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''Properties:'''
'''''Select signal''''' - click to select a signal from the session list
'''''<signal state>''''' - click to select a state from the list

'''Trigger Check Rule:''' - Waits for any train to enter one of the designated triggers. This rule replaces the older and less versatile "Trigger Rule".

'''Properties:'''
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list
Add Trigger click to choose from session list
Trigger only once check to set
Wait for child rules to complete even if check to set
Only activate when the entering click to choose forward, backward

'''Wait on Navigation Point Rule:''' Waits for a navigation point to be completed then the following child rules will be executed

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

'''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start

'''Properties:'''
Accept all trains fill-in to set
Accept trains matching specific criteria fill-in to set and choose from session list
Wait for a train that matches the click to choose: start moving, stop moving
Trigger rule once check to set
Note: One or the other fill-ins must be

=='''Driver Rules'''==

'''Control Type Rule''' Sets control type

'''Properties:'''
Current control method is: Easy Mode, Choice one of the three

'''Control Check Rule:''' Activates child rules based on the control method changes

'''Properties:'''
Excite child rules when: DCC mode is fill-in one or the other
Excite child rules: Every time control fill-in one or the other

'''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule

'''Properties:'''
Trigger add Trigger
Portal index from PCP value
Use UnPortal yes/no
Delay from Trigger to Emit: seconds value

'''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry

'''Properties:'''
Apply to every vehicle in the session fill-in
Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles
Note: One of the Applies will always be
Load/Unload for industry Disable/Enable choose Industry

'''Driver Command Rule:''' Specify which commands will be available for the drivers

'''Properties''':
Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.
Navigate To TrackMarkList V2- No description.
Navigate To Station V2- No description.
Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.
Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.
Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.
Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.
Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.
Drive To Station V2- No description.
Drive To Track mark List V2- No description.
Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.
Drive To Industry- Drive to a specific industry.
Change Destination Sign-Changes the destination signs of a train.

WaitFor- Pauses the driver's schedule for a set duration of time.
Wait For Random- TRS2008: Wait for specified or optionally random period of time.
Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).
WaitUntil- No description.

VR Set Train Lamps-Driver command that sets the train lamps.
Notify- Notifies the player of schedule progress/completion.
Reverse Tram- Reverse a tram(max 2 cars).
Couple- Couple train to designate vehicle.
Decouple- Decouples the train at the specified vehicle.
UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).
Halt Train- Brings the train to a complete stop.
Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.
Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger
station before using this command.
Cab: Wait-Maintains current control state until some condition is met.
Delete Train- Causes the train and its driver to be deleted from the session.
Hornz- Driver sounds the train horn.
Cab: Set Control-Sets a cab mode control.
Headlights On/Off-Allows the driver to to switch the headlights on and off.
Interior Lights Command- Driver command to switch interior lights on or off for the current train.
Set Max Speed To- No description.

Release Junction - Lets a driver release the junction they have been holding.
Move Turntable- TRS2008: Move turntable to a stop point .

Load- Loads the train's vehicles at the industry the driver is currently at with the train.
Unload- Unload train vehicles at current industry location.
Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.
Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.
Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.

'''Driver Command Check Rule:''' Verifies the driver commands of a driver character

'''Properties'''
Wait for driver character to have add driver, all, delete all
Trigger Rule once check
Driver character to watch the name driver

'''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar

'''Properties'''
The Driver Main Bar choice show/hide

'''Driver Schedule Rule''' Execution of basic scheduled commands

'''Properties:'''
Note: Only one of the fill-in can be
Driver Schedule Rule assigned to name driver
Commands insert driver commands in Drive Schedule
Classic style: If there is a schedule fill-in
Killer style: If there is a schedule fill-in
Cooperative style: If there is a schedule fill-in
Active style: Emit a new schedule, only fill-in

'''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders

'''Properties'''
Generate new Drivers for empty check
The following drivers will be available Driver's Name Add
Remove all existing Drivers first check

'''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers

'''Properties'''
Assign Driver commands check Driver Commands
Train criteria fill in all trains
Train criteria list train only trains matching criteria

'''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted

'''Properties'''
Config/txt file tag 'max_permitted_speed-60850 in mph or kph
Add to config.txt and kuid-table for value <KUID2:60850:88000:4
Note: Old root level config tag will

'''QuickDrive Rule:''' Change the Session settings and add consists in Driver

'''Properties'''
Set Time to insert time
QuickDrive Consist Option List by
Rate of Change insert rate as number times
Enable gameplay Session Mode check
Enable in game help by default check
Set the default Control method to fill-in choose: Easy Mode, Realistic Mode
Prevent player from changing this check
Realistic mode requires achievement add Achievement's Name
In Asset choose Auran achievements
Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic
Prevent player from changing 10.0 check
Set the default units to fill-in choose: Imperial, Metric, Default
Open QuickDriver Window when check

'''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train

'''Properties'''
Note: One or the other fill-ins must be
Accept trains matching specific criteria fill-in to select from session list
Accept all trains fill-in to set
Trigger rule once check to set
Wait for a driver character to get ? a click to select: On, Off

'''Wait for Driver/Train to be Locally Owned Rule:''' Waits for a specific driver or train car to be locally owned, Owned then executes child rules. If the driver/train car becomes unowned again the child rules are paused

'''Properties'''
Wait for ownership of a specific Driver fill-in to set
Wait for ownership of Driver fill-in to set
Note: One or the other fill-in must be
Driver or Vehicle click to choose from session lists

=='''Arrangement of Session Rules:'''==

'''Ordered List Rule:''' Child rules will be executed in order once this rule starts

'''Properties'''
Note: One of the two must be chosen
This process will repeat fill-in click to add number of repeats
This process will repeat forever fill-in

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

'''Properties'''
After last child run is executed click to choose: First child is chosen again, It will be
used for all successive runs, Successive runs will
do nothing

'''Random List Rule:''' One of the child rules indented under this rule will be randomly selected and executed

'''Properties'''
executed randomly
Once one of the child rule is ??

'''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle

'''Properties'''
None

'''Simultaneous List Rule:''' Child rules are executed simultaneously once this rule starts

'''Properties'''
Rules completes when click choose all rules have reached completed state,
was completed state

=='''Camera Rules:'''==

'''Cinematic Camera Rule:''' Provides several different cinematic style cameras

'''Properties'''
Lock camera controls for the duration check
Prevent rain control for duration check
Camera target: name any of the many objects in session
Camera mode: Stationary, Circle fill-in
Initial camera values: Pitch, Yaw, Zoom value
Total time to animate: seconds value

'''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties

'''Properties'''
Change the camera view mode to check to choose: Cab View, External View, Tracking
View, Free Roaming
Vehicle fill-in choose from session vehicles
Set the camera flags to enable/disable check to choose different properties from list
Junction fill-in choose from session junctions
Set the target objet of the camera to check
Map object fill-in choose from map objects

'''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view

'''Properties'''
Trigger rule once check to set
Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking
View, Free Roaming View
Wait for the camera to target vehicle ? click to choose form session list

=='''Message Rules:'''==

'''Close Message Popup Rule:''' Closes open message popups

'''Properties:'''
None
'''Known Issues:'''
This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule

'''Custom Script Rule:'''

'''Properties'''
None.

'''Display Custom HUD Rule:''' Show or hide the Custom Heads Up Display.

'''Properties'''
Show the Custom Heads up Display- fill-in to choose.
Hide the Custom Heads up Display- fill-in to choose.
Note: One or the other will be chosen by default.

'''Wait for Click on HUD Icon Rule:'''

'''Properties'''
Trigger rule once-check to choose.
HUD Panel- click to choose from list.
Wait for click on- click to choose; choice depends on HUD Panel chosen.

'''Display HTML Pages Rule:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.

'''Properties'''
Add Page- click on to choose from list; click to Add Page Name or Remove.
Add All- click to add all files from the designated assets.
Delete All- delete all files from this property list.
Prevent user from exiting browser until all pages viewed- check to choose.
Disable closing of browser window by user- check to choose.
Disable browser window scrolling- check to choose.
Make browser window invisible- check to choose.
Set position-Under Construction!!!- check to choose.
Set size-Under Construction!!!- check to choose.
Use the page- click to choose Insert Page Name.
From asset HTML- click to choose from list.

'''Timed limited display HTML Rule:''' Displays an html browser window for a limited time.

'''Properties'''
HTML Asset Name-

'''Display Video Rule:''' Displays a page from a HTML assets in a browser window.

'''Properties'''

'''End Session Rule:''' End Session without saving.

'''Properties'''

'''Fade in/out Rule:''' Fade in or out within seconds, color and opacity considered.

'''Properties'''

'''Flash HUD Icon Rule:''' Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.

'''Properties'''

'''Generic Tree Node Debug Window Rule:''' No description.

'''Properties'''

'''InputTable Rule:''' Creating a list of message names to be used for various purposes.

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

'''Properties'''
'''(Check Box) Pause game while message is displayed:''' - stops the game until this message is switched off
'''(Check Box) Close previous popup windows:''' - closes any Message Popups currently displayed
'''Message location: ''<Top Left/Top Right/Bottom Left/Bottom Right>''''' - select one to position the browser window on the screen
'''Message Source:'''
'''(Option button) Custom text:''' - the simplest and easiest option
'''Icon: ''<Click here to set>''''' - shows a list of message icons. Select one to be displayed with the message
'''Icon: ''<Clear icon>''''' - clears any currently displayed message icon
'''Custom text box:''' Enter text to be displayed. You will be limited to about 6 lines of text. For longer messages or to include graphics, use the '''A predefined HTML page''' option.
'''(Option button) 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.
'''(Option button) 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.

'''Minimap Options Rule:''' Sets the display options for the minimap.

'''Properties'''

'''Play Sound Rule:''' Plays a wav sound file.

'''Properties'''

'''Session Debug Rule Rule:''' Executes the first child if debug mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.

'''Properties'''

'''Session Metadata Rule:''' Sets session metadata in the config file. Info can be read by other systems and displayed to the player.

'''Properties'''

'''Set Helper Icon Size Rule:''' Sets the size of helper icons such as the junction lever arrows.

'''Properties'''

'''Set HTML Page Rule:''' Instructs the Display HTML Pages rule to perform specific operations

'''Properties'''

'''Show/Hide HUD Panel Rule:''' Shows or hides a HUD panel.

'''Properties'''

'''Show/Hide Layer Rule:''' Shows or hides a layer from Driver.

'''Properties:'''
'''Show/Hide''' - select one
'''click here to set''' - enter name of layer. Name is case sensitive.

'''Known Bugs:'''
TANE (all versions) - layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded

'''Show/Hide Minimap Rule:''' Shows the Driver the minimap window.

'''Properties'''
'''Minimap Window'''-click to choose Show,Hide

'''Show/hide on-screen help Rule:''' Shows or hides On-screen help in Driver.

'''Properties'''
'''Junction Overlays:''' - fill-in to choose: Show, Hide, Leave unchanged. by default one is chosen
'''On Screen Vehicle Name:''' - Fill-in to choose: Show, Hide, Leave unchanged. By default one is chosen

'''Wait for Click on HUD Icon Rule:''' Waits for a click on the HUD Icon.

'''Properties'''
'''(Check Box) Trigger Once:''' -to choose
'''HUD Panel:''' - Click to choose from list: Bottom Right Menu, Camera Controls, DCC Controls
'''Icon:''' - Choose from list. Selections depends on HUD Panel chosen

'''Wait on Waybill Screen/Main Screen Rule:''' Waits for the Waybill window to be opened.

'''Properties'''

=='''Startup Rules:'''==

'''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.

'''Properties'''

'''Startup Options Rule''' Specifies the starting options for the session.

'''Properties'''

=='''Time Rules:'''==

'''Clock Rule:''' Rule needed for animated clocks, you need to apply this rule to your session to make use of the animated clocks, see forum for code to include in you clock object to work with this rule.

'''Properties'''

'''Timecheck Rule:''' Executes child rules at a certain time.

'''Properties'''

'''Timing Check Rule:''' Triggers sub rules if called within the time window specified.

'''Properties'''

'''Wait Rule:''' Wait for number of seconds'

'''Properties'''

=='''Variable Rules:'''==

'''Variable Check Rule:''' If the specified variable matches the specified conditions then the child rules will be executed in order.

'''Properties'''
'''''<variable-name>''''' - enter a variable-name. Variable name is case sensitive.
'''''<test-condition>''''' - '''is less than/is less than or equal to/is equal to/is greater than or equal to/is greater than/is not equal to/is between x and y''' - select one
'''''This condition will be evaluated only once .../This condition will be evaluated once every second''''' - click to select one
'''Test condition option: is between x and y'''
Enter minimum (x) and maximum (y) test values

'''Test condition option: (all other options)'''
Enter test value

'''Evaluation option: 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

'''Evaluation option: This condition will be evaluated evaluated once every second''' - the rule will be run and the variable rechecked every second

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

'''Properties'''
'''Change: Add to variable/Subtract from variable/Change variable''' - select one
'''(optional check box) Set the minimum value''' of ''<variable-name>'' to ''<value>'' - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.
('''optional check box) Set the maximum value''' of ''<variable-name>'' to ''<value>'' - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.

'''Change option: 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.

'''Change option: 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 option: Change variable'''
'''Change variable ''<variable-name>'' to ''<value>''''' - enter variable-name, enter new value. This cannot be undone if the rule is stopped. Variable-name is case sensitive.

'''Variable Modify Continuous Rule:''' Adds, subtracts or sets a value to a specified variable every second.

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

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

'''Properties'''
'''Check box: Add'''
''<variable-name>'' - enter variable-name. 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. Variable-name is case sensitive.

Variables are saved in the session file and persist from one saved game to another.
They can be accessed/modified by the following '''driver commands''':

'''Driver Commands by trev999:'''
'''Set S-Variable driver command: '''
'''Skip if session-variable driver command: '''
'''Wait until S-variable driver command: '''

'''Driver Commands by atilabarut'''
'''ChangeSVariables driver command: '''
'''WaitUntilSVariable driver command: '''

=='''Weather Rules:'''==

'''EIRS Weather Rule NE USA Rule:''' Customize random weather rule relative to the North East Region of the United States.

'''Properties'''

'''Weather Rule:''' Set the weather conditions.

'''Properties'''

Session Rules By Categories With Properties

2017-09-28T13:43:48Z

Coop2:

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

=='''Achievement Rules'''==

'''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement

'''Properties:'''
None

'''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload

'''Properties:'''
'''Target object''' ?? name of object such as Power Station, Coal Pit or Portal
'''Lock train's controls'''- checked during a stopped load/unload operation
'''Override 'begin load' and 'begin unload' '''- checked # of seconds to override

'''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations

'''Properties:'''
'''<Click to Select>'''- Trigger from Session List.
'''<Click to Select>'''- Industry from Session List
'''<Radio Buttons>'''
-Choose to accept all trains.
-Accept trains matching specific criteria of Assets from Session List

'''Power Station Rule:''' Sets up Station and Consumers

'''Properties:'''
'''<Click to Select>'''- from Session Stations.
'''<Click to Select>'''- Consumers(Add Object) choose from Session List

'''Resource Check Rule:''' Check the progress of the amount of a resource and target object

'''Properties:'''
'''<Radio Buttons>'''
-Watch industry queue
-Watch vehicle
'''Note:''' Both have: Target Object, Queue: click to choose
'''<Radio Buttons>'''- Complete when designated queue
-equals or exceeds required amount
-falls below required amount

'''Multiple Resource Check Rule:''' If specified resources in a selected industry or vehicle reaches set levels, then the following child rules will be executed

'''Properties:'''
'''''<Reach-Exceed/Fall below>'':''' - click to select one
'''''<value>'':''' - enter required quantity value
'''''<Click to 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. For each object:-
'''''<Object>'':''' - click to select session active industry or product enabled rail vehicle
'''''<Queue>'':''' - select product queue (there may be only one available)
'''''<Remove''>:''' - removes the object and its product queue from the rule
'''Notes:'''
'''''Reach/Exceed''''' - sets an upper limit for the resource 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 resource 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.

'''Objective Add Rule:''' Sets up a game Objective with ID and display Name

'''Properties:'''
'''Priority <Click to Select>'''
''''-Above Normal:''''
''''-Below Normal:''''
''''-Normal:''''
''''-Optional:''''
''''-Urgent:''''
'''Completion Target Number <Click to Select>'''
''''-sets Completion Target Number''''
'''Icon <Click to Select>'''
''''- select Icon from list''''
'''Display Name <Click to Insert>'''
''''-insert Name''''
'''Unique Objective ID <Click to Set>'''
''''-set ID''''
'''Custom Message <Text Box>'''
''''-insert typed message in text area

'''Objective Check Rule:''' Executes child rules when objective is complete

'''Properties:'''
Unique Objective ID click insert ID number
Mode click choose Wait for completion, Wait for failure, Wait for progress

'''Objective Update Rule:''' Changes progress outcome according to Property choices

'''Properties:'''
Unique Objective ID click to set ID number
Mode click Set objective as Decrement progress/Increment progress/Reset objective/Set objects as complete/Set objects as failed/Set progress/Set progress only if greater
Amount click insert number

'''Ranked Session Begin Rule:''' Begins a ranked Session

'''Properties:'''
Countdown requires a Starting Value insert hrs., min,sec
1 through 5 stars, points for each star insert number of points
Session timer mode fill-in chooses: Timer, Countdown, None

'''Ranked Session Complete Rule:''' Completes the active ranked Session

'''Properties:'''
Set the active ranked session as fill-in choose: Complete, Failed
Customize the completion message check insert text message

'''Session Complete Rule:''' Set session to a percentage of completion

'''Properties:'''
Set session to percent complete click to insert number in percent
Separate achievements for completion check

=='''Danger Rules'''==

'''ATP Speed Limiter Rule:''' Limits speed over set limit

'''Properties:'''
speed limit over the set limit mph

'''Speeding Check Rule:''' If player controlled trains are over the local speed limit or over a set (custom) speed, then the following child rules will be executed

'''Properties:'''
'''(Option button) Watch for trains travelling above the posted speed limit'''
'''''<speed value>'':''' - click to enter a new overspeed tolerance value
'''''<Kmph/MPH/mps>'':''' - click to select one
'''(Option button) Watch for trains travelling above a custom speed'''
'''''<speed value>'':''' - click to enter a new custom speed value
'''''<Kmph/MPH/mps>'':''' - click to select one
'''Warning: This option is very performance intensive and should only be used in sessions with few trains'''

'''AWS Configuration Rule:''' This rule configures the Trainz implementation of the Automatic Warning System when approaching signals

'''Properties:'''
Use modern sound set for unfitted cabs? check
Simulate AWS for unfitted cabs? check
Passive with HUD hidden fill-in
Active fill-in
Passive fill-in

'''Wait for Derailment Rule:''' Waits for a derailment to occur

'''Properties:'''
Trigger derailment watch once check to set

'''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars after a set time delay

'''Properties:'''
'''''<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.

'''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule

'''Properties:'''
'''(Check box) Respawn trains if they are abandoned for 10 minutes'''
If checked:-
'''(Option button) Respawn trains at their original locations'''
'''(Option button) Respawn trains from portals'''
If '''Respawn trains from portals''' is selected, then:-
'''''<+ Add a new portal>''''' - click to enter the name of a portal, there can be more than one portal.
Entered names that appear in red have not been found in the session

'''Coupler Breakage Check Rule:''' Checks for breaking couplers and, if found, then executes any following child rules.

'''Properties:'''
None

'''Coupler Breakage HUD Rule:''' HUD displays warning about coupler stress and breakage

'''Properties:'''
'''(Option button) Show the Coupler Breakage Display'''
'''(Option button) Hide the Coupler Breakage Display'''

'''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles

'''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: ''<Locked/Unlocked>''''' - click to select
'''Back: ''<Locked/Unlocked>''''' - click to select
'''Decoupling Mask:'''
'''Front: ''<Locked/Unlocked>''''' - click to select
'''Back: ''<Locked/Unlocked>''''' - click to select
'''''<Remove>'':''' - click to remove that vehicle from the rule

'''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users and, if found, then executes any following child rules.

'''Properties:'''
'''(Check box) Trigger only once:'''

'''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users and, if found, then executes any following child rules.

'''Properties:'''
'''(Check box) Trigger only once:'''

'''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger (stop) and, if found, then executes any following child rules.

'''Properties:'''
'''(Check box) Trigger only once:'''

'''Vehicle Physics Rule:''' Overrides the default vehicle physics properties

'''Properties:'''
Accept all trains fill-in
Cab sway level is set ? % click to insert percent of sway
Traction boost is % ? while sanding click to insert percent of boost
Tractions reduced to ? % while click to set traction percent
Maximum tractive effort adjusted by ? click to insert percent amount
Show coupler breakage in HUD Rule check to set
Couplers break when coupling above ? click to set speed
Accept trains matching specific criteria fill-in to insert specific trains
Couplers break at ? kN check to insert amount of force

=='''Navigation Rules'''==

'''DestSignTable Rule:''' Table for creating a table of destination signs

'''Properties:'''
Enable Track Marks as destinations check
Enable table of destinations check
Import destination from texture-group. name
Destination Name name
Enable industries/stations as check
Interlocking Tower Configure Path Alters settings on an interlocking tower path
Interlocking Tower choose Name and Objects
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
Show path activation message in Driver check

'''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train

'''Properties:'''
Interlocking Tower choose Names and Objects
Multiple Junction Alignment Check Checks multiple junctions are in alignment
Wait until the following junctions are choose all or anyone
Add junction click add junction from session list
Add all click add all junctions from session list
Delete all click deletes all junctions from rule list

'''Navigation Display Rule:''' Creates a set of navigation points. Multiple sets can be created by adding additional copies of this rule. This rule creates the navigation set, it does not display it. Use the '''Navigation set hide/show rule''' to make a set visible. Navigation sets can be completed (terminated) by the '''Navigation Set Clear Rule''', individual navigation points can be ''manually'' completed by the '''Navigation Point Complete Rule'''. Click the help icon at the top of the properties box for in game instructions.

'''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.
'''Navigation mode:''' - select one option
'''(Option button) 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.
'''(Option button) 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.
'''(Option button) 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 (a trigger, trackmark, track object or rolling stock asset) 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'': ''<Automatic/Manual/Require Stop>''''' - click to select one
'''''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''' 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.

'''Navigation Point Complete Rule:''' Manually completes a navigation point in a set

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

'''Navigation Set Check Rule:''' Checks if a navigation set is complete or incomplete, if so then the following child rules will be executed

'''Properties:'''
'''Checks if navigation point set ''<click to select>'':''' - 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.

'''Navigation Set Clear Rule:''' Clears a navigation set removing any uncompleted navigation points

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

'''Navigation Set Hide/Show:''' Shows and hides navigation sets. You can have multiple sets visible and hidden at the same time.

'''Properties:'''
'''''<Hide/Show>'':''' - click to select one
'''''<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.

'''Schedule Rule:''' Allows a schedule of timed events to be applied to a train

'''Properties:'''
Insert track mark click to select from session list
Note: Both has an arrival and departure set time hr:min:sec
Current Train click to select from session list
Insert destination click to select from session list

'''Set Junctions Rule:''' Sets the selected junctions to a specific state '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''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:-
'''''<Left/Center/Right/Don't change>''''' - click to set the junction direction
'''''<Locked/Unlocked>''''' - click to select. '''Locked''' means the junction setting cannot be changed by the user
'''''<Allows AI control/Blocks AI control>''''' - click to select
'''''Remove''''' - click to remove that junction from the rule list

'''Set Signal Extended Rule:''' Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''Properties:'''
'''''Select signal''''' - click to select a signal from the session list
'''''<signal state>''''' - click to select a state from the list

'''Trigger Check Rule:''' - Waits for any train to enter one of the designated triggers. This rule replaces the older and less versatile "Trigger Rule".

'''Properties:'''
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list
Add Trigger click to choose from session list
Trigger only once check to set
Wait for child rules to complete even if check to set
Only activate when the entering click to choose forward, backward

'''Wait on Navigation Point Rule:''' Waits for a navigation point to be completed then the following child rules will be executed

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

'''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start

'''Properties:'''
Accept all trains fill-in to set
Accept trains matching specific criteria fill-in to set and choose from session list
Wait for a train that matches the click to choose: start moving, stop moving
Trigger rule once check to set
Note: One or the other fill-ins must be

=='''Driver Rules'''==

'''Control Type Rule''' Sets control type

'''Properties:'''
Current control method is: Easy Mode, Choice one of the three

'''Control Check Rule:''' Activates child rules based on the control method changes

'''Properties:'''
Excite child rules when: DCC mode is fill-in one or the other
Excite child rules: Every time control fill-in one or the other

'''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule

'''Properties:'''
Trigger add Trigger
Portal index from PCP value
Use UnPortal yes/no
Delay from Trigger to Emit: seconds value

'''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry

'''Properties:'''
Apply to every vehicle in the session fill-in
Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles
Note: One of the Applies will always be
Load/Unload for industry Disable/Enable choose Industry

'''Driver Command Rule:''' Specify which commands will be available for the drivers

'''Properties''':
Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.
Navigate To TrackMarkList V2- No description.
Navigate To Station V2- No description.
Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.
Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.
Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.
Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.
Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.
Drive To Station V2- No description.
Drive To Track mark List V2- No description.
Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.
Drive To Industry- Drive to a specific industry.
Change Destination Sign-Changes the destination signs of a train.

WaitFor- Pauses the driver's schedule for a set duration of time.
Wait For Random- TRS2008: Wait for specified or optionally random period of time.
Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).
WaitUntil- No description.

VR Set Train Lamps-Driver command that sets the train lamps.
Notify- Notifies the player of schedule progress/completion.
Reverse Tram- Reverse a tram(max 2 cars).
Couple- Couple train to designate vehicle.
Decouple- Decouples the train at the specified vehicle.
UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).
Halt Train- Brings the train to a complete stop.
Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.
Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger
station before using this command.
Cab: Wait-Maintains current control state until some condition is met.
Delete Train- Causes the train and its driver to be deleted from the session.
Hornz- Driver sounds the train horn.
Cab: Set Control-Sets a cab mode control.
Headlights On/Off-Allows the driver to to switch the headlights on and off.
Interior Lights Command- Driver command to switch interior lights on or off for the current train.
Set Max Speed To- No description.

Release Junction - Lets a driver release the junction they have been holding.
Move Turntable- TRS2008: Move turntable to a stop point .

Load- Loads the train's vehicles at the industry the driver is currently at with the train.
Unload- Unload train vehicles at current industry location.
Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.
Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.
Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.

'''Driver Command Check Rule:''' Verifies the driver commands of a driver character

'''Properties'''
Wait for driver character to have add driver, all, delete all
Trigger Rule once check
Driver character to watch the name driver

'''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar

'''Properties'''
The Driver Main Bar choice show/hide

'''Driver Schedule Rule''' Execution of basic scheduled commands

'''Properties:'''
Note: Only one of the fill-in can be
Driver Schedule Rule assigned to name driver
Commands insert driver commands in Drive Schedule
Classic style: If there is a schedule fill-in
Killer style: If there is a schedule fill-in
Cooperative style: If there is a schedule fill-in
Active style: Emit a new schedule, only fill-in

'''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders

'''Properties'''
Generate new Drivers for empty check
The following drivers will be available Driver's Name Add
Remove all existing Drivers first check

'''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers

'''Properties'''
Assign Driver commands check Driver Commands
Train criteria fill in all trains
Train criteria list train only trains matching criteria

'''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted

'''Properties'''
Config/txt file tag 'max_permitted_speed-60850 in mph or kph
Add to config.txt and kuid-table for value <KUID2:60850:88000:4
Note: Old root level config tag will

'''QuickDrive Rule:''' Change the Session settings and add consists in Driver

'''Properties'''
Set Time to insert time
QuickDrive Consist Option List by
Rate of Change insert rate as number times
Enable gameplay Session Mode check
Enable in game help by default check
Set the default Control method to fill-in choose: Easy Mode, Realistic Mode
Prevent player from changing this check
Realistic mode requires achievement add Achievement's Name
In Asset choose Auran achievements
Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic
Prevent player from changing 10.0 check
Set the default units to fill-in choose: Imperial, Metric, Default
Open QuickDriver Window when check

'''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train

'''Properties'''
Note: One or the other fill-ins must be
Accept trains matching specific criteria fill-in to select from session list
Accept all trains fill-in to set
Trigger rule once check to set
Wait for a driver character to get ? a click to select: On, Off

'''Wait for Driver/Train to be Locally Owned Rule:''' Waits for a specific driver or train car to be locally owned, Owned then executes child rules. If the driver/train car becomes unowned again the child rules are paused

'''Properties'''
Wait for ownership of a specific Driver fill-in to set
Wait for ownership of Driver fill-in to set
Note: One or the other fill-in must be
Driver or Vehicle click to choose from session lists

=='''Arrangement of Session Rules:'''==

'''Ordered List Rule:''' Child rules will be executed in order once this rule starts

'''Properties'''
Note: One of the two must be chosen
This process will repeat fill-in click to add number of repeats
This process will repeat forever fill-in

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

'''Properties'''
After last child run is executed click to choose: First child is chosen again, It will be
used for all successive runs, Successive runs will
do nothing

'''Random List Rule:''' One of the child rules indented under this rule will be randomly selected and executed

'''Properties'''
executed randomly
Once one of the child rule is ??

'''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle

'''Properties'''
None

'''Simultaneous List Rule:''' Child rules are executed simultaneously once this rule starts

'''Properties'''
Rules completes when click choose all rules have reached completed state,
was completed state

=='''Camera Rules:'''==

'''Cinematic Camera Rule:''' Provides several different cinematic style cameras

'''Properties'''
Lock camera controls for the duration check
Prevent rain control for duration check
Camera target: name any of the many objects in session
Camera mode: Stationary, Circle fill-in
Initial camera values: Pitch, Yaw, Zoom value
Total time to animate: seconds value

'''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties

'''Properties'''
Change the camera view mode to check to choose: Cab View, External View, Tracking
View, Free Roaming
Vehicle fill-in choose from session vehicles
Set the camera flags to enable/disable check to choose different properties from list
Junction fill-in choose from session junctions
Set the target objet of the camera to check
Map object fill-in choose from map objects

'''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view

'''Properties'''
Trigger rule once check to set
Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking
View, Free Roaming View
Wait for the camera to target vehicle ? click to choose form session list

=='''Message Rules:'''==

'''Close Message Popup Rule:''' Closes open message popups

'''Properties:'''
None
'''Known Issues:'''
This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule

'''Custom Script Rule:'''

'''Properties'''
None.

'''Display Custom HUD Rule:''' Show or hide the Custom Heads Up Display.

'''Properties'''
Show the Custom Heads up Display- fill-in to choose.
Hide the Custom Heads up Display- fill-in to choose.
Note: One or the other will be chosen by default.

'''Wait for Click on HUD Icon Rule:'''

'''Properties'''
Trigger rule once-check to choose.
HUD Panel- click to choose from list.
Wait for click on- click to choose; choice depends on HUD Panel chosen.

'''Display HTML Pages Rule:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.

'''Properties'''
Add Page- click on to choose from list; click to Add Page Name or Remove.
Add All- click to add all files from the designated assets.
Delete All- delete all files from this property list.
Prevent user from exiting browser until all pages viewed- check to choose.
Disable closing of browser window by user- check to choose.
Disable browser window scrolling- check to choose.
Make browser window invisible- check to choose.
Set position-Under Construction!!!- check to choose.
Set size-Under Construction!!!- check to choose.
Use the page- click to choose Insert Page Name.
From asset HTML- click to choose from list.

'''Timed limited display HTML Rule:''' Displays an html browser window for a limited time.

'''Properties'''
HTML Asset Name-

'''Display Video Rule:''' Displays a page from a HTML assets in a browser window.

'''Properties'''

'''End Session Rule:''' End Session without saving.

'''Properties'''

'''Fade in/out Rule:''' Fade in or out within seconds, color and opacity considered.

'''Properties'''

'''Flash HUD Icon Rule:''' Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.

'''Properties'''

'''Generic Tree Node Debug Window Rule:''' No description.

'''Properties'''

'''InputTable Rule:''' Creating a list of message names to be used for various purposes.

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

'''Properties'''
'''(Check Box) Pause game while message is displayed:''' - stops the game until this message is switched off
'''(Check Box) Close previous popup windows:''' - closes any Message Popups currently displayed
'''Message location: ''<Top Left/Top Right/Bottom Left/Bottom Right>''''' - select one to position the browser window on the screen
'''Message Source:'''
'''(Option button) Custom text:''' - the simplest and easiest option
'''Icon: ''<Click here to set>''''' - shows a list of message icons. Select one to be displayed with the message
'''Icon: ''<Clear icon>''''' - clears any currently displayed message icon
'''Custom text box:''' Enter text to be displayed. You will be limited to about 6 lines of text. For longer messages or to include graphics, use the '''A predefined HTML page''' option.
'''(Option button) 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.
'''(Option button) 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.

'''Minimap Options Rule:''' Sets the display options for the minimap.

'''Properties'''

'''Play Sound Rule:''' Plays a wav sound file.

'''Properties'''

'''Session Debug Rule Rule:''' Executes the first child if debug mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.

'''Properties'''

'''Session Metadata Rule:''' Sets session metadata in the config file. Info can be read by other systems and displayed to the player.

'''Properties'''

'''Set Helper Icon Size Rule:''' Sets the size of helper icons such as the junction lever arrows.

'''Properties'''

'''Set HTML Page Rule:''' Instructs the Display HTML Pages rule to perform specific operations

'''Properties'''

'''Show/Hide HUD Panel Rule:''' Shows or hides a HUD panel.

'''Properties'''

'''Show/Hide Layer Rule:''' Shows or hides a layer from Driver.

'''Properties:'''
'''Show/Hide''' - select one
'''click here to set''' - enter name of layer. Name is case sensitive.

'''Known Bugs:'''
TANE (all versions) - layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded

'''Show/Hide Minimap Rule:''' Shows the Driver the minimap window.

'''Properties'''
'''Minimap Window'''-click to choose Show,Hide

'''Show/hide on-screen help Rule:''' Shows or hides On-screen help in Driver.

'''Properties'''
'''Junction Overlays:''' - fill-in to choose: Show, Hide, Leave unchanged. by default one is chosen
'''On Screen Vehicle Name:''' - Fill-in to choose: Show, Hide, Leave unchanged. By default one is chosen

'''Wait for Click on HUD Icon Rule:''' Waits for a click on the HUD Icon.

'''Properties'''
'''(Check Box) Trigger Once:''' -to choose
'''HUD Panel:''' - Click to choose from list: Bottom Right Menu, Camera Controls, DCC Controls
'''Icon:''' - Choose from list. Selections depends on HUD Panel chosen

'''Wait on Waybill Screen/Main Screen Rule:''' Waits for the Waybill window to be opened.

'''Properties'''

=='''Startup Rules:'''==

'''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.

'''Properties'''

'''Startup Options Rule''' Specifies the starting options for the session.

'''Properties'''

=='''Time Rules:'''==

'''Clock Rule:''' Rule needed for animated clocks, you need to apply this rule to your session to make use of the animated clocks, see forum for code to include in you clock object to work with this rule.

'''Properties'''

'''Timecheck Rule:''' Executes child rules at a certain time.

'''Properties'''

'''Timing Check Rule:''' Triggers sub rules if called within the time window specified.

'''Properties'''

'''Wait Rule:''' Wait for number of seconds'

'''Properties'''

=='''Variable Rules:'''==

'''Variable Check Rule:''' If the specified variable matches the specified conditions then the child rules will be executed in order.

'''Properties'''
'''''<variable-name>''''' - enter a variable-name. Variable name is case sensitive.
'''''<test-condition>''''' - '''is less than/is less than or equal to/is equal to/is greater than or equal to/is greater than/is not equal to/is between x and y''' - select one
'''''This condition will be evaluated only once .../This condition will be evaluated once every second''''' - click to select one
'''Test condition option: is between x and y'''
Enter minimum (x) and maximum (y) test values

'''Test condition option: (all other options)'''
Enter test value

'''Evaluation option: 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

'''Evaluation option: This condition will be evaluated evaluated once every second''' - the rule will be run and the variable rechecked every second

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

'''Properties'''
'''Change: Add to variable/Subtract from variable/Change variable''' - select one
'''(optional check box) Set the minimum value''' of ''<variable-name>'' to ''<value>'' - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.
('''optional check box) Set the maximum value''' of ''<variable-name>'' to ''<value>'' - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.

'''Change option: 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.

'''Change option: 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 option: Change variable'''
'''Change variable ''<variable-name>'' to ''<value>''''' - enter variable-name, enter new value. This cannot be undone if the rule is stopped. Variable-name is case sensitive.

'''Variable Modify Continuous Rule:''' Adds, subtracts or sets a value to a specified variable every second.

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

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

'''Properties'''
'''Check box: Add'''
''<variable-name>'' - enter variable-name. 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. Variable-name is case sensitive.

Variables are saved in the session file and persist from one saved game to another.
They can be accessed/modified by the following '''driver commands''':

'''Driver Commands by trev999:'''
'''Set S-Variable driver command: '''
'''Skip if session-variable driver command: '''
'''Wait until S-variable driver command: '''

'''Driver Commands by atilabarut'''
'''ChangeSVariables driver command: '''
'''WaitUntilSVariable driver command: '''

=='''Weather Rules:'''==

'''EIRS Weather Rule NE USA Rule:''' Customize random weather rule relative to the North East Region of the United States.

'''Properties'''

'''Weather Rule:''' Set the weather conditions.

'''Properties'''

Session Rules By Categories With Properties

2017-09-27T21:39:05Z

Coop2:

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

=='''Achievement Rules'''==

'''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement

'''Properties:'''
None

'''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload

'''Properties:'''
'''Target object''' ?? name of object such as Power Station, Coal Pit or Portal
'''Lock train's controls'''- checked during a stopped load/unload operation
'''Override 'begin load' and 'begin unload' '''- checked # of seconds to override

'''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations

'''Properties:'''
'''<Click to Select>'''- Trigger from Session List.
'''<Click to Select>'''- Industry from Session List
'''<Radio Buttons>'''
-Choose to accept all trains.
-Accept trains matching specific criteria of Assets from Session List

'''Power Station Rule:''' Sets up Station and Consumers

'''Properties:'''
'''<Click to Select>'''- from Session Stations.
'''<Click to Select>'''- Consumers(Add Object) choose from Session List

'''Resource Check Rule:''' Check the progress of the amount of a resource and target object

'''Properties:'''
'''<Radio Buttons>'''
-Watch industry queue
-Watch vehicle
'''Note:''' Both have: Target Object, Queue: click to choose
'''<Radio Buttons>'''- Complete when designated queue
-equals or exceeds required amount
-falls below required amount

'''Multiple Resource Check Rule:''' If specified resources in a selected industry or vehicle reaches set levels, then the following child rules will be executed

'''Properties:'''
'''''Reach-Exceed/Fall below'':''' - click to select one
'''''<value>'':''' - enter required quantity value
'''''<Click to 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. For each object:-
'''Object:''' - select session active industry or product enabled rail vehicle
'''Queue:''' - select product queue (there may be only one available)
'''Remove:''' - removes the object and its product queue from the rule
'''Notes:'''
'''''Reach/Exceed''''' - sets an upper limit for the resource 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 resource 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.

'''Objective Add Rule:''' Sets up a game Objective with ID and display Name

'''Properties:'''
Priority click choose Above Normal, Below Normal, Normal, Optional, Urgent
Completion Target click to set target number
Icon click choose from list
Display Name click insert Name
Unique Objective ID click set ID
Custom Message insert typed message in text area

'''Objective Check Rule:''' Executes child rules when objective is complete

'''Properties:'''
Unique Objective ID click insert ID number
Mode click choose Wait for completion, Wait for failure, Wait for progress

'''Objective Update Rule:''' Changes progress outcome according to Property choices

'''Properties:'''
Unique Objective ID click to set ID number
Mode click Set objective as Decrement progress/Increment progress/Reset objective/Set objects as complete/Set objects as failed/Set progress/Set progress only if greater
Amount click insert number

'''Ranked Session Begin Rule:''' Begins a ranked Session

'''Properties:'''
Countdown requires a Starting Value insert hrs., min,sec
1 through 5 stars, points for each star insert number of points
Session timer mode fill-in chooses: Timer, Countdown, None

'''Ranked Session Complete Rule:''' Completes the active ranked Session

'''Properties:'''
Set the active ranked session as fill-in choose: Complete, Failed
Customize the completion message check insert text message

'''Session Complete Rule:''' Set session to a percentage of completion

'''Properties:'''
Set session to percent complete click to insert number in percent
Separate achievements for completion check

=='''Danger Rules'''==

'''ATP Speed Limiter Rule:''' Limits speed over set limit

'''Properties:'''
speed limit over the set limit mph

'''Speeding Check Rule:''' If player controlled trains are over the local speed limit or over a set (custom) speed, then the following child rules will be executed

'''Properties:'''
'''(Option button) Watch for trains travelling above the posted speed limit'''
'''''<speed value>'':''' - click to enter a new overspeed tolerance value
'''''<units>'':''' - '''Kmph/MPH/mps''' - click to select one
'''(Option button) Watch for trains travelling above a custom speed'''
'''''<speed value>'':''' - click to enter a new custom speed value
'''''<Kmph/MPH/mps>'':''' - click to select one
'''Warning: This option is very performance intensive and should only be used in sessions with few trains'''

'''AWS Configuration Rule:''' This rule configures the Trainz implementation of the Automatic Warning System when approaching signals

'''Properties:'''
Use modern sound set for unfitted cabs? check
Simulate AWS for unfitted cabs? check
Passive with HUD hidden fill-in
Active fill-in
Passive fill-in

'''Wait for Derailment Rule:''' Waits for a derailment to occur

'''Properties:'''
Trigger derailment watch once check to set

'''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars after a set time delay

'''Properties:'''
'''''<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.

'''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule

'''Properties:'''
'''(Check box) Respawn trains if they are abandoned for 10 minutes'''
If checked:-
'''(Option button) Respawn trains at their original locations'''
'''(Option button) Respawn trains from portals'''
If '''Respawn trains from portals''' is selected, then:-
'''+ Add a new portal''' - click to enter the name of a portal, there can be more than one portal.
Entered names that appear in red have not been found in the session

'''Coupler Breakage Check Rule:''' Checks for breaking couplers and, if found, then executes any following child rules.

'''Properties:'''
None

'''Coupler Breakage HUD Rule:''' HUD displays warning about coupler stress and breakage

'''Properties:'''
'''(Option button) Show the Coupler Breakage Display'''
'''(Option button) Hide the Coupler Breakage Display'''

'''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles

'''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: ''Locked/Unlocked''''' - click to select
'''Back: ''Locked/Unlocked''''' - click to select
'''Decoupling Mask:'''
'''Front: ''Locked/Unlocked''''' - click to select
'''Back: ''Locked/Unlocked''''' - click to select
'''''Remove'':''' - click to remove that vehicle from the rule

'''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users and, if found, then executes any following child rules.

'''Properties:'''
'''(Check box) Trigger only once:'''

'''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users and, if found, then executes any following child rules.

'''Properties:'''
'''(Check box) Trigger only once:'''

'''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger (stop) and, if found, then executes any following child rules.

'''Properties:'''
'''(Check box) Trigger only once:'''

'''Vehicle Physics Rule:''' Overrides the default vehicle physics properties

'''Properties:'''
Accept all trains fill-in
Cab sway level is set ? % click to insert percent of sway
Traction boost is % ? while sanding click to insert percent of boost
Tractions reduced to ? % while click to set traction percent
Maximum tractive effort adjusted by ? click to insert percent amount
Show coupler breakage in HUD Rule check to set
Couplers break when coupling above ? click to set speed
Accept trains matching specific criteria fill-in to insert specific trains
Couplers break at ? kN check to insert amount of force

=='''Navigation Rules'''==

'''DestSignTable Rule:''' Table for creating a table of destination signs

'''Properties:'''
Enable Track Marks as destinations check
Enable table of destinations check
Import destination from texture-group. name
Destination Name name
Enable industries/stations as check
Interlocking Tower Configure Path Alters settings on an interlocking tower path
Interlocking Tower choose Name and Objects
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
Show path activation message in Driver check

'''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train

'''Properties:'''
Interlocking Tower choose Names and Objects
Multiple Junction Alignment Check Checks multiple junctions are in alignment
Wait until the following junctions are choose all or anyone
Add junction click add junction from session list
Add all click add all junctions from session list
Delete all click deletes all junctions from rule list

'''Navigation Display Rule:''' Creates a set of navigation points. Multiple sets can be created by adding additional copies of this rule. This rule creates the navigation set, it does not display it. Use the '''Navigation set hide/show rule''' to make a set visible. Click the help icon at the top of the properties box for in game instructions.

'''Properties:'''
'''Unique set ID:''' - enter a unique name for the navigation set. Name must be in lowercase and have no spaces.
'''Train (optional):''' - select a rolling stock asset from the session list shown.
'''Navigation mode:''' select one
'''(Option button) 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.
'''(Option button) 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.
'''(Option button) 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 (a trigger, trackmark, track object or rolling stock asset) 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'':''' - select an icon for the navigation point.
'''''Style'': ''Automatic/Manual/Require Stop''''' - click to select one
'''''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'''.
This allows you to execute other rules (e.g. consist check, trigger 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.

'''Navigation Point Complete Rule:''' Marks a navigation point complete

'''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 set display rule'''.
Name must be in lowercase and have no spaces.
'''Know Issues:'''
The rule will '''NOT''' check to see if the named navigation set and point exists or not.

'''Navigation Set Check Rule:''' Checks if a navigation set is complete or incomplete, then the following child rules will be executed

'''Properties:'''
'''Checks if navigation point set ''<click to select>'':''' - enter the unique name for the navigation set created using the '''Navigation set display rule'''.
Name must be in lowercase and have no spaces.
'''is ''<Complete/Incomplete>'':''' - click to select one
'''Know Issues:'''
The rule will '''NOT''' check to see if the named navigation set exists or not.

'''Navigation Set Clear Rule:''' Clears a navigation set removing any uncompleted navigation points

'''Properties:'''
'''''<Click here to set>'':''' - enter the unique name for the navigation set created using the '''Navigation set display rule'''.
Name must be in lowercase and have no spaces.
'''Know Issues:'''
The rule will '''NOT''' check to see if the named navigation set exists or not.

'''Navigation Set Hide/Show:''' Shows and hides navigation sets. You can have multiple sets visible at the same time.

'''Properties:'''
'''''<Hide/Show>'':''' - click to select one
'''''<click here to set>'':''' - enter the unique name for the navigation set created using the '''Navigation set display rule'''.
Name must be in lowercase and have no spaces.
'''Know Issues:'''
The rule will '''NOT''' check to see if the named navigation set exists or not.

'''Schedule Rule:''' Allows a schedule of timed events to be applied to a train

'''Properties:'''
Insert track mark click to select from session list
Note: Both has an arrival and departure set time hr:min:sec
Current Train click to select from session list
Insert destination click to select from session list

'''Set Junctions Rule:''' Sets the selected junctions to a specific state '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''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:-
'''''Setting'': Left/Center/Right/Don't change''' - click one to set the junction direction
'''''Locked'': Locked/Unlocked''' - click to select one. '''Locked''' means the junction setting cannot be changed by the user
'''''Allows AI control/Blocks AI control''''' - click to select one.
'''''Remove''''' - click to remove that junction from the rule list

'''Set Signal Extended Rule:''' Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''Properties:'''
'''''Select signal''''' - click to select a signal from the session list
'''''<signal state>''''' - click to select a state from the list

'''Trigger Check Rule:''' - Waits for any train to enter one of the designated triggers. This rule replaces the older and less versatile "Trigger Rule".

'''Properties:'''
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list
Add Trigger click to choose from session list
Trigger only once check to set
Wait for child rules to complete even if check to set
Only activate when the entering click to choose forward, backward

'''Wait on Navigation Point Rule:''' Waits for a navigation point to be completed then the following child rules will be executed

'''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 set display rule'''.
Name must be in lowercase and have no spaces.
'''Know Issues:'''
The rule will '''NOT''' check to see if the named navigation set and point exists or not.

'''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start

'''Properties:'''
Accept all trains fill-in to set
Accept trains matching specific criteria fill-in to set and choose from session list
Wait for a train that matches the click to choose: start moving, stop moving
Trigger rule once check to set
Note: One or the other fill-ins must be

=='''Driver Rules'''==

'''Control Type Rule''' Sets control type

'''Properties:'''
Current control method is: Easy Mode, Choice one of the three

'''Control Check Rule:''' Activates child rules based on the control method changes

'''Properties:'''
Excite child rules when: DCC mode is fill-in one or the other
Excite child rules: Every time control fill-in one or the other

'''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule

'''Properties:'''
Trigger add Trigger
Portal index from PCP value
Use UnPortal yes/no
Delay from Trigger to Emit: seconds value

'''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry

'''Properties:'''
Apply to every vehicle in the session fill-in
Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles
Note: One of the Applies will always be
Load/Unload for industry Disable/Enable choose Industry

'''Driver Command Rule:''' Specify which commands will be available for the drivers

'''Properties''':
Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.
Navigate To TrackMarkList V2- No description.
Navigate To Station V2- No description.
Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.
Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.
Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.
Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.
Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.
Drive To Station V2- No description.
Drive To Track mark List V2- No description.
Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.
Drive To Industry- Drive to a specific industry.
Change Destination Sign-Changes the destination signs of a train.

WaitFor- Pauses the driver's schedule for a set duration of time.
Wait For Random- TRS2008: Wait for specified or optionally random period of time.
Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).
WaitUntil- No description.

VR Set Train Lamps-Driver command that sets the train lamps.
Notify- Notifies the player of schedule progress/completion.
Reverse Tram- Reverse a tram(max 2 cars).
Couple- Couple train to designate vehicle.
Decouple- Decouples the train at the specified vehicle.
UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).
Halt Train- Brings the train to a complete stop.
Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.
Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger
station before using this command.
Cab: Wait-Maintains current control state until some condition is met.
Delete Train- Causes the train and its driver to be deleted from the session.
Hornz- Driver sounds the train horn.
Cab: Set Control-Sets a cab mode control.
Headlights On/Off-Allows the driver to to switch the headlights on and off.
Interior Lights Command- Driver command to switch interior lights on or off for the current train.
Set Max Speed To- No description.

Release Junction - Lets a driver release the junction they have been holding.
Move Turntable- TRS2008: Move turntable to a stop point .

Load- Loads the train's vehicles at the industry the driver is currently at with the train.
Unload- Unload train vehicles at current industry location.
Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.
Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.
Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.

'''Driver Command Check Rule:''' Verifies the driver commands of a driver character

'''Properties'''
Wait for driver character to have add driver, all, delete all
Trigger Rule once check
Driver character to watch the name driver

'''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar

'''Properties'''
The Driver Main Bar choice show/hide

'''Driver Schedule Rule''' Execution of basic scheduled commands

'''Properties:'''
Note: Only one of the fill-in can be
Driver Schedule Rule assigned to name driver
Commands insert driver commands in Drive Schedule
Classic style: If there is a schedule fill-in
Killer style: If there is a schedule fill-in
Cooperative style: If there is a schedule fill-in
Active style: Emit a new schedule, only fill-in

'''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders

'''Properties'''
Generate new Drivers for empty check
The following drivers will be available Driver's Name Add
Remove all existing Drivers first check

'''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers

'''Properties'''
Assign Driver commands check Driver Commands
Train criteria fill in all trains
Train criteria list train only trains matching criteria

'''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted

'''Properties'''
Config/txt file tag 'max_permitted_speed-60850 in mph or kph
Add to config.txt and kuid-table for value <KUID2:60850:88000:4
Note: Old root level config tag will

'''QuickDrive Rule:''' Change the Session settings and add consists in Driver

'''Properties'''
Set Time to insert time
QuickDrive Consist Option List by
Rate of Change insert rate as number times
Enable gameplay Session Mode check
Enable in game help by default check
Set the default Control method to fill-in choose: Easy Mode, Realistic Mode
Prevent player from changing this check
Realistic mode requires achievement add Achievement's Name
In Asset choose Auran achievements
Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic
Prevent player from changing 10.0 check
Set the default units to fill-in choose: Imperial, Metric, Default
Open QuickDriver Window when check

'''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train

'''Properties'''
Note: One or the other fill-ins must be
Accept trains matching specific criteria fill-in to select from session list
Accept all trains fill-in to set
Trigger rule once check to set
Wait for a driver character to get ? a click to select: On, Off

'''Wait for Driver/Train to be Locally Owned Rule:''' Waits for a specific driver or train car to be locally owned, Owned then executes child rules. If the driver/train car becomes unowned again the child rules are paused

'''Properties'''
Wait for ownership of a specific Driver fill-in to set
Wait for ownership of Driver fill-in to set
Note: One or the other fill-in must be
Driver or Vehicle click to choose from session lists

=='''Arrangement of Session Rules:'''==

'''Ordered List Rule:''' Child rules will be executed in order once this rule starts

'''Properties'''
Note: One of the two must be chosen
This process will repeat fill-in click to add number of repeats
This process will repeat forever fill-in

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

'''Properties'''
After last child run is executed click to choose: First child is chosen again, It will be
used for all successive runs, Successive runs will
do nothing

'''Random List Rule:''' One of the child rules indented under this rule will be randomly selected and executed

'''Properties'''
executed randomly
Once one of the child rule is ??

'''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle

'''Properties'''
None

'''Simultaneous List Rule:''' Child rules are executed simultaneously once this rule starts

'''Properties'''
Rules completes when click choose all rules have reached completed state,
was completed state

=='''Camera Rules:'''==

'''Cinematic Camera Rule:''' Provides several different cinematic style cameras

'''Properties'''
Lock camera controls for the duration check
Prevent rain control for duration check
Camera target: name any of the many objects in session
Camera mode: Stationary, Circle fill-in
Initial camera values: Pitch, Yaw, Zoom value
Total time to animate: seconds value

'''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties

'''Properties'''
Change the camera view mode to check to choose: Cab View, External View, Tracking
View, Free Roaming
Vehicle fill-in choose from session vehicles
Set the camera flags to enable/disable check to choose different properties from list
Junction fill-in choose from session junctions
Set the target objet of the camera to check
Map object fill-in choose from map objects

'''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view

'''Properties'''
Trigger rule once check to set
Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking
View, Free Roaming View
Wait for the camera to target vehicle ? click to choose form session list

=='''Message Rules:'''==

'''Close Message Popup Rule:''' Closes open message popups

'''Properties:'''
None
'''Known Issues:'''
This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule

'''Custom Script Rule:'''

'''Properties'''
None.

'''Display Custom HUD Rule:''' Show or hide the Custom Heads Up Display.

'''Properties'''
Show the Custom Heads up Display- fill-in to choose.
Hide the Custom Heads up Display- fill-in to choose.
Note: One or the other will be chosen by default.

'''Wait for Click on HUD Icon Rule:'''

'''Properties'''
Trigger rule once-check to choose.
HUD Panel- click to choose from list.
Wait for click on- click to choose; choice depends on HUD Panel chosen.

'''Display HTML Pages Rule:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.

'''Properties'''
Add Page- click on to choose from list; click to Add Page Name or Remove.
Add All- click to add all files from the designated assets.
Delete All- delete all files from this property list.
Prevent user from exiting browser until all pages viewed- check to choose.
Disable closing of browser window by user- check to choose.
Disable browser window scrolling- check to choose.
Make browser window invisible- check to choose.
Set position-Under Construction!!!- check to choose.
Set size-Under Construction!!!- check to choose.
Use the page- click to choose Insert Page Name.
From asset HTML- click to choose from list.

'''Timed limited display HTML Rule:''' Displays an html browser window for a limited time.

'''Properties'''
HTML Asset Name-

'''Display Video Rule:''' Displays a page from a HTML assets in a browser window.

'''Properties'''

'''End Session Rule:''' End Session without saving.

'''Properties'''

'''Fade in/out Rule:''' Fade in or out within seconds, color and opacity considered.

'''Properties'''

'''Flash HUD Icon Rule:''' Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.

'''Properties'''

'''Generic Tree Node Debug Window Rule:''' No description.

'''Properties'''

'''InputTable Rule:''' Creating a list of message names to be used for various purposes.

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

'''Properties'''
'''(Check Box) Pause game while message is displayed:''' - stops the game until this message is switched off
'''(Check Box) Close previous popup windows:''' - closes any Message Popups currently displayed
'''Message location: ''Top Left/Top Right/Bottom Left/Bottom Right''''' - select one to position the browser window on the screen
'''Message Source:'''
'''(Option button) Custom text:''' - the simplest and easiest option
'''Icon: ''Click here to set''''' - shows a list of message icons. Select one to be displayed with the message
'''Icon: ''Clear icon''''' - clears any currently displayed message icon
'''Custom text:''' Enter text to be displayed. You will be limited to about 6 lines of text. For longer messages or to include graphics, use the '''A predefined HTML page''' option.
'''(Option button) 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.
'''(Option button) 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.

'''Minimap Options Rule:''' Sets the display options for the minimap.

'''Properties'''

'''Play Sound Rule:''' Plays a wav sound file.

'''Properties'''

'''Session Debug Rule Rule:''' Executes the first child if debug mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.

'''Properties'''

'''Session Metadata Rule:''' Sets session metadata in the config file. Info can be read by other systems and displayed to the player.

'''Properties'''

'''Set Helper Icon Size Rule:''' Sets the size of helper icons such as the junction lever arrows.

'''Properties'''

'''Set HTML Page Rule:''' Instructs the Display HTML Pages rule to perform specific operations

'''Properties'''

'''Show/Hide HUD Panel Rule:''' Shows or hides a HUD panel.

'''Properties'''

'''Show/Hide Layer Rule:''' Shows or hides a layer from Driver.

'''Properties:'''
'''Show/Hide''' - select one
'''click here to set''' - enter name of layer. Name is case sensitive.

'''Known Bugs:'''
TANE (all versions) - layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded

'''Show/Hide Minimap Rule:''' Shows the Driver the minimap window.

'''Properties'''
'''Minimap Window'''-click to choose Show,Hide

'''Show/hide on-screen help Rule:''' Shows or hides On-screen help in Driver.

'''Properties'''
'''Junction Overlays:''' - fill-in to choose: Show, Hide, Leave unchanged. by default one is chosen
'''On Screen Vehicle Name:''' - Fill-in to choose: Show, Hide, Leave unchanged. By default one is chosen

'''Wait for Click on HUD Icon Rule:''' Waits for a click on the HUD Icon.

'''Properties'''
'''(Check Box) Trigger Once:''' -to choose
'''HUD Panel:''' - Click to choose from list: Bottom Right Menu, Camera Controls, DCC Controls
'''Icon:''' - Choose from list. Selections depends on HUD Panel chosen

'''Wait on Waybill Screen/Main Screen Rule:''' Waits for the Waybill window to be opened.

'''Properties'''

=='''Startup Rules:'''==

'''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.

'''Properties'''

'''Startup Options Rule''' Specifies the starting options for the session.

'''Properties'''

=='''Time Rules:'''==

'''Clock Rule:''' Rule needed for animated clocks, you need to apply this rule to your session to make use of the animated clocks, see forum for code to include in you clock object to work with this rule.

'''Properties'''

'''Timecheck Rule:''' Executes child rules at a certain time.

'''Properties'''

'''Timing Check Rule:''' Triggers sub rules if called within the time window specified.

'''Properties'''

'''Wait Rule:''' Wait for number of seconds'

'''Properties'''

=='''Variable Rules:'''==

'''Variable Check Rule:''' If the specified variable matches the specified conditions then the child rules will be executed in order.

'''Properties'''
'''''<variable-name>''''' - enter a variable-name. Variable name is case sensitive.
'''''<test-condition>''''' - '''is less than/is less than or equal to/is equal to/is greater than or equal to/is greater than/is not equal to/is between x and y''' - select one
'''''This condition will be evaluated only once .../This condition will be evaluated once every second''''' - click to select one
'''Test condition option: is between x and y'''
Enter minimum (x) and maximum (y) test values

'''Test condition option: (all other options)'''
Enter test value

'''Evaluation option: 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

'''Evaluation option: This condition will be evaluated evaluated once every second''' - the rule will be run and the variable rechecked every second

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

'''Properties'''
'''Change: Add to variable/Subtract from variable/Change variable''' - select one
'''(optional check box) Set the minimum value''' of ''<variable-name>'' to ''<value>'' - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.
('''optional check box) Set the maximum value''' of ''<variable-name>'' to ''<value>'' - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.

'''Change option: 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.

'''Change option: 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 option: Change variable'''
'''Change variable ''<variable-name>'' to ''<value>''''' - enter variable-name, enter new value. This cannot be undone if the rule is stopped. Variable-name is case sensitive.

'''Variable Modify Continuous Rule:''' Adds, subtracts or sets a value to a specified variable every second.

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

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

'''Properties'''
'''Check box: Add'''
''<variable-name>'' - enter variable-name. 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. Variable-name is case sensitive.

Variables are saved in the session file and persist from one saved game to another.
They can be accessed/modified by the following '''driver commands''':

'''Driver Commands by trev999:'''
'''Set S-Variable driver command: '''
'''Skip if session-variable driver command: '''
'''Wait until S-variable driver command: '''

'''Driver Commands by atilabarut'''
'''ChangeSVariables driver command: '''
'''WaitUntilSVariable driver command: '''

=='''Weather Rules:'''==

'''EIRS Weather Rule NE USA Rule:''' Customize random weather rule relative to the North East Region of the United States.

'''Properties'''

'''Weather Rule:''' Set the weather conditions.

'''Properties'''

Session Rules By Categories With Properties

2017-09-27T21:37:58Z

Coop2:

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

=='''Achievement Rules'''==

'''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement

'''Properties:'''
None

'''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload

'''Properties:'''
'''Target object''' ?? name of object such as Power Station, Coal Pit or Portal
'''Lock train's controls'''- checked during a stopped load/unload operation
'''Override 'begin load' and 'begin unload' '''- checked # of seconds to override

'''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations

'''Properties:'''
'''<Click to Select>'''- Trigger from Session List.
'''<Click to Select>'''- Industry from Session List
'''<Radio Buttons>'''
-Choose to accept all trains.
-Accept trains matching specific criteria of Assets from Session List

'''Power Station Rule:''' Sets up Station and Consumers

'''Properties:'''
'''<Click to Select>'''- from Session Stations.
'''<Click to Select>'''- Consumers(Add Object) choose from Session List

'''Resource Check Rule:''' Check the progress of the amount of a resource and target object

'''Properties:'''
'''<Radio Buttons>'''
-Watch industry queue
-Watch vehicle
'''Note:''' Both have: Target Object, Queue: click to choose
'''<Radio Button>'''- Complete when designated queue
-equals or exceeds required amount
-falls below required amount

'''Multiple Resource Check Rule:''' If specified resources in a selected industry or vehicle reaches set levels, then the following child rules will be executed

'''Properties:'''
'''''Reach-Exceed/Fall below'':''' - click to select one
'''''<value>'':''' - enter required quantity value
'''''<Click to 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. For each object:-
'''Object:''' - select session active industry or product enabled rail vehicle
'''Queue:''' - select product queue (there may be only one available)
'''Remove:''' - removes the object and its product queue from the rule
'''Notes:'''
'''''Reach/Exceed''''' - sets an upper limit for the resource 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 resource 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.

'''Objective Add Rule:''' Sets up a game Objective with ID and display Name

'''Properties:'''
Priority click choose Above Normal, Below Normal, Normal, Optional, Urgent
Completion Target click to set target number
Icon click choose from list
Display Name click insert Name
Unique Objective ID click set ID
Custom Message insert typed message in text area

'''Objective Check Rule:''' Executes child rules when objective is complete

'''Properties:'''
Unique Objective ID click insert ID number
Mode click choose Wait for completion, Wait for failure, Wait for progress

'''Objective Update Rule:''' Changes progress outcome according to Property choices

'''Properties:'''
Unique Objective ID click to set ID number
Mode click Set objective as Decrement progress/Increment progress/Reset objective/Set objects as complete/Set objects as failed/Set progress/Set progress only if greater
Amount click insert number

'''Ranked Session Begin Rule:''' Begins a ranked Session

'''Properties:'''
Countdown requires a Starting Value insert hrs., min,sec
1 through 5 stars, points for each star insert number of points
Session timer mode fill-in chooses: Timer, Countdown, None

'''Ranked Session Complete Rule:''' Completes the active ranked Session

'''Properties:'''
Set the active ranked session as fill-in choose: Complete, Failed
Customize the completion message check insert text message

'''Session Complete Rule:''' Set session to a percentage of completion

'''Properties:'''
Set session to percent complete click to insert number in percent
Separate achievements for completion check

=='''Danger Rules'''==

'''ATP Speed Limiter Rule:''' Limits speed over set limit

'''Properties:'''
speed limit over the set limit mph

'''Speeding Check Rule:''' If player controlled trains are over the local speed limit or over a set (custom) speed, then the following child rules will be executed

'''Properties:'''
'''(Option button) Watch for trains travelling above the posted speed limit'''
'''''<speed value>'':''' - click to enter a new overspeed tolerance value
'''''<units>'':''' - '''Kmph/MPH/mps''' - click to select one
'''(Option button) Watch for trains travelling above a custom speed'''
'''''<speed value>'':''' - click to enter a new custom speed value
'''''<Kmph/MPH/mps>'':''' - click to select one
'''Warning: This option is very performance intensive and should only be used in sessions with few trains'''

'''AWS Configuration Rule:''' This rule configures the Trainz implementation of the Automatic Warning System when approaching signals

'''Properties:'''
Use modern sound set for unfitted cabs? check
Simulate AWS for unfitted cabs? check
Passive with HUD hidden fill-in
Active fill-in
Passive fill-in

'''Wait for Derailment Rule:''' Waits for a derailment to occur

'''Properties:'''
Trigger derailment watch once check to set

'''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars after a set time delay

'''Properties:'''
'''''<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.

'''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule

'''Properties:'''
'''(Check box) Respawn trains if they are abandoned for 10 minutes'''
If checked:-
'''(Option button) Respawn trains at their original locations'''
'''(Option button) Respawn trains from portals'''
If '''Respawn trains from portals''' is selected, then:-
'''+ Add a new portal''' - click to enter the name of a portal, there can be more than one portal.
Entered names that appear in red have not been found in the session

'''Coupler Breakage Check Rule:''' Checks for breaking couplers and, if found, then executes any following child rules.

'''Properties:'''
None

'''Coupler Breakage HUD Rule:''' HUD displays warning about coupler stress and breakage

'''Properties:'''
'''(Option button) Show the Coupler Breakage Display'''
'''(Option button) Hide the Coupler Breakage Display'''

'''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles

'''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: ''Locked/Unlocked''''' - click to select
'''Back: ''Locked/Unlocked''''' - click to select
'''Decoupling Mask:'''
'''Front: ''Locked/Unlocked''''' - click to select
'''Back: ''Locked/Unlocked''''' - click to select
'''''Remove'':''' - click to remove that vehicle from the rule

'''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users and, if found, then executes any following child rules.

'''Properties:'''
'''(Check box) Trigger only once:'''

'''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users and, if found, then executes any following child rules.

'''Properties:'''
'''(Check box) Trigger only once:'''

'''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger (stop) and, if found, then executes any following child rules.

'''Properties:'''
'''(Check box) Trigger only once:'''

'''Vehicle Physics Rule:''' Overrides the default vehicle physics properties

'''Properties:'''
Accept all trains fill-in
Cab sway level is set ? % click to insert percent of sway
Traction boost is % ? while sanding click to insert percent of boost
Tractions reduced to ? % while click to set traction percent
Maximum tractive effort adjusted by ? click to insert percent amount
Show coupler breakage in HUD Rule check to set
Couplers break when coupling above ? click to set speed
Accept trains matching specific criteria fill-in to insert specific trains
Couplers break at ? kN check to insert amount of force

=='''Navigation Rules'''==

'''DestSignTable Rule:''' Table for creating a table of destination signs

'''Properties:'''
Enable Track Marks as destinations check
Enable table of destinations check
Import destination from texture-group. name
Destination Name name
Enable industries/stations as check
Interlocking Tower Configure Path Alters settings on an interlocking tower path
Interlocking Tower choose Name and Objects
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
Show path activation message in Driver check

'''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train

'''Properties:'''
Interlocking Tower choose Names and Objects
Multiple Junction Alignment Check Checks multiple junctions are in alignment
Wait until the following junctions are choose all or anyone
Add junction click add junction from session list
Add all click add all junctions from session list
Delete all click deletes all junctions from rule list

'''Navigation Display Rule:''' Creates a set of navigation points. Multiple sets can be created by adding additional copies of this rule. This rule creates the navigation set, it does not display it. Use the '''Navigation set hide/show rule''' to make a set visible. Click the help icon at the top of the properties box for in game instructions.

'''Properties:'''
'''Unique set ID:''' - enter a unique name for the navigation set. Name must be in lowercase and have no spaces.
'''Train (optional):''' - select a rolling stock asset from the session list shown.
'''Navigation mode:''' select one
'''(Option button) 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.
'''(Option button) 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.
'''(Option button) 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 (a trigger, trackmark, track object or rolling stock asset) 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'':''' - select an icon for the navigation point.
'''''Style'': ''Automatic/Manual/Require Stop''''' - click to select one
'''''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'''.
This allows you to execute other rules (e.g. consist check, trigger 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.

'''Navigation Point Complete Rule:''' Marks a navigation point complete

'''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 set display rule'''.
Name must be in lowercase and have no spaces.
'''Know Issues:'''
The rule will '''NOT''' check to see if the named navigation set and point exists or not.

'''Navigation Set Check Rule:''' Checks if a navigation set is complete or incomplete, then the following child rules will be executed

'''Properties:'''
'''Checks if navigation point set ''<click to select>'':''' - enter the unique name for the navigation set created using the '''Navigation set display rule'''.
Name must be in lowercase and have no spaces.
'''is ''<Complete/Incomplete>'':''' - click to select one
'''Know Issues:'''
The rule will '''NOT''' check to see if the named navigation set exists or not.

'''Navigation Set Clear Rule:''' Clears a navigation set removing any uncompleted navigation points

'''Properties:'''
'''''<Click here to set>'':''' - enter the unique name for the navigation set created using the '''Navigation set display rule'''.
Name must be in lowercase and have no spaces.
'''Know Issues:'''
The rule will '''NOT''' check to see if the named navigation set exists or not.

'''Navigation Set Hide/Show:''' Shows and hides navigation sets. You can have multiple sets visible at the same time.

'''Properties:'''
'''''<Hide/Show>'':''' - click to select one
'''''<click here to set>'':''' - enter the unique name for the navigation set created using the '''Navigation set display rule'''.
Name must be in lowercase and have no spaces.
'''Know Issues:'''
The rule will '''NOT''' check to see if the named navigation set exists or not.

'''Schedule Rule:''' Allows a schedule of timed events to be applied to a train

'''Properties:'''
Insert track mark click to select from session list
Note: Both has an arrival and departure set time hr:min:sec
Current Train click to select from session list
Insert destination click to select from session list

'''Set Junctions Rule:''' Sets the selected junctions to a specific state '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''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:-
'''''Setting'': Left/Center/Right/Don't change''' - click one to set the junction direction
'''''Locked'': Locked/Unlocked''' - click to select one. '''Locked''' means the junction setting cannot be changed by the user
'''''Allows AI control/Blocks AI control''''' - click to select one.
'''''Remove''''' - click to remove that junction from the rule list

'''Set Signal Extended Rule:''' Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''Properties:'''
'''''Select signal''''' - click to select a signal from the session list
'''''<signal state>''''' - click to select a state from the list

'''Trigger Check Rule:''' - Waits for any train to enter one of the designated triggers. This rule replaces the older and less versatile "Trigger Rule".

'''Properties:'''
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list
Add Trigger click to choose from session list
Trigger only once check to set
Wait for child rules to complete even if check to set
Only activate when the entering click to choose forward, backward

'''Wait on Navigation Point Rule:''' Waits for a navigation point to be completed then the following child rules will be executed

'''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 set display rule'''.
Name must be in lowercase and have no spaces.
'''Know Issues:'''
The rule will '''NOT''' check to see if the named navigation set and point exists or not.

'''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start

'''Properties:'''
Accept all trains fill-in to set
Accept trains matching specific criteria fill-in to set and choose from session list
Wait for a train that matches the click to choose: start moving, stop moving
Trigger rule once check to set
Note: One or the other fill-ins must be

=='''Driver Rules'''==

'''Control Type Rule''' Sets control type

'''Properties:'''
Current control method is: Easy Mode, Choice one of the three

'''Control Check Rule:''' Activates child rules based on the control method changes

'''Properties:'''
Excite child rules when: DCC mode is fill-in one or the other
Excite child rules: Every time control fill-in one or the other

'''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule

'''Properties:'''
Trigger add Trigger
Portal index from PCP value
Use UnPortal yes/no
Delay from Trigger to Emit: seconds value

'''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry

'''Properties:'''
Apply to every vehicle in the session fill-in
Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles
Note: One of the Applies will always be
Load/Unload for industry Disable/Enable choose Industry

'''Driver Command Rule:''' Specify which commands will be available for the drivers

'''Properties''':
Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.
Navigate To TrackMarkList V2- No description.
Navigate To Station V2- No description.
Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.
Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.
Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.
Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.
Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.
Drive To Station V2- No description.
Drive To Track mark List V2- No description.
Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.
Drive To Industry- Drive to a specific industry.
Change Destination Sign-Changes the destination signs of a train.

WaitFor- Pauses the driver's schedule for a set duration of time.
Wait For Random- TRS2008: Wait for specified or optionally random period of time.
Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).
WaitUntil- No description.

VR Set Train Lamps-Driver command that sets the train lamps.
Notify- Notifies the player of schedule progress/completion.
Reverse Tram- Reverse a tram(max 2 cars).
Couple- Couple train to designate vehicle.
Decouple- Decouples the train at the specified vehicle.
UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).
Halt Train- Brings the train to a complete stop.
Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.
Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger
station before using this command.
Cab: Wait-Maintains current control state until some condition is met.
Delete Train- Causes the train and its driver to be deleted from the session.
Hornz- Driver sounds the train horn.
Cab: Set Control-Sets a cab mode control.
Headlights On/Off-Allows the driver to to switch the headlights on and off.
Interior Lights Command- Driver command to switch interior lights on or off for the current train.
Set Max Speed To- No description.

Release Junction - Lets a driver release the junction they have been holding.
Move Turntable- TRS2008: Move turntable to a stop point .

Load- Loads the train's vehicles at the industry the driver is currently at with the train.
Unload- Unload train vehicles at current industry location.
Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.
Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.
Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.

'''Driver Command Check Rule:''' Verifies the driver commands of a driver character

'''Properties'''
Wait for driver character to have add driver, all, delete all
Trigger Rule once check
Driver character to watch the name driver

'''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar

'''Properties'''
The Driver Main Bar choice show/hide

'''Driver Schedule Rule''' Execution of basic scheduled commands

'''Properties:'''
Note: Only one of the fill-in can be
Driver Schedule Rule assigned to name driver
Commands insert driver commands in Drive Schedule
Classic style: If there is a schedule fill-in
Killer style: If there is a schedule fill-in
Cooperative style: If there is a schedule fill-in
Active style: Emit a new schedule, only fill-in

'''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders

'''Properties'''
Generate new Drivers for empty check
The following drivers will be available Driver's Name Add
Remove all existing Drivers first check

'''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers

'''Properties'''
Assign Driver commands check Driver Commands
Train criteria fill in all trains
Train criteria list train only trains matching criteria

'''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted

'''Properties'''
Config/txt file tag 'max_permitted_speed-60850 in mph or kph
Add to config.txt and kuid-table for value <KUID2:60850:88000:4
Note: Old root level config tag will

'''QuickDrive Rule:''' Change the Session settings and add consists in Driver

'''Properties'''
Set Time to insert time
QuickDrive Consist Option List by
Rate of Change insert rate as number times
Enable gameplay Session Mode check
Enable in game help by default check
Set the default Control method to fill-in choose: Easy Mode, Realistic Mode
Prevent player from changing this check
Realistic mode requires achievement add Achievement's Name
In Asset choose Auran achievements
Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic
Prevent player from changing 10.0 check
Set the default units to fill-in choose: Imperial, Metric, Default
Open QuickDriver Window when check

'''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train

'''Properties'''
Note: One or the other fill-ins must be
Accept trains matching specific criteria fill-in to select from session list
Accept all trains fill-in to set
Trigger rule once check to set
Wait for a driver character to get ? a click to select: On, Off

'''Wait for Driver/Train to be Locally Owned Rule:''' Waits for a specific driver or train car to be locally owned, Owned then executes child rules. If the driver/train car becomes unowned again the child rules are paused

'''Properties'''
Wait for ownership of a specific Driver fill-in to set
Wait for ownership of Driver fill-in to set
Note: One or the other fill-in must be
Driver or Vehicle click to choose from session lists

=='''Arrangement of Session Rules:'''==

'''Ordered List Rule:''' Child rules will be executed in order once this rule starts

'''Properties'''
Note: One of the two must be chosen
This process will repeat fill-in click to add number of repeats
This process will repeat forever fill-in

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

'''Properties'''
After last child run is executed click to choose: First child is chosen again, It will be
used for all successive runs, Successive runs will
do nothing

'''Random List Rule:''' One of the child rules indented under this rule will be randomly selected and executed

'''Properties'''
executed randomly
Once one of the child rule is ??

'''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle

'''Properties'''
None

'''Simultaneous List Rule:''' Child rules are executed simultaneously once this rule starts

'''Properties'''
Rules completes when click choose all rules have reached completed state,
was completed state

=='''Camera Rules:'''==

'''Cinematic Camera Rule:''' Provides several different cinematic style cameras

'''Properties'''
Lock camera controls for the duration check
Prevent rain control for duration check
Camera target: name any of the many objects in session
Camera mode: Stationary, Circle fill-in
Initial camera values: Pitch, Yaw, Zoom value
Total time to animate: seconds value

'''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties

'''Properties'''
Change the camera view mode to check to choose: Cab View, External View, Tracking
View, Free Roaming
Vehicle fill-in choose from session vehicles
Set the camera flags to enable/disable check to choose different properties from list
Junction fill-in choose from session junctions
Set the target objet of the camera to check
Map object fill-in choose from map objects

'''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view

'''Properties'''
Trigger rule once check to set
Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking
View, Free Roaming View
Wait for the camera to target vehicle ? click to choose form session list

=='''Message Rules:'''==

'''Close Message Popup Rule:''' Closes open message popups

'''Properties:'''
None
'''Known Issues:'''
This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule

'''Custom Script Rule:'''

'''Properties'''
None.

'''Display Custom HUD Rule:''' Show or hide the Custom Heads Up Display.

'''Properties'''
Show the Custom Heads up Display- fill-in to choose.
Hide the Custom Heads up Display- fill-in to choose.
Note: One or the other will be chosen by default.

'''Wait for Click on HUD Icon Rule:'''

'''Properties'''
Trigger rule once-check to choose.
HUD Panel- click to choose from list.
Wait for click on- click to choose; choice depends on HUD Panel chosen.

'''Display HTML Pages Rule:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.

'''Properties'''
Add Page- click on to choose from list; click to Add Page Name or Remove.
Add All- click to add all files from the designated assets.
Delete All- delete all files from this property list.
Prevent user from exiting browser until all pages viewed- check to choose.
Disable closing of browser window by user- check to choose.
Disable browser window scrolling- check to choose.
Make browser window invisible- check to choose.
Set position-Under Construction!!!- check to choose.
Set size-Under Construction!!!- check to choose.
Use the page- click to choose Insert Page Name.
From asset HTML- click to choose from list.

'''Timed limited display HTML Rule:''' Displays an html browser window for a limited time.

'''Properties'''
HTML Asset Name-

'''Display Video Rule:''' Displays a page from a HTML assets in a browser window.

'''Properties'''

'''End Session Rule:''' End Session without saving.

'''Properties'''

'''Fade in/out Rule:''' Fade in or out within seconds, color and opacity considered.

'''Properties'''

'''Flash HUD Icon Rule:''' Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.

'''Properties'''

'''Generic Tree Node Debug Window Rule:''' No description.

'''Properties'''

'''InputTable Rule:''' Creating a list of message names to be used for various purposes.

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

'''Properties'''
'''(Check Box) Pause game while message is displayed:''' - stops the game until this message is switched off
'''(Check Box) Close previous popup windows:''' - closes any Message Popups currently displayed
'''Message location: ''Top Left/Top Right/Bottom Left/Bottom Right''''' - select one to position the browser window on the screen
'''Message Source:'''
'''(Option button) Custom text:''' - the simplest and easiest option
'''Icon: ''Click here to set''''' - shows a list of message icons. Select one to be displayed with the message
'''Icon: ''Clear icon''''' - clears any currently displayed message icon
'''Custom text:''' Enter text to be displayed. You will be limited to about 6 lines of text. For longer messages or to include graphics, use the '''A predefined HTML page''' option.
'''(Option button) 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.
'''(Option button) 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.

'''Minimap Options Rule:''' Sets the display options for the minimap.

'''Properties'''

'''Play Sound Rule:''' Plays a wav sound file.

'''Properties'''

'''Session Debug Rule Rule:''' Executes the first child if debug mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.

'''Properties'''

'''Session Metadata Rule:''' Sets session metadata in the config file. Info can be read by other systems and displayed to the player.

'''Properties'''

'''Set Helper Icon Size Rule:''' Sets the size of helper icons such as the junction lever arrows.

'''Properties'''

'''Set HTML Page Rule:''' Instructs the Display HTML Pages rule to perform specific operations

'''Properties'''

'''Show/Hide HUD Panel Rule:''' Shows or hides a HUD panel.

'''Properties'''

'''Show/Hide Layer Rule:''' Shows or hides a layer from Driver.

'''Properties:'''
'''Show/Hide''' - select one
'''click here to set''' - enter name of layer. Name is case sensitive.

'''Known Bugs:'''
TANE (all versions) - layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded

'''Show/Hide Minimap Rule:''' Shows the Driver the minimap window.

'''Properties'''
'''Minimap Window'''-click to choose Show,Hide

'''Show/hide on-screen help Rule:''' Shows or hides On-screen help in Driver.

'''Properties'''
'''Junction Overlays:''' - fill-in to choose: Show, Hide, Leave unchanged. by default one is chosen
'''On Screen Vehicle Name:''' - Fill-in to choose: Show, Hide, Leave unchanged. By default one is chosen

'''Wait for Click on HUD Icon Rule:''' Waits for a click on the HUD Icon.

'''Properties'''
'''(Check Box) Trigger Once:''' -to choose
'''HUD Panel:''' - Click to choose from list: Bottom Right Menu, Camera Controls, DCC Controls
'''Icon:''' - Choose from list. Selections depends on HUD Panel chosen

'''Wait on Waybill Screen/Main Screen Rule:''' Waits for the Waybill window to be opened.

'''Properties'''

=='''Startup Rules:'''==

'''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.

'''Properties'''

'''Startup Options Rule''' Specifies the starting options for the session.

'''Properties'''

=='''Time Rules:'''==

'''Clock Rule:''' Rule needed for animated clocks, you need to apply this rule to your session to make use of the animated clocks, see forum for code to include in you clock object to work with this rule.

'''Properties'''

'''Timecheck Rule:''' Executes child rules at a certain time.

'''Properties'''

'''Timing Check Rule:''' Triggers sub rules if called within the time window specified.

'''Properties'''

'''Wait Rule:''' Wait for number of seconds'

'''Properties'''

=='''Variable Rules:'''==

'''Variable Check Rule:''' If the specified variable matches the specified conditions then the child rules will be executed in order.

'''Properties'''
'''''<variable-name>''''' - enter a variable-name. Variable name is case sensitive.
'''''<test-condition>''''' - '''is less than/is less than or equal to/is equal to/is greater than or equal to/is greater than/is not equal to/is between x and y''' - select one
'''''This condition will be evaluated only once .../This condition will be evaluated once every second''''' - click to select one
'''Test condition option: is between x and y'''
Enter minimum (x) and maximum (y) test values

'''Test condition option: (all other options)'''
Enter test value

'''Evaluation option: 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

'''Evaluation option: This condition will be evaluated evaluated once every second''' - the rule will be run and the variable rechecked every second

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

'''Properties'''
'''Change: Add to variable/Subtract from variable/Change variable''' - select one
'''(optional check box) Set the minimum value''' of ''<variable-name>'' to ''<value>'' - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.
('''optional check box) Set the maximum value''' of ''<variable-name>'' to ''<value>'' - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.

'''Change option: 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.

'''Change option: 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 option: Change variable'''
'''Change variable ''<variable-name>'' to ''<value>''''' - enter variable-name, enter new value. This cannot be undone if the rule is stopped. Variable-name is case sensitive.

'''Variable Modify Continuous Rule:''' Adds, subtracts or sets a value to a specified variable every second.

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

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

'''Properties'''
'''Check box: Add'''
''<variable-name>'' - enter variable-name. 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. Variable-name is case sensitive.

Variables are saved in the session file and persist from one saved game to another.
They can be accessed/modified by the following '''driver commands''':

'''Driver Commands by trev999:'''
'''Set S-Variable driver command: '''
'''Skip if session-variable driver command: '''
'''Wait until S-variable driver command: '''

'''Driver Commands by atilabarut'''
'''ChangeSVariables driver command: '''
'''WaitUntilSVariable driver command: '''

=='''Weather Rules:'''==

'''EIRS Weather Rule NE USA Rule:''' Customize random weather rule relative to the North East Region of the United States.

'''Properties'''

'''Weather Rule:''' Set the weather conditions.

'''Properties'''

Session Rules By Categories With Properties

2017-09-27T21:35:26Z

Coop2:

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

=='''Achievement Rules'''==

'''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement

'''Properties:'''
None

'''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload

'''Properties:'''
'''Target object''' ?? name of object such as Power Station, Coal Pit or Portal
'''Lock train's controls'''- checked during a stopped load/unload operation
'''Override 'begin load' and 'begin unload' '''- checked # of seconds to override

'''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations

'''Properties:'''
'''<Click to Select>'''- Trigger from Session List.
'''<Click to Select>'''- Industry from Session List
'''<Radio Buttons>'''
-Choose to accept all trains.
-Accept trains matching specific criteria of Assets from Session List

'''Power Station Rule:''' Sets up Station and Consumers

'''Properties:'''
'''<Click to Select>'''- from Session Stations.
'''<Click to Select>'''- Consumers(Add Object) choose from Session List

'''Resource Check Rule:''' Check the progress of the amount of a resource and target object

'''Properties:'''
'''<Radio Buttons>'''
-Watch industry queue
-Watch vehicle
'''Note:''' Both have: Target Object, Queue: click to choose
'''<Radio Button>'''- Complete when designated queue
-equals or exceeds required amount
-falls below required amount

'''Multiple Resource Check Rule:''' If specified resources in a selected industry or vehicle reaches set levels, then the following child rules will be executed

'''Properties:'''
'''''Reach-Exceed/Fall below'':''' - click to select one
'''''<value>'':''' - enter required quantity value
'''''<Click to 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. For each object:-
'''Object:''' - select session active industry or product enabled rail vehicle
'''Queue:''' - select product queue (there may be only one available)
'''Remove:''' - removes the object and its product queue from the rule
'''Notes:'''
'''''Reach/Exceed''''' - sets an upper limit for the resource 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 resource 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.

'''Objective Add Rule:''' Sets up a game Objective with ID and display Name

'''Properties:'''
Priority click choose Above Normal, Below Normal, Normal, Optional, Urgent
Completion Target click to set target number
Icon click choose from list
Display Name click insert Name
Unique Objective ID click set ID
Custom Message insert typed message in text area

'''Objective Check Rule:''' Executes child rules when objective is complete

'''Properties:'''
Unique Objective ID click insert ID number
Mode click choose Wait for completion, Wait for failure, Wait for progress

'''Objective Update Rule:''' Changes progress outcome according to Property choices

'''Properties:'''
Unique Objective ID click to set ID number
Mode click Set objective as Decrement progress/Increment progress/Reset objective/Set objects as complete/Set objects as failed/Set progress/Set progress only if greater
Amount click insert number

'''Ranked Session Begin Rule:''' Begins a ranked Session

'''Properties:'''
Countdown requires a Starting Value insert hrs., min,sec
1 through 5 stars, points for each star insert number of points
Session timer mode fill-in chooses: Timer, Countdown, None

'''Ranked Session Complete Rule:''' Completes the active ranked Session

'''Properties:'''
Set the active ranked session as fill-in choose: Complete, Failed
Customize the completion message check insert text message

'''Session Complete Rule:''' Set session to a percentage of completion

'''Properties:'''
Set session to percent complete click to insert number in percent
Separate achievements for completion check

=='''Danger Rules'''==

'''ATP Speed Limiter Rule:''' Limits speed over set limit

'''Properties:'''
speed limit over the set limit mph

'''Speeding Check Rule:''' If player controlled trains are over the local speed limit or over a set (custom) speed, then the following child rules will be executed

'''Properties:'''
'''(Option button) Watch for trains travelling above the posted speed limit'''
'''''<speed value>'':''' - click to enter a new overspeed tolerance value
'''''<units>'':''' - '''Kmph/MPH/mps''' - click to select one
'''(Option button) Watch for trains travelling above a custom speed'''
'''''<speed value>'':''' - click to enter a new custom speed value
'''''<Kmph/MPH/mps>'':''' - click to select one
'''Warning: This option is very performance intensive and should only be used in sessions with few trains'''

'''AWS Configuration Rule:''' This rule configures the Trainz implementation of the Automatic Warning System when approaching signals

'''Properties:'''
Use modern sound set for unfitted cabs? check
Simulate AWS for unfitted cabs? check
Passive with HUD hidden fill-in
Active fill-in
Passive fill-in

'''Wait for Derailment Rule:''' Waits for a derailment to occur

'''Properties:'''
Trigger derailment watch once check to set

'''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars after a set time delay

'''Properties:'''
'''''<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.

'''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule

'''Properties:'''
'''(Check box) Respawn trains if they are abandoned for 10 minutes'''
If checked:-
'''(Option button) Respawn trains at their original locations'''
'''(Option button) Respawn trains from portals'''
If '''Respawn trains from portals''' is selected, then:-
'''+ Add a new portal''' - click to enter the name of a portal, there can be more than one portal.
Entered names that appear in red have not been found in the session

'''Coupler Breakage Check Rule:''' Checks for breaking couplers and, if found, then executes any following child rules.

'''Properties:'''
None

'''Coupler Breakage HUD Rule:''' HUD displays warning about coupler stress and breakage

'''Properties:'''
'''(Option button) Show the Coupler Breakage Display'''
'''(Option button) Hide the Coupler Breakage Display'''

'''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles

'''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: ''Locked/Unlocked''''' - click to select
'''Back: ''Locked/Unlocked''''' - click to select
'''Decoupling Mask:'''
'''Front: ''Locked/Unlocked''''' - click to select
'''Back: ''Locked/Unlocked''''' - click to select
'''''Remove'':''' - click to remove that vehicle from the rule

'''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users and, if found, then executes any following child rules.

'''Properties:'''
'''(Check box) Trigger only once:'''

'''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users and, if found, then executes any following child rules.

'''Properties:'''
'''(Check box) Trigger only once:'''

'''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger (stop) and, if found, then executes any following child rules.

'''Properties:'''
'''(Check box) Trigger only once:'''

'''Vehicle Physics Rule:''' Overrides the default vehicle physics properties

'''Properties:'''
Accept all trains fill-in
Cab sway level is set ? % click to insert percent of sway
Traction boost is % ? while sanding click to insert percent of boost
Tractions reduced to ? % while click to set traction percent
Maximum tractive effort adjusted by ? click to insert percent amount
Show coupler breakage in HUD Rule check to set
Couplers break when coupling above ? click to set speed
Accept trains matching specific criteria fill-in to insert specific trains
Couplers break at ? kN check to insert amount of force

=='''Navigation Rules'''==

'''DestSignTable Rule:''' Table for creating a table of destination signs

'''Properties:'''
Enable Track Marks as destinations check
Enable table of destinations check
Import destination from texture-group. name
Destination Name name
Enable industries/stations as check
Interlocking Tower Configure Path Alters settings on an interlocking tower path
Interlocking Tower choose Name and Objects
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
Show path activation message in Driver check

'''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train

'''Properties:'''
Interlocking Tower choose Names and Objects
Multiple Junction Alignment Check Checks multiple junctions are in alignment
Wait until the following junctions are choose all or anyone
Add junction click add junction from session list
Add all click add all junctions from session list
Delete all click deletes all junctions from rule list

'''Navigation Display Rule:''' Creates a set of navigation points. Multiple sets can be created by adding additional copies of this rule. This rule creates the navigation set, it does not display it. Use the '''Navigation set hide/show rule''' to make a set visible. Click the help icon at the top of the properties box for in game instructions.

'''Properties:'''
'''Unique set ID:''' - enter a unique name for the navigation set. Name must be in lowercase and have no spaces.
'''Train (optional):''' - select a rolling stock asset from the session list shown.
'''Navigation mode:''' select one
'''(Option button) 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.
'''(Option button) 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.
'''(Option button) 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 (a trigger, trackmark, track object or rolling stock asset) 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'':''' - select an icon for the navigation point.
'''''Style'': ''Automatic/Manual/Require Stop''''' - click to select one
'''''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'''.
This allows you to execute other rules (e.g. consist check, trigger 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.

'''Navigation Point Complete Rule:''' Marks a navigation point complete

'''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 set display rule'''.
Name must be in lowercase and have no spaces.
'''Know Issues:'''
The rule will '''NOT''' check to see if the named navigation set and point exists or not.

'''Navigation Set Check Rule:''' Checks if a navigation set is complete or incomplete, then the following child rules will be executed

'''Properties:'''
'''Checks if navigation point set ''<click to select>'':''' - enter the unique name for the navigation set created using the '''Navigation set display rule'''.
Name must be in lowercase and have no spaces.
'''is ''<Complete/Incomplete>'':''' - click to select one
'''Know Issues:'''
The rule will '''NOT''' check to see if the named navigation set exists or not.

'''Navigation Set Clear Rule:''' Clears a navigation set removing any uncompleted navigation points

'''Properties:'''
'''''<Click here to set>'':''' - enter the unique name for the navigation set created using the '''Navigation set display rule'''.
Name must be in lowercase and have no spaces.
'''Know Issues:'''
The rule will '''NOT''' check to see if the named navigation set exists or not.

'''Navigation Set Hide/Show:''' Shows and hides navigation sets. You can have multiple sets visible at the same time.

'''Properties:'''
'''''<Hide/Show>'':''' - click to select one
'''''<click here to set>'':''' - enter the unique name for the navigation set created using the '''Navigation set display rule'''.
Name must be in lowercase and have no spaces.
'''Know Issues:'''
The rule will '''NOT''' check to see if the named navigation set exists or not.

'''Schedule Rule:''' Allows a schedule of timed events to be applied to a train

'''Properties:'''
Insert track mark click to select from session list
Note: Both has an arrival and departure set time hr:min:sec
Current Train click to select from session list
Insert destination click to select from session list

'''Set Junctions Rule:''' Sets the selected junctions to a specific state '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''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:-
'''''Setting'': Left/Center/Right/Don't change''' - click one to set the junction direction
'''''Locked'': Locked/Unlocked''' - click to select one. '''Locked''' means the junction setting cannot be changed by the user
'''''Allows AI control/Blocks AI control''''' - click to select one.
'''''Remove''''' - click to remove that junction from the rule list

'''Set Signal Extended Rule:''' Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''Properties:'''
'''''Select signal''''' - click to select a signal from the session list
'''''<signal state>''''' - click to select a state from the list

'''Trigger Check Rule:''' - Waits for any train to enter one of the designated triggers. This rule replaces the older and less versatile "Trigger Rule".

'''Properties:'''
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list
Add Trigger click to choose from session list
Trigger only once check to set
Wait for child rules to complete even if check to set
Only activate when the entering click to choose forward, backward

'''Wait on Navigation Point Rule:''' Waits for a navigation point to be completed then the following child rules will be executed

'''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 set display rule'''.
Name must be in lowercase and have no spaces.
'''Know Issues:'''
The rule will '''NOT''' check to see if the named navigation set and point exists or not.

'''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start

'''Properties:'''
Accept all trains fill-in to set
Accept trains matching specific criteria fill-in to set and choose from session list
Wait for a train that matches the click to choose: start moving, stop moving
Trigger rule once check to set
Note: One or the other fill-ins must be

=='''Driver Rules'''==

'''Control Type Rule''' Sets control type

'''Properties:'''
Current control method is: Easy Mode, Choice one of the three

'''Control Check Rule:''' Activates child rules based on the control method changes

'''Properties:'''
Excite child rules when: DCC mode is fill-in one or the other
Excite child rules: Every time control fill-in one or the other

'''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule

'''Properties:'''
Trigger add Trigger
Portal index from PCP value
Use UnPortal yes/no
Delay from Trigger to Emit: seconds value

'''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry

'''Properties:'''
Apply to every vehicle in the session fill-in
Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles
Note: One of the Applies will always be
Load/Unload for industry Disable/Enable choose Industry

'''Driver Command Rule:''' Specify which commands will be available for the drivers

'''Properties''':
Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.
Navigate To TrackMarkList V2- No description.
Navigate To Station V2- No description.
Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.
Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.
Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.
Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.
Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.
Drive To Station V2- No description.
Drive To Track mark List V2- No description.
Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.
Drive To Industry- Drive to a specific industry.
Change Destination Sign-Changes the destination signs of a train.

WaitFor- Pauses the driver's schedule for a set duration of time.
Wait For Random- TRS2008: Wait for specified or optionally random period of time.
Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).
WaitUntil- No description.

VR Set Train Lamps-Driver command that sets the train lamps.
Notify- Notifies the player of schedule progress/completion.
Reverse Tram- Reverse a tram(max 2 cars).
Couple- Couple train to designate vehicle.
Decouple- Decouples the train at the specified vehicle.
UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).
Halt Train- Brings the train to a complete stop.
Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.
Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger
station before using this command.
Cab: Wait-Maintains current control state until some condition is met.
Delete Train- Causes the train and its driver to be deleted from the session.
Hornz- Driver sounds the train horn.
Cab: Set Control-Sets a cab mode control.
Headlights On/Off-Allows the driver to to switch the headlights on and off.
Interior Lights Command- Driver command to switch interior lights on or off for the current train.
Set Max Speed To- No description.

Release Junction - Lets a driver release the junction they have been holding.
Move Turntable- TRS2008: Move turntable to a stop point .

Load- Loads the train's vehicles at the industry the driver is currently at with the train.
Unload- Unload train vehicles at current industry location.
Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.
Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.
Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.

'''Driver Command Check Rule:''' Verifies the driver commands of a driver character

'''Properties'''
Wait for driver character to have add driver, all, delete all
Trigger Rule once check
Driver character to watch the name driver

'''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar

'''Properties'''
The Driver Main Bar choice show/hide

'''Driver Schedule Rule''' Execution of basic scheduled commands

'''Properties:'''
Note: Only one of the fill-in can be
Driver Schedule Rule assigned to name driver
Commands insert driver commands in Drive Schedule
Classic style: If there is a schedule fill-in
Killer style: If there is a schedule fill-in
Cooperative style: If there is a schedule fill-in
Active style: Emit a new schedule, only fill-in

'''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders

'''Properties'''
Generate new Drivers for empty check
The following drivers will be available Driver's Name Add
Remove all existing Drivers first check

'''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers

'''Properties'''
Assign Driver commands check Driver Commands
Train criteria fill in all trains
Train criteria list train only trains matching criteria

'''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted

'''Properties'''
Config/txt file tag 'max_permitted_speed-60850 in mph or kph
Add to config.txt and kuid-table for value <KUID2:60850:88000:4
Note: Old root level config tag will

'''QuickDrive Rule:''' Change the Session settings and add consists in Driver

'''Properties'''
Set Time to insert time
QuickDrive Consist Option List by
Rate of Change insert rate as number times
Enable gameplay Session Mode check
Enable in game help by default check
Set the default Control method to fill-in choose: Easy Mode, Realistic Mode
Prevent player from changing this check
Realistic mode requires achievement add Achievement's Name
In Asset choose Auran achievements
Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic
Prevent player from changing 10.0 check
Set the default units to fill-in choose: Imperial, Metric, Default
Open QuickDriver Window when check

'''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train

'''Properties'''
Note: One or the other fill-ins must be
Accept trains matching specific criteria fill-in to select from session list
Accept all trains fill-in to set
Trigger rule once check to set
Wait for a driver character to get ? a click to select: On, Off

'''Wait for Driver/Train to be Locally Owned Rule:''' Waits for a specific driver or train car to be locally owned, Owned then executes child rules. If the driver/train car becomes unowned again the child rules are paused

'''Properties'''
Wait for ownership of a specific Driver fill-in to set
Wait for ownership of Driver fill-in to set
Note: One or the other fill-in must be
Driver or Vehicle click to choose from session lists

=='''Arrangement of Session Rules:'''==

'''Ordered List Rule:''' Child rules will be executed in order once this rule starts

'''Properties'''
Note: One of the two must be chosen
This process will repeat fill-in click to add number of repeats
This process will repeat forever fill-in

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

'''Properties'''
After last child run is executed click to choose: First child is chosen again, It will be
used for all successive runs, Successive runs will
do nothing

'''Random List Rule:''' One of the child rules indented under this rule will be randomly selected and executed

'''Properties'''
executed randomly
Once one of the child rule is ??

'''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle

'''Properties'''
None

'''Simultaneous List Rule:''' Child rules are executed simultaneously once this rule starts

'''Properties'''
Rules completes when click choose all rules have reached completed state,
was completed state

=='''Camera Rules:'''==

'''Cinematic Camera Rule:''' Provides several different cinematic style cameras

'''Properties'''
Lock camera controls for the duration check
Prevent rain control for duration check
Camera target: name any of the many objects in session
Camera mode: Stationary, Circle fill-in
Initial camera values: Pitch, Yaw, Zoom value
Total time to animate: seconds value

'''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties

'''Properties'''
Change the camera view mode to check to choose: Cab View, External View, Tracking
View, Free Roaming
Vehicle fill-in choose from session vehicles
Set the camera flags to enable/disable check to choose different properties from list
Junction fill-in choose from session junctions
Set the target objet of the camera to check
Map object fill-in choose from map objects

'''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view

'''Properties'''
Trigger rule once check to set
Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking
View, Free Roaming View
Wait for the camera to target vehicle ? click to choose form session list

=='''Message Rules:'''==

'''Close Message Popup Rule:''' Closes open message popups

'''Properties:'''
None
'''Known Issues:'''
This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule

'''Custom Script Rule:'''

'''Properties'''
None.

'''Display Custom HUD Rule:''' Show or hide the Custom Heads Up Display.

'''Properties'''
Show the Custom Heads up Display- fill-in to choose.
Hide the Custom Heads up Display- fill-in to choose.
Note: One or the other will be chosen by default.

'''Wait for Click on HUD Icon Rule:'''

'''Properties'''
Trigger rule once-check to choose.
HUD Panel- click to choose from list.
Wait for click on- click to choose; choice depends on HUD Panel chosen.

'''Display HTML Pages Rule:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.

'''Properties'''
Add Page- click on to choose from list; click to Add Page Name or Remove.
Add All- click to add all files from the designated assets.
Delete All- delete all files from this property list.
Prevent user from exiting browser until all pages viewed- check to choose.
Disable closing of browser window by user- check to choose.
Disable browser window scrolling- check to choose.
Make browser window invisible- check to choose.
Set position-Under Construction!!!- check to choose.
Set size-Under Construction!!!- check to choose.
Use the page- click to choose Insert Page Name.
From asset HTML- click to choose from list.

'''Timed limited display HTML Rule:''' Displays an html browser window for a limited time.

'''Properties'''
HTML Asset Name-

'''Display Video Rule:''' Displays a page from a HTML assets in a browser window.

'''Properties'''

'''End Session Rule:''' End Session without saving.

'''Properties'''

'''Fade in/out Rule:''' Fade in or out within seconds, color and opacity considered.

'''Properties'''

'''Flash HUD Icon Rule:''' Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.

'''Properties'''

'''Generic Tree Node Debug Window Rule:''' No description.

'''Properties'''

'''InputTable Rule:''' Creating a list of message names to be used for various purposes.

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

'''Properties'''
'''(Check Box) Pause game while message is displayed:''' - stops the game until this message is switched off
'''(Check Box) Close previous popup windows:''' - closes any Message Popups currently displayed
'''Message location: ''Top Left/Top Right/Bottom Left/Bottom Right''''' - select one to position the browser window on the screen
'''Message Source:'''
'''(Option button) Custom text:''' - the simplest and easiest option
'''Icon: ''Click here to set''''' - shows a list of message icons. Select one to be displayed with the message
'''Icon: ''Clear icon''''' - clears any currently displayed message icon
'''Custom text:''' Enter text to be displayed. You will be limited to about 6 lines of text. For longer messages or to include graphics, use the '''A predefined HTML page''' option.
'''(Option button) 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.
'''(Option button) 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.

'''Minimap Options Rule:''' Sets the display options for the minimap.

'''Properties'''

'''Play Sound Rule:''' Plays a wav sound file.

'''Properties'''

'''Session Debug Rule Rule:''' Executes the first child if debug mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.

'''Properties'''

'''Session Metadata Rule:''' Sets session metadata in the config file. Info can be read by other systems and displayed to the player.

'''Properties'''

'''Set Helper Icon Size Rule:''' Sets the size of helper icons such as the junction lever arrows.

'''Properties'''

'''Set HTML Page Rule:''' Instructs the Display HTML Pages rule to perform specific operations

'''Properties'''

'''Show/Hide HUD Panel Rule:''' Shows or hides a HUD panel.

'''Properties'''

'''Show/Hide Layer Rule:''' Shows or hides a layer from Driver.

'''Properties:'''
'''Show/Hide''' - select one
'''click here to set''' - enter name of layer. Name is case sensitive.

'''Known Bugs:'''
TANE (all versions) - layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded

'''Show/Hide Minimap Rule:''' Shows the Driver the minimap window.

'''Properties'''
'''Minimap Window'''-click to choose Show,Hide

'''Show/hide on-screen help Rule:''' Shows or hides On-screen help in Driver.

'''Properties'''
'''Junction Overlays:''' - fill-in to choose: Show, Hide, Leave unchanged. by default one is chosen
'''On Screen Vehicle Name:''' - Fill-in to choose: Show, Hide, Leave unchanged. By default one is chosen

'''Wait for Click on HUD Icon Rule:''' Waits for a click on the HUD Icon.

'''Properties'''
'''(Check Box) Trigger Once:''' -to choose
'''HUD Panel:''' - Click to choose from list: Bottom Right Menu, Camera Controls, DCC Controls
'''Icon:''' - Choose from list. Selections depends on HUD Panel chosen

'''Wait on Waybill Screen/Main Screen Rule:''' Waits for the Waybill window to be opened.

'''Properties'''

=='''Startup Rules:'''==

'''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.

'''Properties'''

'''Startup Options Rule''' Specifies the starting options for the session.

'''Properties'''

=='''Time Rules:'''==

'''Clock Rule:''' Rule needed for animated clocks, you need to apply this rule to your session to make use of the animated clocks, see forum for code to include in you clock object to work with this rule.

'''Properties'''

'''Timecheck Rule:''' Executes child rules at a certain time.

'''Properties'''

'''Timing Check Rule:''' Triggers sub rules if called within the time window specified.

'''Properties'''

'''Wait Rule:''' Wait for number of seconds'

'''Properties'''

=='''Variable Rules:'''==

'''Variable Check Rule:''' If the specified variable matches the specified conditions then the child rules will be executed in order.

'''Properties'''
'''''<variable-name>''''' - enter a variable-name. Variable name is case sensitive.
'''''<test-condition>''''' - '''is less than/is less than or equal to/is equal to/is greater than or equal to/is greater than/is not equal to/is between x and y''' - select one
'''''This condition will be evaluated only once .../This condition will be evaluated once every second''''' - click to select one
'''Test condition option: is between x and y'''
Enter minimum (x) and maximum (y) test values

'''Test condition option: (all other options)'''
Enter test value

'''Evaluation option: 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

'''Evaluation option: This condition will be evaluated evaluated once every second''' - the rule will be run and the variable rechecked every second

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

'''Properties'''
'''Change: Add to variable/Subtract from variable/Change variable''' - select one
'''(optional check box) Set the minimum value''' of ''<variable-name>'' to ''<value>'' - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.
('''optional check box) Set the maximum value''' of ''<variable-name>'' to ''<value>'' - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.

'''Change option: 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.

'''Change option: 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 option: Change variable'''
'''Change variable ''<variable-name>'' to ''<value>''''' - enter variable-name, enter new value. This cannot be undone if the rule is stopped. Variable-name is case sensitive.

'''Variable Modify Continuous Rule:''' Adds, subtracts or sets a value to a specified variable every second.

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

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

'''Properties'''
'''Check box: Add'''
''<variable-name>'' - enter variable-name. 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. Variable-name is case sensitive.

Variables are saved in the session file and persist from one saved game to another.
They can be accessed/modified by the following '''driver commands''':

'''Driver Commands by trev999:'''
'''Set S-Variable driver command: '''
'''Skip if session-variable driver command: '''
'''Wait until S-variable driver command: '''

'''Driver Commands by atilabarut'''
'''ChangeSVariables driver command: '''
'''WaitUntilSVariable driver command: '''

=='''Weather Rules:'''==

'''EIRS Weather Rule NE USA Rule:''' Customize random weather rule relative to the North East Region of the United States.

'''Properties'''

'''Weather Rule:''' Set the weather conditions.

'''Properties'''

Session Rules By Categories With Properties

2017-09-26T23:52:40Z

Coop2:

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

=='''Achievement Rules'''==

'''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement

'''Properties:'''
None

'''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload

'''Properties:'''
'''Target object''' ?? name of object such as Power Station, Coal Pit or Portal
'''Lock train's controls'''- checked during a stopped load/unload operation
'''Override 'begin load' and 'begin unload' '''- checked # of seconds to override

'''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations

'''Properties:'''
'''Trigger'''- click to choose from list
'''Add Industry'''- click to add from session list
'''Accept all trains'''- fill-in
'''Accept trains matching specific criteria'''- fill-in to choose from session list

'''Power Station Rule:''' Sets up Station and Consumers

'''Properties:'''
'''Power Station'''- click to choose from session Stations
'''Consumers(Add Object)'''- click to choose from session list

'''Resource Check Rule:''' Check the progress of the amount of a resource and target object

'''Properties:'''
'''Watch industry queue or Watch vehicle'''- fill-in choose one or the other
'''Note:''' Both have: Target Object, Queue: click to choose
'''Complete when designated queue'''- fill-in equals or exceeds required amount, falls below required amount

'''Multiple Resource Check Rule:''' If specified resources in a selected industry or vehicle reaches set levels, then the following child rules will be executed

'''Properties:'''
'''''Reach-Exceed/Fall below'':''' - click to select one
'''''<value>'':''' - enter required quantity value
'''''<Click to 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. For each object:-
'''Object:''' - select session active industry or product enabled rail vehicle
'''Queue:''' - select product queue (there may be only one available)
'''Remove:''' - removes the object and its product queue from the rule
'''Notes:'''
'''''Reach/Exceed''''' - sets an upper limit for the resource 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 resource 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.

'''Objective Add Rule:''' Sets up a game Objective with ID and display Name

'''Properties:'''
Priority click choose Above Normal, Below Normal, Normal, Optional, Urgent
Completion Target click to set target number
Icon click choose from list
Display Name click insert Name
Unique Objective ID click set ID
Custom Message insert typed message in text area

'''Objective Check Rule:''' Executes child rules when objective is complete

'''Properties:'''
Unique Objective ID click insert ID number
Mode click choose Wait for completion, Wait for failure, Wait for progress

'''Objective Update Rule:''' Changes progress outcome according to Property choices

'''Properties:'''
Unique Objective ID click to set ID number
Mode click Set objective as Decrement progress/Increment progress/Reset objective/Set objects as complete/Set objects as failed/Set progress/Set progress only if greater
Amount click insert number

'''Ranked Session Begin Rule:''' Begins a ranked Session

'''Properties:'''
Countdown requires a Starting Value insert hrs., min,sec
1 through 5 stars, points for each star insert number of points
Session timer mode fill-in chooses: Timer, Countdown, None

'''Ranked Session Complete Rule:''' Completes the active ranked Session

'''Properties:'''
Set the active ranked session as fill-in choose: Complete, Failed
Customize the completion message check insert text message

'''Session Complete Rule:''' Set session to a percentage of completion

'''Properties:'''
Set session to percent complete click to insert number in percent
Separate achievements for completion check

=='''Danger Rules'''==

'''ATP Speed Limiter Rule:''' Limits speed over set limit

'''Properties:'''
speed limit over the set limit mph

'''Speeding Check Rule:''' If player controlled trains are over the local speed limit or over a set (custom) speed, then the following child rules will be executed

'''Properties:'''
'''(Option button) Watch for trains travelling above the posted speed limit'''
'''''<speed value>'':''' - click to enter a new overspeed tolerance value
'''''<units>'':''' - '''Kmph/MPH/mps''' - click to select one
'''(Option button) Watch for trains travelling above a custom speed'''
'''''<speed value>'':''' - click to enter a new custom speed value
'''''<units>'':''' - '''Kmph/MPH/mps''' - click to select one
'''Warning: This option is very performance intensive and should only be used in sessions with few trains'''

'''AWS Configuration Rule:''' This rule configures the Trainz implementation of the Automatic Warning System when approaching signals

'''Properties:'''
Use modern sound set for unfitted cabs? check
Simulate AWS for unfitted cabs? check
Passive with HUD hidden fill-in
Active fill-in
Passive fill-in

'''Wait for Derailment Rule:''' Waits for a derailment to occur

'''Properties:'''
Trigger derailment watch once check to set

'''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars

'''Properties:'''
Set delay to clean up derailed train cars values

'''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule

'''Properties:'''
Respawn trains if they are abandoned check
Respawn trains fill-in choose: at their original locations, from portals from Session List

'''Coupler Breakage Check Rule:''' Checks for breaking couplers. No parameters.

'''Properties:'''
None

'''Coupler Breakage HUDRule:''' HUD displays warning about coupler stress and breakage

'''Properties:'''
Show the Coupler Breakage Display fill-in must choose one or the other
Hide the Coupler Breakage Display fill-in must choose one or the other

'''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles

'''Properties:'''
Add vehicle click to select from session list
Coupling Mask, Decoupling Mask : click to select: lock or unlock
Add All click to select all vehicle in session
Delete All click to delete all vehicle from list

'''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users

'''Properties:'''
Trigger only once check

'''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users

'''Properties:'''
Trigger only once check

'''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger

'''Properties:'''
Trigger only once check to set

'''Vehicle Physics Rule:''' Overrides the default vehicle physics properties

'''Properties:'''
Accept all trains fill-in
Cab sway level is set ? % click to insert percent of sway
Traction boost is % ? while sanding click to insert percent of boost
Tractions reduced to ? % while click to set traction percent
Maximum tractive effort adjusted by ? click to insert percent amount
Show coupler breakage in HUD Rule check to set
Couplers break when coupling above ? click to set speed
Accept trains matching specific criteria fill-in to insert specific trains
Couplers break at ? kN check to insert amount of force

=='''Navigation Rules'''==

'''DestSignTable Rule:''' Table for creating a table of destination signs

'''Properties:'''
Enable Track Marks as destinations check
Enable table of destinations check
Import destination from texture-group. name
Destination Name name
Enable industries/stations as check
Interlocking Tower Configure Path Alters settings on an interlocking tower path
Interlocking Tower choose Name and Objects
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
Show path activation message in Driver check

'''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train

'''Properties:'''
Interlocking Tower choose Names and Objects
Multiple Junction Alignment Check Checks multiple junctions are in alignment
Wait until the following junctions are choose all or anyone
Add junction click add junction from session list
Add all click add all junctions from session list
Delete all click deletes all junctions from rule list

'''Navigation Display Rule:''' Creates a set of navigation points. Multiple sets can be created by adding additional copies of this rule. This rule creates the navigation set, it does not display it. Use the '''Navigation set hide/show rule''' to make a set visible. Click the help icon at the top of the properties box for in game instructions.

'''Properties:'''
'''Unique set ID:''' - enter a unique name for the navigation set. Name must be in lowercase and have no spaces.
'''Train (optional):''' - select a rolling stock asset from the session list shown.
'''Navigation mode:''' select one
'''(Option button) 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.
'''(Option button) 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.
'''(Option button) 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 (a trigger, trackmark, track object or rolling stock asset) 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'':''' - select an icon for the navigation point.
'''''Style'': ''Automatic/Manual/Require Stop''''' - click to select one
'''''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'''.
This allows you to execute other rules (e.g. consist check, trigger 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.

'''Navigation Point Complete Rule:''' Marks a navigation point complete

'''Properties:'''
Mark navigation point click set index number
Complete in set click to set ID

'''Navigation Set Check Rule:''' Checks if a navigation point is complete/incomplete

'''Properties:'''
Checks if navigation point is set click set ID
Is click Complete, Incomplete
Navigation Set Clear Clears a navigation point set
Clear the navigation point set click to set ID
Navigation Set Hide/Show Show or hide navigation point set
The navigation point click hide, show
Navigation point set click to set ID

'''Navigation Set Clear Rule:''' Clears a navigation set removing any uncompleted navigation points

'''Properties:'''
'''''Click here to set'':''' - enter the unique name for the navigation set created using the '''Navigation set display rule'''.
Name must be in lowercase and have no spaces. The rule will NOT check to see if the named navigation set exists or not.

'''Navigation Set Hide/Show:''' Shows and hides navigation sets. You can have multiple sets visible at the same time.

'''Properties:'''
'''''Hide/Show'':''' - click to select one
'''''click here to set'':''' - enter the unique name for the navigation set created using the '''Navigation set display rule'''.
Name must be in lowercase and have no spaces. The rule will NOT check to see if the named navigation set exists or not.

'''Schedule Rule:''' Allows a schedule of timed events to be applied to a train

'''Properties:'''
Insert track mark click to select from session list
Note: Both has an arrival and departure set time hr:min:sec
Current Train click to select from session list
Insert destination click to select from session list

'''Set Junctions Rule:''' Sets the selected junctions to a specific state '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''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:-
'''''Setting'': Left/Center/Right/Don't change''' - click one to set the junction direction
'''''Locked'': Locked/Unlocked''' - click to select one. '''Locked''' means the junction setting cannot be changed by the user
'''''Allows AI control/Blocks AI control''''' - click to select one.
'''''Remove''''' - click to remove that junction from the rule list

'''Set Signal Extended Rule:''' Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''Properties:'''
'''''Select signal''''' - click to select a signal from the session list
'''''<signal state>''''' - click to select a state from the list

'''Trigger Check Rule:''' Waits for any train to enter one of the designated triggers. This rule replaces the older and less versatile "Trigger Rule".

'''Properties:'''
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list
Add Trigger click to choose from session list
Trigger only once check to set
Wait for child rules to complete even if check to set
Only activate when the entering click to choose forward, backward

'''Wait on Navigation Point Rule:''' Waits for a navigation point to be completed then the following child rules will be executed

'''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 set display rule'''.
Name must be in lowercase and have no spaces. The rule will NOT check to see if the named navigation set and point exists or not.

'''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start

'''Properties:'''
Accept all trains fill-in to set
Accept trains matching specific criteria fill-in to set and choose from session list
Wait for a train that matches the click to choose: start moving, stop moving
Trigger rule once check to set
Note: One or the other fill-ins must be

=='''Driver Rules'''==

'''Control Type Rule''' Sets control type

'''Properties:'''
Current control method is: Easy Mode, Choice one of the three

'''Control Check Rule:''' Activates child rules based on the control method changes

'''Properties:'''
Excite child rules when: DCC mode is fill-in one or the other
Excite child rules: Every time control fill-in one or the other

'''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule

'''Properties:'''
Trigger add Trigger
Portal index from PCP value
Use UnPortal yes/no
Delay from Trigger to Emit: seconds value

'''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry

'''Properties:'''
Apply to every vehicle in the session fill-in
Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles
Note: One of the Applies will always be
Load/Unload for industry Disable/Enable choose Industry

'''Driver Command Rule:''' Specify which commands will be available for the drivers

'''Properties''':
Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.
Navigate To TrackMarkList V2- No description.
Navigate To Station V2- No description.
Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.
Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.
Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.
Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.
Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.
Drive To Station V2- No description.
Drive To Track mark List V2- No description.
Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.
Drive To Industry- Drive to a specific industry.
Change Destination Sign-Changes the destination signs of a train.

WaitFor- Pauses the driver's schedule for a set duration of time.
Wait For Random- TRS2008: Wait for specified or optionally random period of time.
Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).
WaitUntil- No description.

VR Set Train Lamps-Driver command that sets the train lamps.
Notify- Notifies the player of schedule progress/completion.
Reverse Tram- Reverse a tram(max 2 cars).
Couple- Couple train to designate vehicle.
Decouple- Decouples the train at the specified vehicle.
UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).
Halt Train- Brings the train to a complete stop.
Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.
Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger
station before using this command.
Cab: Wait-Maintains current control state until some condition is met.
Delete Train- Causes the train and its driver to be deleted from the session.
Hornz- Driver sounds the train horn.
Cab: Set Control-Sets a cab mode control.
Headlights On/Off-Allows the driver to to switch the headlights on and off.
Interior Lights Command- Driver command to switch interior lights on or off for the current train.
Set Max Speed To- No description.

Release Junction - Lets a driver release the junction they have been holding.
Move Turntable- TRS2008: Move turntable to a stop point .

Load- Loads the train's vehicles at the industry the driver is currently at with the train.
Unload- Unload train vehicles at current industry location.
Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.
Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.
Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.

'''Driver Command Check Rule:''' Verifies the driver commands of a driver character

'''Properties'''
Wait for driver character to have add driver, all, delete all
Trigger Rule once check
Driver character to watch the name driver

'''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar

'''Properties'''
The Driver Main Bar choice show/hide

'''Driver Schedule Rule''' Execution of basic scheduled commands

'''Properties:'''
Note: Only one of the fill-in can be
Driver Schedule Rule assigned to name driver
Commands insert driver commands in Drive Schedule
Classic style: If there is a schedule fill-in
Killer style: If there is a schedule fill-in
Cooperative style: If there is a schedule fill-in
Active style: Emit a new schedule, only fill-in

'''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders

'''Properties'''
Generate new Drivers for empty check
The following drivers will be available Driver's Name Add
Remove all existing Drivers first check

'''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers

'''Properties'''
Assign Driver commands check Driver Commands
Train criteria fill in all trains
Train criteria list train only trains matching criteria

'''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted

'''Properties'''
Config/txt file tag 'max_permitted_speed-60850 in mph or kph
Add to config.txt and kuid-table for value <KUID2:60850:88000:4
Note: Old root level config tag will

'''QuickDrive Rule:''' Change the Session settings and add consists in Driver

'''Properties'''
Set Time to insert time
QuickDrive Consist Option List by
Rate of Change insert rate as number times
Enable gameplay Session Mode check
Enable in game help by default check
Set the default Control method to fill-in choose: Easy Mode, Realistic Mode
Prevent player from changing this check
Realistic mode requires achievement add Achievement's Name
In Asset choose Auran achievements
Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic
Prevent player from changing 10.0 check
Set the default units to fill-in choose: Imperial, Metric, Default
Open QuickDriver Window when check

'''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train

'''Properties'''
Note: One or the other fill-ins must be
Accept trains matching specific criteria fill-in to select from session list
Accept all trains fill-in to set
Trigger rule once check to set
Wait for a driver character to get ? a click to select: On, Off

'''Wait for Driver/Train to be Locally Owned Rule:''' Waits for a specific driver or train car to be locally owned, Owned then executes child rules. If the driver/train car becomes unowned again the child rules are paused

'''Properties'''
Wait for ownership of a specific Driver fill-in to set
Wait for ownership of Driver fill-in to set
Note: One or the other fill-in must be
Driver or Vehicle click to choose from session lists

=='''Arrangement of Session Rules:'''==

'''Ordered List Rule:''' Child rules will be executed in order once this rule starts

'''Properties'''
Note: One of the two must be chosen
This process will repeat fill-in click to add number of repeats
This process will repeat forever fill-in

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

'''Properties'''
After last child run is executed click to choose: First child is chosen again, It will be
used for all successive runs, Successive runs will
do nothing

'''Random List Rule:''' One of the child rules indented under this rule will be randomly selected and executed

'''Properties'''
executed randomly
Once one of the child rule is ??

'''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle

'''Properties'''
None

'''Simultaneous List Rule:''' Child rules are executed simultaneously once this rule starts

'''Properties'''
Rules completes when click choose all rules have reached completed state,
was completed state

=='''Camera Rules:'''==

'''Cinematic Camera Rule:''' Provides several different cinematic style cameras

'''Properties'''
Lock camera controls for the duration check
Prevent rain control for duration check
Camera target: name any of the many objects in session
Camera mode: Stationary, Circle fill-in
Initial camera values: Pitch, Yaw, Zoom value
Total time to animate: seconds value

'''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties

'''Properties'''
Change the camera view mode to check to choose: Cab View, External View, Tracking
View, Free Roaming
Vehicle fill-in choose from session vehicles
Set the camera flags to enable/disable check to choose different properties from list
Junction fill-in choose from session junctions
Set the target objet of the camera to check
Map object fill-in choose from map objects

'''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view

'''Properties'''
Trigger rule once check to set
Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking
View, Free Roaming View
Wait for the camera to target vehicle ? click to choose form session list

=='''Message Rules:'''==

'''Close Message Popup Rule:''' Closes open message popups

'''Properties:'''
None

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

'''Custom Script Rule:'''

'''Properties'''
None.

'''Display Custom HUD Rule:''' Show or hide the Custom Heads Up Display.

'''Properties'''
Show the Custom Heads up Display- fill-in to choose.
Hide the Custom Heads up Display- fill-in to choose.
Note: One or the other will be chosen by default.

'''Wait for Click on HUD Icon Rule:'''

'''Properties'''
Trigger rule once-check to choose.
HUD Panel- click to choose from list.
Wait for click on- click to choose; choice depends on HUD Panel chosen.

'''Display HTML Pages Rule:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.

'''Properties'''
Add Page- click on to choose from list; click to Add Page Name or Remove.
Add All- click to add all files from the designated assets.
Delete All- delete all files from this property list.
Prevent user from exiting browser until all pages viewed- check to choose.
Disable closing of browser window by user- check to choose.
Disable browser window scrolling- check to choose.
Make browser window invisible- check to choose.
Set position-Under Construction!!!- check to choose.
Set size-Under Construction!!!- check to choose.
Use the page- click to choose Insert Page Name.
From asset HTML- click to choose from list.

'''Timed limited display HTML Rule:''' Displays an html browser window for a limited time.

'''Properties'''
HTML Asset Name-

'''Display Video Rule:''' Displays a page from a HTML assets in a browser window.

'''Properties'''

'''End Session Rule:''' End Session without saving.

'''Properties'''

'''Fade in/out Rule:''' Fade in or out within seconds, color and opacity considered.

'''Properties'''

'''Flash HUD Icon Rule:''' Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.

'''Properties'''

'''Generic Tree Node Debug Window Rule:''' No description.

'''Properties'''

'''InputTable Rule:''' Creating a list of message names to be used for various purposes.

'''Properties'''

'''Message Popup Rule:''' Displays a pop-up browser window and waits to be closed.

'''Properties'''
'''(Check Box) Pause game while message is displayed:''' - stops the game until this message is switched off
'''(Check Box) Close previous popup windows:''' - closes any Message Popups currently displayed
'''Message location: Top Left/Top Right/Bottom Left/Bottom Right''' - select one to position the browser window on the screen
'''Message Source: Custom text/A predefined HTML page (advanced)/A predefined string-table entry from a HTML asset (advanced)''' - select one

'''Message Source Option: Custom text'''
'''Icon: ''Click here to set''''' - shows a list of message icons. Select one to be displayed with the message
'''Icon: ''Clear icon''''' - clears any currently displayed message icon
'''Custom text:''' Enter text to be displayed. You will be limited to about 6 lines of text. For longer messages or to include graphics, use the '''A predefined HTML page''' option.

'''Message Source Option: A predefined HTML page'''
'''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.

'''Message Source Option: 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.

'''Minimap Options Rule:''' Sets the display options for the minimap.

'''Properties'''

'''Play Sound Rule:''' Plays a wav sound file.

'''Properties'''

'''Session Debug Rule Rule:''' Executes the first child if debug mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.

'''Properties'''

'''Session Metadata Rule:''' Sets session metadata in the config file. Info can be read by other systems and displayed to the player.

'''Properties'''

'''Set Helper Icon Size Rule:''' Sets the size of helper icons such as the junction lever arrows.

'''Properties'''

'''Set HTML Page Rule:''' Instructs the Display HTML Pages rule to perform specific operations

'''Properties'''

'''Show/Hide HUD Panel Rule:''' Shows or hides a HUD panel.

'''Properties'''

'''Show/Hide Layer Rule:''' Shows or hides a layer from Driver.

'''Properties:'''
'''Show/Hide''' - select one
'''click here to set''' - enter name of layer. Name is case sensitive.

'''Known Bugs:'''
TANE (all versions) - layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded

'''Show/Hide Minimap Rule:''' Shows the Driver the minimap window.

'''Properties'''
'''Minimap Window'''-click to choose Show,Hide

'''Show/hide on-screen help Rule:''' Shows or hides On-screen help in Driver.

'''Properties'''
'''Junction Overlays:''' - fill-in to choose: Show, Hide, Leave unchanged. by default one is chosen
'''On Screen Vehicle Name:''' - Fill-in to choose: Show, Hide, Leave unchanged. By default one is chosen

'''Wait for Click on HUD Icon Rule:''' Waits for a click on the HUD Icon.

'''Properties'''
'''(Check Box) Trigger Once:''' -to choose
'''HUD Panel:''' - Click to choose from list: Bottom Right Menu, Camera Controls, DCC Controls
'''Icon:''' - Choose from list. Selections depends on HUD Panel chosen

'''Wait on Waybill Screen/Main Screen Rule:''' Waits for the Waybill window to be opened.

'''Properties'''

=='''Startup Rules:'''==

'''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.

'''Properties'''

'''Startup Options Rule''' Specifies the starting options for the session.

'''Properties'''

=='''Time Rules:'''==

'''Clock Rule:''' Rule needed for animated clocks, you need to apply this rule to your session to make use of the animated clocks, see forum for code to include in you clock object to work with this rule.

'''Properties'''

'''Timecheck Rule:''' Executes child rules at a certain time.

'''Properties'''

'''Timing Check Rule:''' Triggers sub rules if called within the time window specified.

'''Properties'''

'''Wait Rule:''' Wait for number of seconds'

'''Properties'''

=='''Variable Rules:'''==

'''Variable Check Rule:''' If the specified variable matches the specified conditions then the child rules will be executed in order.

'''Properties'''
'''''<variable-name>''''' - enter a variable-name. Variable name is case sensitive.
'''''<test-condition>''''' - '''is less than/is less than or equal to/is equal to/is greater than or equal to/is greater than/is not equal to/is between x and y''' - select one
'''''This condition will be evaluated only once .../This condition will be evaluated once every second''''' - click to select one
'''Test condition option: is between x and y'''
Enter minimum (x) and maximum (y) test values

'''Test condition option: (all other options)'''
Enter test value

'''Evaluation option: 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

'''Evaluation option: This condition will be evaluated evaluated once every second''' - the rule will be run and the variable rechecked every second

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

'''Properties'''
'''Change: Add to variable/Subtract from variable/Change variable''' - select one
'''(optional check box) Set the minimum value''' of ''<variable-name>'' to ''<value>'' - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.
('''optional check box) Set the maximum value''' of ''<variable-name>'' to ''<value>'' - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.

'''Change option: 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.

'''Change option: 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 option: Change variable'''
'''Change variable ''<variable-name>'' to ''<value>''''' - enter variable-name, enter new value. This cannot be undone if the rule is stopped. Variable-name is case sensitive.

'''Variable Modify Continuous Rule:''' Adds, subtracts or sets a value to a specified variable every second.

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

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

'''Properties'''
'''Check box: Add'''
''<variable-name>'' - enter variable-name. 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. Variable-name is case sensitive.

Variables are saved in the session file and persist from one saved game to another.
They can be accessed/modified by the following '''driver commands''':

'''Driver Commands by trev999:'''
'''Set S-Variable driver command: '''
'''Skip if session-variable driver command: '''
'''Wait until S-variable driver command: '''

'''Driver Commands by atilabarut'''
'''ChangeSVariables driver command: '''
'''WaitUntilSVariable driver command: '''

=='''Weather Rules:'''==

'''EIRS Weather Rule NE USA Rule:''' Customize random weather rule relative to the North East Region of the United States.

'''Properties'''

'''Weather Rule:''' Set the weather conditions.

'''Properties'''

Session Rules By Categories With Properties

2017-09-26T23:51:40Z

Coop2:

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

==:1;'''Achievement Rules'''==

'''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement

'''Properties:'''
None

'''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload

'''Properties:'''
'''Target object''' ?? name of object such as Power Station, Coal Pit or Portal
'''Lock train's controls'''- checked during a stopped load/unload operation
'''Override 'begin load' and 'begin unload' '''- checked # of seconds to override

'''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations

'''Properties:'''
'''Trigger'''- click to choose from list
'''Add Industry'''- click to add from session list
'''Accept all trains'''- fill-in
'''Accept trains matching specific criteria'''- fill-in to choose from session list

'''Power Station Rule:''' Sets up Station and Consumers

'''Properties:'''
'''Power Station'''- click to choose from session Stations
'''Consumers(Add Object)'''- click to choose from session list

'''Resource Check Rule:''' Check the progress of the amount of a resource and target object

'''Properties:'''
'''Watch industry queue or Watch vehicle'''- fill-in choose one or the other
'''Note:''' Both have: Target Object, Queue: click to choose
'''Complete when designated queue'''- fill-in equals or exceeds required amount, falls below required amount

'''Multiple Resource Check Rule:''' If specified resources in a selected industry or vehicle reaches set levels, then the following child rules will be executed

'''Properties:'''
'''''Reach-Exceed/Fall below'':''' - click to select one
'''''<value>'':''' - enter required quantity value
'''''<Click to 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. For each object:-
'''Object:''' - select session active industry or product enabled rail vehicle
'''Queue:''' - select product queue (there may be only one available)
'''Remove:''' - removes the object and its product queue from the rule
'''Notes:'''
'''''Reach/Exceed''''' - sets an upper limit for the resource 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 resource 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.

'''Objective Add Rule:''' Sets up a game Objective with ID and display Name

'''Properties:'''
Priority click choose Above Normal, Below Normal, Normal, Optional, Urgent
Completion Target click to set target number
Icon click choose from list
Display Name click insert Name
Unique Objective ID click set ID
Custom Message insert typed message in text area

'''Objective Check Rule:''' Executes child rules when objective is complete

'''Properties:'''
Unique Objective ID click insert ID number
Mode click choose Wait for completion, Wait for failure, Wait for progress

'''Objective Update Rule:''' Changes progress outcome according to Property choices

'''Properties:'''
Unique Objective ID click to set ID number
Mode click Set objective as Decrement progress/Increment progress/Reset objective/Set objects as complete/Set objects as failed/Set progress/Set progress only if greater
Amount click insert number

'''Ranked Session Begin Rule:''' Begins a ranked Session

'''Properties:'''
Countdown requires a Starting Value insert hrs., min,sec
1 through 5 stars, points for each star insert number of points
Session timer mode fill-in chooses: Timer, Countdown, None

'''Ranked Session Complete Rule:''' Completes the active ranked Session

'''Properties:'''
Set the active ranked session as fill-in choose: Complete, Failed
Customize the completion message check insert text message

'''Session Complete Rule:''' Set session to a percentage of completion

'''Properties:'''
Set session to percent complete click to insert number in percent
Separate achievements for completion check

=='''Danger Rules'''==

'''ATP Speed Limiter Rule:''' Limits speed over set limit

'''Properties:'''
speed limit over the set limit mph

'''Speeding Check Rule:''' If player controlled trains are over the local speed limit or over a set (custom) speed, then the following child rules will be executed

'''Properties:'''
'''(Option button) Watch for trains travelling above the posted speed limit'''
'''''<speed value>'':''' - click to enter a new overspeed tolerance value
'''''<units>'':''' - '''Kmph/MPH/mps''' - click to select one
'''(Option button) Watch for trains travelling above a custom speed'''
'''''<speed value>'':''' - click to enter a new custom speed value
'''''<units>'':''' - '''Kmph/MPH/mps''' - click to select one
'''Warning: This option is very performance intensive and should only be used in sessions with few trains'''

'''AWS Configuration Rule:''' This rule configures the Trainz implementation of the Automatic Warning System when approaching signals

'''Properties:'''
Use modern sound set for unfitted cabs? check
Simulate AWS for unfitted cabs? check
Passive with HUD hidden fill-in
Active fill-in
Passive fill-in

'''Wait for Derailment Rule:''' Waits for a derailment to occur

'''Properties:'''
Trigger derailment watch once check to set

'''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars

'''Properties:'''
Set delay to clean up derailed train cars values

'''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule

'''Properties:'''
Respawn trains if they are abandoned check
Respawn trains fill-in choose: at their original locations, from portals from Session List

'''Coupler Breakage Check Rule:''' Checks for breaking couplers. No parameters.

'''Properties:'''
None

'''Coupler Breakage HUDRule:''' HUD displays warning about coupler stress and breakage

'''Properties:'''
Show the Coupler Breakage Display fill-in must choose one or the other
Hide the Coupler Breakage Display fill-in must choose one or the other

'''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles

'''Properties:'''
Add vehicle click to select from session list
Coupling Mask, Decoupling Mask : click to select: lock or unlock
Add All click to select all vehicle in session
Delete All click to delete all vehicle from list

'''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users

'''Properties:'''
Trigger only once check

'''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users

'''Properties:'''
Trigger only once check

'''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger

'''Properties:'''
Trigger only once check to set

'''Vehicle Physics Rule:''' Overrides the default vehicle physics properties

'''Properties:'''
Accept all trains fill-in
Cab sway level is set ? % click to insert percent of sway
Traction boost is % ? while sanding click to insert percent of boost
Tractions reduced to ? % while click to set traction percent
Maximum tractive effort adjusted by ? click to insert percent amount
Show coupler breakage in HUD Rule check to set
Couplers break when coupling above ? click to set speed
Accept trains matching specific criteria fill-in to insert specific trains
Couplers break at ? kN check to insert amount of force

=='''Navigation Rules'''==

'''DestSignTable Rule:''' Table for creating a table of destination signs

'''Properties:'''
Enable Track Marks as destinations check
Enable table of destinations check
Import destination from texture-group. name
Destination Name name
Enable industries/stations as check
Interlocking Tower Configure Path Alters settings on an interlocking tower path
Interlocking Tower choose Name and Objects
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
Show path activation message in Driver check

'''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train

'''Properties:'''
Interlocking Tower choose Names and Objects
Multiple Junction Alignment Check Checks multiple junctions are in alignment
Wait until the following junctions are choose all or anyone
Add junction click add junction from session list
Add all click add all junctions from session list
Delete all click deletes all junctions from rule list

'''Navigation Display Rule:''' Creates a set of navigation points. Multiple sets can be created by adding additional copies of this rule. This rule creates the navigation set, it does not display it. Use the '''Navigation set hide/show rule''' to make a set visible. Click the help icon at the top of the properties box for in game instructions.

'''Properties:'''
'''Unique set ID:''' - enter a unique name for the navigation set. Name must be in lowercase and have no spaces.
'''Train (optional):''' - select a rolling stock asset from the session list shown.
'''Navigation mode:''' select one
'''(Option button) 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.
'''(Option button) 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.
'''(Option button) 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 (a trigger, trackmark, track object or rolling stock asset) 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'':''' - select an icon for the navigation point.
'''''Style'': ''Automatic/Manual/Require Stop''''' - click to select one
'''''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'''.
This allows you to execute other rules (e.g. consist check, trigger 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.

'''Navigation Point Complete Rule:''' Marks a navigation point complete

'''Properties:'''
Mark navigation point click set index number
Complete in set click to set ID

'''Navigation Set Check Rule:''' Checks if a navigation point is complete/incomplete

'''Properties:'''
Checks if navigation point is set click set ID
Is click Complete, Incomplete
Navigation Set Clear Clears a navigation point set
Clear the navigation point set click to set ID
Navigation Set Hide/Show Show or hide navigation point set
The navigation point click hide, show
Navigation point set click to set ID

'''Navigation Set Clear Rule:''' Clears a navigation set removing any uncompleted navigation points

'''Properties:'''
'''''Click here to set'':''' - enter the unique name for the navigation set created using the '''Navigation set display rule'''.
Name must be in lowercase and have no spaces. The rule will NOT check to see if the named navigation set exists or not.

'''Navigation Set Hide/Show:''' Shows and hides navigation sets. You can have multiple sets visible at the same time.

'''Properties:'''
'''''Hide/Show'':''' - click to select one
'''''click here to set'':''' - enter the unique name for the navigation set created using the '''Navigation set display rule'''.
Name must be in lowercase and have no spaces. The rule will NOT check to see if the named navigation set exists or not.

'''Schedule Rule:''' Allows a schedule of timed events to be applied to a train

'''Properties:'''
Insert track mark click to select from session list
Note: Both has an arrival and departure set time hr:min:sec
Current Train click to select from session list
Insert destination click to select from session list

'''Set Junctions Rule:''' Sets the selected junctions to a specific state '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''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:-
'''''Setting'': Left/Center/Right/Don't change''' - click one to set the junction direction
'''''Locked'': Locked/Unlocked''' - click to select one. '''Locked''' means the junction setting cannot be changed by the user
'''''Allows AI control/Blocks AI control''''' - click to select one.
'''''Remove''''' - click to remove that junction from the rule list

'''Set Signal Extended Rule:''' Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''Properties:'''
'''''Select signal''''' - click to select a signal from the session list
'''''<signal state>''''' - click to select a state from the list

'''Trigger Check Rule:''' Waits for any train to enter one of the designated triggers. This rule replaces the older and less versatile "Trigger Rule".

'''Properties:'''
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list
Add Trigger click to choose from session list
Trigger only once check to set
Wait for child rules to complete even if check to set
Only activate when the entering click to choose forward, backward

'''Wait on Navigation Point Rule:''' Waits for a navigation point to be completed then the following child rules will be executed

'''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 set display rule'''.
Name must be in lowercase and have no spaces. The rule will NOT check to see if the named navigation set and point exists or not.

'''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start

'''Properties:'''
Accept all trains fill-in to set
Accept trains matching specific criteria fill-in to set and choose from session list
Wait for a train that matches the click to choose: start moving, stop moving
Trigger rule once check to set
Note: One or the other fill-ins must be

=='''Driver Rules'''==

'''Control Type Rule''' Sets control type

'''Properties:'''
Current control method is: Easy Mode, Choice one of the three

'''Control Check Rule:''' Activates child rules based on the control method changes

'''Properties:'''
Excite child rules when: DCC mode is fill-in one or the other
Excite child rules: Every time control fill-in one or the other

'''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule

'''Properties:'''
Trigger add Trigger
Portal index from PCP value
Use UnPortal yes/no
Delay from Trigger to Emit: seconds value

'''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry

'''Properties:'''
Apply to every vehicle in the session fill-in
Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles
Note: One of the Applies will always be
Load/Unload for industry Disable/Enable choose Industry

'''Driver Command Rule:''' Specify which commands will be available for the drivers

'''Properties''':
Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.
Navigate To TrackMarkList V2- No description.
Navigate To Station V2- No description.
Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.
Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.
Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.
Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.
Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.
Drive To Station V2- No description.
Drive To Track mark List V2- No description.
Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.
Drive To Industry- Drive to a specific industry.
Change Destination Sign-Changes the destination signs of a train.

WaitFor- Pauses the driver's schedule for a set duration of time.
Wait For Random- TRS2008: Wait for specified or optionally random period of time.
Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).
WaitUntil- No description.

VR Set Train Lamps-Driver command that sets the train lamps.
Notify- Notifies the player of schedule progress/completion.
Reverse Tram- Reverse a tram(max 2 cars).
Couple- Couple train to designate vehicle.
Decouple- Decouples the train at the specified vehicle.
UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).
Halt Train- Brings the train to a complete stop.
Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.
Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger
station before using this command.
Cab: Wait-Maintains current control state until some condition is met.
Delete Train- Causes the train and its driver to be deleted from the session.
Hornz- Driver sounds the train horn.
Cab: Set Control-Sets a cab mode control.
Headlights On/Off-Allows the driver to to switch the headlights on and off.
Interior Lights Command- Driver command to switch interior lights on or off for the current train.
Set Max Speed To- No description.

Release Junction - Lets a driver release the junction they have been holding.
Move Turntable- TRS2008: Move turntable to a stop point .

Load- Loads the train's vehicles at the industry the driver is currently at with the train.
Unload- Unload train vehicles at current industry location.
Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.
Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.
Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.

'''Driver Command Check Rule:''' Verifies the driver commands of a driver character

'''Properties'''
Wait for driver character to have add driver, all, delete all
Trigger Rule once check
Driver character to watch the name driver

'''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar

'''Properties'''
The Driver Main Bar choice show/hide

'''Driver Schedule Rule''' Execution of basic scheduled commands

'''Properties:'''
Note: Only one of the fill-in can be
Driver Schedule Rule assigned to name driver
Commands insert driver commands in Drive Schedule
Classic style: If there is a schedule fill-in
Killer style: If there is a schedule fill-in
Cooperative style: If there is a schedule fill-in
Active style: Emit a new schedule, only fill-in

'''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders

'''Properties'''
Generate new Drivers for empty check
The following drivers will be available Driver's Name Add
Remove all existing Drivers first check

'''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers

'''Properties'''
Assign Driver commands check Driver Commands
Train criteria fill in all trains
Train criteria list train only trains matching criteria

'''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted

'''Properties'''
Config/txt file tag 'max_permitted_speed-60850 in mph or kph
Add to config.txt and kuid-table for value <KUID2:60850:88000:4
Note: Old root level config tag will

'''QuickDrive Rule:''' Change the Session settings and add consists in Driver

'''Properties'''
Set Time to insert time
QuickDrive Consist Option List by
Rate of Change insert rate as number times
Enable gameplay Session Mode check
Enable in game help by default check
Set the default Control method to fill-in choose: Easy Mode, Realistic Mode
Prevent player from changing this check
Realistic mode requires achievement add Achievement's Name
In Asset choose Auran achievements
Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic
Prevent player from changing 10.0 check
Set the default units to fill-in choose: Imperial, Metric, Default
Open QuickDriver Window when check

'''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train

'''Properties'''
Note: One or the other fill-ins must be
Accept trains matching specific criteria fill-in to select from session list
Accept all trains fill-in to set
Trigger rule once check to set
Wait for a driver character to get ? a click to select: On, Off

'''Wait for Driver/Train to be Locally Owned Rule:''' Waits for a specific driver or train car to be locally owned, Owned then executes child rules. If the driver/train car becomes unowned again the child rules are paused

'''Properties'''
Wait for ownership of a specific Driver fill-in to set
Wait for ownership of Driver fill-in to set
Note: One or the other fill-in must be
Driver or Vehicle click to choose from session lists

=='''Arrangement of Session Rules:'''==

'''Ordered List Rule:''' Child rules will be executed in order once this rule starts

'''Properties'''
Note: One of the two must be chosen
This process will repeat fill-in click to add number of repeats
This process will repeat forever fill-in

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

'''Properties'''
After last child run is executed click to choose: First child is chosen again, It will be
used for all successive runs, Successive runs will
do nothing

'''Random List Rule:''' One of the child rules indented under this rule will be randomly selected and executed

'''Properties'''
executed randomly
Once one of the child rule is ??

'''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle

'''Properties'''
None

'''Simultaneous List Rule:''' Child rules are executed simultaneously once this rule starts

'''Properties'''
Rules completes when click choose all rules have reached completed state,
was completed state

=='''Camera Rules:'''==

'''Cinematic Camera Rule:''' Provides several different cinematic style cameras

'''Properties'''
Lock camera controls for the duration check
Prevent rain control for duration check
Camera target: name any of the many objects in session
Camera mode: Stationary, Circle fill-in
Initial camera values: Pitch, Yaw, Zoom value
Total time to animate: seconds value

'''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties

'''Properties'''
Change the camera view mode to check to choose: Cab View, External View, Tracking
View, Free Roaming
Vehicle fill-in choose from session vehicles
Set the camera flags to enable/disable check to choose different properties from list
Junction fill-in choose from session junctions
Set the target objet of the camera to check
Map object fill-in choose from map objects

'''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view

'''Properties'''
Trigger rule once check to set
Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking
View, Free Roaming View
Wait for the camera to target vehicle ? click to choose form session list

=='''Message Rules:'''==

'''Close Message Popup Rule:''' Closes open message popups

'''Properties:'''
None

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

'''Custom Script Rule:'''

'''Properties'''
None.

'''Display Custom HUD Rule:''' Show or hide the Custom Heads Up Display.

'''Properties'''
Show the Custom Heads up Display- fill-in to choose.
Hide the Custom Heads up Display- fill-in to choose.
Note: One or the other will be chosen by default.

'''Wait for Click on HUD Icon Rule:'''

'''Properties'''
Trigger rule once-check to choose.
HUD Panel- click to choose from list.
Wait for click on- click to choose; choice depends on HUD Panel chosen.

'''Display HTML Pages Rule:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.

'''Properties'''
Add Page- click on to choose from list; click to Add Page Name or Remove.
Add All- click to add all files from the designated assets.
Delete All- delete all files from this property list.
Prevent user from exiting browser until all pages viewed- check to choose.
Disable closing of browser window by user- check to choose.
Disable browser window scrolling- check to choose.
Make browser window invisible- check to choose.
Set position-Under Construction!!!- check to choose.
Set size-Under Construction!!!- check to choose.
Use the page- click to choose Insert Page Name.
From asset HTML- click to choose from list.

'''Timed limited display HTML Rule:''' Displays an html browser window for a limited time.

'''Properties'''
HTML Asset Name-

'''Display Video Rule:''' Displays a page from a HTML assets in a browser window.

'''Properties'''

'''End Session Rule:''' End Session without saving.

'''Properties'''

'''Fade in/out Rule:''' Fade in or out within seconds, color and opacity considered.

'''Properties'''

'''Flash HUD Icon Rule:''' Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.

'''Properties'''

'''Generic Tree Node Debug Window Rule:''' No description.

'''Properties'''

'''InputTable Rule:''' Creating a list of message names to be used for various purposes.

'''Properties'''

'''Message Popup Rule:''' Displays a pop-up browser window and waits to be closed.

'''Properties'''
'''(Check Box) Pause game while message is displayed:''' - stops the game until this message is switched off
'''(Check Box) Close previous popup windows:''' - closes any Message Popups currently displayed
'''Message location: Top Left/Top Right/Bottom Left/Bottom Right''' - select one to position the browser window on the screen
'''Message Source: Custom text/A predefined HTML page (advanced)/A predefined string-table entry from a HTML asset (advanced)''' - select one

'''Message Source Option: Custom text'''
'''Icon: ''Click here to set''''' - shows a list of message icons. Select one to be displayed with the message
'''Icon: ''Clear icon''''' - clears any currently displayed message icon
'''Custom text:''' Enter text to be displayed. You will be limited to about 6 lines of text. For longer messages or to include graphics, use the '''A predefined HTML page''' option.

'''Message Source Option: A predefined HTML page'''
'''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.

'''Message Source Option: 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.

'''Minimap Options Rule:''' Sets the display options for the minimap.

'''Properties'''

'''Play Sound Rule:''' Plays a wav sound file.

'''Properties'''

'''Session Debug Rule Rule:''' Executes the first child if debug mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.

'''Properties'''

'''Session Metadata Rule:''' Sets session metadata in the config file. Info can be read by other systems and displayed to the player.

'''Properties'''

'''Set Helper Icon Size Rule:''' Sets the size of helper icons such as the junction lever arrows.

'''Properties'''

'''Set HTML Page Rule:''' Instructs the Display HTML Pages rule to perform specific operations

'''Properties'''

'''Show/Hide HUD Panel Rule:''' Shows or hides a HUD panel.

'''Properties'''

'''Show/Hide Layer Rule:''' Shows or hides a layer from Driver.

'''Properties:'''
'''Show/Hide''' - select one
'''click here to set''' - enter name of layer. Name is case sensitive.

'''Known Bugs:'''
TANE (all versions) - layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded

'''Show/Hide Minimap Rule:''' Shows the Driver the minimap window.

'''Properties'''
'''Minimap Window'''-click to choose Show,Hide

'''Show/hide on-screen help Rule:''' Shows or hides On-screen help in Driver.

'''Properties'''
'''Junction Overlays:''' - fill-in to choose: Show, Hide, Leave unchanged. by default one is chosen
'''On Screen Vehicle Name:''' - Fill-in to choose: Show, Hide, Leave unchanged. By default one is chosen

'''Wait for Click on HUD Icon Rule:''' Waits for a click on the HUD Icon.

'''Properties'''
'''(Check Box) Trigger Once:''' -to choose
'''HUD Panel:''' - Click to choose from list: Bottom Right Menu, Camera Controls, DCC Controls
'''Icon:''' - Choose from list. Selections depends on HUD Panel chosen

'''Wait on Waybill Screen/Main Screen Rule:''' Waits for the Waybill window to be opened.

'''Properties'''

=='''Startup Rules:'''==

'''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.

'''Properties'''

'''Startup Options Rule''' Specifies the starting options for the session.

'''Properties'''

=='''Time Rules:'''==

'''Clock Rule:''' Rule needed for animated clocks, you need to apply this rule to your session to make use of the animated clocks, see forum for code to include in you clock object to work with this rule.

'''Properties'''

'''Timecheck Rule:''' Executes child rules at a certain time.

'''Properties'''

'''Timing Check Rule:''' Triggers sub rules if called within the time window specified.

'''Properties'''

'''Wait Rule:''' Wait for number of seconds'

'''Properties'''

=='''Variable Rules:'''==

'''Variable Check Rule:''' If the specified variable matches the specified conditions then the child rules will be executed in order.

'''Properties'''
'''''<variable-name>''''' - enter a variable-name. Variable name is case sensitive.
'''''<test-condition>''''' - '''is less than/is less than or equal to/is equal to/is greater than or equal to/is greater than/is not equal to/is between x and y''' - select one
'''''This condition will be evaluated only once .../This condition will be evaluated once every second''''' - click to select one
'''Test condition option: is between x and y'''
Enter minimum (x) and maximum (y) test values

'''Test condition option: (all other options)'''
Enter test value

'''Evaluation option: 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

'''Evaluation option: This condition will be evaluated evaluated once every second''' - the rule will be run and the variable rechecked every second

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

'''Properties'''
'''Change: Add to variable/Subtract from variable/Change variable''' - select one
'''(optional check box) Set the minimum value''' of ''<variable-name>'' to ''<value>'' - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.
('''optional check box) Set the maximum value''' of ''<variable-name>'' to ''<value>'' - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.

'''Change option: 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.

'''Change option: 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 option: Change variable'''
'''Change variable ''<variable-name>'' to ''<value>''''' - enter variable-name, enter new value. This cannot be undone if the rule is stopped. Variable-name is case sensitive.

'''Variable Modify Continuous Rule:''' Adds, subtracts or sets a value to a specified variable every second.

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

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

'''Properties'''
'''Check box: Add'''
''<variable-name>'' - enter variable-name. 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. Variable-name is case sensitive.

Variables are saved in the session file and persist from one saved game to another.
They can be accessed/modified by the following '''driver commands''':

'''Driver Commands by trev999:'''
'''Set S-Variable driver command: '''
'''Skip if session-variable driver command: '''
'''Wait until S-variable driver command: '''

'''Driver Commands by atilabarut'''
'''ChangeSVariables driver command: '''
'''WaitUntilSVariable driver command: '''

=='''Weather Rules:'''==

'''EIRS Weather Rule NE USA Rule:''' Customize random weather rule relative to the North East Region of the United States.

'''Properties'''

'''Weather Rule:''' Set the weather conditions.

'''Properties'''

Session Rules By Categories With Properties

2017-09-26T23:50:39Z

Coop2:

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

1:=='''Achievement Rules'''==

'''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement

'''Properties:'''
None

'''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload

'''Properties:'''
'''Target object''' ?? name of object such as Power Station, Coal Pit or Portal
'''Lock train's controls'''- checked during a stopped load/unload operation
'''Override 'begin load' and 'begin unload' '''- checked # of seconds to override

'''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations

'''Properties:'''
'''Trigger'''- click to choose from list
'''Add Industry'''- click to add from session list
'''Accept all trains'''- fill-in
'''Accept trains matching specific criteria'''- fill-in to choose from session list

'''Power Station Rule:''' Sets up Station and Consumers

'''Properties:'''
'''Power Station'''- click to choose from session Stations
'''Consumers(Add Object)'''- click to choose from session list

'''Resource Check Rule:''' Check the progress of the amount of a resource and target object

'''Properties:'''
'''Watch industry queue or Watch vehicle'''- fill-in choose one or the other
'''Note:''' Both have: Target Object, Queue: click to choose
'''Complete when designated queue'''- fill-in equals or exceeds required amount, falls below required amount

'''Multiple Resource Check Rule:''' If specified resources in a selected industry or vehicle reaches set levels, then the following child rules will be executed

'''Properties:'''
'''''Reach-Exceed/Fall below'':''' - click to select one
'''''<value>'':''' - enter required quantity value
'''''<Click to 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. For each object:-
'''Object:''' - select session active industry or product enabled rail vehicle
'''Queue:''' - select product queue (there may be only one available)
'''Remove:''' - removes the object and its product queue from the rule
'''Notes:'''
'''''Reach/Exceed''''' - sets an upper limit for the resource 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 resource 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.

'''Objective Add Rule:''' Sets up a game Objective with ID and display Name

'''Properties:'''
Priority click choose Above Normal, Below Normal, Normal, Optional, Urgent
Completion Target click to set target number
Icon click choose from list
Display Name click insert Name
Unique Objective ID click set ID
Custom Message insert typed message in text area

'''Objective Check Rule:''' Executes child rules when objective is complete

'''Properties:'''
Unique Objective ID click insert ID number
Mode click choose Wait for completion, Wait for failure, Wait for progress

'''Objective Update Rule:''' Changes progress outcome according to Property choices

'''Properties:'''
Unique Objective ID click to set ID number
Mode click Set objective as Decrement progress/Increment progress/Reset objective/Set objects as complete/Set objects as failed/Set progress/Set progress only if greater
Amount click insert number

'''Ranked Session Begin Rule:''' Begins a ranked Session

'''Properties:'''
Countdown requires a Starting Value insert hrs., min,sec
1 through 5 stars, points for each star insert number of points
Session timer mode fill-in chooses: Timer, Countdown, None

'''Ranked Session Complete Rule:''' Completes the active ranked Session

'''Properties:'''
Set the active ranked session as fill-in choose: Complete, Failed
Customize the completion message check insert text message

'''Session Complete Rule:''' Set session to a percentage of completion

'''Properties:'''
Set session to percent complete click to insert number in percent
Separate achievements for completion check

=='''Danger Rules'''==

'''ATP Speed Limiter Rule:''' Limits speed over set limit

'''Properties:'''
speed limit over the set limit mph

'''Speeding Check Rule:''' If player controlled trains are over the local speed limit or over a set (custom) speed, then the following child rules will be executed

'''Properties:'''
'''(Option button) Watch for trains travelling above the posted speed limit'''
'''''<speed value>'':''' - click to enter a new overspeed tolerance value
'''''<units>'':''' - '''Kmph/MPH/mps''' - click to select one
'''(Option button) Watch for trains travelling above a custom speed'''
'''''<speed value>'':''' - click to enter a new custom speed value
'''''<units>'':''' - '''Kmph/MPH/mps''' - click to select one
'''Warning: This option is very performance intensive and should only be used in sessions with few trains'''

'''AWS Configuration Rule:''' This rule configures the Trainz implementation of the Automatic Warning System when approaching signals

'''Properties:'''
Use modern sound set for unfitted cabs? check
Simulate AWS for unfitted cabs? check
Passive with HUD hidden fill-in
Active fill-in
Passive fill-in

'''Wait for Derailment Rule:''' Waits for a derailment to occur

'''Properties:'''
Trigger derailment watch once check to set

'''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars

'''Properties:'''
Set delay to clean up derailed train cars values

'''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule

'''Properties:'''
Respawn trains if they are abandoned check
Respawn trains fill-in choose: at their original locations, from portals from Session List

'''Coupler Breakage Check Rule:''' Checks for breaking couplers. No parameters.

'''Properties:'''
None

'''Coupler Breakage HUDRule:''' HUD displays warning about coupler stress and breakage

'''Properties:'''
Show the Coupler Breakage Display fill-in must choose one or the other
Hide the Coupler Breakage Display fill-in must choose one or the other

'''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles

'''Properties:'''
Add vehicle click to select from session list
Coupling Mask, Decoupling Mask : click to select: lock or unlock
Add All click to select all vehicle in session
Delete All click to delete all vehicle from list

'''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users

'''Properties:'''
Trigger only once check

'''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users

'''Properties:'''
Trigger only once check

'''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger

'''Properties:'''
Trigger only once check to set

'''Vehicle Physics Rule:''' Overrides the default vehicle physics properties

'''Properties:'''
Accept all trains fill-in
Cab sway level is set ? % click to insert percent of sway
Traction boost is % ? while sanding click to insert percent of boost
Tractions reduced to ? % while click to set traction percent
Maximum tractive effort adjusted by ? click to insert percent amount
Show coupler breakage in HUD Rule check to set
Couplers break when coupling above ? click to set speed
Accept trains matching specific criteria fill-in to insert specific trains
Couplers break at ? kN check to insert amount of force

=='''Navigation Rules'''==

'''DestSignTable Rule:''' Table for creating a table of destination signs

'''Properties:'''
Enable Track Marks as destinations check
Enable table of destinations check
Import destination from texture-group. name
Destination Name name
Enable industries/stations as check
Interlocking Tower Configure Path Alters settings on an interlocking tower path
Interlocking Tower choose Name and Objects
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
Show path activation message in Driver check

'''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train

'''Properties:'''
Interlocking Tower choose Names and Objects
Multiple Junction Alignment Check Checks multiple junctions are in alignment
Wait until the following junctions are choose all or anyone
Add junction click add junction from session list
Add all click add all junctions from session list
Delete all click deletes all junctions from rule list

'''Navigation Display Rule:''' Creates a set of navigation points. Multiple sets can be created by adding additional copies of this rule. This rule creates the navigation set, it does not display it. Use the '''Navigation set hide/show rule''' to make a set visible. Click the help icon at the top of the properties box for in game instructions.

'''Properties:'''
'''Unique set ID:''' - enter a unique name for the navigation set. Name must be in lowercase and have no spaces.
'''Train (optional):''' - select a rolling stock asset from the session list shown.
'''Navigation mode:''' select one
'''(Option button) 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.
'''(Option button) 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.
'''(Option button) 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 (a trigger, trackmark, track object or rolling stock asset) 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'':''' - select an icon for the navigation point.
'''''Style'': ''Automatic/Manual/Require Stop''''' - click to select one
'''''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'''.
This allows you to execute other rules (e.g. consist check, trigger 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.

'''Navigation Point Complete Rule:''' Marks a navigation point complete

'''Properties:'''
Mark navigation point click set index number
Complete in set click to set ID

'''Navigation Set Check Rule:''' Checks if a navigation point is complete/incomplete

'''Properties:'''
Checks if navigation point is set click set ID
Is click Complete, Incomplete
Navigation Set Clear Clears a navigation point set
Clear the navigation point set click to set ID
Navigation Set Hide/Show Show or hide navigation point set
The navigation point click hide, show
Navigation point set click to set ID

'''Navigation Set Clear Rule:''' Clears a navigation set removing any uncompleted navigation points

'''Properties:'''
'''''Click here to set'':''' - enter the unique name for the navigation set created using the '''Navigation set display rule'''.
Name must be in lowercase and have no spaces. The rule will NOT check to see if the named navigation set exists or not.

'''Navigation Set Hide/Show:''' Shows and hides navigation sets. You can have multiple sets visible at the same time.

'''Properties:'''
'''''Hide/Show'':''' - click to select one
'''''click here to set'':''' - enter the unique name for the navigation set created using the '''Navigation set display rule'''.
Name must be in lowercase and have no spaces. The rule will NOT check to see if the named navigation set exists or not.

'''Schedule Rule:''' Allows a schedule of timed events to be applied to a train

'''Properties:'''
Insert track mark click to select from session list
Note: Both has an arrival and departure set time hr:min:sec
Current Train click to select from session list
Insert destination click to select from session list

'''Set Junctions Rule:''' Sets the selected junctions to a specific state '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''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:-
'''''Setting'': Left/Center/Right/Don't change''' - click one to set the junction direction
'''''Locked'': Locked/Unlocked''' - click to select one. '''Locked''' means the junction setting cannot be changed by the user
'''''Allows AI control/Blocks AI control''''' - click to select one.
'''''Remove''''' - click to remove that junction from the rule list

'''Set Signal Extended Rule:''' Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''Properties:'''
'''''Select signal''''' - click to select a signal from the session list
'''''<signal state>''''' - click to select a state from the list

'''Trigger Check Rule:''' Waits for any train to enter one of the designated triggers. This rule replaces the older and less versatile "Trigger Rule".

'''Properties:'''
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list
Add Trigger click to choose from session list
Trigger only once check to set
Wait for child rules to complete even if check to set
Only activate when the entering click to choose forward, backward

'''Wait on Navigation Point Rule:''' Waits for a navigation point to be completed then the following child rules will be executed

'''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 set display rule'''.
Name must be in lowercase and have no spaces. The rule will NOT check to see if the named navigation set and point exists or not.

'''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start

'''Properties:'''
Accept all trains fill-in to set
Accept trains matching specific criteria fill-in to set and choose from session list
Wait for a train that matches the click to choose: start moving, stop moving
Trigger rule once check to set
Note: One or the other fill-ins must be

=='''Driver Rules'''==

'''Control Type Rule''' Sets control type

'''Properties:'''
Current control method is: Easy Mode, Choice one of the three

'''Control Check Rule:''' Activates child rules based on the control method changes

'''Properties:'''
Excite child rules when: DCC mode is fill-in one or the other
Excite child rules: Every time control fill-in one or the other

'''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule

'''Properties:'''
Trigger add Trigger
Portal index from PCP value
Use UnPortal yes/no
Delay from Trigger to Emit: seconds value

'''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry

'''Properties:'''
Apply to every vehicle in the session fill-in
Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles
Note: One of the Applies will always be
Load/Unload for industry Disable/Enable choose Industry

'''Driver Command Rule:''' Specify which commands will be available for the drivers

'''Properties''':
Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.
Navigate To TrackMarkList V2- No description.
Navigate To Station V2- No description.
Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.
Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.
Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.
Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.
Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.
Drive To Station V2- No description.
Drive To Track mark List V2- No description.
Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.
Drive To Industry- Drive to a specific industry.
Change Destination Sign-Changes the destination signs of a train.

WaitFor- Pauses the driver's schedule for a set duration of time.
Wait For Random- TRS2008: Wait for specified or optionally random period of time.
Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).
WaitUntil- No description.

VR Set Train Lamps-Driver command that sets the train lamps.
Notify- Notifies the player of schedule progress/completion.
Reverse Tram- Reverse a tram(max 2 cars).
Couple- Couple train to designate vehicle.
Decouple- Decouples the train at the specified vehicle.
UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).
Halt Train- Brings the train to a complete stop.
Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.
Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger
station before using this command.
Cab: Wait-Maintains current control state until some condition is met.
Delete Train- Causes the train and its driver to be deleted from the session.
Hornz- Driver sounds the train horn.
Cab: Set Control-Sets a cab mode control.
Headlights On/Off-Allows the driver to to switch the headlights on and off.
Interior Lights Command- Driver command to switch interior lights on or off for the current train.
Set Max Speed To- No description.

Release Junction - Lets a driver release the junction they have been holding.
Move Turntable- TRS2008: Move turntable to a stop point .

Load- Loads the train's vehicles at the industry the driver is currently at with the train.
Unload- Unload train vehicles at current industry location.
Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.
Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.
Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.

'''Driver Command Check Rule:''' Verifies the driver commands of a driver character

'''Properties'''
Wait for driver character to have add driver, all, delete all
Trigger Rule once check
Driver character to watch the name driver

'''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar

'''Properties'''
The Driver Main Bar choice show/hide

'''Driver Schedule Rule''' Execution of basic scheduled commands

'''Properties:'''
Note: Only one of the fill-in can be
Driver Schedule Rule assigned to name driver
Commands insert driver commands in Drive Schedule
Classic style: If there is a schedule fill-in
Killer style: If there is a schedule fill-in
Cooperative style: If there is a schedule fill-in
Active style: Emit a new schedule, only fill-in

'''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders

'''Properties'''
Generate new Drivers for empty check
The following drivers will be available Driver's Name Add
Remove all existing Drivers first check

'''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers

'''Properties'''
Assign Driver commands check Driver Commands
Train criteria fill in all trains
Train criteria list train only trains matching criteria

'''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted

'''Properties'''
Config/txt file tag 'max_permitted_speed-60850 in mph or kph
Add to config.txt and kuid-table for value <KUID2:60850:88000:4
Note: Old root level config tag will

'''QuickDrive Rule:''' Change the Session settings and add consists in Driver

'''Properties'''
Set Time to insert time
QuickDrive Consist Option List by
Rate of Change insert rate as number times
Enable gameplay Session Mode check
Enable in game help by default check
Set the default Control method to fill-in choose: Easy Mode, Realistic Mode
Prevent player from changing this check
Realistic mode requires achievement add Achievement's Name
In Asset choose Auran achievements
Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic
Prevent player from changing 10.0 check
Set the default units to fill-in choose: Imperial, Metric, Default
Open QuickDriver Window when check

'''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train

'''Properties'''
Note: One or the other fill-ins must be
Accept trains matching specific criteria fill-in to select from session list
Accept all trains fill-in to set
Trigger rule once check to set
Wait for a driver character to get ? a click to select: On, Off

'''Wait for Driver/Train to be Locally Owned Rule:''' Waits for a specific driver or train car to be locally owned, Owned then executes child rules. If the driver/train car becomes unowned again the child rules are paused

'''Properties'''
Wait for ownership of a specific Driver fill-in to set
Wait for ownership of Driver fill-in to set
Note: One or the other fill-in must be
Driver or Vehicle click to choose from session lists

=='''Arrangement of Session Rules:'''==

'''Ordered List Rule:''' Child rules will be executed in order once this rule starts

'''Properties'''
Note: One of the two must be chosen
This process will repeat fill-in click to add number of repeats
This process will repeat forever fill-in

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

'''Properties'''
After last child run is executed click to choose: First child is chosen again, It will be
used for all successive runs, Successive runs will
do nothing

'''Random List Rule:''' One of the child rules indented under this rule will be randomly selected and executed

'''Properties'''
executed randomly
Once one of the child rule is ??

'''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle

'''Properties'''
None

'''Simultaneous List Rule:''' Child rules are executed simultaneously once this rule starts

'''Properties'''
Rules completes when click choose all rules have reached completed state,
was completed state

=='''Camera Rules:'''==

'''Cinematic Camera Rule:''' Provides several different cinematic style cameras

'''Properties'''
Lock camera controls for the duration check
Prevent rain control for duration check
Camera target: name any of the many objects in session
Camera mode: Stationary, Circle fill-in
Initial camera values: Pitch, Yaw, Zoom value
Total time to animate: seconds value

'''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties

'''Properties'''
Change the camera view mode to check to choose: Cab View, External View, Tracking
View, Free Roaming
Vehicle fill-in choose from session vehicles
Set the camera flags to enable/disable check to choose different properties from list
Junction fill-in choose from session junctions
Set the target objet of the camera to check
Map object fill-in choose from map objects

'''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view

'''Properties'''
Trigger rule once check to set
Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking
View, Free Roaming View
Wait for the camera to target vehicle ? click to choose form session list

=='''Message Rules:'''==

'''Close Message Popup Rule:''' Closes open message popups

'''Properties:'''
None

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

'''Custom Script Rule:'''

'''Properties'''
None.

'''Display Custom HUD Rule:''' Show or hide the Custom Heads Up Display.

'''Properties'''
Show the Custom Heads up Display- fill-in to choose.
Hide the Custom Heads up Display- fill-in to choose.
Note: One or the other will be chosen by default.

'''Wait for Click on HUD Icon Rule:'''

'''Properties'''
Trigger rule once-check to choose.
HUD Panel- click to choose from list.
Wait for click on- click to choose; choice depends on HUD Panel chosen.

'''Display HTML Pages Rule:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.

'''Properties'''
Add Page- click on to choose from list; click to Add Page Name or Remove.
Add All- click to add all files from the designated assets.
Delete All- delete all files from this property list.
Prevent user from exiting browser until all pages viewed- check to choose.
Disable closing of browser window by user- check to choose.
Disable browser window scrolling- check to choose.
Make browser window invisible- check to choose.
Set position-Under Construction!!!- check to choose.
Set size-Under Construction!!!- check to choose.
Use the page- click to choose Insert Page Name.
From asset HTML- click to choose from list.

'''Timed limited display HTML Rule:''' Displays an html browser window for a limited time.

'''Properties'''
HTML Asset Name-

'''Display Video Rule:''' Displays a page from a HTML assets in a browser window.

'''Properties'''

'''End Session Rule:''' End Session without saving.

'''Properties'''

'''Fade in/out Rule:''' Fade in or out within seconds, color and opacity considered.

'''Properties'''

'''Flash HUD Icon Rule:''' Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.

'''Properties'''

'''Generic Tree Node Debug Window Rule:''' No description.

'''Properties'''

'''InputTable Rule:''' Creating a list of message names to be used for various purposes.

'''Properties'''

'''Message Popup Rule:''' Displays a pop-up browser window and waits to be closed.

'''Properties'''
'''(Check Box) Pause game while message is displayed:''' - stops the game until this message is switched off
'''(Check Box) Close previous popup windows:''' - closes any Message Popups currently displayed
'''Message location: Top Left/Top Right/Bottom Left/Bottom Right''' - select one to position the browser window on the screen
'''Message Source: Custom text/A predefined HTML page (advanced)/A predefined string-table entry from a HTML asset (advanced)''' - select one

'''Message Source Option: Custom text'''
'''Icon: ''Click here to set''''' - shows a list of message icons. Select one to be displayed with the message
'''Icon: ''Clear icon''''' - clears any currently displayed message icon
'''Custom text:''' Enter text to be displayed. You will be limited to about 6 lines of text. For longer messages or to include graphics, use the '''A predefined HTML page''' option.

'''Message Source Option: A predefined HTML page'''
'''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.

'''Message Source Option: 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.

'''Minimap Options Rule:''' Sets the display options for the minimap.

'''Properties'''

'''Play Sound Rule:''' Plays a wav sound file.

'''Properties'''

'''Session Debug Rule Rule:''' Executes the first child if debug mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.

'''Properties'''

'''Session Metadata Rule:''' Sets session metadata in the config file. Info can be read by other systems and displayed to the player.

'''Properties'''

'''Set Helper Icon Size Rule:''' Sets the size of helper icons such as the junction lever arrows.

'''Properties'''

'''Set HTML Page Rule:''' Instructs the Display HTML Pages rule to perform specific operations

'''Properties'''

'''Show/Hide HUD Panel Rule:''' Shows or hides a HUD panel.

'''Properties'''

'''Show/Hide Layer Rule:''' Shows or hides a layer from Driver.

'''Properties:'''
'''Show/Hide''' - select one
'''click here to set''' - enter name of layer. Name is case sensitive.

'''Known Bugs:'''
TANE (all versions) - layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded

'''Show/Hide Minimap Rule:''' Shows the Driver the minimap window.

'''Properties'''
'''Minimap Window'''-click to choose Show,Hide

'''Show/hide on-screen help Rule:''' Shows or hides On-screen help in Driver.

'''Properties'''
'''Junction Overlays:''' - fill-in to choose: Show, Hide, Leave unchanged. by default one is chosen
'''On Screen Vehicle Name:''' - Fill-in to choose: Show, Hide, Leave unchanged. By default one is chosen

'''Wait for Click on HUD Icon Rule:''' Waits for a click on the HUD Icon.

'''Properties'''
'''(Check Box) Trigger Once:''' -to choose
'''HUD Panel:''' - Click to choose from list: Bottom Right Menu, Camera Controls, DCC Controls
'''Icon:''' - Choose from list. Selections depends on HUD Panel chosen

'''Wait on Waybill Screen/Main Screen Rule:''' Waits for the Waybill window to be opened.

'''Properties'''

=='''Startup Rules:'''==

'''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.

'''Properties'''

'''Startup Options Rule''' Specifies the starting options for the session.

'''Properties'''

=='''Time Rules:'''==

'''Clock Rule:''' Rule needed for animated clocks, you need to apply this rule to your session to make use of the animated clocks, see forum for code to include in you clock object to work with this rule.

'''Properties'''

'''Timecheck Rule:''' Executes child rules at a certain time.

'''Properties'''

'''Timing Check Rule:''' Triggers sub rules if called within the time window specified.

'''Properties'''

'''Wait Rule:''' Wait for number of seconds'

'''Properties'''

=='''Variable Rules:'''==

'''Variable Check Rule:''' If the specified variable matches the specified conditions then the child rules will be executed in order.

'''Properties'''
'''''<variable-name>''''' - enter a variable-name. Variable name is case sensitive.
'''''<test-condition>''''' - '''is less than/is less than or equal to/is equal to/is greater than or equal to/is greater than/is not equal to/is between x and y''' - select one
'''''This condition will be evaluated only once .../This condition will be evaluated once every second''''' - click to select one
'''Test condition option: is between x and y'''
Enter minimum (x) and maximum (y) test values

'''Test condition option: (all other options)'''
Enter test value

'''Evaluation option: 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

'''Evaluation option: This condition will be evaluated evaluated once every second''' - the rule will be run and the variable rechecked every second

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

'''Properties'''
'''Change: Add to variable/Subtract from variable/Change variable''' - select one
'''(optional check box) Set the minimum value''' of ''<variable-name>'' to ''<value>'' - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.
('''optional check box) Set the maximum value''' of ''<variable-name>'' to ''<value>'' - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.

'''Change option: 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.

'''Change option: 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 option: Change variable'''
'''Change variable ''<variable-name>'' to ''<value>''''' - enter variable-name, enter new value. This cannot be undone if the rule is stopped. Variable-name is case sensitive.

'''Variable Modify Continuous Rule:''' Adds, subtracts or sets a value to a specified variable every second.

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

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

'''Properties'''
'''Check box: Add'''
''<variable-name>'' - enter variable-name. 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. Variable-name is case sensitive.

Variables are saved in the session file and persist from one saved game to another.
They can be accessed/modified by the following '''driver commands''':

'''Driver Commands by trev999:'''
'''Set S-Variable driver command: '''
'''Skip if session-variable driver command: '''
'''Wait until S-variable driver command: '''

'''Driver Commands by atilabarut'''
'''ChangeSVariables driver command: '''
'''WaitUntilSVariable driver command: '''

=='''Weather Rules:'''==

'''EIRS Weather Rule NE USA Rule:''' Customize random weather rule relative to the North East Region of the United States.

'''Properties'''

'''Weather Rule:''' Set the weather conditions.

'''Properties'''

Session Rules By Categories With Properties

2017-09-26T23:42:35Z

Coop2: /* Message Rules: */

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

1
=='''Achievement Rules'''==

'''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement

'''Properties:'''
None

'''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload

'''Properties:'''
Target object ?? name of object such as Power Station, Coal Pit or Portal
Lock train's controls checked during a stopped load/unload operation
Override 'begin load' and 'begin unload' checked # of seconds to override

'''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations

'''Properties:'''
Trigger click to choose from list
Add Industry click to add from session list
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list

'''Power Station Rule:''' Sets up Station and Consumers

'''Properties:'''
Power Station click to choose from session Stations
Consumers(Add Object) click to choose from session list

'''Resource Check Rule:''' Check the progress of the amount of a resource and target object

'''Properties:'''
Watch industry queue or Watch vehicle fill-in choose one or the other
Note: Both have: Target Object, Queue: click to choose
Complete when designated queue fill-in equals or exceeds required amount, falls below required amount

'''Multiple Resource Check Rule:''' If specified resources in a selected industry or vehicle reaches set levels, then the following child rules will be executed

'''Properties:'''
'''''Reach-Exceed/Fall below'':''' - click to select one
'''''<value>'':''' - enter required quantity value
'''''<Click to 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. For each object:-
'''Object:''' - select session active industry or product enabled rail vehicle
'''Queue:''' - select product queue (there may be only one available)
'''Remove:''' - removes the object and its product queue from the rule
'''Notes:'''
'''''Reach/Exceed''''' - sets an upper limit for the resource 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 resource 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.

'''Objective Add Rule:''' Sets up a game Objective with ID and display Name

'''Properties:'''
Priority click choose Above Normal, Below Normal, Normal, Optional, Urgent
Completion Target click to set target number
Icon click choose from list
Display Name click insert Name
Unique Objective ID click set ID
Custom Message insert typed message in text area

'''Objective Check Rule:''' Executes child rules when objective is complete

'''Properties:'''
Unique Objective ID click insert ID number
Mode click choose Wait for completion, Wait for failure, Wait for progress

'''Objective Update Rule:''' Changes progress outcome according to Property choices

'''Properties:'''
Unique Objective ID click to set ID number
Mode click Set objective as Decrement progress/Increment progress/Reset objective/Set objects as complete/Set objects as failed/Set progress/Set progress only if greater
Amount click insert number

'''Ranked Session Begin Rule:''' Begins a ranked Session

'''Properties:'''
Countdown requires a Starting Value insert hrs., min,sec
1 through 5 stars, points for each star insert number of points
Session timer mode fill-in chooses: Timer, Countdown, None

'''Ranked Session Complete Rule:''' Completes the active ranked Session

'''Properties:'''
Set the active ranked session as fill-in choose: Complete, Failed
Customize the completion message check insert text message

'''Session Complete Rule:''' Set session to a percentage of completion

'''Properties:'''
Set session to percent complete click to insert number in percent
Separate achievements for completion check

=='''Danger Rules'''==

'''ATP Speed Limiter Rule:''' Limits speed over set limit

'''Properties:'''
speed limit over the set limit mph

'''Speeding Check Rule:''' If player controlled trains are over the local speed limit or over a set (custom) speed, then the following child rules will be executed

'''Properties:'''
'''(Option button) Watch for trains travelling above the posted speed limit'''
'''''<speed value>'':''' - click to enter a new overspeed tolerance value
'''''<units>'':''' - '''Kmph/MPH/mps''' - click to select one
'''(Option button) Watch for trains travelling above a custom speed'''
'''''<speed value>'':''' - click to enter a new custom speed value
'''''<units>'':''' - '''Kmph/MPH/mps''' - click to select one
'''Warning: This option is very performance intensive and should only be used in sessions with few trains'''

'''AWS Configuration Rule:''' This rule configures the Trainz implementation of the Automatic Warning System when approaching signals

'''Properties:'''
Use modern sound set for unfitted cabs? check
Simulate AWS for unfitted cabs? check
Passive with HUD hidden fill-in
Active fill-in
Passive fill-in

'''Wait for Derailment Rule:''' Waits for a derailment to occur

'''Properties:'''
Trigger derailment watch once check to set

'''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars

'''Properties:'''
Set delay to clean up derailed train cars values

'''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule

'''Properties:'''
Respawn trains if they are abandoned check
Respawn trains fill-in choose: at their original locations, from portals from Session List

'''Coupler Breakage Check Rule:''' Checks for breaking couplers. No parameters.

'''Properties:'''
None

'''Coupler Breakage HUDRule:''' HUD displays warning about coupler stress and breakage

'''Properties:'''
Show the Coupler Breakage Display fill-in must choose one or the other
Hide the Coupler Breakage Display fill-in must choose one or the other

'''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles

'''Properties:'''
Add vehicle click to select from session list
Coupling Mask, Decoupling Mask : click to select: lock or unlock
Add All click to select all vehicle in session
Delete All click to delete all vehicle from list

'''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users

'''Properties:'''
Trigger only once check

'''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users

'''Properties:'''
Trigger only once check

'''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger

'''Properties:'''
Trigger only once check to set

'''Vehicle Physics Rule:''' Overrides the default vehicle physics properties

'''Properties:'''
Accept all trains fill-in
Cab sway level is set ? % click to insert percent of sway
Traction boost is % ? while sanding click to insert percent of boost
Tractions reduced to ? % while click to set traction percent
Maximum tractive effort adjusted by ? click to insert percent amount
Show coupler breakage in HUD Rule check to set
Couplers break when coupling above ? click to set speed
Accept trains matching specific criteria fill-in to insert specific trains
Couplers break at ? kN check to insert amount of force

=='''Navigation Rules'''==

'''DestSignTable Rule:''' Table for creating a table of destination signs

'''Properties:'''
Enable Track Marks as destinations check
Enable table of destinations check
Import destination from texture-group. name
Destination Name name
Enable industries/stations as check
Interlocking Tower Configure Path Alters settings on an interlocking tower path
Interlocking Tower choose Name and Objects
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
Show path activation message in Driver check

'''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train

'''Properties:'''
Interlocking Tower choose Names and Objects
Multiple Junction Alignment Check Checks multiple junctions are in alignment
Wait until the following junctions are choose all or anyone
Add junction click add junction from session list
Add all click add all junctions from session list
Delete all click deletes all junctions from rule list

'''Navigation Display Rule:''' Creates a set of navigation points. Multiple sets can be created by adding additional copies of this rule. This rule creates the navigation set, it does not display it. Use the '''Navigation set hide/show rule''' to make a set visible. Click the help icon at the top of the properties box for in game instructions.

'''Properties:'''
'''Unique set ID:''' - enter a unique name for the navigation set. Name must be in lowercase and have no spaces.
'''Train (optional):''' - select a rolling stock asset from the session list shown.
'''Navigation mode:''' select one
'''(Option button) 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.
'''(Option button) 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.
'''(Option button) 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 (a trigger, trackmark, track object or rolling stock asset) 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'':''' - select an icon for the navigation point.
'''''Style'': ''Automatic/Manual/Require Stop''''' - click to select one
'''''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'''.
This allows you to execute other rules (e.g. consist check, trigger 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.

'''Navigation Point Complete Rule:''' Marks a navigation point complete

'''Properties:'''
Mark navigation point click set index number
Complete in set click to set ID

'''Navigation Set Check Rule:''' Checks if a navigation point is complete/incomplete

'''Properties:'''
Checks if navigation point is set click set ID
Is click Complete, Incomplete
Navigation Set Clear Clears a navigation point set
Clear the navigation point set click to set ID
Navigation Set Hide/Show Show or hide navigation point set
The navigation point click hide, show
Navigation point set click to set ID

'''Navigation Set Clear Rule:''' Clears a navigation set removing any uncompleted navigation points

'''Properties:'''
'''''Click here to set'':''' - enter the unique name for the navigation set created using the '''Navigation set display rule'''.
Name must be in lowercase and have no spaces. The rule will NOT check to see if the named navigation set exists or not.

'''Navigation Set Hide/Show:''' Shows and hides navigation sets. You can have multiple sets visible at the same time.

'''Properties:'''
'''''Hide/Show'':''' - click to select one
'''''click here to set'':''' - enter the unique name for the navigation set created using the '''Navigation set display rule'''.
Name must be in lowercase and have no spaces. The rule will NOT check to see if the named navigation set exists or not.

'''Schedule Rule:''' Allows a schedule of timed events to be applied to a train

'''Properties:'''
Insert track mark click to select from session list
Note: Both has an arrival and departure set time hr:min:sec
Current Train click to select from session list
Insert destination click to select from session list

'''Set Junctions Rule:''' Sets the selected junctions to a specific state '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''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:-
'''''Setting'': Left/Center/Right/Don't change''' - click one to set the junction direction
'''''Locked'': Locked/Unlocked''' - click to select one. '''Locked''' means the junction setting cannot be changed by the user
'''''Allows AI control/Blocks AI control''''' - click to select one.
'''''Remove''''' - click to remove that junction from the rule list

'''Set Signal Extended Rule:''' Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''Properties:'''
'''''Select signal''''' - click to select a signal from the session list
'''''<signal state>''''' - click to select a state from the list

'''Trigger Check Rule:''' Waits for any train to enter one of the designated triggers. This rule replaces the older and less versatile "Trigger Rule".

'''Properties:'''
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list
Add Trigger click to choose from session list
Trigger only once check to set
Wait for child rules to complete even if check to set
Only activate when the entering click to choose forward, backward

'''Wait on Navigation Point Rule:''' Waits for a navigation point to be completed then the following child rules will be executed

'''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 set display rule'''.
Name must be in lowercase and have no spaces. The rule will NOT check to see if the named navigation set and point exists or not.

'''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start

'''Properties:'''
Accept all trains fill-in to set
Accept trains matching specific criteria fill-in to set and choose from session list
Wait for a train that matches the click to choose: start moving, stop moving
Trigger rule once check to set
Note: One or the other fill-ins must be

=='''Driver Rules'''==

'''Control Type Rule''' Sets control type

'''Properties:'''
Current control method is: Easy Mode, Choice one of the three

'''Control Check Rule:''' Activates child rules based on the control method changes

'''Properties:'''
Excite child rules when: DCC mode is fill-in one or the other
Excite child rules: Every time control fill-in one or the other

'''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule

'''Properties:'''
Trigger add Trigger
Portal index from PCP value
Use UnPortal yes/no
Delay from Trigger to Emit: seconds value

'''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry

'''Properties:'''
Apply to every vehicle in the session fill-in
Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles
Note: One of the Applies will always be
Load/Unload for industry Disable/Enable choose Industry

'''Driver Command Rule:''' Specify which commands will be available for the drivers

'''Properties''':
Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.
Navigate To TrackMarkList V2- No description.
Navigate To Station V2- No description.
Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.
Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.
Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.
Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.
Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.
Drive To Station V2- No description.
Drive To Track mark List V2- No description.
Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.
Drive To Industry- Drive to a specific industry.
Change Destination Sign-Changes the destination signs of a train.

WaitFor- Pauses the driver's schedule for a set duration of time.
Wait For Random- TRS2008: Wait for specified or optionally random period of time.
Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).
WaitUntil- No description.

VR Set Train Lamps-Driver command that sets the train lamps.
Notify- Notifies the player of schedule progress/completion.
Reverse Tram- Reverse a tram(max 2 cars).
Couple- Couple train to designate vehicle.
Decouple- Decouples the train at the specified vehicle.
UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).
Halt Train- Brings the train to a complete stop.
Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.
Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger
station before using this command.
Cab: Wait-Maintains current control state until some condition is met.
Delete Train- Causes the train and its driver to be deleted from the session.
Hornz- Driver sounds the train horn.
Cab: Set Control-Sets a cab mode control.
Headlights On/Off-Allows the driver to to switch the headlights on and off.
Interior Lights Command- Driver command to switch interior lights on or off for the current train.
Set Max Speed To- No description.

Release Junction - Lets a driver release the junction they have been holding.
Move Turntable- TRS2008: Move turntable to a stop point .

Load- Loads the train's vehicles at the industry the driver is currently at with the train.
Unload- Unload train vehicles at current industry location.
Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.
Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.
Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.

'''Driver Command Check Rule:''' Verifies the driver commands of a driver character

'''Properties'''
Wait for driver character to have add driver, all, delete all
Trigger Rule once check
Driver character to watch the name driver

'''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar

'''Properties'''
The Driver Main Bar choice show/hide

'''Driver Schedule Rule''' Execution of basic scheduled commands

'''Properties:'''
Note: Only one of the fill-in can be
Driver Schedule Rule assigned to name driver
Commands insert driver commands in Drive Schedule
Classic style: If there is a schedule fill-in
Killer style: If there is a schedule fill-in
Cooperative style: If there is a schedule fill-in
Active style: Emit a new schedule, only fill-in

'''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders

'''Properties'''
Generate new Drivers for empty check
The following drivers will be available Driver's Name Add
Remove all existing Drivers first check

'''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers

'''Properties'''
Assign Driver commands check Driver Commands
Train criteria fill in all trains
Train criteria list train only trains matching criteria

'''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted

'''Properties'''
Config/txt file tag 'max_permitted_speed-60850 in mph or kph
Add to config.txt and kuid-table for value <KUID2:60850:88000:4
Note: Old root level config tag will

'''QuickDrive Rule:''' Change the Session settings and add consists in Driver

'''Properties'''
Set Time to insert time
QuickDrive Consist Option List by
Rate of Change insert rate as number times
Enable gameplay Session Mode check
Enable in game help by default check
Set the default Control method to fill-in choose: Easy Mode, Realistic Mode
Prevent player from changing this check
Realistic mode requires achievement add Achievement's Name
In Asset choose Auran achievements
Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic
Prevent player from changing 10.0 check
Set the default units to fill-in choose: Imperial, Metric, Default
Open QuickDriver Window when check

'''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train

'''Properties'''
Note: One or the other fill-ins must be
Accept trains matching specific criteria fill-in to select from session list
Accept all trains fill-in to set
Trigger rule once check to set
Wait for a driver character to get ? a click to select: On, Off

'''Wait for Driver/Train to be Locally Owned Rule:''' Waits for a specific driver or train car to be locally owned, Owned then executes child rules. If the driver/train car becomes unowned again the child rules are paused

'''Properties'''
Wait for ownership of a specific Driver fill-in to set
Wait for ownership of Driver fill-in to set
Note: One or the other fill-in must be
Driver or Vehicle click to choose from session lists

=='''Arrangement of Session Rules:'''==

'''Ordered List Rule:''' Child rules will be executed in order once this rule starts

'''Properties'''
Note: One of the two must be chosen
This process will repeat fill-in click to add number of repeats
This process will repeat forever fill-in

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

'''Properties'''
After last child run is executed click to choose: First child is chosen again, It will be
used for all successive runs, Successive runs will
do nothing

'''Random List Rule:''' One of the child rules indented under this rule will be randomly selected and executed

'''Properties'''
executed randomly
Once one of the child rule is ??

'''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle

'''Properties'''
None

'''Simultaneous List Rule:''' Child rules are executed simultaneously once this rule starts

'''Properties'''
Rules completes when click choose all rules have reached completed state,
was completed state

=='''Camera Rules:'''==

'''Cinematic Camera Rule:''' Provides several different cinematic style cameras

'''Properties'''
Lock camera controls for the duration check
Prevent rain control for duration check
Camera target: name any of the many objects in session
Camera mode: Stationary, Circle fill-in
Initial camera values: Pitch, Yaw, Zoom value
Total time to animate: seconds value

'''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties

'''Properties'''
Change the camera view mode to check to choose: Cab View, External View, Tracking
View, Free Roaming
Vehicle fill-in choose from session vehicles
Set the camera flags to enable/disable check to choose different properties from list
Junction fill-in choose from session junctions
Set the target objet of the camera to check
Map object fill-in choose from map objects

'''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view

'''Properties'''
Trigger rule once check to set
Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking
View, Free Roaming View
Wait for the camera to target vehicle ? click to choose form session list

=='''Message Rules:'''==

'''Close Message Popup Rule:''' Closes open message popups

'''Properties:'''
None

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

'''Custom Script Rule:'''

'''Properties'''
None.

'''Display Custom HUD Rule:''' Show or hide the Custom Heads Up Display.

'''Properties'''
Show the Custom Heads up Display- fill-in to choose.
Hide the Custom Heads up Display- fill-in to choose.
Note: One or the other will be chosen by default.

'''Wait for Click on HUD Icon Rule:'''

'''Properties'''
Trigger rule once-check to choose.
HUD Panel- click to choose from list.
Wait for click on- click to choose; choice depends on HUD Panel chosen.

'''Display HTML Pages Rule:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.

'''Properties'''
Add Page- click on to choose from list; click to Add Page Name or Remove.
Add All- click to add all files from the designated assets.
Delete All- delete all files from this property list.
Prevent user from exiting browser until all pages viewed- check to choose.
Disable closing of browser window by user- check to choose.
Disable browser window scrolling- check to choose.
Make browser window invisible- check to choose.
Set position-Under Construction!!!- check to choose.
Set size-Under Construction!!!- check to choose.
Use the page- click to choose Insert Page Name.
From asset HTML- click to choose from list.

'''Timed limited display HTML Rule:''' Displays an html browser window for a limited time.

'''Properties'''
HTML Asset Name-

'''Display Video Rule:''' Displays a page from a HTML assets in a browser window.

'''Properties'''

'''End Session Rule:''' End Session without saving.

'''Properties'''

'''Fade in/out Rule:''' Fade in or out within seconds, color and opacity considered.

'''Properties'''

'''Flash HUD Icon Rule:''' Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.

'''Properties'''

'''Generic Tree Node Debug Window Rule:''' No description.

'''Properties'''

'''InputTable Rule:''' Creating a list of message names to be used for various purposes.

'''Properties'''

'''Message Popup Rule:''' Displays a pop-up browser window and waits to be closed.

'''Properties'''
'''(Check Box) Pause game while message is displayed:''' - stops the game until this message is switched off
'''(Check Box) Close previous popup windows:''' - closes any Message Popups currently displayed
'''Message location: Top Left/Top Right/Bottom Left/Bottom Right''' - select one to position the browser window on the screen
'''Message Source: Custom text/A predefined HTML page (advanced)/A predefined string-table entry from a HTML asset (advanced)''' - select one

'''Message Source Option: Custom text'''
'''Icon: ''Click here to set''''' - shows a list of message icons. Select one to be displayed with the message
'''Icon: ''Clear icon''''' - clears any currently displayed message icon
'''Custom text:''' Enter text to be displayed. You will be limited to about 6 lines of text. For longer messages or to include graphics, use the '''A predefined HTML page''' option.

'''Message Source Option: A predefined HTML page'''
'''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.

'''Message Source Option: 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.

'''Minimap Options Rule:''' Sets the display options for the minimap.

'''Properties'''

'''Play Sound Rule:''' Plays a wav sound file.

'''Properties'''

'''Session Debug Rule Rule:''' Executes the first child if debug mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.

'''Properties'''

'''Session Metadata Rule:''' Sets session metadata in the config file. Info can be read by other systems and displayed to the player.

'''Properties'''

'''Set Helper Icon Size Rule:''' Sets the size of helper icons such as the junction lever arrows.

'''Properties'''

'''Set HTML Page Rule:''' Instructs the Display HTML Pages rule to perform specific operations

'''Properties'''

'''Show/Hide HUD Panel Rule:''' Shows or hides a HUD panel.

'''Properties'''

'''Show/Hide Layer Rule:''' Shows or hides a layer from Driver.

'''Properties:'''
'''Show/Hide''' - select one
'''click here to set''' - enter name of layer. Name is case sensitive.

'''Known Bugs:'''
TANE (all versions) - layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded

'''Show/Hide Minimap Rule:''' Shows the Driver the minimap window.

'''Properties'''
'''Minimap Window'''-click to choose Show,Hide

'''Show/hide on-screen help Rule:''' Shows or hides On-screen help in Driver.

'''Properties'''
'''Junction Overlays:''' - fill-in to choose: Show, Hide, Leave unchanged. by default one is chosen
'''On Screen Vehicle Name:''' - Fill-in to choose: Show, Hide, Leave unchanged. By default one is chosen

'''Wait for Click on HUD Icon Rule:''' Waits for a click on the HUD Icon.

'''Properties'''
'''(Check Box) Trigger Once:''' -to choose
'''HUD Panel:''' - Click to choose from list: Bottom Right Menu, Camera Controls, DCC Controls
'''Icon:''' - Choose from list. Selections depends on HUD Panel chosen

'''Wait on Waybill Screen/Main Screen Rule:''' Waits for the Waybill window to be opened.

'''Properties'''

=='''Startup Rules:'''==

'''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.

'''Properties'''

'''Startup Options Rule''' Specifies the starting options for the session.

'''Properties'''

=='''Time Rules:'''==

'''Clock Rule:''' Rule needed for animated clocks, you need to apply this rule to your session to make use of the animated clocks, see forum for code to include in you clock object to work with this rule.

'''Properties'''

'''Timecheck Rule:''' Executes child rules at a certain time.

'''Properties'''

'''Timing Check Rule:''' Triggers sub rules if called within the time window specified.

'''Properties'''

'''Wait Rule:''' Wait for number of seconds'

'''Properties'''

=='''Variable Rules:'''==

'''Variable Check Rule:''' If the specified variable matches the specified conditions then the child rules will be executed in order.

'''Properties'''
'''''<variable-name>''''' - enter a variable-name. Variable name is case sensitive.
'''''<test-condition>''''' - '''is less than/is less than or equal to/is equal to/is greater than or equal to/is greater than/is not equal to/is between x and y''' - select one
'''''This condition will be evaluated only once .../This condition will be evaluated once every second''''' - click to select one
'''Test condition option: is between x and y'''
Enter minimum (x) and maximum (y) test values

'''Test condition option: (all other options)'''
Enter test value

'''Evaluation option: 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

'''Evaluation option: This condition will be evaluated evaluated once every second''' - the rule will be run and the variable rechecked every second

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

'''Properties'''
'''Change: Add to variable/Subtract from variable/Change variable''' - select one
'''(optional check box) Set the minimum value''' of ''<variable-name>'' to ''<value>'' - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.
('''optional check box) Set the maximum value''' of ''<variable-name>'' to ''<value>'' - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.

'''Change option: 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.

'''Change option: 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 option: Change variable'''
'''Change variable ''<variable-name>'' to ''<value>''''' - enter variable-name, enter new value. This cannot be undone if the rule is stopped. Variable-name is case sensitive.

'''Variable Modify Continuous Rule:''' Adds, subtracts or sets a value to a specified variable every second.

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

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

'''Properties'''
'''Check box: Add'''
''<variable-name>'' - enter variable-name. 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. Variable-name is case sensitive.

Variables are saved in the session file and persist from one saved game to another.
They can be accessed/modified by the following '''driver commands''':

'''Driver Commands by trev999:'''
'''Set S-Variable driver command: '''
'''Skip if session-variable driver command: '''
'''Wait until S-variable driver command: '''

'''Driver Commands by atilabarut'''
'''ChangeSVariables driver command: '''
'''WaitUntilSVariable driver command: '''

=='''Weather Rules:'''==

'''EIRS Weather Rule NE USA Rule:''' Customize random weather rule relative to the North East Region of the United States.

'''Properties'''

'''Weather Rule:''' Set the weather conditions.

'''Properties'''

Talk:Session Rules By Categories With Properties

2017-09-26T23:38:04Z

Coop2: Created page with "Pware thanks for your input with this project!"

Pware thanks for your input with this project!

Session Rules By Categories With Properties

2017-09-26T23:32:10Z

Coop2:

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

1
=='''Achievement Rules'''==

'''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement

'''Properties:'''
None

'''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload

'''Properties:'''
Target object ?? name of object such as Power Station, Coal Pit or Portal
Lock train's controls checked during a stopped load/unload operation
Override 'begin load' and 'begin unload' checked # of seconds to override

'''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations

'''Properties:'''
Trigger click to choose from list
Add Industry click to add from session list
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list

'''Power Station Rule:''' Sets up Station and Consumers

'''Properties:'''
Power Station click to choose from session Stations
Consumers(Add Object) click to choose from session list

'''Resource Check Rule:''' Check the progress of the amount of a resource and target object

'''Properties:'''
Watch industry queue or Watch vehicle fill-in choose one or the other
Note: Both have: Target Object, Queue: click to choose
Complete when designated queue fill-in equals or exceeds required amount, falls below required amount

'''Multiple Resource Check Rule:''' If specified resources in a selected industry or vehicle reaches set levels, then the following child rules will be executed

'''Properties:'''
'''''Reach-Exceed/Fall below'':''' - click to select one
'''''<value>'':''' - enter required quantity value
'''''<Click to 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. For each object:-
'''Object:''' - select session active industry or product enabled rail vehicle
'''Queue:''' - select product queue (there may be only one available)
'''Remove:''' - removes the object and its product queue from the rule
'''Notes:'''
'''''Reach/Exceed''''' - sets an upper limit for the resource 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 resource 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.

'''Objective Add Rule:''' Sets up a game Objective with ID and display Name

'''Properties:'''
Priority click choose Above Normal, Below Normal, Normal, Optional, Urgent
Completion Target click to set target number
Icon click choose from list
Display Name click insert Name
Unique Objective ID click set ID
Custom Message insert typed message in text area

'''Objective Check Rule:''' Executes child rules when objective is complete

'''Properties:'''
Unique Objective ID click insert ID number
Mode click choose Wait for completion, Wait for failure, Wait for progress

'''Objective Update Rule:''' Changes progress outcome according to Property choices

'''Properties:'''
Unique Objective ID click to set ID number
Mode click Set objective as Decrement progress/Increment progress/Reset objective/Set objects as complete/Set objects as failed/Set progress/Set progress only if greater
Amount click insert number

'''Ranked Session Begin Rule:''' Begins a ranked Session

'''Properties:'''
Countdown requires a Starting Value insert hrs., min,sec
1 through 5 stars, points for each star insert number of points
Session timer mode fill-in chooses: Timer, Countdown, None

'''Ranked Session Complete Rule:''' Completes the active ranked Session

'''Properties:'''
Set the active ranked session as fill-in choose: Complete, Failed
Customize the completion message check insert text message

'''Session Complete Rule:''' Set session to a percentage of completion

'''Properties:'''
Set session to percent complete click to insert number in percent
Separate achievements for completion check

=='''Danger Rules'''==

'''ATP Speed Limiter Rule:''' Limits speed over set limit

'''Properties:'''
speed limit over the set limit mph

'''Speeding Check Rule:''' If player controlled trains are over the local speed limit or over a set (custom) speed, then the following child rules will be executed

'''Properties:'''
'''(Option button) Watch for trains travelling above the posted speed limit'''
'''''<speed value>'':''' - click to enter a new overspeed tolerance value
'''''<units>'':''' - '''Kmph/MPH/mps''' - click to select one
'''(Option button) Watch for trains travelling above a custom speed'''
'''''<speed value>'':''' - click to enter a new custom speed value
'''''<units>'':''' - '''Kmph/MPH/mps''' - click to select one
'''Warning: This option is very performance intensive and should only be used in sessions with few trains'''

'''AWS Configuration Rule:''' This rule configures the Trainz implementation of the Automatic Warning System when approaching signals

'''Properties:'''
Use modern sound set for unfitted cabs? check
Simulate AWS for unfitted cabs? check
Passive with HUD hidden fill-in
Active fill-in
Passive fill-in

'''Wait for Derailment Rule:''' Waits for a derailment to occur

'''Properties:'''
Trigger derailment watch once check to set

'''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars

'''Properties:'''
Set delay to clean up derailed train cars values

'''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule

'''Properties:'''
Respawn trains if they are abandoned check
Respawn trains fill-in choose: at their original locations, from portals from Session List

'''Coupler Breakage Check Rule:''' Checks for breaking couplers. No parameters.

'''Properties:'''
None

'''Coupler Breakage HUDRule:''' HUD displays warning about coupler stress and breakage

'''Properties:'''
Show the Coupler Breakage Display fill-in must choose one or the other
Hide the Coupler Breakage Display fill-in must choose one or the other

'''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles

'''Properties:'''
Add vehicle click to select from session list
Coupling Mask, Decoupling Mask : click to select: lock or unlock
Add All click to select all vehicle in session
Delete All click to delete all vehicle from list

'''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users

'''Properties:'''
Trigger only once check

'''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users

'''Properties:'''
Trigger only once check

'''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger

'''Properties:'''
Trigger only once check to set

'''Vehicle Physics Rule:''' Overrides the default vehicle physics properties

'''Properties:'''
Accept all trains fill-in
Cab sway level is set ? % click to insert percent of sway
Traction boost is % ? while sanding click to insert percent of boost
Tractions reduced to ? % while click to set traction percent
Maximum tractive effort adjusted by ? click to insert percent amount
Show coupler breakage in HUD Rule check to set
Couplers break when coupling above ? click to set speed
Accept trains matching specific criteria fill-in to insert specific trains
Couplers break at ? kN check to insert amount of force

=='''Navigation Rules'''==

'''DestSignTable Rule:''' Table for creating a table of destination signs

'''Properties:'''
Enable Track Marks as destinations check
Enable table of destinations check
Import destination from texture-group. name
Destination Name name
Enable industries/stations as check
Interlocking Tower Configure Path Alters settings on an interlocking tower path
Interlocking Tower choose Name and Objects
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
Show path activation message in Driver check

'''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train

'''Properties:'''
Interlocking Tower choose Names and Objects
Multiple Junction Alignment Check Checks multiple junctions are in alignment
Wait until the following junctions are choose all or anyone
Add junction click add junction from session list
Add all click add all junctions from session list
Delete all click deletes all junctions from rule list

'''Navigation Display Rule:''' Creates a set of navigation points. Multiple sets can be created by adding additional copies of this rule. This rule creates the navigation set, it does not display it. Use the '''Navigation set hide/show rule''' to make a set visible. Click the help icon at the top of the properties box for in game instructions.

'''Properties:'''
'''Unique set ID:''' - enter a unique name for the navigation set. Name must be in lowercase and have no spaces.
'''Train (optional):''' - select a rolling stock asset from the session list shown.
'''Navigation mode:''' select one
'''(Option button) 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.
'''(Option button) 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.
'''(Option button) 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 (a trigger, trackmark, track object or rolling stock asset) 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'':''' - select an icon for the navigation point.
'''''Style'': ''Automatic/Manual/Require Stop''''' - click to select one
'''''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'''.
This allows you to execute other rules (e.g. consist check, trigger 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.

'''Navigation Point Complete Rule:''' Marks a navigation point complete

'''Properties:'''
Mark navigation point click set index number
Complete in set click to set ID

'''Navigation Set Check Rule:''' Checks if a navigation point is complete/incomplete

'''Properties:'''
Checks if navigation point is set click set ID
Is click Complete, Incomplete
Navigation Set Clear Clears a navigation point set
Clear the navigation point set click to set ID
Navigation Set Hide/Show Show or hide navigation point set
The navigation point click hide, show
Navigation point set click to set ID

'''Navigation Set Clear Rule:''' Clears a navigation set removing any uncompleted navigation points

'''Properties:'''
'''''Click here to set'':''' - enter the unique name for the navigation set created using the '''Navigation set display rule'''.
Name must be in lowercase and have no spaces. The rule will NOT check to see if the named navigation set exists or not.

'''Navigation Set Hide/Show:''' Shows and hides navigation sets. You can have multiple sets visible at the same time.

'''Properties:'''
'''''Hide/Show'':''' - click to select one
'''''click here to set'':''' - enter the unique name for the navigation set created using the '''Navigation set display rule'''.
Name must be in lowercase and have no spaces. The rule will NOT check to see if the named navigation set exists or not.

'''Schedule Rule:''' Allows a schedule of timed events to be applied to a train

'''Properties:'''
Insert track mark click to select from session list
Note: Both has an arrival and departure set time hr:min:sec
Current Train click to select from session list
Insert destination click to select from session list

'''Set Junctions Rule:''' Sets the selected junctions to a specific state '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''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:-
'''''Setting'': Left/Center/Right/Don't change''' - click one to set the junction direction
'''''Locked'': Locked/Unlocked''' - click to select one. '''Locked''' means the junction setting cannot be changed by the user
'''''Allows AI control/Blocks AI control''''' - click to select one.
'''''Remove''''' - click to remove that junction from the rule list

'''Set Signal Extended Rule:''' Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''Properties:'''
'''''Select signal''''' - click to select a signal from the session list
'''''<signal state>''''' - click to select a state from the list

'''Trigger Check Rule:''' Waits for any train to enter one of the designated triggers. This rule replaces the older and less versatile "Trigger Rule".

'''Properties:'''
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list
Add Trigger click to choose from session list
Trigger only once check to set
Wait for child rules to complete even if check to set
Only activate when the entering click to choose forward, backward

'''Wait on Navigation Point Rule:''' Waits for a navigation point to be completed then the following child rules will be executed

'''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 set display rule'''.
Name must be in lowercase and have no spaces. The rule will NOT check to see if the named navigation set and point exists or not.

'''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start

'''Properties:'''
Accept all trains fill-in to set
Accept trains matching specific criteria fill-in to set and choose from session list
Wait for a train that matches the click to choose: start moving, stop moving
Trigger rule once check to set
Note: One or the other fill-ins must be

=='''Driver Rules'''==

'''Control Type Rule''' Sets control type

'''Properties:'''
Current control method is: Easy Mode, Choice one of the three

'''Control Check Rule:''' Activates child rules based on the control method changes

'''Properties:'''
Excite child rules when: DCC mode is fill-in one or the other
Excite child rules: Every time control fill-in one or the other

'''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule

'''Properties:'''
Trigger add Trigger
Portal index from PCP value
Use UnPortal yes/no
Delay from Trigger to Emit: seconds value

'''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry

'''Properties:'''
Apply to every vehicle in the session fill-in
Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles
Note: One of the Applies will always be
Load/Unload for industry Disable/Enable choose Industry

'''Driver Command Rule:''' Specify which commands will be available for the drivers

'''Properties''':
Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.
Navigate To TrackMarkList V2- No description.
Navigate To Station V2- No description.
Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.
Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.
Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.
Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.
Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.
Drive To Station V2- No description.
Drive To Track mark List V2- No description.
Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.
Drive To Industry- Drive to a specific industry.
Change Destination Sign-Changes the destination signs of a train.

WaitFor- Pauses the driver's schedule for a set duration of time.
Wait For Random- TRS2008: Wait for specified or optionally random period of time.
Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).
WaitUntil- No description.

VR Set Train Lamps-Driver command that sets the train lamps.
Notify- Notifies the player of schedule progress/completion.
Reverse Tram- Reverse a tram(max 2 cars).
Couple- Couple train to designate vehicle.
Decouple- Decouples the train at the specified vehicle.
UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).
Halt Train- Brings the train to a complete stop.
Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.
Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger
station before using this command.
Cab: Wait-Maintains current control state until some condition is met.
Delete Train- Causes the train and its driver to be deleted from the session.
Hornz- Driver sounds the train horn.
Cab: Set Control-Sets a cab mode control.
Headlights On/Off-Allows the driver to to switch the headlights on and off.
Interior Lights Command- Driver command to switch interior lights on or off for the current train.
Set Max Speed To- No description.

Release Junction - Lets a driver release the junction they have been holding.
Move Turntable- TRS2008: Move turntable to a stop point .

Load- Loads the train's vehicles at the industry the driver is currently at with the train.
Unload- Unload train vehicles at current industry location.
Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.
Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.
Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.

'''Driver Command Check Rule:''' Verifies the driver commands of a driver character

'''Properties'''
Wait for driver character to have add driver, all, delete all
Trigger Rule once check
Driver character to watch the name driver

'''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar

'''Properties'''
The Driver Main Bar choice show/hide

'''Driver Schedule Rule''' Execution of basic scheduled commands

'''Properties:'''
Note: Only one of the fill-in can be
Driver Schedule Rule assigned to name driver
Commands insert driver commands in Drive Schedule
Classic style: If there is a schedule fill-in
Killer style: If there is a schedule fill-in
Cooperative style: If there is a schedule fill-in
Active style: Emit a new schedule, only fill-in

'''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders

'''Properties'''
Generate new Drivers for empty check
The following drivers will be available Driver's Name Add
Remove all existing Drivers first check

'''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers

'''Properties'''
Assign Driver commands check Driver Commands
Train criteria fill in all trains
Train criteria list train only trains matching criteria

'''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted

'''Properties'''
Config/txt file tag 'max_permitted_speed-60850 in mph or kph
Add to config.txt and kuid-table for value <KUID2:60850:88000:4
Note: Old root level config tag will

'''QuickDrive Rule:''' Change the Session settings and add consists in Driver

'''Properties'''
Set Time to insert time
QuickDrive Consist Option List by
Rate of Change insert rate as number times
Enable gameplay Session Mode check
Enable in game help by default check
Set the default Control method to fill-in choose: Easy Mode, Realistic Mode
Prevent player from changing this check
Realistic mode requires achievement add Achievement's Name
In Asset choose Auran achievements
Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic
Prevent player from changing 10.0 check
Set the default units to fill-in choose: Imperial, Metric, Default
Open QuickDriver Window when check

'''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train

'''Properties'''
Note: One or the other fill-ins must be
Accept trains matching specific criteria fill-in to select from session list
Accept all trains fill-in to set
Trigger rule once check to set
Wait for a driver character to get ? a click to select: On, Off

'''Wait for Driver/Train to be Locally Owned Rule:''' Waits for a specific driver or train car to be locally owned, Owned then executes child rules. If the driver/train car becomes unowned again the child rules are paused

'''Properties'''
Wait for ownership of a specific Driver fill-in to set
Wait for ownership of Driver fill-in to set
Note: One or the other fill-in must be
Driver or Vehicle click to choose from session lists

=='''Arrangement of Session Rules:'''==

'''Ordered List Rule:''' Child rules will be executed in order once this rule starts

'''Properties'''
Note: One of the two must be chosen
This process will repeat fill-in click to add number of repeats
This process will repeat forever fill-in

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

'''Properties'''
After last child run is executed click to choose: First child is chosen again, It will be
used for all successive runs, Successive runs will
do nothing

'''Random List Rule:''' One of the child rules indented under this rule will be randomly selected and executed

'''Properties'''
executed randomly
Once one of the child rule is ??

'''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle

'''Properties'''
None

'''Simultaneous List Rule:''' Child rules are executed simultaneously once this rule starts

'''Properties'''
Rules completes when click choose all rules have reached completed state,
was completed state

=='''Camera Rules:'''==

'''Cinematic Camera Rule:''' Provides several different cinematic style cameras

'''Properties'''
Lock camera controls for the duration check
Prevent rain control for duration check
Camera target: name any of the many objects in session
Camera mode: Stationary, Circle fill-in
Initial camera values: Pitch, Yaw, Zoom value
Total time to animate: seconds value

'''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties

'''Properties'''
Change the camera view mode to check to choose: Cab View, External View, Tracking
View, Free Roaming
Vehicle fill-in choose from session vehicles
Set the camera flags to enable/disable check to choose different properties from list
Junction fill-in choose from session junctions
Set the target objet of the camera to check
Map object fill-in choose from map objects

'''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view

'''Properties'''
Trigger rule once check to set
Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking
View, Free Roaming View
Wait for the camera to target vehicle ? click to choose form session list

=='''Message Rules:'''==

'''Close Message Popup Rule:''' Closes open message popups

'''Properties:'''
None

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

'''Custom Script Rule:'''

'''Properties'''
None.

'''Display Custom HUD Rule:''' Show or hide the Custom Heads Up Display.

'''Properties'''
Show the Custom Heads up Display- fill-in to choose.
Hide the Custom Heads up Display- fill-in to choose.
Note: One or the other will be chosen by default.

'''Wait for Click on HUD Icon Rule:'''

'''Properties'''
Trigger rule once-check to choose.
HUD Panel- click to choose from list.
Wait for click on- click to choose; choice depends on HUD Panel chosen.

'''Display HTML Pages Rule:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.

'''Properties'''
Add Page- click on to choose from list; click to Add Page Name or Remove.
Add All- click to add all files from the designated assets.
Delete All- delete all files from this property list.
Prevent user from exiting browser until all pages viewed- check to choose.
Disable closing of browser window by user- check to choose.
Disable browser window scrolling- check to choose.
Make browser window invisible- check to choose.
Set position-Under Construction!!!- check to choose.
Set size-Under Construction!!!- check to choose.
Use the page- click to choose Insert Page Name.
From asset HTML- click to choose from list.

'''Timed limited display HTML Rule:''' Displays an html browser window for a limited time.

'''Properties'''
HTML Asset Name-

'''Display Video Rule:''' Displays a page from a HTML assets in a browser window.

'''Properties'''

'''End Session Rule:''' End Session without saving.

'''Properties'''

'''Fade in/out Rule:''' Fade in or out within seconds, color and opacity considered.

'''Properties'''

'''Flash HUD Icon Rule:''' Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.

'''Properties'''

'''Generic Tree Node Debug Window Rule:''' No description.

'''Properties'''

'''InputTable Rule:''' Creating a list of message names to be used for various purposes.

'''Properties'''

'''Message Popup Rule:''' Displays a pop-up browser window and waits to be closed.

'''Properties'''
'''(Check Box) Pause game while message is displayed:''' - stops the game until this message is switched off
'''(Check Box) Close previous popup windows:''' - closes any Message Popups currently displayed
'''Message location: Top Left/Top Right/Bottom Left/Bottom Right''' - select one to position the browser window on the screen
'''Message Source: Custom text/A predefined HTML page (advanced)/A predefined string-table entry from a HTML asset (advanced)''' - select one

'''Message Source Option: Custom text'''
'''Icon: ''Click here to set''''' - shows a list of message icons. Select one to be displayed with the message
'''Icon: ''Clear icon''''' - clears any currently displayed message icon
'''Custom text:''' Enter text to be displayed. You will be limited to about 6 lines of text. For longer messages or to include graphics, use the '''A predefined HTML page''' option.

'''Message Source Option: A predefined HTML page'''
'''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.

'''Message Source Option: 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.

'''Minimap Options Rule:''' Sets the display options for the minimap.

'''Properties'''

'''Play Sound Rule:''' Plays a wav sound file.

'''Properties'''

'''Session Debug Rule Rule:''' Executes the first child if debug mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.

'''Properties'''

'''Session Metadata Rule:''' Sets session metadata in the config file. Info can be read by other systems and displayed to the player.

'''Properties'''

'''Set Helper Icon Size Rule:''' Sets the size of helper icons such as the junction lever arrows.

'''Properties'''

'''Set HTML Page Rule:''' Instructs the Display HTML Pages rule to perform specific operations

'''Properties'''

'''Show/Hide HUD Panel Rule:''' Shows or hides a HUD panel.

'''Properties'''

'''Show/Hide Layer Rule:''' Shows or hides a layer from Driver.

'''Properties:'''
'''Show/Hide''' - select one
'''click here to set''' - enter name of layer. Name is case sensitive.

'''Known Bugs:'''
TANE (all versions) - layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded

'''Show/Hide Minimap Rule:''' Shows the Driver the minimap window.

'''Properties'''
'''Minimap Window'''-click to choose Show,Hide

'''Show/hide on-screen help Rule:''' Shows or hides On-screen help in Driver.

'''Properties'''
'''Junction Overlays:''' - fill-in to choose: Show, Hide, Leave unchanged. by default one is chosen
'''On Screen Vehicle Name:''' - Fill-in to choose: Show, Hide, Leave unchanged. By default one is chosen

'''Wait for Click on HUD Icon Rule:''' Waits for a click on the HUD Icon.

'''Properties'''
'''Trigger Once:''' - Check to choose
'''HUD Panel:''' - Click to choose from list: Bottom Right Menu, Camera Controls, DCC Controls
'''Icon:''' - Choose from list. Selections depends on HUD Panel chosen

'''Wait on Waybill Screen/Main Screen Rule:''' Waits for the Waybill window to be opened.

'''Properties'''

=='''Startup Rules:'''==

'''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.

'''Properties'''

'''Startup Options Rule''' Specifies the starting options for the session.

'''Properties'''

=='''Time Rules:'''==

'''Clock Rule:''' Rule needed for animated clocks, you need to apply this rule to your session to make use of the animated clocks, see forum for code to include in you clock object to work with this rule.

'''Properties'''

'''Timecheck Rule:''' Executes child rules at a certain time.

'''Properties'''

'''Timing Check Rule:''' Triggers sub rules if called within the time window specified.

'''Properties'''

'''Wait Rule:''' Wait for number of seconds'

'''Properties'''

=='''Variable Rules:'''==

'''Variable Check Rule:''' If the specified variable matches the specified conditions then the child rules will be executed in order.

'''Properties'''
'''''<variable-name>''''' - enter a variable-name. Variable name is case sensitive.
'''''<test-condition>''''' - '''is less than/is less than or equal to/is equal to/is greater than or equal to/is greater than/is not equal to/is between x and y''' - select one
'''''This condition will be evaluated only once .../This condition will be evaluated once every second''''' - click to select one
'''Test condition option: is between x and y'''
Enter minimum (x) and maximum (y) test values

'''Test condition option: (all other options)'''
Enter test value

'''Evaluation option: 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

'''Evaluation option: This condition will be evaluated evaluated once every second''' - the rule will be run and the variable rechecked every second

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

'''Properties'''
'''Change: Add to variable/Subtract from variable/Change variable''' - select one
'''(optional check box) Set the minimum value''' of ''<variable-name>'' to ''<value>'' - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.
('''optional check box) Set the maximum value''' of ''<variable-name>'' to ''<value>'' - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.

'''Change option: 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.

'''Change option: 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 option: Change variable'''
'''Change variable ''<variable-name>'' to ''<value>''''' - enter variable-name, enter new value. This cannot be undone if the rule is stopped. Variable-name is case sensitive.

'''Variable Modify Continuous Rule:''' Adds, subtracts or sets a value to a specified variable every second.

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

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

'''Properties'''
'''Check box: Add'''
''<variable-name>'' - enter variable-name. 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. Variable-name is case sensitive.

Variables are saved in the session file and persist from one saved game to another.
They can be accessed/modified by the following '''driver commands''':

'''Driver Commands by trev999:'''
'''Set S-Variable driver command: '''
'''Skip if session-variable driver command: '''
'''Wait until S-variable driver command: '''

'''Driver Commands by atilabarut'''
'''ChangeSVariables driver command: '''
'''WaitUntilSVariable driver command: '''

=='''Weather Rules:'''==

'''EIRS Weather Rule NE USA Rule:''' Customize random weather rule relative to the North East Region of the United States.

'''Properties'''

'''Weather Rule:''' Set the weather conditions.

'''Properties'''

Session Rules By Categories With Properties

2017-09-26T23:30:31Z

Coop2:

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

1 =='''Achievement Rules'''==

'''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement

'''Properties:'''
None

'''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload

'''Properties:'''
Target object ?? name of object such as Power Station, Coal Pit or Portal
Lock train's controls checked during a stopped load/unload operation
Override 'begin load' and 'begin unload' checked # of seconds to override

'''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations

'''Properties:'''
Trigger click to choose from list
Add Industry click to add from session list
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list

'''Power Station Rule:''' Sets up Station and Consumers

'''Properties:'''
Power Station click to choose from session Stations
Consumers(Add Object) click to choose from session list

'''Resource Check Rule:''' Check the progress of the amount of a resource and target object

'''Properties:'''
Watch industry queue or Watch vehicle fill-in choose one or the other
Note: Both have: Target Object, Queue: click to choose
Complete when designated queue fill-in equals or exceeds required amount, falls below required amount

'''Multiple Resource Check Rule:''' If specified resources in a selected industry or vehicle reaches set levels, then the following child rules will be executed

'''Properties:'''
'''''Reach-Exceed/Fall below'':''' - click to select one
'''''<value>'':''' - enter required quantity value
'''''<Click to 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. For each object:-
'''Object:''' - select session active industry or product enabled rail vehicle
'''Queue:''' - select product queue (there may be only one available)
'''Remove:''' - removes the object and its product queue from the rule
'''Notes:'''
'''''Reach/Exceed''''' - sets an upper limit for the resource 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 resource 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.

'''Objective Add Rule:''' Sets up a game Objective with ID and display Name

'''Properties:'''
Priority click choose Above Normal, Below Normal, Normal, Optional, Urgent
Completion Target click to set target number
Icon click choose from list
Display Name click insert Name
Unique Objective ID click set ID
Custom Message insert typed message in text area

'''Objective Check Rule:''' Executes child rules when objective is complete

'''Properties:'''
Unique Objective ID click insert ID number
Mode click choose Wait for completion, Wait for failure, Wait for progress

'''Objective Update Rule:''' Changes progress outcome according to Property choices

'''Properties:'''
Unique Objective ID click to set ID number
Mode click Set objective as Decrement progress/Increment progress/Reset objective/Set objects as complete/Set objects as failed/Set progress/Set progress only if greater
Amount click insert number

'''Ranked Session Begin Rule:''' Begins a ranked Session

'''Properties:'''
Countdown requires a Starting Value insert hrs., min,sec
1 through 5 stars, points for each star insert number of points
Session timer mode fill-in chooses: Timer, Countdown, None

'''Ranked Session Complete Rule:''' Completes the active ranked Session

'''Properties:'''
Set the active ranked session as fill-in choose: Complete, Failed
Customize the completion message check insert text message

'''Session Complete Rule:''' Set session to a percentage of completion

'''Properties:'''
Set session to percent complete click to insert number in percent
Separate achievements for completion check

=='''Danger Rules'''==

'''ATP Speed Limiter Rule:''' Limits speed over set limit

'''Properties:'''
speed limit over the set limit mph

'''Speeding Check Rule:''' If player controlled trains are over the local speed limit or over a set (custom) speed, then the following child rules will be executed

'''Properties:'''
'''(Option button) Watch for trains travelling above the posted speed limit'''
'''''<speed value>'':''' - click to enter a new overspeed tolerance value
'''''<units>'':''' - '''Kmph/MPH/mps''' - click to select one
'''(Option button) Watch for trains travelling above a custom speed'''
'''''<speed value>'':''' - click to enter a new custom speed value
'''''<units>'':''' - '''Kmph/MPH/mps''' - click to select one
'''Warning: This option is very performance intensive and should only be used in sessions with few trains'''

'''AWS Configuration Rule:''' This rule configures the Trainz implementation of the Automatic Warning System when approaching signals

'''Properties:'''
Use modern sound set for unfitted cabs? check
Simulate AWS for unfitted cabs? check
Passive with HUD hidden fill-in
Active fill-in
Passive fill-in

'''Wait for Derailment Rule:''' Waits for a derailment to occur

'''Properties:'''
Trigger derailment watch once check to set

'''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars

'''Properties:'''
Set delay to clean up derailed train cars values

'''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule

'''Properties:'''
Respawn trains if they are abandoned check
Respawn trains fill-in choose: at their original locations, from portals from Session List

'''Coupler Breakage Check Rule:''' Checks for breaking couplers. No parameters.

'''Properties:'''
None

'''Coupler Breakage HUDRule:''' HUD displays warning about coupler stress and breakage

'''Properties:'''
Show the Coupler Breakage Display fill-in must choose one or the other
Hide the Coupler Breakage Display fill-in must choose one or the other

'''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles

'''Properties:'''
Add vehicle click to select from session list
Coupling Mask, Decoupling Mask : click to select: lock or unlock
Add All click to select all vehicle in session
Delete All click to delete all vehicle from list

'''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users

'''Properties:'''
Trigger only once check

'''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users

'''Properties:'''
Trigger only once check

'''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger

'''Properties:'''
Trigger only once check to set

'''Vehicle Physics Rule:''' Overrides the default vehicle physics properties

'''Properties:'''
Accept all trains fill-in
Cab sway level is set ? % click to insert percent of sway
Traction boost is % ? while sanding click to insert percent of boost
Tractions reduced to ? % while click to set traction percent
Maximum tractive effort adjusted by ? click to insert percent amount
Show coupler breakage in HUD Rule check to set
Couplers break when coupling above ? click to set speed
Accept trains matching specific criteria fill-in to insert specific trains
Couplers break at ? kN check to insert amount of force

=='''Navigation Rules'''==

'''DestSignTable Rule:''' Table for creating a table of destination signs

'''Properties:'''
Enable Track Marks as destinations check
Enable table of destinations check
Import destination from texture-group. name
Destination Name name
Enable industries/stations as check
Interlocking Tower Configure Path Alters settings on an interlocking tower path
Interlocking Tower choose Name and Objects
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
Show path activation message in Driver check

'''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train

'''Properties:'''
Interlocking Tower choose Names and Objects
Multiple Junction Alignment Check Checks multiple junctions are in alignment
Wait until the following junctions are choose all or anyone
Add junction click add junction from session list
Add all click add all junctions from session list
Delete all click deletes all junctions from rule list

'''Navigation Display Rule:''' Creates a set of navigation points. Multiple sets can be created by adding additional copies of this rule. This rule creates the navigation set, it does not display it. Use the '''Navigation set hide/show rule''' to make a set visible. Click the help icon at the top of the properties box for in game instructions.

'''Properties:'''
'''Unique set ID:''' - enter a unique name for the navigation set. Name must be in lowercase and have no spaces.
'''Train (optional):''' - select a rolling stock asset from the session list shown.
'''Navigation mode:''' select one
'''(Option button) 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.
'''(Option button) 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.
'''(Option button) 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 (a trigger, trackmark, track object or rolling stock asset) 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'':''' - select an icon for the navigation point.
'''''Style'': ''Automatic/Manual/Require Stop''''' - click to select one
'''''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'''.
This allows you to execute other rules (e.g. consist check, trigger 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.

'''Navigation Point Complete Rule:''' Marks a navigation point complete

'''Properties:'''
Mark navigation point click set index number
Complete in set click to set ID

'''Navigation Set Check Rule:''' Checks if a navigation point is complete/incomplete

'''Properties:'''
Checks if navigation point is set click set ID
Is click Complete, Incomplete
Navigation Set Clear Clears a navigation point set
Clear the navigation point set click to set ID
Navigation Set Hide/Show Show or hide navigation point set
The navigation point click hide, show
Navigation point set click to set ID

'''Navigation Set Clear Rule:''' Clears a navigation set removing any uncompleted navigation points

'''Properties:'''
'''''Click here to set'':''' - enter the unique name for the navigation set created using the '''Navigation set display rule'''.
Name must be in lowercase and have no spaces. The rule will NOT check to see if the named navigation set exists or not.

'''Navigation Set Hide/Show:''' Shows and hides navigation sets. You can have multiple sets visible at the same time.

'''Properties:'''
'''''Hide/Show'':''' - click to select one
'''''click here to set'':''' - enter the unique name for the navigation set created using the '''Navigation set display rule'''.
Name must be in lowercase and have no spaces. The rule will NOT check to see if the named navigation set exists or not.

'''Schedule Rule:''' Allows a schedule of timed events to be applied to a train

'''Properties:'''
Insert track mark click to select from session list
Note: Both has an arrival and departure set time hr:min:sec
Current Train click to select from session list
Insert destination click to select from session list

'''Set Junctions Rule:''' Sets the selected junctions to a specific state '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''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:-
'''''Setting'': Left/Center/Right/Don't change''' - click one to set the junction direction
'''''Locked'': Locked/Unlocked''' - click to select one. '''Locked''' means the junction setting cannot be changed by the user
'''''Allows AI control/Blocks AI control''''' - click to select one.
'''''Remove''''' - click to remove that junction from the rule list

'''Set Signal Extended Rule:''' Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''Properties:'''
'''''Select signal''''' - click to select a signal from the session list
'''''<signal state>''''' - click to select a state from the list

'''Trigger Check Rule:''' Waits for any train to enter one of the designated triggers. This rule replaces the older and less versatile "Trigger Rule".

'''Properties:'''
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list
Add Trigger click to choose from session list
Trigger only once check to set
Wait for child rules to complete even if check to set
Only activate when the entering click to choose forward, backward

'''Wait on Navigation Point Rule:''' Waits for a navigation point to be completed then the following child rules will be executed

'''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 set display rule'''.
Name must be in lowercase and have no spaces. The rule will NOT check to see if the named navigation set and point exists or not.

'''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start

'''Properties:'''
Accept all trains fill-in to set
Accept trains matching specific criteria fill-in to set and choose from session list
Wait for a train that matches the click to choose: start moving, stop moving
Trigger rule once check to set
Note: One or the other fill-ins must be

=='''Driver Rules'''==

'''Control Type Rule''' Sets control type

'''Properties:'''
Current control method is: Easy Mode, Choice one of the three

'''Control Check Rule:''' Activates child rules based on the control method changes

'''Properties:'''
Excite child rules when: DCC mode is fill-in one or the other
Excite child rules: Every time control fill-in one or the other

'''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule

'''Properties:'''
Trigger add Trigger
Portal index from PCP value
Use UnPortal yes/no
Delay from Trigger to Emit: seconds value

'''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry

'''Properties:'''
Apply to every vehicle in the session fill-in
Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles
Note: One of the Applies will always be
Load/Unload for industry Disable/Enable choose Industry

'''Driver Command Rule:''' Specify which commands will be available for the drivers

'''Properties''':
Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.
Navigate To TrackMarkList V2- No description.
Navigate To Station V2- No description.
Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.
Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.
Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.
Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.
Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.
Drive To Station V2- No description.
Drive To Track mark List V2- No description.
Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.
Drive To Industry- Drive to a specific industry.
Change Destination Sign-Changes the destination signs of a train.

WaitFor- Pauses the driver's schedule for a set duration of time.
Wait For Random- TRS2008: Wait for specified or optionally random period of time.
Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).
WaitUntil- No description.

VR Set Train Lamps-Driver command that sets the train lamps.
Notify- Notifies the player of schedule progress/completion.
Reverse Tram- Reverse a tram(max 2 cars).
Couple- Couple train to designate vehicle.
Decouple- Decouples the train at the specified vehicle.
UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).
Halt Train- Brings the train to a complete stop.
Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.
Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger
station before using this command.
Cab: Wait-Maintains current control state until some condition is met.
Delete Train- Causes the train and its driver to be deleted from the session.
Hornz- Driver sounds the train horn.
Cab: Set Control-Sets a cab mode control.
Headlights On/Off-Allows the driver to to switch the headlights on and off.
Interior Lights Command- Driver command to switch interior lights on or off for the current train.
Set Max Speed To- No description.

Release Junction - Lets a driver release the junction they have been holding.
Move Turntable- TRS2008: Move turntable to a stop point .

Load- Loads the train's vehicles at the industry the driver is currently at with the train.
Unload- Unload train vehicles at current industry location.
Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.
Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.
Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.

'''Driver Command Check Rule:''' Verifies the driver commands of a driver character

'''Properties'''
Wait for driver character to have add driver, all, delete all
Trigger Rule once check
Driver character to watch the name driver

'''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar

'''Properties'''
The Driver Main Bar choice show/hide

'''Driver Schedule Rule''' Execution of basic scheduled commands

'''Properties:'''
Note: Only one of the fill-in can be
Driver Schedule Rule assigned to name driver
Commands insert driver commands in Drive Schedule
Classic style: If there is a schedule fill-in
Killer style: If there is a schedule fill-in
Cooperative style: If there is a schedule fill-in
Active style: Emit a new schedule, only fill-in

'''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders

'''Properties'''
Generate new Drivers for empty check
The following drivers will be available Driver's Name Add
Remove all existing Drivers first check

'''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers

'''Properties'''
Assign Driver commands check Driver Commands
Train criteria fill in all trains
Train criteria list train only trains matching criteria

'''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted

'''Properties'''
Config/txt file tag 'max_permitted_speed-60850 in mph or kph
Add to config.txt and kuid-table for value <KUID2:60850:88000:4
Note: Old root level config tag will

'''QuickDrive Rule:''' Change the Session settings and add consists in Driver

'''Properties'''
Set Time to insert time
QuickDrive Consist Option List by
Rate of Change insert rate as number times
Enable gameplay Session Mode check
Enable in game help by default check
Set the default Control method to fill-in choose: Easy Mode, Realistic Mode
Prevent player from changing this check
Realistic mode requires achievement add Achievement's Name
In Asset choose Auran achievements
Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic
Prevent player from changing 10.0 check
Set the default units to fill-in choose: Imperial, Metric, Default
Open QuickDriver Window when check

'''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train

'''Properties'''
Note: One or the other fill-ins must be
Accept trains matching specific criteria fill-in to select from session list
Accept all trains fill-in to set
Trigger rule once check to set
Wait for a driver character to get ? a click to select: On, Off

'''Wait for Driver/Train to be Locally Owned Rule:''' Waits for a specific driver or train car to be locally owned, Owned then executes child rules. If the driver/train car becomes unowned again the child rules are paused

'''Properties'''
Wait for ownership of a specific Driver fill-in to set
Wait for ownership of Driver fill-in to set
Note: One or the other fill-in must be
Driver or Vehicle click to choose from session lists

=='''Arrangement of Session Rules:'''==

'''Ordered List Rule:''' Child rules will be executed in order once this rule starts

'''Properties'''
Note: One of the two must be chosen
This process will repeat fill-in click to add number of repeats
This process will repeat forever fill-in

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

'''Properties'''
After last child run is executed click to choose: First child is chosen again, It will be
used for all successive runs, Successive runs will
do nothing

'''Random List Rule:''' One of the child rules indented under this rule will be randomly selected and executed

'''Properties'''
executed randomly
Once one of the child rule is ??

'''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle

'''Properties'''
None

'''Simultaneous List Rule:''' Child rules are executed simultaneously once this rule starts

'''Properties'''
Rules completes when click choose all rules have reached completed state,
was completed state

=='''Camera Rules:'''==

'''Cinematic Camera Rule:''' Provides several different cinematic style cameras

'''Properties'''
Lock camera controls for the duration check
Prevent rain control for duration check
Camera target: name any of the many objects in session
Camera mode: Stationary, Circle fill-in
Initial camera values: Pitch, Yaw, Zoom value
Total time to animate: seconds value

'''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties

'''Properties'''
Change the camera view mode to check to choose: Cab View, External View, Tracking
View, Free Roaming
Vehicle fill-in choose from session vehicles
Set the camera flags to enable/disable check to choose different properties from list
Junction fill-in choose from session junctions
Set the target objet of the camera to check
Map object fill-in choose from map objects

'''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view

'''Properties'''
Trigger rule once check to set
Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking
View, Free Roaming View
Wait for the camera to target vehicle ? click to choose form session list

=='''Message Rules:'''==

'''Close Message Popup Rule:''' Closes open message popups

'''Properties:'''
None

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

'''Custom Script Rule:'''

'''Properties'''
None.

'''Display Custom HUD Rule:''' Show or hide the Custom Heads Up Display.

'''Properties'''
Show the Custom Heads up Display- fill-in to choose.
Hide the Custom Heads up Display- fill-in to choose.
Note: One or the other will be chosen by default.

'''Wait for Click on HUD Icon Rule:'''

'''Properties'''
Trigger rule once-check to choose.
HUD Panel- click to choose from list.
Wait for click on- click to choose; choice depends on HUD Panel chosen.

'''Display HTML Pages Rule:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.

'''Properties'''
Add Page- click on to choose from list; click to Add Page Name or Remove.
Add All- click to add all files from the designated assets.
Delete All- delete all files from this property list.
Prevent user from exiting browser until all pages viewed- check to choose.
Disable closing of browser window by user- check to choose.
Disable browser window scrolling- check to choose.
Make browser window invisible- check to choose.
Set position-Under Construction!!!- check to choose.
Set size-Under Construction!!!- check to choose.
Use the page- click to choose Insert Page Name.
From asset HTML- click to choose from list.

'''Timed limited display HTML Rule:''' Displays an html browser window for a limited time.

'''Properties'''
HTML Asset Name-

'''Display Video Rule:''' Displays a page from a HTML assets in a browser window.

'''Properties'''

'''End Session Rule:''' End Session without saving.

'''Properties'''

'''Fade in/out Rule:''' Fade in or out within seconds, color and opacity considered.

'''Properties'''

'''Flash HUD Icon Rule:''' Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.

'''Properties'''

'''Generic Tree Node Debug Window Rule:''' No description.

'''Properties'''

'''InputTable Rule:''' Creating a list of message names to be used for various purposes.

'''Properties'''

'''Message Popup Rule:''' Displays a pop-up browser window and waits to be closed.

'''Properties'''
'''(Check Box) Pause game while message is displayed:''' - stops the game until this message is switched off
'''(Check Box) Close previous popup windows:''' - closes any Message Popups currently displayed
'''Message location: Top Left/Top Right/Bottom Left/Bottom Right''' - select one to position the browser window on the screen
'''Message Source: Custom text/A predefined HTML page (advanced)/A predefined string-table entry from a HTML asset (advanced)''' - select one

'''Message Source Option: Custom text'''
'''Icon: ''Click here to set''''' - shows a list of message icons. Select one to be displayed with the message
'''Icon: ''Clear icon''''' - clears any currently displayed message icon
'''Custom text:''' Enter text to be displayed. You will be limited to about 6 lines of text. For longer messages or to include graphics, use the '''A predefined HTML page''' option.

'''Message Source Option: A predefined HTML page'''
'''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.

'''Message Source Option: 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.

'''Minimap Options Rule:''' Sets the display options for the minimap.

'''Properties'''

'''Play Sound Rule:''' Plays a wav sound file.

'''Properties'''

'''Session Debug Rule Rule:''' Executes the first child if debug mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.

'''Properties'''

'''Session Metadata Rule:''' Sets session metadata in the config file. Info can be read by other systems and displayed to the player.

'''Properties'''

'''Set Helper Icon Size Rule:''' Sets the size of helper icons such as the junction lever arrows.

'''Properties'''

'''Set HTML Page Rule:''' Instructs the Display HTML Pages rule to perform specific operations

'''Properties'''

'''Show/Hide HUD Panel Rule:''' Shows or hides a HUD panel.

'''Properties'''

'''Show/Hide Layer Rule:''' Shows or hides a layer from Driver.

'''Properties:'''
'''Show/Hide''' - select one
'''click here to set''' - enter name of layer. Name is case sensitive.

'''Known Bugs:'''
TANE (all versions) - layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded

'''Show/Hide Minimap Rule:''' Shows the Driver the minimap window.

'''Properties'''
'''Minimap Window'''-click to choose Show,Hide

'''Show/hide on-screen help Rule:''' Shows or hides On-screen help in Driver.

'''Properties'''
'''Junction Overlays:''' - fill-in to choose: Show, Hide, Leave unchanged. by default one is chosen
'''On Screen Vehicle Name:''' - Fill-in to choose: Show, Hide, Leave unchanged. By default one is chosen

'''Wait for Click on HUD Icon Rule:''' Waits for a click on the HUD Icon.

'''Properties'''
'''Trigger Once:''' - Check to choose
'''HUD Panel:''' - Click to choose from list: Bottom Right Menu, Camera Controls, DCC Controls
'''Icon:''' - Choose from list. Selections depends on HUD Panel chosen

'''Wait on Waybill Screen/Main Screen Rule:''' Waits for the Waybill window to be opened.

'''Properties'''

=='''Startup Rules:'''==

'''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.

'''Properties'''

'''Startup Options Rule''' Specifies the starting options for the session.

'''Properties'''

=='''Time Rules:'''==

'''Clock Rule:''' Rule needed for animated clocks, you need to apply this rule to your session to make use of the animated clocks, see forum for code to include in you clock object to work with this rule.

'''Properties'''

'''Timecheck Rule:''' Executes child rules at a certain time.

'''Properties'''

'''Timing Check Rule:''' Triggers sub rules if called within the time window specified.

'''Properties'''

'''Wait Rule:''' Wait for number of seconds'

'''Properties'''

=='''Variable Rules:'''==

'''Variable Check Rule:''' If the specified variable matches the specified conditions then the child rules will be executed in order.

'''Properties'''
'''''<variable-name>''''' - enter a variable-name. Variable name is case sensitive.
'''''<test-condition>''''' - '''is less than/is less than or equal to/is equal to/is greater than or equal to/is greater than/is not equal to/is between x and y''' - select one
'''''This condition will be evaluated only once .../This condition will be evaluated once every second''''' - click to select one
'''Test condition option: is between x and y'''
Enter minimum (x) and maximum (y) test values

'''Test condition option: (all other options)'''
Enter test value

'''Evaluation option: 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

'''Evaluation option: This condition will be evaluated evaluated once every second''' - the rule will be run and the variable rechecked every second

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

'''Properties'''
'''Change: Add to variable/Subtract from variable/Change variable''' - select one
'''(optional check box) Set the minimum value''' of ''<variable-name>'' to ''<value>'' - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.
('''optional check box) Set the maximum value''' of ''<variable-name>'' to ''<value>'' - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.

'''Change option: 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.

'''Change option: 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 option: Change variable'''
'''Change variable ''<variable-name>'' to ''<value>''''' - enter variable-name, enter new value. This cannot be undone if the rule is stopped. Variable-name is case sensitive.

'''Variable Modify Continuous Rule:''' Adds, subtracts or sets a value to a specified variable every second.

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

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

'''Properties'''
'''Check box: Add'''
''<variable-name>'' - enter variable-name. 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. Variable-name is case sensitive.

Variables are saved in the session file and persist from one saved game to another.
They can be accessed/modified by the following '''driver commands''':

'''Driver Commands by trev999:'''
'''Set S-Variable driver command: '''
'''Skip if session-variable driver command: '''
'''Wait until S-variable driver command: '''

'''Driver Commands by atilabarut'''
'''ChangeSVariables driver command: '''
'''WaitUntilSVariable driver command: '''

=='''Weather Rules:'''==

'''EIRS Weather Rule NE USA Rule:''' Customize random weather rule relative to the North East Region of the United States.

'''Properties'''

'''Weather Rule:''' Set the weather conditions.

'''Properties'''

Session Rules By Categories With Properties

2017-09-26T23:30:09Z

Coop2:

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

=='''1 Achievement Rules'''==

'''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement

'''Properties:'''
None

'''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload

'''Properties:'''
Target object ?? name of object such as Power Station, Coal Pit or Portal
Lock train's controls checked during a stopped load/unload operation
Override 'begin load' and 'begin unload' checked # of seconds to override

'''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations

'''Properties:'''
Trigger click to choose from list
Add Industry click to add from session list
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list

'''Power Station Rule:''' Sets up Station and Consumers

'''Properties:'''
Power Station click to choose from session Stations
Consumers(Add Object) click to choose from session list

'''Resource Check Rule:''' Check the progress of the amount of a resource and target object

'''Properties:'''
Watch industry queue or Watch vehicle fill-in choose one or the other
Note: Both have: Target Object, Queue: click to choose
Complete when designated queue fill-in equals or exceeds required amount, falls below required amount

'''Multiple Resource Check Rule:''' If specified resources in a selected industry or vehicle reaches set levels, then the following child rules will be executed

'''Properties:'''
'''''Reach-Exceed/Fall below'':''' - click to select one
'''''<value>'':''' - enter required quantity value
'''''<Click to 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. For each object:-
'''Object:''' - select session active industry or product enabled rail vehicle
'''Queue:''' - select product queue (there may be only one available)
'''Remove:''' - removes the object and its product queue from the rule
'''Notes:'''
'''''Reach/Exceed''''' - sets an upper limit for the resource 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 resource 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.

'''Objective Add Rule:''' Sets up a game Objective with ID and display Name

'''Properties:'''
Priority click choose Above Normal, Below Normal, Normal, Optional, Urgent
Completion Target click to set target number
Icon click choose from list
Display Name click insert Name
Unique Objective ID click set ID
Custom Message insert typed message in text area

'''Objective Check Rule:''' Executes child rules when objective is complete

'''Properties:'''
Unique Objective ID click insert ID number
Mode click choose Wait for completion, Wait for failure, Wait for progress

'''Objective Update Rule:''' Changes progress outcome according to Property choices

'''Properties:'''
Unique Objective ID click to set ID number
Mode click Set objective as Decrement progress/Increment progress/Reset objective/Set objects as complete/Set objects as failed/Set progress/Set progress only if greater
Amount click insert number

'''Ranked Session Begin Rule:''' Begins a ranked Session

'''Properties:'''
Countdown requires a Starting Value insert hrs., min,sec
1 through 5 stars, points for each star insert number of points
Session timer mode fill-in chooses: Timer, Countdown, None

'''Ranked Session Complete Rule:''' Completes the active ranked Session

'''Properties:'''
Set the active ranked session as fill-in choose: Complete, Failed
Customize the completion message check insert text message

'''Session Complete Rule:''' Set session to a percentage of completion

'''Properties:'''
Set session to percent complete click to insert number in percent
Separate achievements for completion check

=='''Danger Rules'''==

'''ATP Speed Limiter Rule:''' Limits speed over set limit

'''Properties:'''
speed limit over the set limit mph

'''Speeding Check Rule:''' If player controlled trains are over the local speed limit or over a set (custom) speed, then the following child rules will be executed

'''Properties:'''
'''(Option button) Watch for trains travelling above the posted speed limit'''
'''''<speed value>'':''' - click to enter a new overspeed tolerance value
'''''<units>'':''' - '''Kmph/MPH/mps''' - click to select one
'''(Option button) Watch for trains travelling above a custom speed'''
'''''<speed value>'':''' - click to enter a new custom speed value
'''''<units>'':''' - '''Kmph/MPH/mps''' - click to select one
'''Warning: This option is very performance intensive and should only be used in sessions with few trains'''

'''AWS Configuration Rule:''' This rule configures the Trainz implementation of the Automatic Warning System when approaching signals

'''Properties:'''
Use modern sound set for unfitted cabs? check
Simulate AWS for unfitted cabs? check
Passive with HUD hidden fill-in
Active fill-in
Passive fill-in

'''Wait for Derailment Rule:''' Waits for a derailment to occur

'''Properties:'''
Trigger derailment watch once check to set

'''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars

'''Properties:'''
Set delay to clean up derailed train cars values

'''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule

'''Properties:'''
Respawn trains if they are abandoned check
Respawn trains fill-in choose: at their original locations, from portals from Session List

'''Coupler Breakage Check Rule:''' Checks for breaking couplers. No parameters.

'''Properties:'''
None

'''Coupler Breakage HUDRule:''' HUD displays warning about coupler stress and breakage

'''Properties:'''
Show the Coupler Breakage Display fill-in must choose one or the other
Hide the Coupler Breakage Display fill-in must choose one or the other

'''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles

'''Properties:'''
Add vehicle click to select from session list
Coupling Mask, Decoupling Mask : click to select: lock or unlock
Add All click to select all vehicle in session
Delete All click to delete all vehicle from list

'''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users

'''Properties:'''
Trigger only once check

'''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users

'''Properties:'''
Trigger only once check

'''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger

'''Properties:'''
Trigger only once check to set

'''Vehicle Physics Rule:''' Overrides the default vehicle physics properties

'''Properties:'''
Accept all trains fill-in
Cab sway level is set ? % click to insert percent of sway
Traction boost is % ? while sanding click to insert percent of boost
Tractions reduced to ? % while click to set traction percent
Maximum tractive effort adjusted by ? click to insert percent amount
Show coupler breakage in HUD Rule check to set
Couplers break when coupling above ? click to set speed
Accept trains matching specific criteria fill-in to insert specific trains
Couplers break at ? kN check to insert amount of force

=='''Navigation Rules'''==

'''DestSignTable Rule:''' Table for creating a table of destination signs

'''Properties:'''
Enable Track Marks as destinations check
Enable table of destinations check
Import destination from texture-group. name
Destination Name name
Enable industries/stations as check
Interlocking Tower Configure Path Alters settings on an interlocking tower path
Interlocking Tower choose Name and Objects
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
Show path activation message in Driver check

'''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train

'''Properties:'''
Interlocking Tower choose Names and Objects
Multiple Junction Alignment Check Checks multiple junctions are in alignment
Wait until the following junctions are choose all or anyone
Add junction click add junction from session list
Add all click add all junctions from session list
Delete all click deletes all junctions from rule list

'''Navigation Display Rule:''' Creates a set of navigation points. Multiple sets can be created by adding additional copies of this rule. This rule creates the navigation set, it does not display it. Use the '''Navigation set hide/show rule''' to make a set visible. Click the help icon at the top of the properties box for in game instructions.

'''Properties:'''
'''Unique set ID:''' - enter a unique name for the navigation set. Name must be in lowercase and have no spaces.
'''Train (optional):''' - select a rolling stock asset from the session list shown.
'''Navigation mode:''' select one
'''(Option button) 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.
'''(Option button) 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.
'''(Option button) 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 (a trigger, trackmark, track object or rolling stock asset) 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'':''' - select an icon for the navigation point.
'''''Style'': ''Automatic/Manual/Require Stop''''' - click to select one
'''''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'''.
This allows you to execute other rules (e.g. consist check, trigger 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.

'''Navigation Point Complete Rule:''' Marks a navigation point complete

'''Properties:'''
Mark navigation point click set index number
Complete in set click to set ID

'''Navigation Set Check Rule:''' Checks if a navigation point is complete/incomplete

'''Properties:'''
Checks if navigation point is set click set ID
Is click Complete, Incomplete
Navigation Set Clear Clears a navigation point set
Clear the navigation point set click to set ID
Navigation Set Hide/Show Show or hide navigation point set
The navigation point click hide, show
Navigation point set click to set ID

'''Navigation Set Clear Rule:''' Clears a navigation set removing any uncompleted navigation points

'''Properties:'''
'''''Click here to set'':''' - enter the unique name for the navigation set created using the '''Navigation set display rule'''.
Name must be in lowercase and have no spaces. The rule will NOT check to see if the named navigation set exists or not.

'''Navigation Set Hide/Show:''' Shows and hides navigation sets. You can have multiple sets visible at the same time.

'''Properties:'''
'''''Hide/Show'':''' - click to select one
'''''click here to set'':''' - enter the unique name for the navigation set created using the '''Navigation set display rule'''.
Name must be in lowercase and have no spaces. The rule will NOT check to see if the named navigation set exists or not.

'''Schedule Rule:''' Allows a schedule of timed events to be applied to a train

'''Properties:'''
Insert track mark click to select from session list
Note: Both has an arrival and departure set time hr:min:sec
Current Train click to select from session list
Insert destination click to select from session list

'''Set Junctions Rule:''' Sets the selected junctions to a specific state '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''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:-
'''''Setting'': Left/Center/Right/Don't change''' - click one to set the junction direction
'''''Locked'': Locked/Unlocked''' - click to select one. '''Locked''' means the junction setting cannot be changed by the user
'''''Allows AI control/Blocks AI control''''' - click to select one.
'''''Remove''''' - click to remove that junction from the rule list

'''Set Signal Extended Rule:''' Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''Properties:'''
'''''Select signal''''' - click to select a signal from the session list
'''''<signal state>''''' - click to select a state from the list

'''Trigger Check Rule:''' Waits for any train to enter one of the designated triggers. This rule replaces the older and less versatile "Trigger Rule".

'''Properties:'''
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list
Add Trigger click to choose from session list
Trigger only once check to set
Wait for child rules to complete even if check to set
Only activate when the entering click to choose forward, backward

'''Wait on Navigation Point Rule:''' Waits for a navigation point to be completed then the following child rules will be executed

'''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 set display rule'''.
Name must be in lowercase and have no spaces. The rule will NOT check to see if the named navigation set and point exists or not.

'''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start

'''Properties:'''
Accept all trains fill-in to set
Accept trains matching specific criteria fill-in to set and choose from session list
Wait for a train that matches the click to choose: start moving, stop moving
Trigger rule once check to set
Note: One or the other fill-ins must be

=='''Driver Rules'''==

'''Control Type Rule''' Sets control type

'''Properties:'''
Current control method is: Easy Mode, Choice one of the three

'''Control Check Rule:''' Activates child rules based on the control method changes

'''Properties:'''
Excite child rules when: DCC mode is fill-in one or the other
Excite child rules: Every time control fill-in one or the other

'''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule

'''Properties:'''
Trigger add Trigger
Portal index from PCP value
Use UnPortal yes/no
Delay from Trigger to Emit: seconds value

'''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry

'''Properties:'''
Apply to every vehicle in the session fill-in
Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles
Note: One of the Applies will always be
Load/Unload for industry Disable/Enable choose Industry

'''Driver Command Rule:''' Specify which commands will be available for the drivers

'''Properties''':
Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.
Navigate To TrackMarkList V2- No description.
Navigate To Station V2- No description.
Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.
Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.
Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.
Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.
Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.
Drive To Station V2- No description.
Drive To Track mark List V2- No description.
Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.
Drive To Industry- Drive to a specific industry.
Change Destination Sign-Changes the destination signs of a train.

WaitFor- Pauses the driver's schedule for a set duration of time.
Wait For Random- TRS2008: Wait for specified or optionally random period of time.
Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).
WaitUntil- No description.

VR Set Train Lamps-Driver command that sets the train lamps.
Notify- Notifies the player of schedule progress/completion.
Reverse Tram- Reverse a tram(max 2 cars).
Couple- Couple train to designate vehicle.
Decouple- Decouples the train at the specified vehicle.
UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).
Halt Train- Brings the train to a complete stop.
Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.
Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger
station before using this command.
Cab: Wait-Maintains current control state until some condition is met.
Delete Train- Causes the train and its driver to be deleted from the session.
Hornz- Driver sounds the train horn.
Cab: Set Control-Sets a cab mode control.
Headlights On/Off-Allows the driver to to switch the headlights on and off.
Interior Lights Command- Driver command to switch interior lights on or off for the current train.
Set Max Speed To- No description.

Release Junction - Lets a driver release the junction they have been holding.
Move Turntable- TRS2008: Move turntable to a stop point .

Load- Loads the train's vehicles at the industry the driver is currently at with the train.
Unload- Unload train vehicles at current industry location.
Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.
Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.
Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.

'''Driver Command Check Rule:''' Verifies the driver commands of a driver character

'''Properties'''
Wait for driver character to have add driver, all, delete all
Trigger Rule once check
Driver character to watch the name driver

'''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar

'''Properties'''
The Driver Main Bar choice show/hide

'''Driver Schedule Rule''' Execution of basic scheduled commands

'''Properties:'''
Note: Only one of the fill-in can be
Driver Schedule Rule assigned to name driver
Commands insert driver commands in Drive Schedule
Classic style: If there is a schedule fill-in
Killer style: If there is a schedule fill-in
Cooperative style: If there is a schedule fill-in
Active style: Emit a new schedule, only fill-in

'''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders

'''Properties'''
Generate new Drivers for empty check
The following drivers will be available Driver's Name Add
Remove all existing Drivers first check

'''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers

'''Properties'''
Assign Driver commands check Driver Commands
Train criteria fill in all trains
Train criteria list train only trains matching criteria

'''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted

'''Properties'''
Config/txt file tag 'max_permitted_speed-60850 in mph or kph
Add to config.txt and kuid-table for value <KUID2:60850:88000:4
Note: Old root level config tag will

'''QuickDrive Rule:''' Change the Session settings and add consists in Driver

'''Properties'''
Set Time to insert time
QuickDrive Consist Option List by
Rate of Change insert rate as number times
Enable gameplay Session Mode check
Enable in game help by default check
Set the default Control method to fill-in choose: Easy Mode, Realistic Mode
Prevent player from changing this check
Realistic mode requires achievement add Achievement's Name
In Asset choose Auran achievements
Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic
Prevent player from changing 10.0 check
Set the default units to fill-in choose: Imperial, Metric, Default
Open QuickDriver Window when check

'''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train

'''Properties'''
Note: One or the other fill-ins must be
Accept trains matching specific criteria fill-in to select from session list
Accept all trains fill-in to set
Trigger rule once check to set
Wait for a driver character to get ? a click to select: On, Off

'''Wait for Driver/Train to be Locally Owned Rule:''' Waits for a specific driver or train car to be locally owned, Owned then executes child rules. If the driver/train car becomes unowned again the child rules are paused

'''Properties'''
Wait for ownership of a specific Driver fill-in to set
Wait for ownership of Driver fill-in to set
Note: One or the other fill-in must be
Driver or Vehicle click to choose from session lists

=='''Arrangement of Session Rules:'''==

'''Ordered List Rule:''' Child rules will be executed in order once this rule starts

'''Properties'''
Note: One of the two must be chosen
This process will repeat fill-in click to add number of repeats
This process will repeat forever fill-in

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

'''Properties'''
After last child run is executed click to choose: First child is chosen again, It will be
used for all successive runs, Successive runs will
do nothing

'''Random List Rule:''' One of the child rules indented under this rule will be randomly selected and executed

'''Properties'''
executed randomly
Once one of the child rule is ??

'''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle

'''Properties'''
None

'''Simultaneous List Rule:''' Child rules are executed simultaneously once this rule starts

'''Properties'''
Rules completes when click choose all rules have reached completed state,
was completed state

=='''Camera Rules:'''==

'''Cinematic Camera Rule:''' Provides several different cinematic style cameras

'''Properties'''
Lock camera controls for the duration check
Prevent rain control for duration check
Camera target: name any of the many objects in session
Camera mode: Stationary, Circle fill-in
Initial camera values: Pitch, Yaw, Zoom value
Total time to animate: seconds value

'''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties

'''Properties'''
Change the camera view mode to check to choose: Cab View, External View, Tracking
View, Free Roaming
Vehicle fill-in choose from session vehicles
Set the camera flags to enable/disable check to choose different properties from list
Junction fill-in choose from session junctions
Set the target objet of the camera to check
Map object fill-in choose from map objects

'''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view

'''Properties'''
Trigger rule once check to set
Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking
View, Free Roaming View
Wait for the camera to target vehicle ? click to choose form session list

=='''Message Rules:'''==

'''Close Message Popup Rule:''' Closes open message popups

'''Properties:'''
None

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

'''Custom Script Rule:'''

'''Properties'''
None.

'''Display Custom HUD Rule:''' Show or hide the Custom Heads Up Display.

'''Properties'''
Show the Custom Heads up Display- fill-in to choose.
Hide the Custom Heads up Display- fill-in to choose.
Note: One or the other will be chosen by default.

'''Wait for Click on HUD Icon Rule:'''

'''Properties'''
Trigger rule once-check to choose.
HUD Panel- click to choose from list.
Wait for click on- click to choose; choice depends on HUD Panel chosen.

'''Display HTML Pages Rule:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.

'''Properties'''
Add Page- click on to choose from list; click to Add Page Name or Remove.
Add All- click to add all files from the designated assets.
Delete All- delete all files from this property list.
Prevent user from exiting browser until all pages viewed- check to choose.
Disable closing of browser window by user- check to choose.
Disable browser window scrolling- check to choose.
Make browser window invisible- check to choose.
Set position-Under Construction!!!- check to choose.
Set size-Under Construction!!!- check to choose.
Use the page- click to choose Insert Page Name.
From asset HTML- click to choose from list.

'''Timed limited display HTML Rule:''' Displays an html browser window for a limited time.

'''Properties'''
HTML Asset Name-

'''Display Video Rule:''' Displays a page from a HTML assets in a browser window.

'''Properties'''

'''End Session Rule:''' End Session without saving.

'''Properties'''

'''Fade in/out Rule:''' Fade in or out within seconds, color and opacity considered.

'''Properties'''

'''Flash HUD Icon Rule:''' Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.

'''Properties'''

'''Generic Tree Node Debug Window Rule:''' No description.

'''Properties'''

'''InputTable Rule:''' Creating a list of message names to be used for various purposes.

'''Properties'''

'''Message Popup Rule:''' Displays a pop-up browser window and waits to be closed.

'''Properties'''
'''(Check Box) Pause game while message is displayed:''' - stops the game until this message is switched off
'''(Check Box) Close previous popup windows:''' - closes any Message Popups currently displayed
'''Message location: Top Left/Top Right/Bottom Left/Bottom Right''' - select one to position the browser window on the screen
'''Message Source: Custom text/A predefined HTML page (advanced)/A predefined string-table entry from a HTML asset (advanced)''' - select one

'''Message Source Option: Custom text'''
'''Icon: ''Click here to set''''' - shows a list of message icons. Select one to be displayed with the message
'''Icon: ''Clear icon''''' - clears any currently displayed message icon
'''Custom text:''' Enter text to be displayed. You will be limited to about 6 lines of text. For longer messages or to include graphics, use the '''A predefined HTML page''' option.

'''Message Source Option: A predefined HTML page'''
'''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.

'''Message Source Option: 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.

'''Minimap Options Rule:''' Sets the display options for the minimap.

'''Properties'''

'''Play Sound Rule:''' Plays a wav sound file.

'''Properties'''

'''Session Debug Rule Rule:''' Executes the first child if debug mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.

'''Properties'''

'''Session Metadata Rule:''' Sets session metadata in the config file. Info can be read by other systems and displayed to the player.

'''Properties'''

'''Set Helper Icon Size Rule:''' Sets the size of helper icons such as the junction lever arrows.

'''Properties'''

'''Set HTML Page Rule:''' Instructs the Display HTML Pages rule to perform specific operations

'''Properties'''

'''Show/Hide HUD Panel Rule:''' Shows or hides a HUD panel.

'''Properties'''

'''Show/Hide Layer Rule:''' Shows or hides a layer from Driver.

'''Properties:'''
'''Show/Hide''' - select one
'''click here to set''' - enter name of layer. Name is case sensitive.

'''Known Bugs:'''
TANE (all versions) - layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded

'''Show/Hide Minimap Rule:''' Shows the Driver the minimap window.

'''Properties'''
'''Minimap Window'''-click to choose Show,Hide

'''Show/hide on-screen help Rule:''' Shows or hides On-screen help in Driver.

'''Properties'''
'''Junction Overlays:''' - fill-in to choose: Show, Hide, Leave unchanged. by default one is chosen
'''On Screen Vehicle Name:''' - Fill-in to choose: Show, Hide, Leave unchanged. By default one is chosen

'''Wait for Click on HUD Icon Rule:''' Waits for a click on the HUD Icon.

'''Properties'''
'''Trigger Once:''' - Check to choose
'''HUD Panel:''' - Click to choose from list: Bottom Right Menu, Camera Controls, DCC Controls
'''Icon:''' - Choose from list. Selections depends on HUD Panel chosen

'''Wait on Waybill Screen/Main Screen Rule:''' Waits for the Waybill window to be opened.

'''Properties'''

=='''Startup Rules:'''==

'''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.

'''Properties'''

'''Startup Options Rule''' Specifies the starting options for the session.

'''Properties'''

=='''Time Rules:'''==

'''Clock Rule:''' Rule needed for animated clocks, you need to apply this rule to your session to make use of the animated clocks, see forum for code to include in you clock object to work with this rule.

'''Properties'''

'''Timecheck Rule:''' Executes child rules at a certain time.

'''Properties'''

'''Timing Check Rule:''' Triggers sub rules if called within the time window specified.

'''Properties'''

'''Wait Rule:''' Wait for number of seconds'

'''Properties'''

=='''Variable Rules:'''==

'''Variable Check Rule:''' If the specified variable matches the specified conditions then the child rules will be executed in order.

'''Properties'''
'''''<variable-name>''''' - enter a variable-name. Variable name is case sensitive.
'''''<test-condition>''''' - '''is less than/is less than or equal to/is equal to/is greater than or equal to/is greater than/is not equal to/is between x and y''' - select one
'''''This condition will be evaluated only once .../This condition will be evaluated once every second''''' - click to select one
'''Test condition option: is between x and y'''
Enter minimum (x) and maximum (y) test values

'''Test condition option: (all other options)'''
Enter test value

'''Evaluation option: 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

'''Evaluation option: This condition will be evaluated evaluated once every second''' - the rule will be run and the variable rechecked every second

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

'''Properties'''
'''Change: Add to variable/Subtract from variable/Change variable''' - select one
'''(optional check box) Set the minimum value''' of ''<variable-name>'' to ''<value>'' - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.
('''optional check box) Set the maximum value''' of ''<variable-name>'' to ''<value>'' - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.

'''Change option: 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.

'''Change option: 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 option: Change variable'''
'''Change variable ''<variable-name>'' to ''<value>''''' - enter variable-name, enter new value. This cannot be undone if the rule is stopped. Variable-name is case sensitive.

'''Variable Modify Continuous Rule:''' Adds, subtracts or sets a value to a specified variable every second.

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

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

'''Properties'''
'''Check box: Add'''
''<variable-name>'' - enter variable-name. 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. Variable-name is case sensitive.

Variables are saved in the session file and persist from one saved game to another.
They can be accessed/modified by the following '''driver commands''':

'''Driver Commands by trev999:'''
'''Set S-Variable driver command: '''
'''Skip if session-variable driver command: '''
'''Wait until S-variable driver command: '''

'''Driver Commands by atilabarut'''
'''ChangeSVariables driver command: '''
'''WaitUntilSVariable driver command: '''

=='''Weather Rules:'''==

'''EIRS Weather Rule NE USA Rule:''' Customize random weather rule relative to the North East Region of the United States.

'''Properties'''

'''Weather Rule:''' Set the weather conditions.

'''Properties'''

Session Rules By Categories With Properties

2017-09-26T23:29:36Z

Coop2:

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

=='''Achievement Rules'''==

1'''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement

'''Properties:'''
None

'''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload

'''Properties:'''
Target object ?? name of object such as Power Station, Coal Pit or Portal
Lock train's controls checked during a stopped load/unload operation
Override 'begin load' and 'begin unload' checked # of seconds to override

'''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations

'''Properties:'''
Trigger click to choose from list
Add Industry click to add from session list
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list

'''Power Station Rule:''' Sets up Station and Consumers

'''Properties:'''
Power Station click to choose from session Stations
Consumers(Add Object) click to choose from session list

'''Resource Check Rule:''' Check the progress of the amount of a resource and target object

'''Properties:'''
Watch industry queue or Watch vehicle fill-in choose one or the other
Note: Both have: Target Object, Queue: click to choose
Complete when designated queue fill-in equals or exceeds required amount, falls below required amount

'''Multiple Resource Check Rule:''' If specified resources in a selected industry or vehicle reaches set levels, then the following child rules will be executed

'''Properties:'''
'''''Reach-Exceed/Fall below'':''' - click to select one
'''''<value>'':''' - enter required quantity value
'''''<Click to 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. For each object:-
'''Object:''' - select session active industry or product enabled rail vehicle
'''Queue:''' - select product queue (there may be only one available)
'''Remove:''' - removes the object and its product queue from the rule
'''Notes:'''
'''''Reach/Exceed''''' - sets an upper limit for the resource 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 resource 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.

'''Objective Add Rule:''' Sets up a game Objective with ID and display Name

'''Properties:'''
Priority click choose Above Normal, Below Normal, Normal, Optional, Urgent
Completion Target click to set target number
Icon click choose from list
Display Name click insert Name
Unique Objective ID click set ID
Custom Message insert typed message in text area

'''Objective Check Rule:''' Executes child rules when objective is complete

'''Properties:'''
Unique Objective ID click insert ID number
Mode click choose Wait for completion, Wait for failure, Wait for progress

'''Objective Update Rule:''' Changes progress outcome according to Property choices

'''Properties:'''
Unique Objective ID click to set ID number
Mode click Set objective as Decrement progress/Increment progress/Reset objective/Set objects as complete/Set objects as failed/Set progress/Set progress only if greater
Amount click insert number

'''Ranked Session Begin Rule:''' Begins a ranked Session

'''Properties:'''
Countdown requires a Starting Value insert hrs., min,sec
1 through 5 stars, points for each star insert number of points
Session timer mode fill-in chooses: Timer, Countdown, None

'''Ranked Session Complete Rule:''' Completes the active ranked Session

'''Properties:'''
Set the active ranked session as fill-in choose: Complete, Failed
Customize the completion message check insert text message

'''Session Complete Rule:''' Set session to a percentage of completion

'''Properties:'''
Set session to percent complete click to insert number in percent
Separate achievements for completion check

=='''Danger Rules'''==

'''ATP Speed Limiter Rule:''' Limits speed over set limit

'''Properties:'''
speed limit over the set limit mph

'''Speeding Check Rule:''' If player controlled trains are over the local speed limit or over a set (custom) speed, then the following child rules will be executed

'''Properties:'''
'''(Option button) Watch for trains travelling above the posted speed limit'''
'''''<speed value>'':''' - click to enter a new overspeed tolerance value
'''''<units>'':''' - '''Kmph/MPH/mps''' - click to select one
'''(Option button) Watch for trains travelling above a custom speed'''
'''''<speed value>'':''' - click to enter a new custom speed value
'''''<units>'':''' - '''Kmph/MPH/mps''' - click to select one
'''Warning: This option is very performance intensive and should only be used in sessions with few trains'''

'''AWS Configuration Rule:''' This rule configures the Trainz implementation of the Automatic Warning System when approaching signals

'''Properties:'''
Use modern sound set for unfitted cabs? check
Simulate AWS for unfitted cabs? check
Passive with HUD hidden fill-in
Active fill-in
Passive fill-in

'''Wait for Derailment Rule:''' Waits for a derailment to occur

'''Properties:'''
Trigger derailment watch once check to set

'''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars

'''Properties:'''
Set delay to clean up derailed train cars values

'''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule

'''Properties:'''
Respawn trains if they are abandoned check
Respawn trains fill-in choose: at their original locations, from portals from Session List

'''Coupler Breakage Check Rule:''' Checks for breaking couplers. No parameters.

'''Properties:'''
None

'''Coupler Breakage HUDRule:''' HUD displays warning about coupler stress and breakage

'''Properties:'''
Show the Coupler Breakage Display fill-in must choose one or the other
Hide the Coupler Breakage Display fill-in must choose one or the other

'''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles

'''Properties:'''
Add vehicle click to select from session list
Coupling Mask, Decoupling Mask : click to select: lock or unlock
Add All click to select all vehicle in session
Delete All click to delete all vehicle from list

'''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users

'''Properties:'''
Trigger only once check

'''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users

'''Properties:'''
Trigger only once check

'''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger

'''Properties:'''
Trigger only once check to set

'''Vehicle Physics Rule:''' Overrides the default vehicle physics properties

'''Properties:'''
Accept all trains fill-in
Cab sway level is set ? % click to insert percent of sway
Traction boost is % ? while sanding click to insert percent of boost
Tractions reduced to ? % while click to set traction percent
Maximum tractive effort adjusted by ? click to insert percent amount
Show coupler breakage in HUD Rule check to set
Couplers break when coupling above ? click to set speed
Accept trains matching specific criteria fill-in to insert specific trains
Couplers break at ? kN check to insert amount of force

=='''Navigation Rules'''==

'''DestSignTable Rule:''' Table for creating a table of destination signs

'''Properties:'''
Enable Track Marks as destinations check
Enable table of destinations check
Import destination from texture-group. name
Destination Name name
Enable industries/stations as check
Interlocking Tower Configure Path Alters settings on an interlocking tower path
Interlocking Tower choose Name and Objects
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
Show path activation message in Driver check

'''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train

'''Properties:'''
Interlocking Tower choose Names and Objects
Multiple Junction Alignment Check Checks multiple junctions are in alignment
Wait until the following junctions are choose all or anyone
Add junction click add junction from session list
Add all click add all junctions from session list
Delete all click deletes all junctions from rule list

'''Navigation Display Rule:''' Creates a set of navigation points. Multiple sets can be created by adding additional copies of this rule. This rule creates the navigation set, it does not display it. Use the '''Navigation set hide/show rule''' to make a set visible. Click the help icon at the top of the properties box for in game instructions.

'''Properties:'''
'''Unique set ID:''' - enter a unique name for the navigation set. Name must be in lowercase and have no spaces.
'''Train (optional):''' - select a rolling stock asset from the session list shown.
'''Navigation mode:''' select one
'''(Option button) 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.
'''(Option button) 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.
'''(Option button) 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 (a trigger, trackmark, track object or rolling stock asset) 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'':''' - select an icon for the navigation point.
'''''Style'': ''Automatic/Manual/Require Stop''''' - click to select one
'''''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'''.
This allows you to execute other rules (e.g. consist check, trigger 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.

'''Navigation Point Complete Rule:''' Marks a navigation point complete

'''Properties:'''
Mark navigation point click set index number
Complete in set click to set ID

'''Navigation Set Check Rule:''' Checks if a navigation point is complete/incomplete

'''Properties:'''
Checks if navigation point is set click set ID
Is click Complete, Incomplete
Navigation Set Clear Clears a navigation point set
Clear the navigation point set click to set ID
Navigation Set Hide/Show Show or hide navigation point set
The navigation point click hide, show
Navigation point set click to set ID

'''Navigation Set Clear Rule:''' Clears a navigation set removing any uncompleted navigation points

'''Properties:'''
'''''Click here to set'':''' - enter the unique name for the navigation set created using the '''Navigation set display rule'''.
Name must be in lowercase and have no spaces. The rule will NOT check to see if the named navigation set exists or not.

'''Navigation Set Hide/Show:''' Shows and hides navigation sets. You can have multiple sets visible at the same time.

'''Properties:'''
'''''Hide/Show'':''' - click to select one
'''''click here to set'':''' - enter the unique name for the navigation set created using the '''Navigation set display rule'''.
Name must be in lowercase and have no spaces. The rule will NOT check to see if the named navigation set exists or not.

'''Schedule Rule:''' Allows a schedule of timed events to be applied to a train

'''Properties:'''
Insert track mark click to select from session list
Note: Both has an arrival and departure set time hr:min:sec
Current Train click to select from session list
Insert destination click to select from session list

'''Set Junctions Rule:''' Sets the selected junctions to a specific state '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''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:-
'''''Setting'': Left/Center/Right/Don't change''' - click one to set the junction direction
'''''Locked'': Locked/Unlocked''' - click to select one. '''Locked''' means the junction setting cannot be changed by the user
'''''Allows AI control/Blocks AI control''''' - click to select one.
'''''Remove''''' - click to remove that junction from the rule list

'''Set Signal Extended Rule:''' Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''Properties:'''
'''''Select signal''''' - click to select a signal from the session list
'''''<signal state>''''' - click to select a state from the list

'''Trigger Check Rule:''' Waits for any train to enter one of the designated triggers. This rule replaces the older and less versatile "Trigger Rule".

'''Properties:'''
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list
Add Trigger click to choose from session list
Trigger only once check to set
Wait for child rules to complete even if check to set
Only activate when the entering click to choose forward, backward

'''Wait on Navigation Point Rule:''' Waits for a navigation point to be completed then the following child rules will be executed

'''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 set display rule'''.
Name must be in lowercase and have no spaces. The rule will NOT check to see if the named navigation set and point exists or not.

'''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start

'''Properties:'''
Accept all trains fill-in to set
Accept trains matching specific criteria fill-in to set and choose from session list
Wait for a train that matches the click to choose: start moving, stop moving
Trigger rule once check to set
Note: One or the other fill-ins must be

=='''Driver Rules'''==

'''Control Type Rule''' Sets control type

'''Properties:'''
Current control method is: Easy Mode, Choice one of the three

'''Control Check Rule:''' Activates child rules based on the control method changes

'''Properties:'''
Excite child rules when: DCC mode is fill-in one or the other
Excite child rules: Every time control fill-in one or the other

'''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule

'''Properties:'''
Trigger add Trigger
Portal index from PCP value
Use UnPortal yes/no
Delay from Trigger to Emit: seconds value

'''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry

'''Properties:'''
Apply to every vehicle in the session fill-in
Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles
Note: One of the Applies will always be
Load/Unload for industry Disable/Enable choose Industry

'''Driver Command Rule:''' Specify which commands will be available for the drivers

'''Properties''':
Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.
Navigate To TrackMarkList V2- No description.
Navigate To Station V2- No description.
Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.
Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.
Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.
Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.
Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.
Drive To Station V2- No description.
Drive To Track mark List V2- No description.
Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.
Drive To Industry- Drive to a specific industry.
Change Destination Sign-Changes the destination signs of a train.

WaitFor- Pauses the driver's schedule for a set duration of time.
Wait For Random- TRS2008: Wait for specified or optionally random period of time.
Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).
WaitUntil- No description.

VR Set Train Lamps-Driver command that sets the train lamps.
Notify- Notifies the player of schedule progress/completion.
Reverse Tram- Reverse a tram(max 2 cars).
Couple- Couple train to designate vehicle.
Decouple- Decouples the train at the specified vehicle.
UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).
Halt Train- Brings the train to a complete stop.
Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.
Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger
station before using this command.
Cab: Wait-Maintains current control state until some condition is met.
Delete Train- Causes the train and its driver to be deleted from the session.
Hornz- Driver sounds the train horn.
Cab: Set Control-Sets a cab mode control.
Headlights On/Off-Allows the driver to to switch the headlights on and off.
Interior Lights Command- Driver command to switch interior lights on or off for the current train.
Set Max Speed To- No description.

Release Junction - Lets a driver release the junction they have been holding.
Move Turntable- TRS2008: Move turntable to a stop point .

Load- Loads the train's vehicles at the industry the driver is currently at with the train.
Unload- Unload train vehicles at current industry location.
Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.
Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.
Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.

'''Driver Command Check Rule:''' Verifies the driver commands of a driver character

'''Properties'''
Wait for driver character to have add driver, all, delete all
Trigger Rule once check
Driver character to watch the name driver

'''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar

'''Properties'''
The Driver Main Bar choice show/hide

'''Driver Schedule Rule''' Execution of basic scheduled commands

'''Properties:'''
Note: Only one of the fill-in can be
Driver Schedule Rule assigned to name driver
Commands insert driver commands in Drive Schedule
Classic style: If there is a schedule fill-in
Killer style: If there is a schedule fill-in
Cooperative style: If there is a schedule fill-in
Active style: Emit a new schedule, only fill-in

'''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders

'''Properties'''
Generate new Drivers for empty check
The following drivers will be available Driver's Name Add
Remove all existing Drivers first check

'''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers

'''Properties'''
Assign Driver commands check Driver Commands
Train criteria fill in all trains
Train criteria list train only trains matching criteria

'''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted

'''Properties'''
Config/txt file tag 'max_permitted_speed-60850 in mph or kph
Add to config.txt and kuid-table for value <KUID2:60850:88000:4
Note: Old root level config tag will

'''QuickDrive Rule:''' Change the Session settings and add consists in Driver

'''Properties'''
Set Time to insert time
QuickDrive Consist Option List by
Rate of Change insert rate as number times
Enable gameplay Session Mode check
Enable in game help by default check
Set the default Control method to fill-in choose: Easy Mode, Realistic Mode
Prevent player from changing this check
Realistic mode requires achievement add Achievement's Name
In Asset choose Auran achievements
Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic
Prevent player from changing 10.0 check
Set the default units to fill-in choose: Imperial, Metric, Default
Open QuickDriver Window when check

'''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train

'''Properties'''
Note: One or the other fill-ins must be
Accept trains matching specific criteria fill-in to select from session list
Accept all trains fill-in to set
Trigger rule once check to set
Wait for a driver character to get ? a click to select: On, Off

'''Wait for Driver/Train to be Locally Owned Rule:''' Waits for a specific driver or train car to be locally owned, Owned then executes child rules. If the driver/train car becomes unowned again the child rules are paused

'''Properties'''
Wait for ownership of a specific Driver fill-in to set
Wait for ownership of Driver fill-in to set
Note: One or the other fill-in must be
Driver or Vehicle click to choose from session lists

=='''Arrangement of Session Rules:'''==

'''Ordered List Rule:''' Child rules will be executed in order once this rule starts

'''Properties'''
Note: One of the two must be chosen
This process will repeat fill-in click to add number of repeats
This process will repeat forever fill-in

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

'''Properties'''
After last child run is executed click to choose: First child is chosen again, It will be
used for all successive runs, Successive runs will
do nothing

'''Random List Rule:''' One of the child rules indented under this rule will be randomly selected and executed

'''Properties'''
executed randomly
Once one of the child rule is ??

'''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle

'''Properties'''
None

'''Simultaneous List Rule:''' Child rules are executed simultaneously once this rule starts

'''Properties'''
Rules completes when click choose all rules have reached completed state,
was completed state

=='''Camera Rules:'''==

'''Cinematic Camera Rule:''' Provides several different cinematic style cameras

'''Properties'''
Lock camera controls for the duration check
Prevent rain control for duration check
Camera target: name any of the many objects in session
Camera mode: Stationary, Circle fill-in
Initial camera values: Pitch, Yaw, Zoom value
Total time to animate: seconds value

'''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties

'''Properties'''
Change the camera view mode to check to choose: Cab View, External View, Tracking
View, Free Roaming
Vehicle fill-in choose from session vehicles
Set the camera flags to enable/disable check to choose different properties from list
Junction fill-in choose from session junctions
Set the target objet of the camera to check
Map object fill-in choose from map objects

'''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view

'''Properties'''
Trigger rule once check to set
Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking
View, Free Roaming View
Wait for the camera to target vehicle ? click to choose form session list

=='''Message Rules:'''==

'''Close Message Popup Rule:''' Closes open message popups

'''Properties:'''
None

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

'''Custom Script Rule:'''

'''Properties'''
None.

'''Display Custom HUD Rule:''' Show or hide the Custom Heads Up Display.

'''Properties'''
Show the Custom Heads up Display- fill-in to choose.
Hide the Custom Heads up Display- fill-in to choose.
Note: One or the other will be chosen by default.

'''Wait for Click on HUD Icon Rule:'''

'''Properties'''
Trigger rule once-check to choose.
HUD Panel- click to choose from list.
Wait for click on- click to choose; choice depends on HUD Panel chosen.

'''Display HTML Pages Rule:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.

'''Properties'''
Add Page- click on to choose from list; click to Add Page Name or Remove.
Add All- click to add all files from the designated assets.
Delete All- delete all files from this property list.
Prevent user from exiting browser until all pages viewed- check to choose.
Disable closing of browser window by user- check to choose.
Disable browser window scrolling- check to choose.
Make browser window invisible- check to choose.
Set position-Under Construction!!!- check to choose.
Set size-Under Construction!!!- check to choose.
Use the page- click to choose Insert Page Name.
From asset HTML- click to choose from list.

'''Timed limited display HTML Rule:''' Displays an html browser window for a limited time.

'''Properties'''
HTML Asset Name-

'''Display Video Rule:''' Displays a page from a HTML assets in a browser window.

'''Properties'''

'''End Session Rule:''' End Session without saving.

'''Properties'''

'''Fade in/out Rule:''' Fade in or out within seconds, color and opacity considered.

'''Properties'''

'''Flash HUD Icon Rule:''' Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.

'''Properties'''

'''Generic Tree Node Debug Window Rule:''' No description.

'''Properties'''

'''InputTable Rule:''' Creating a list of message names to be used for various purposes.

'''Properties'''

'''Message Popup Rule:''' Displays a pop-up browser window and waits to be closed.

'''Properties'''
'''(Check Box) Pause game while message is displayed:''' - stops the game until this message is switched off
'''(Check Box) Close previous popup windows:''' - closes any Message Popups currently displayed
'''Message location: Top Left/Top Right/Bottom Left/Bottom Right''' - select one to position the browser window on the screen
'''Message Source: Custom text/A predefined HTML page (advanced)/A predefined string-table entry from a HTML asset (advanced)''' - select one

'''Message Source Option: Custom text'''
'''Icon: ''Click here to set''''' - shows a list of message icons. Select one to be displayed with the message
'''Icon: ''Clear icon''''' - clears any currently displayed message icon
'''Custom text:''' Enter text to be displayed. You will be limited to about 6 lines of text. For longer messages or to include graphics, use the '''A predefined HTML page''' option.

'''Message Source Option: A predefined HTML page'''
'''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.

'''Message Source Option: 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.

'''Minimap Options Rule:''' Sets the display options for the minimap.

'''Properties'''

'''Play Sound Rule:''' Plays a wav sound file.

'''Properties'''

'''Session Debug Rule Rule:''' Executes the first child if debug mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.

'''Properties'''

'''Session Metadata Rule:''' Sets session metadata in the config file. Info can be read by other systems and displayed to the player.

'''Properties'''

'''Set Helper Icon Size Rule:''' Sets the size of helper icons such as the junction lever arrows.

'''Properties'''

'''Set HTML Page Rule:''' Instructs the Display HTML Pages rule to perform specific operations

'''Properties'''

'''Show/Hide HUD Panel Rule:''' Shows or hides a HUD panel.

'''Properties'''

'''Show/Hide Layer Rule:''' Shows or hides a layer from Driver.

'''Properties:'''
'''Show/Hide''' - select one
'''click here to set''' - enter name of layer. Name is case sensitive.

'''Known Bugs:'''
TANE (all versions) - layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded

'''Show/Hide Minimap Rule:''' Shows the Driver the minimap window.

'''Properties'''
'''Minimap Window'''-click to choose Show,Hide

'''Show/hide on-screen help Rule:''' Shows or hides On-screen help in Driver.

'''Properties'''
'''Junction Overlays:''' - fill-in to choose: Show, Hide, Leave unchanged. by default one is chosen
'''On Screen Vehicle Name:''' - Fill-in to choose: Show, Hide, Leave unchanged. By default one is chosen

'''Wait for Click on HUD Icon Rule:''' Waits for a click on the HUD Icon.

'''Properties'''
'''Trigger Once:''' - Check to choose
'''HUD Panel:''' - Click to choose from list: Bottom Right Menu, Camera Controls, DCC Controls
'''Icon:''' - Choose from list. Selections depends on HUD Panel chosen

'''Wait on Waybill Screen/Main Screen Rule:''' Waits for the Waybill window to be opened.

'''Properties'''

=='''Startup Rules:'''==

'''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.

'''Properties'''

'''Startup Options Rule''' Specifies the starting options for the session.

'''Properties'''

=='''Time Rules:'''==

'''Clock Rule:''' Rule needed for animated clocks, you need to apply this rule to your session to make use of the animated clocks, see forum for code to include in you clock object to work with this rule.

'''Properties'''

'''Timecheck Rule:''' Executes child rules at a certain time.

'''Properties'''

'''Timing Check Rule:''' Triggers sub rules if called within the time window specified.

'''Properties'''

'''Wait Rule:''' Wait for number of seconds'

'''Properties'''

=='''Variable Rules:'''==

'''Variable Check Rule:''' If the specified variable matches the specified conditions then the child rules will be executed in order.

'''Properties'''
'''''<variable-name>''''' - enter a variable-name. Variable name is case sensitive.
'''''<test-condition>''''' - '''is less than/is less than or equal to/is equal to/is greater than or equal to/is greater than/is not equal to/is between x and y''' - select one
'''''This condition will be evaluated only once .../This condition will be evaluated once every second''''' - click to select one
'''Test condition option: is between x and y'''
Enter minimum (x) and maximum (y) test values

'''Test condition option: (all other options)'''
Enter test value

'''Evaluation option: 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

'''Evaluation option: This condition will be evaluated evaluated once every second''' - the rule will be run and the variable rechecked every second

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

'''Properties'''
'''Change: Add to variable/Subtract from variable/Change variable''' - select one
'''(optional check box) Set the minimum value''' of ''<variable-name>'' to ''<value>'' - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.
('''optional check box) Set the maximum value''' of ''<variable-name>'' to ''<value>'' - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.

'''Change option: 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.

'''Change option: 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 option: Change variable'''
'''Change variable ''<variable-name>'' to ''<value>''''' - enter variable-name, enter new value. This cannot be undone if the rule is stopped. Variable-name is case sensitive.

'''Variable Modify Continuous Rule:''' Adds, subtracts or sets a value to a specified variable every second.

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

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

'''Properties'''
'''Check box: Add'''
''<variable-name>'' - enter variable-name. 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. Variable-name is case sensitive.

Variables are saved in the session file and persist from one saved game to another.
They can be accessed/modified by the following '''driver commands''':

'''Driver Commands by trev999:'''
'''Set S-Variable driver command: '''
'''Skip if session-variable driver command: '''
'''Wait until S-variable driver command: '''

'''Driver Commands by atilabarut'''
'''ChangeSVariables driver command: '''
'''WaitUntilSVariable driver command: '''

=='''Weather Rules:'''==

'''EIRS Weather Rule NE USA Rule:''' Customize random weather rule relative to the North East Region of the United States.

'''Properties'''

'''Weather Rule:''' Set the weather conditions.

'''Properties'''

Session Rules By Categories With Properties

2017-09-26T18:42:06Z

Coop2:

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

=='''Achievement Rules'''==

'''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement

'''Properties:'''
None

'''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload

'''Properties:'''
Target object ?? name of object such as Power Station, Coal Pit or Portal
Lock train's controls checked during a stopped load/unload operation
Override 'begin load' and 'begin unload' checked # of seconds to override

'''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations

'''Properties:'''
Trigger click to choose from list
Add Industry click to add from session list
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list

'''Power Station Rule:''' Sets up Station and Consumers

'''Properties:'''
Power Station click to choose from session Stations
Consumers(Add Object) click to choose from session list

'''Resource Check Rule:''' Check the progress of the amount of a resource and target object

'''Properties:'''
Watch industry queue or Watch vehicle fill-in choose one or the other
Note: Both have: Target Object, Queue: click to choose
Complete when designated queue fill-in equals or exceeds required amount, falls below required amount

'''Multiple Resource Check Rule:''' If specified resources in a selected industry or vehicle reaches set levels, then the following child rules will be executed

'''Properties:'''
'''''Reach-Exceed/Fall below''''' - click to select one
'''Units:''' - enter required value
'''Product type:''' - select from session list of products
'''Object:''' - 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
Multiple objects and their queues can be added to the rule

'''Notes:'''
'''''Reach-Exceed''''' - sets an upper limit for the resource 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 resource 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.

'''Objective Add Rule:''' Sets up a game Objective with ID and display Name

'''Properties:'''
Priority click choose Above Normal, Below Normal, Normal, Optional, Urgent
Completion Target click to set target number
Icon click choose from list
Display Name click insert Name
Unique Objective ID click set ID
Custom Message insert typed message in text area

'''Objective Check Rule:''' Executes child rules when objective is complete

'''Properties:'''
Unique Objective ID click insert ID number
Mode click choose Wait for completion, Wait for failure, Wait for progress

'''Objective Update Rule:''' Changes progress outcome according to Property choices

'''Properties:'''
Unique Objective ID click to set ID number
Mode click Set objective as Decrement progress/Increment progress/Reset objective/Set objects as complete/Set objects as failed/Set progress/Set progress only if greater
Amount click insert number

'''Ranked Session Begin Rule:''' Begins a ranked Session

'''Properties:'''
Countdown requires a Starting Value insert hrs., min,sec
1 through 5 stars, points for each star insert number of points
Session timer mode fill-in chooses: Timer, Countdown, None

'''Ranked Session Complete Rule:''' Completes the active ranked Session

'''Properties:'''
Set the active ranked session as fill-in choose: Complete, Failed
Customize the completion message check insert text message

'''Session Complete Rule:''' Set session to a percentage of completion

'''Properties:'''
Set session to percent complete click to insert number in percent
Separate achievements for completion check

=='''Danger Rules'''==

'''ATP Speed Limiter Rule:''' Limits speed over set limit

'''Properties:'''
speed limit over the set limit mph

'''Speeding Check Rule:''' Checks to see if player controlled trains are over the local speed limit or over a set (custom) speed

'''Properties:'''
'''(Option button) Watch for trains travelling above the posted speed limit'''
'''''<speed value>''''' - click to enter a new overspeed tolerance value
'''''<units>''''' - '''Kmph/MPH/mps''' - click to select one
'''(Option button) Watch for trains travelling above a custom speed'''
'''''<speed value>''''' - click to enter a new custom speed value
'''''<units>''''' - '''Kmph/MPH/mps''' - click to select one
'''Warning: This option is very performance intensive and should only be used in sessions with few trains'''

'''AWS Configuration Rule:''' This rule configures the Trainz implementation of the Automatic Warning System when approaching signals

'''Properties:'''
Use modern sound set for unfitted cabs? check
Simulate AWS for unfitted cabs? check
Passive with HUD hidden fill-in
Active fill-in
Passive fill-in

'''Wait for Derailment Rule:''' Waits for a derailment to occur

'''Properties:'''
Trigger derailment watch once check to set

'''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars

'''Properties:'''
Set delay to clean up derailed train cars values

'''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule

'''Properties:'''
Respawn trains if they are abandoned check
Respawn trains fill-in choose: at their original locations, from portals from Session List

'''Coupler Breakage Check Rule:''' Checks for breaking couplers. No parameters.

'''Properties:'''
None

'''Coupler Breakage HUDRule:''' HUD displays warning about coupler stress and breakage

'''Properties:'''
Show the Coupler Breakage Display fill-in must choose one or the other
Hide the Coupler Breakage Display fill-in must choose one or the other

'''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles

'''Properties:'''
Add vehicle click to select from session list
Coupling Mask, Decoupling Mask : click to select: lock or unlock
Add All click to select all vehicle in session
Delete All click to delete all vehicle from list

'''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users

'''Properties:'''
Trigger only once check

'''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users

'''Properties:'''
Trigger only once check

'''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger

'''Properties:'''
Trigger only once check to set

'''Vehicle Physics Rule:''' Overrides the default vehicle physics properties

'''Properties:'''
Accept all trains fill-in
Cab sway level is set ? % click to insert percent of sway
Traction boost is % ? while sanding click to insert percent of boost
Tractions reduced to ? % while click to set traction percent
Maximum tractive effort adjusted by ? click to insert percent amount
Show coupler breakage in HUD Rule check to set
Couplers break when coupling above ? click to set speed
Accept trains matching specific criteria fill-in to insert specific trains
Couplers break at ? kN check to insert amount of force

=='''Navigation Rules'''==

'''DestSignTable Rule:''' Table for creating a table of destination signs

'''Properties:'''
Enable Track Marks as destinations check
Enable table of destinations check
Import destination from texture-group. name
Destination Name name
Enable industries/stations as check
Interlocking Tower Configure Path Alters settings on an interlocking tower path
Interlocking Tower choose Name and Objects
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
Show path activation message in Driver check

'''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train

'''Properties:'''
Interlocking Tower choose Names and Objects
Multiple Junction Alignment Check Checks multiple junctions are in alignment
Wait until the following junctions are choose all or anyone
Add junction click add junction from session list
Add all click add all junctions from session list
Delete all click deletes all junctions from rule list

'''Navigation Display Rule:''' Creates a set of navigation points. Multiple sets can be created by adding additional copies of this rule. This rule creates the navigation set, it does not display it. Use the '''Navigation set hide/show rule''' to make a set visible. Click the help icon at the top of the properties box for in game instructions.

'''Properties:'''
'''Unique set ID:''' - enter a unique name for the navigation set. Name must be in lowercase and have no spaces.
'''Train (optional):''' - select a rolling stock asset from the session list shown.
'''Navigation mode:''' select one
'''(Option button) 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.
'''(Option button) 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.
'''(Option button) 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 (a trigger, trackmark, track object or rolling stock asset) 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'':''' - select an icon for the navigation point.
'''''Style'': ''Automatic/Manual/Require Stop''''' - click to select one
'''''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'''.
This allows you to execute other rules (e.g. consist check, trigger 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.

'''Navigation Point Complete Rule:''' Marks a navigation point complete

'''Properties:'''
Mark navigation point click set index number
Complete in set click to set ID

'''Navigation Set Check Rule:''' Checks if a navigation point is complete/incomplete

'''Properties:'''
Checks if navigation point is set click set ID
Is click Complete, Incomplete
Navigation Set Clear Clears a navigation point set
Clear the navigation point set click to set ID
Navigation Set Hide/Show Show or hide navigation point set
The navigation point click hide, show
Navigation point set click to set ID

'''Navigation Set Clear Rule:''' Clears a navigation set removing any uncompleted navigation points

'''Properties:'''
'''''Click here to set'':''' - enter the unique name for the navigation set created using the '''Navigation set display rule'''.
Name must be in lowercase and have no spaces. The rule will NOT check to see if the named navigation set exists or not.

'''Navigation Set Hide/Show:''' Shows and hides navigation sets. You can have multiple sets visible at the same time.

'''Properties:'''
'''''Hide/Show'':''' - click to select one
'''''click here to set'':''' - enter the unique name for the navigation set created using the '''Navigation set display rule'''.
Name must be in lowercase and have no spaces. The rule will NOT check to see if the named navigation set exists or not.

'''Schedule Rule:''' Allows a schedule of timed events to be applied to a train

'''Properties:'''
Insert track mark click to select from session list
Note: Both has an arrival and departure set time hr:min:sec
Current Train click to select from session list
Insert destination click to select from session list

'''Set Junctions Rule:''' Sets the selected junctions to a specific state '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''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:-
'''''Setting'': Left/Center/Right/Don't change''' - click one to set the junction direction
'''''Locked'': Locked/Unlocked''' - click to select one. '''Locked''' means the junction setting cannot be changed by the user
'''''Allows AI control/Blocks AI control''''' - click to select one.
'''''Remove''''' - click to remove that junction from the rule list

'''Set Signal Extended Rule:''' Sets the state of a selected signal '''''Warning:'' not compatible with Interlocking Tower Assets'''

'''Properties:'''
'''''Select signal''''' - click to select a signal from the session list
'''''<signal state>''''' - click to select a state from the list

'''Trigger Check Rule:''' Waits for any train to enter one of the designated triggers. This rule replaces the older and less versatile "Trigger Rule".

'''Properties:'''
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list
Add Trigger click to choose from session list
Trigger only once check to set
Wait for child rules to complete even if check to set
Only activate when the entering click to choose forward, backward

'''Wait on Navigation Point Rule:''' Waits for a navigation point to be completed then the following child rules will be executed

'''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 set display rule'''.
Name must be in lowercase and have no spaces. The rule will NOT check to see if the named navigation set and point exists or not.

'''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start

'''Properties:'''
Accept all trains fill-in to set
Accept trains matching specific criteria fill-in to set and choose from session list
Wait for a train that matches the click to choose: start moving, stop moving
Trigger rule once check to set
Note: One or the other fill-ins must be

=='''Driver Rules'''==

'''Control Type Rule''' Sets control type

'''Properties:'''
Current control method is: Easy Mode, Choice one of the three

'''Control Check Rule:''' Activates child rules based on the control method changes

'''Properties:'''
Excite child rules when: DCC mode is fill-in one or the other
Excite child rules: Every time control fill-in one or the other

'''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule

'''Properties:'''
Trigger add Trigger
Portal index from PCP value
Use UnPortal yes/no
Delay from Trigger to Emit: seconds value

'''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry

'''Properties:'''
Apply to every vehicle in the session fill-in
Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles
Note: One of the Applies will always be
Load/Unload for industry Disable/Enable choose Industry

'''Driver Command Rule:''' Specify which commands will be available for the drivers

'''Properties''':
Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.
Navigate To TrackMarkList V2- No description.
Navigate To Station V2- No description.
Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.
Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.
Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.
Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.
Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.
Drive To Station V2- No description.
Drive To Track mark List V2- No description.
Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.
Drive To Industry- Drive to a specific industry.
Change Destination Sign-Changes the destination signs of a train.

WaitFor- Pauses the driver's schedule for a set duration of time.
Wait For Random- TRS2008: Wait for specified or optionally random period of time.
Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).
WaitUntil- No description.

VR Set Train Lamps-Driver command that sets the train lamps.
Notify- Notifies the player of schedule progress/completion.
Reverse Tram- Reverse a tram(max 2 cars).
Couple- Couple train to designate vehicle.
Decouple- Decouples the train at the specified vehicle.
UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).
Halt Train- Brings the train to a complete stop.
Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.
Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger
station before using this command.
Cab: Wait-Maintains current control state until some condition is met.
Delete Train- Causes the train and its driver to be deleted from the session.
Hornz- Driver sounds the train horn.
Cab: Set Control-Sets a cab mode control.
Headlights On/Off-Allows the driver to to switch the headlights on and off.
Interior Lights Command- Driver command to switch interior lights on or off for the current train.
Set Max Speed To- No description.

Release Junction - Lets a driver release the junction they have been holding.
Move Turntable- TRS2008: Move turntable to a stop point .

Load- Loads the train's vehicles at the industry the driver is currently at with the train.
Unload- Unload train vehicles at current industry location.
Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.
Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.
Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.

'''Driver Command Check Rule:''' Verifies the driver commands of a driver character

'''Properties'''
Wait for driver character to have add driver, all, delete all
Trigger Rule once check
Driver character to watch the name driver

'''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar

'''Properties'''
The Driver Main Bar choice show/hide

'''Driver Schedule Rule''' Execution of basic scheduled commands

'''Properties:'''
Note: Only one of the fill-in can be
Driver Schedule Rule assigned to name driver
Commands insert driver commands in Drive Schedule
Classic style: If there is a schedule fill-in
Killer style: If there is a schedule fill-in
Cooperative style: If there is a schedule fill-in
Active style: Emit a new schedule, only fill-in

'''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders

'''Properties'''
Generate new Drivers for empty check
The following drivers will be available Driver's Name Add
Remove all existing Drivers first check

'''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers

'''Properties'''
Assign Driver commands check Driver Commands
Train criteria fill in all trains
Train criteria list train only trains matching criteria

'''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted

'''Properties'''
Config/txt file tag 'max_permitted_speed-60850 in mph or kph
Add to config.txt and kuid-table for value <KUID2:60850:88000:4
Note: Old root level config tag will

'''QuickDrive Rule:''' Change the Session settings and add consists in Driver

'''Properties'''
Set Time to insert time
QuickDrive Consist Option List by
Rate of Change insert rate as number times
Enable gameplay Session Mode check
Enable in game help by default check
Set the default Control method to fill-in choose: Easy Mode, Realistic Mode
Prevent player from changing this check
Realistic mode requires achievement add Achievement's Name
In Asset choose Auran achievements
Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic
Prevent player from changing 10.0 check
Set the default units to fill-in choose: Imperial, Metric, Default
Open QuickDriver Window when check

'''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train

'''Properties'''
Note: One or the other fill-ins must be
Accept trains matching specific criteria fill-in to select from session list
Accept all trains fill-in to set
Trigger rule once check to set
Wait for a driver character to get ? a click to select: On, Off

'''Wait for Driver/Train to be Locally Owned Rule:''' Waits for a specific driver or train car to be locally owned, Owned then executes child rules. If the driver/train car becomes unowned again the child rules are paused

'''Properties'''
Wait for ownership of a specific Driver fill-in to set
Wait for ownership of Driver fill-in to set
Note: One or the other fill-in must be
Driver or Vehicle click to choose from session lists

=='''Arrangement of Session Rules:'''==

'''Ordered List Rule:''' Child rules will be executed in order once this rule starts

'''Properties'''
Note: One of the two must be chosen
This process will repeat fill-in click to add number of repeats
This process will repeat forever fill-in

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

'''Properties'''
After last child run is executed click to choose: First child is chosen again, It will be
used for all successive runs, Successive runs will
do nothing

'''Random List Rule:''' One of the child rules indented under this rule will be randomly selected and executed

'''Properties'''
executed randomly
Once one of the child rule is ??

'''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle

'''Properties'''
None

'''Simultaneous List Rule:''' Child rules are executed simultaneously once this rule starts

'''Properties'''
Rules completes when click choose all rules have reached completed state,
was completed state

=='''Camera Rules:'''==

'''Cinematic Camera Rule:''' Provides several different cinematic style cameras

'''Properties'''
Lock camera controls for the duration check
Prevent rain control for duration check
Camera target: name any of the many objects in session
Camera mode: Stationary, Circle fill-in
Initial camera values: Pitch, Yaw, Zoom value
Total time to animate: seconds value

'''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties

'''Properties'''
Change the camera view mode to check to choose: Cab View, External View, Tracking
View, Free Roaming
Vehicle fill-in choose from session vehicles
Set the camera flags to enable/disable check to choose different properties from list
Junction fill-in choose from session junctions
Set the target objet of the camera to check
Map object fill-in choose from map objects

'''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view

'''Properties'''
Trigger rule once check to set
Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking
View, Free Roaming View
Wait for the camera to target vehicle ? click to choose form session list

=='''Message Rules:'''==

'''Close Message Popup Rule:''' Closes open message popups

'''Properties:'''
None

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

'''Custom Script Rule:'''

'''Properties'''
None.

'''Display Custom HUD Rule:''' Show or hide the Custom Heads Up Display.

'''Properties'''
Show the Custom Heads up Display- fill-in to choose.
Hide the Custom Heads up Display- fill-in to choose.
Note: One or the other will be chosen by default.

'''Wait for Click on HUD Icon Rule:'''

'''Properties'''
Trigger rule once-check to choose.
HUD Panel- click to choose from list.
Wait for click on- click to choose; choice depends on HUD Panel chosen.

'''Display HTML Pages Rule:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.

'''Properties'''
Add Page- click on to choose from list; click to Add Page Name or Remove.
Add All- click to add all files from the designated assets.
Delete All- delete all files from this property list.
Prevent user from exiting browser until all pages viewed- check to choose.
Disable closing of browser window by user- check to choose.
Disable browser window scrolling- check to choose.
Make browser window invisible- check to choose.
Set position-Under Construction!!!- check to choose.
Set size-Under Construction!!!- check to choose.
Use the page- click to choose Insert Page Name.
From asset HTML- click to choose from list.

'''Timed limited display HTML Rule:''' Displays an html browser window for a limited time.

'''Properties'''
HTML Asset Name-

'''Display Video Rule:''' Displays a page from a HTML assets in a browser window.

'''Properties'''

'''End Session Rule:''' End Session without saving.

'''Properties'''

'''Fade in/out Rule:''' Fade in or out within seconds, color and opacity considered.

'''Properties'''

'''Flash HUD Icon Rule:''' Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.

'''Properties'''

'''Generic Tree Node Debug Window Rule:''' No description.

'''Properties'''

'''InputTable Rule:''' Creating a list of message names to be used for various purposes.

'''Properties'''

'''Message Popup Rule:''' Displays a pop-up browser window and waits to be closed.

'''Properties'''
'''(Check Box) Pause game while message is displayed:''' - stops the game until this message is switched off
'''(Check Box) Close previous popup windows:''' - closes any Message Popups currently displayed
'''Message location: Top Left/Top Right/Bottom Left/Bottom Right''' - select one to position the browser window on the screen
'''Message Source: Custom text/A predefined HTML page (advanced)/A predefined string-table entry from a HTML asset (advanced)''' - select one

'''Message Source Option: Custom text'''
'''Icon: ''Click here to set''''' - shows a list of message icons. Select one to be displayed with the message
'''Icon: ''Clear icon''''' - clears any currently displayed message icon
'''Custom text:''' Enter text to be displayed. You will be limited to about 6 lines of text. For longer messages or to include graphics, use the '''A predefined HTML page''' option.

'''Message Source Option: A predefined HTML page'''
'''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.

'''Message Source Option: 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.

'''Minimap Options Rule:''' Sets the display options for the minimap.

'''Properties'''

'''Play Sound Rule:''' Plays a wav sound file.

'''Properties'''

'''Session Debug Rule Rule:''' Executes the first child if debug mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.

'''Properties'''

'''Session Metadata Rule:''' Sets session metadata in the config file. Info can be read by other systems and displayed to the player.

'''Properties'''

'''Set Helper Icon Size Rule:''' Sets the size of helper icons such as the junction lever arrows.

'''Properties'''

'''Set HTML Page Rule:''' Instructs the Display HTML Pages rule to perform specific operations

'''Properties'''

'''Show/Hide HUD Panel Rule:''' Shows or hides a HUD panel.

'''Properties'''

'''Show/Hide Layer Rule:''' Shows or hides a layer from Driver.

'''Properties:'''
'''Show/Hide''' - select one
'''click here to set''' - enter name of layer. Name is case sensitive.

'''Known Bugs:'''
TANE (all versions) - layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded

'''Show/Hide Minimap Rule:''' Shows the Driver the minimap window.

'''Properties'''
'''Minimap Window'''-click to choose Show,Hide

'''Show/hide on-screen help Rule:''' Shows or hides On-screen help in Driver.

'''Properties'''
'''Junction Overlays:''' - fill-in to choose: Show, Hide, Leave unchanged. by default one is chosen
'''On Screen Vehicle Name:''' - Fill-in to choose: Show, Hide, Leave unchanged. By default one is chosen

'''Wait for Click on HUD Icon Rule:''' Waits for a click on the HUD Icon.

'''Properties'''
'''Trigger Once:''' - Check to choose
'''HUD Panel:''' - Click to choose from list: Bottom Right Menu, Camera Controls, DCC Controls
'''Icon:''' - Choose from list. Selections depends on HUD Panel chosen

'''Wait on Waybill Screen/Main Screen Rule:''' Waits for the Waybill window to be opened.

'''Properties'''

=='''Startup Rules:'''==

'''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.

'''Properties'''

'''Startup Options Rule''' Specifies the starting options for the session.

'''Properties'''

=='''Time Rules:'''==

'''Clock Rule:''' Rule needed for animated clocks, you need to apply this rule to your session to make use of the animated clocks, see forum for code to include in you clock object to work with this rule.

'''Properties'''

'''Timecheck Rule:''' Executes child rules at a certain time.

'''Properties'''

'''Timing Check Rule:''' Triggers sub rules if called within the time window specified.

'''Properties'''

'''Wait Rule:''' Wait for number of seconds'

'''Properties'''

=='''Variable Rules:'''==

'''Variable Check Rule:''' If the specified variable matches the specified conditions then the child rules will be executed in order.

'''Properties'''
'''''<variable-name>''''' - enter a variable-name. Variable name is case sensitive.
'''''<test-condition>''''' - '''is less than/is less than or equal to/is equal to/is greater than or equal to/is greater than/is not equal to/is between x and y''' - select one
'''''This condition will be evaluated only once .../This condition will be evaluated once every second''''' - click to select one
'''Test condition option: is between x and y'''
Enter minimum (x) and maximum (y) test values

'''Test condition option: (all other options)'''
Enter test value

'''Evaluation option: 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

'''Evaluation option: This condition will be evaluated evaluated once every second''' - the rule will be run and the variable rechecked every second

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

'''Properties'''
'''Change: Add to variable/Subtract from variable/Change variable''' - select one
'''(optional check box) Set the minimum value''' of ''<variable-name>'' to ''<value>'' - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.
('''optional check box) Set the maximum value''' of ''<variable-name>'' to ''<value>'' - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.

'''Change option: 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.

'''Change option: 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 option: Change variable'''
'''Change variable ''<variable-name>'' to ''<value>''''' - enter variable-name, enter new value. This cannot be undone if the rule is stopped. Variable-name is case sensitive.

'''Variable Modify Continuous Rule:''' Adds, subtracts or sets a value to a specified variable every second.

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

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

'''Properties'''
'''Check box: Add'''
''<variable-name>'' - enter variable-name. 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. Variable-name is case sensitive.

Variables are saved in the session file and persist from one saved game to another.
They can be accessed/modified by the following '''driver commands''':

'''Driver Commands by trev999:'''
'''Set S-Variable driver command: '''
'''Skip if session-variable driver command: '''
'''Wait until S-variable driver command: '''

'''Driver Commands by atilabarut'''
'''ChangeSVariables driver command: '''
'''WaitUntilSVariable driver command: '''

=='''Weather Rules:'''==

'''EIRS Weather Rule NE USA Rule:''' Customize random weather rule relative to the North East Region of the United States.

'''Properties'''

'''Weather Rule:''' Set the weather conditions.

'''Properties'''

Session Rules By Categories With Properties

2017-09-24T22:01:47Z

Coop2:

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

=='''Achievement Rules'''==

'''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement

'''Properties:'''
None

'''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload

'''Properties:'''
Target object ?? name of object such as Power Station, Coal Pit or Portal
Lock train's controls checked during a stopped load/unload operation
Override 'begin load' and 'begin unload' checked # of seconds to override

'''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations

'''Properties:'''
Trigger click to choose from list
Add Industry click to add from session list
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list

'''Power Station Rule:''' Sets up Station and Consumers

'''Properties:'''
Power Station click to choose from session Stations
Consumers(Add Object) click to choose from session list

'''Resource Check Rule:''' Check the progress of the amount of a resource and target object

'''Properties:'''
Watch industry queue or Watch vehicle fill-in choose one or the other
Note: Both have: Target Object, Queue: click to choose
Complete when designated queue fill-in equals or exceeds required amount, falls below required amount

'''Multiple Resource Check Rule:''' If specified resources in a selected industry or vehicle reaches set levels, then the following child rules will be executed

'''Properties:'''
Test: '''Reach-Exceed/Fall below''' - select one
Units: - enter required value
Product type: - select from list of products
Object: - select session active industry or product enabled rail vehicle
Queue: - select product queue
Remove: - removes the object and its product queue from the rule
Multiple objects and their queues can be added to the rule

'''Test options: Reach-Exceed''' - sets an upper limit for the resource 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 level.

'''Test options: Fall below''' - sets a lower limit for the resource 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 level. This rule cannot be used to detect when a resource level reaches zero (i.e. is empty)
by setting the "Fall below" to zero as a resource level can never fall below zero. Instead set the "Fall below" level to a very low value.

'''Objective Add Rule:''' Sets up a game Objective with ID and display Name

'''Properties:'''
Priority click choose Above Normal, Below Normal, Normal, Optional, Urgent
Completion Target click to set target number
Icon click choose from list
Display Name click insert Name
Unique Objective ID click set ID
Custom Message insert typed message in text area

'''Objective Check Rule:''' Executes child rules when objective is complete

'''Properties:'''
Unique Objective ID click insert ID number
Mode click choose Wait for completion, Wait for failure, Wait for progress

'''Objective Update Rule:''' Changes progress outcome according to Property choices

'''Properties:'''
Unique Objective ID click to set ID number
Mode click Set objective as Decrement progress/Increment progress/Reset objective/Set objects as complete/Set objects as failed/Set progress/Set progress only if greater
Amount click insert number

'''Ranked Session Begin Rule:''' Begins a ranked Session

'''Properties:'''
Countdown requires a Starting Value insert hrs., min,sec
1 through 5 stars, points for each star insert number of points
Session timer mode fill-in chooses: Timer, Countdown, None

'''Ranked Session Complete Rule:''' Completes the active ranked Session

'''Properties:'''
Set the active ranked session as fill-in choose: Complete, Failed
Customize the completion message check insert text message

'''Session Complete Rule:''' Set session to a percentage of completion

'''Properties:'''
Set session to percent complete click to insert number in percent
Separate achievements for completion check

=='''Danger Rules'''==

'''ATP Speed Limiter Rule:''' Limits speed over set limit

'''Properties:'''
speed limit over the set limit mph

'''Speeding Check Rule:''' Checks to see if player control trains are over the speed

'''Properties:'''
Watch for trains travelling above the fill-in
Allow an over speed tolerance of click to insert mph over posted limit
Watch for trains travelling above a fill-in to insert custom speed limit
Warning: This method is very

'''AWS Configuration Rule:''' This rule configures the Trainz implementation of the Automatic Warning System when approaching signals

'''Properties:'''
Use modern sound set for unfitted cabs? check
Simulate AWS for unfitted cabs? check
Passive with HUD hidden fill-in
Active fill-in
Passive fill-in

'''Wait for Derailment Rule:''' Waits for a derailment to occur

'''Properties:'''
Trigger derailment watch once check to set

'''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars

'''Properties:'''
Set delay to clean up derailed train cars values

'''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule

'''Properties:'''
Respawn trains if they are abandoned check
Respawn trains fill-in choose: at their original locations, from portals from Session List

'''Coupler Breakage Check Rule:''' Checks for breaking couplers. No parameters.

'''Properties:'''
None

'''Coupler Breakage HUDRule:''' HUD displays warning about coupler stress and breakage

'''Properties:'''
Show the Coupler Breakage Display fill-in must choose one or the other
Hide the Coupler Breakage Display fill-in must choose one or the other

'''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles

'''Properties:'''
Add vehicle click to select from session list
Coupling Mask, Decoupling Mask : click to select: lock or unlock
Add All click to select all vehicle in session
Delete All click to delete all vehicle from list

'''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users

'''Properties:'''
Trigger only once check

'''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users

'''Properties:'''
Trigger only once check

'''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger

'''Properties:'''
Trigger only once check to set

'''Vehicle Physics Rule:''' Overrides the default vehicle physics properties

'''Properties:'''
Accept all trains fill-in
Cab sway level is set ? % click to insert percent of sway
Traction boost is % ? while sanding click to insert percent of boost
Tractions reduced to ? % while click to set traction percent
Maximum tractive effort adjusted by ? click to insert percent amount
Show coupler breakage in HUD Rule check to set
Couplers break when coupling above ? click to set speed
Accept trains matching specific criteria fill-in to insert specific trains
Couplers break at ? kN check to insert amount of force

=='''Navigation Rules'''==

'''DestSignTable Rule:''' Table for creating a table of destination signs

'''Properties:'''
Enable Track Marks as destinations check
Enable table of destinations check
Import destination from texture-group. name
Destination Name name
Enable industries/stations as check
Interlocking Tower Configure Path Alters settings on an interlocking tower path
Interlocking Tower choose Name and Objects
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
Show path activation message in Driver check

'''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train

'''Properties:'''
Interlocking Tower choose Names and Objects
Multiple Junction Alignment Check Checks multiple junctions are in alignment
Wait until the following junctions are choose all or anyone
Add junction click add junction from session list
Add all click add all junctions from session list
Delete all click deletes all junctions from rule list

'''Navigation Display Rule:''' Creates a set of navigation points. Multiple sets can be created by adding additional copies of this rule. This rule creates the navigation set, it does not display it. Use the '''Navigation set hide/show rule''' to make a set visible. Click the help icon at the top of the properties box for in game instructions.

'''Properties:'''
'''Unique set ID:''' - enter a unique name for the navigation set. Name must be in lowercase and have no spaces.
'''Train (optional):''' - select a rolling stock asset from the session list shown.
'''Navigation mode:''' '''All points must be completed in sequence/Points will be completed in sequence, but can be skipped/All points must be completed, but in any order''' - choose one
For each navigation point:
'''Click here to set:''' - select an item (a trigger, trackmark, track object or rolling stock asset) from the session list to attach the navigation point to.
'''Display text:''' - enter text message to display with the navigation point icon. You are limited to 25 characters.
'''Icon:''' - select an icon for the navigation point from a very limited range
'''Style:''' '''Automatic/Manual/Require Stop''' - select one

'''Navigation mode options:'''
'''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.

'''Style options:'''
'''Automatic:''' - the navigation point will be completed as soon as the consist reaches it.
'''Manual:''' - the navigation point must be set as complete by using the '''Navigation point complete rule'''.
This allows you to execute other rules (e.g. consist check, trigger check, wait, etc) before completing the navigation point.
'''Require stop:''' - the navigation point will not be completed until the consist comes to a complete stop.

'''Navigation Point Complete Rule:''' Marks a navigation point complete

'''Properties:'''
Mark navigation point click set index number
Complete in set click to set ID

'''Navigation Set Check Rule:''' Checks if a navigation point is complete/incomplete

'''Properties:'''
Checks if navigation point is set click set ID
Is click Complete, Incomplete
Navigation Set Clear Clears a navigation point set
Clear the navigation point set click to set ID
Navigation Set Hide/Show Show or hide navigation point set
The navigation point click hide, show
Navigation point set click to set ID

'''Navigation Set Hide/Show:''' Shows and hides navigation sets. You can have multiple sets visible at the same time.

'''Properties:'''
'''Hide/Show:''' - select one
'''"click here to set":''' - enter the unique name for the navigation set created using the '''Navigation set display rule'''.
Name must be in lowercase and have no spaces. The rule will NOT check to see if the named navigation set exists or not.

'''Schedule Rule:''' Allows a schedule of timed events to be applied to a train

'''Properties:'''
Insert track mark click to select from session list
Note: Both has an arrival and departure set time hr:min:sec
Current Train click to select from session list
Insert destination click to select from session list

'''Set Junctions Rule:''' Sets the selected junctions to a specific state ''Warning: not compatible with Interlocking Tower Assets''

'''Properties:'''
Add Junction click to select session junction list
Add All click
Delete All click

'''Set Signal Extended Rule:''' Sets the state of a selected signal ''Warning: not compatible with Interlocking Tower Assets''

'''Properties:'''
Set signal click to select from session list
State ' to select state from list

'''Trigger Check Rule:''' Waits for any train to enter one of the designated triggers. This rule replaces the older and less versatile "Trigger Rule".

'''Properties:'''
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list
Add Trigger click to choose from session list
Trigger only once check to set
Wait for child rules to complete even if check to set
Only activate when the entering click to choose forward, backward

'''Wait on Navigation Point Rule:''' Waits for a navigation point to be completed then the following child rules will be executed

'''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 set display rule'''.
Name must be in lowercase and have no spaces. The rule will NOT check to see if the named navigation set and point exists or not.

'''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start

'''Properties:'''
Accept all trains fill-in to set
Accept trains matching specific criteria fill-in to set and choose from session list
Wait for a train that matches the click to choose: start moving, stop moving
Trigger rule once check to set
Note: One or the other fill-ins must be

=='''Driver Rules'''==

'''Control Type Rule''' Sets control type

'''Properties:'''
Current control method is: Easy Mode, Choice one of the three

'''Control Check Rule:''' Activates child rules based on the control method changes

'''Properties:'''
Excite child rules when: DCC mode is fill-in one or the other
Excite child rules: Every time control fill-in one or the other

'''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule

'''Properties:'''
Trigger add Trigger
Portal index from PCP value
Use UnPortal yes/no
Delay from Trigger to Emit: seconds value

'''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry

'''Properties:'''
Apply to every vehicle in the session fill-in
Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles
Note: One of the Applies will always be
Load/Unload for industry Disable/Enable choose Industry

'''Driver Command Rule:''' Specify which commands will be available for the drivers

'''Properties''':
Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.
Navigate To TrackMarkList V2- No description.
Navigate To Station V2- No description.
Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.
Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.
Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.
Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.
Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.
Drive To Station V2- No description.
Drive To Track mark List V2- No description.
Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.
Drive To Industry- Drive to a specific industry.
Change Destination Sign-Changes the destination signs of a train.

WaitFor- Pauses the driver's schedule for a set duration of time.
Wait For Random- TRS2008: Wait for specified or optionally random period of time.
Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).
WaitUntil- No description.

VR Set Train Lamps-Driver command that sets the train lamps.
Notify- Notifies the player of schedule progress/completion.
Reverse Tram- Reverse a tram(max 2 cars).
Couple- Couple train to designate vehicle.
Decouple- Decouples the train at the specified vehicle.
UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).
Halt Train- Brings the train to a complete stop.
Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.
Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger
station before using this command.
Cab: Wait-Maintains current control state until some condition is met.
Delete Train- Causes the train and its driver to be deleted from the session.
Hornz- Driver sounds the train horn.
Cab: Set Control-Sets a cab mode control.
Headlights On/Off-Allows the driver to to switch the headlights on and off.
Interior Lights Command- Driver command to switch interior lights on or off for the current train.
Set Max Speed To- No description.

Release Junction - Lets a driver release the junction they have been holding.
Move Turntable- TRS2008: Move turntable to a stop point .

Load- Loads the train's vehicles at the industry the driver is currently at with the train.
Unload- Unload train vehicles at current industry location.
Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.
Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.
Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.

'''Driver Command Check Rule:''' Verifies the driver commands of a driver character

'''Properties'''
Wait for driver character to have add driver, all, delete all
Trigger Rule once check
Driver character to watch the name driver

'''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar

'''Properties'''
The Driver Main Bar choice show/hide

'''Driver Schedule Rule''' Execution of basic scheduled commands

'''Properties:'''
Note: Only one of the fill-in can be
Driver Schedule Rule assigned to name driver
Commands insert driver commands in Drive Schedule
Classic style: If there is a schedule fill-in
Killer style: If there is a schedule fill-in
Cooperative style: If there is a schedule fill-in
Active style: Emit a new schedule, only fill-in

'''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders

'''Properties'''
Generate new Drivers for empty check
The following drivers will be available Driver's Name Add
Remove all existing Drivers first check

'''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers

'''Properties'''
Assign Driver commands check Driver Commands
Train criteria fill in all trains
Train criteria list train only trains matching criteria

'''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted

'''Properties'''
Config/txt file tag 'max_permitted_speed-60850 in mph or kph
Add to config.txt and kuid-table for value <KUID2:60850:88000:4
Note: Old root level config tag will

'''QuickDrive Rule:''' Change the Session settings and add consists in Driver

'''Properties'''
Set Time to insert time
QuickDrive Consist Option List by
Rate of Change insert rate as number times
Enable gameplay Session Mode check
Enable in game help by default check
Set the default Control method to fill-in choose: Easy Mode, Realistic Mode
Prevent player from changing this check
Realistic mode requires achievement add Achievement's Name
In Asset choose Auran achievements
Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic
Prevent player from changing 10.0 check
Set the default units to fill-in choose: Imperial, Metric, Default
Open QuickDriver Window when check

'''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train

'''Properties'''
Note: One or the other fill-ins must be
Accept trains matching specific criteria fill-in to select from session list
Accept all trains fill-in to set
Trigger rule once check to set
Wait for a driver character to get ? a click to select: On, Off

'''Wait for Driver/Train to be Locally Owned Rule:''' Waits for a specific driver or train car to be locally owned, Owned then executes child rules. If the driver/train car becomes unowned again the child rules are paused

'''Properties'''
Wait for ownership of a specific Driver fill-in to set
Wait for ownership of Driver fill-in to set
Note: One or the other fill-in must be
Driver or Vehicle click to choose from session lists

=='''Arrangement of Session Rules:'''==

'''Ordered List Rule:''' Child rules will be executed in order once this rule starts

'''Properties'''
Note: One of the two must be chosen
This process will repeat fill-in click to add number of repeats
This process will repeat forever fill-in

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

'''Properties'''
After last child run is executed click to choose: First child is chosen again, It will be
used for all successive runs, Successive runs will
do nothing

'''Random List Rule:''' One of the child rules indented under this rule will be randomly selected and executed

'''Properties'''
executed randomly
Once one of the child rule is ??

'''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle

'''Properties'''
None

'''Simultaneous List Rule:''' Child rules are executed simultaneously once this rule starts

'''Properties'''
Rules completes when click choose all rules have reached completed state,
was completed state

=='''Camera Rules:'''==

'''Cinematic Camera Rule:''' Provides several different cinematic style cameras

'''Properties'''
Lock camera controls for the duration check
Prevent rain control for duration check
Camera target: name any of the many objects in session
Camera mode: Stationary, Circle fill-in
Initial camera values: Pitch, Yaw, Zoom value
Total time to animate: seconds value

'''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties

'''Properties'''
Change the camera view mode to check to choose: Cab View, External View, Tracking
View, Free Roaming
Vehicle fill-in choose from session vehicles
Set the camera flags to enable/disable check to choose different properties from list
Junction fill-in choose from session junctions
Set the target objet of the camera to check
Map object fill-in choose from map objects

'''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view

'''Properties'''
Trigger rule once check to set
Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking
View, Free Roaming View
Wait for the camera to target vehicle ? click to choose form session list

=='''Message Rules:'''==

'''Close Message Popup Rule:'''

'''Properties:'''
None

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

'''Custom Script Rule'''

'''Properties'''

'''Custom scripted Rule. No Parameters'''

'''Properties'''

'''Display Custom HUD Rule:''' Show or hide the Custom Heads Up Display.

'''Properties'''

'''Wait for Click on HUD Icon Rule:'''

'''Properties'''

'''Display HTML Pages Rule:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.

'''Properties'''

'''Timed limited display HTML Rule:''' Displays an html browser window for a limited time.

'''Properties'''

'''Display Video Rule:''' Displays a page from a HTML assets in a browser window.

'''Properties'''

'''End Session Rule:''' End Session without saving.

'''Properties'''

'''Fade in/out Rule:''' Fade in or out within seconds, color and opacity considered.

'''Properties'''

'''Flash HUD Icon Rule:''' Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.

'''Properties'''

'''Generic Tree Node Debug Window Rule:''' No description.

'''Properties'''

'''InputTable Rule:''' Creating a list of message names to be used for various purposes.

'''Properties'''

'''Message Popup Rule:''' Displays a pop-up browser window and waits to be closed.

'''Properties'''
(Check Box) Pause game while message is displayed: - stops the game until this message is switched off
(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
Message Source: '''Custom text/A predefined HTML page (advanced)/A predefined string-table entry from a HTML asset (advanced)''' - select one

'''Message Source Option: Custom text'''
Icon: '''Click here to set''' - shows a list of message icons. Select one to be displayed with the message
Icon: '''Clear icon''' - clears any currently displayed message icon
Custom text: Enter text to be displayed. You will be limited to about 6 lines of text. For longer messages or to include graphics, use the '''A predefined HTML page''' option.

'''Message Source Option: A predefined HTML page'''
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.
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.

'''Message Source Option: 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: -
HTML Wave: - (optional) select the name of the HTML file containing the wave file to be played.
Wave Name: - (optional) enter the name of a wave (.wav) sound file to be played. The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension ".wav" is optional.
(Check Box) Autoplay Wave: - plays the .wav sound file as soon as message is displayed. If unchecked sound will not be played.

'''Minimap Options Rule:''' Sets the display options for the minimap.

'''Properties'''

'''Play Sound Rule:''' Plays a wav sound file.

'''Properties'''

'''Session Debug Rule Rule:''' Executes the first child if debug mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.

'''Properties'''

'''Session Metadata Rule:''' Sets session metadata in the config file. Info can be read by other systems and displayed to the player.

'''Properties'''

'''Set Helper Icon Size Rule:''' Sets the size of helper icons such as the junction lever arrows.

'''Properties'''

'''Set HTML Page Rule:''' Instructs the Display HTML Pages rule to perform specific operations

'''Properties'''

'''Show/Hide HUD Panel Rule:''' Shows or hides a HUD panel.

'''Properties'''

'''Show/Hide Layer Rule:''' Shows or hides a layer from Driver.

'''Properties:'''
'''Show/Hide''' - select one
'''click here to set''' - enter name of layer. Name is case sensitive.

'''Known Bugs:'''
TANE (all versions) - layers set to '''Hide''' when a game is saved will be '''Shown''' when the game is reloaded

'''Show/Hide Minimap Rule:''' Shows the Driver the minimap window.

'''Properties'''
'''Minimap Window'''-click to choose Show,Hide

'''Show/hide on-screen help Rule:''' Shows or hides On-screen help in Driver.

'''Properties'''
'''Junction Overlays'''- fill-in to choose: Show, Hide, Leave unchanged. by default one is chosen
'''On Screen Vehicle Name'''- Fill-in to choose: Show, Hide, Leave unchanged. By default one is chosen

'''Wait for Click on HUD Icon Rule:''' Waits for a click on the HUD Icon.

'''Properties'''
'''Trigger Once'''-Check to choose
'''HUD Panel'''- Click to choose from list: Bottom Right Menu, Camera Controls, DCC Controls
'''Icon'''- Choose from list. Selections depends on HUD Panel chosen

'''Wait on Waybill Screen/Main Screen Rule:''' Waits for the Waybill window to be opened.

'''Properties'''

=='''Startup Rules:'''==

'''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.

'''Properties'''

'''Startup Options Rule''' Specifies the starting options for the session.

'''Properties'''

=='''Time Rules:'''==

'''Clock Rule:''' Rule needed for animated clocks, you need to apply this rule to your session to make use of the animated clocks, see forum for code to include in you clock object to work with this rule.

'''Properties'''

'''Timecheck Rule:''' Executes child rules at a certain time.

'''Properties'''

'''Timing Check Rule:''' Triggers sub rules if called within the time window specified.

'''Properties'''

'''Wait Rule:''' Wait for number of seconds'

'''Properties'''

=='''Variable Rules:'''==

'''Variable Check Rule:''' If the specified variable matches the specified conditions then the child rules will be executed in order.

'''Properties'''
<variable-name> - enter variable-name. Variable name is case sensitive.
<test-condition> - '''is less than/is less than or equal to/is equal to/is greater than or equal to/is greater than/is not equal to/is between x and y''' - select one

'''Test condition option: is between x and y'''
Enter minimum (x) and maximum (y) test values

'''Test condition option: (all other options)'''
Enter test value

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

'''Properties'''
Change: '''Add to variable/Subtract from variable/Change variable''' - select one
(optional check box) Set the minimum value of <variable-name> to <value> - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.
(optional check box) Set the maximum value of <variable-name> to <value> - enter value, enter variable-name (this will be set by the change option). Variable-name is case sensitive.

'''Change option: 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''' - select one.

'''Change option: 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''' - select one.

'''Change option: Change variable'''
Change variable <variable-name> to <value> - enter variable-name, enter new value. This cannot be undone if the rule is stopped. Variable-name is case sensitive.

'''Variable Modify Continuous Rule:''' Adds, subtracts or sets a value to a specified variable every second.

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

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

'''Properties'''
'''Check box: Add'''
<variable-name> - enter variable-name. 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. Variable-name is case sensitive.

Variables are saved in the session file and persist from one saved game to another.
They can be accessed/modified by the following '''driver commands''':

'''Driver Commands by trev999:'''
'''Set S-Variable driver command: '''
'''Skip if session-variable driver command: '''
'''Wait until S-variable driver command: '''

'''Driver Commands by atilabarut'''
'''ChangeSVariables driver command: '''
'''WaitUntilSVariable driver command: '''

=='''Weather Rules:'''==

'''EIRS Weather Rule NE USA Rule:''' Customize random weather rule relative to the North East Region of the United States.

'''Properties'''

'''Weather Rule:''' Set the weather conditions.

'''Properties'''

Session Rules By Categories With Properties

2017-09-22T17:17:39Z

Coop2:

Session Rules By Categories With Properties

2017-09-22T17:10:03Z

Coop2:

Session Rules By Categories With Properties

2017-09-22T16:55:14Z

Coop2:

Session Rules By Categories With Properties

2017-09-22T16:51:00Z

Coop2:

Session Rules By Categories With Properties

2017-09-22T16:45:37Z

Coop2:

Session Rules By Categories With Properties

2017-09-22T15:55:58Z

Coop2:

Session Rules By Categories With Properties

2017-09-22T15:32:59Z

Coop2:

Session Rules By Categories With Properties

2017-09-22T15:21:00Z

Coop2:

'''This page is under construction'''

List of Trainz Session Rules by Categories with Properties. '''All rules are the Copyrights of N3V Games'''

=='''Achievement Rules'''==

'''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement

Properties:
None

'''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload

Properties:
Target object ?? name of object such as Power Station, Coal Pit or Portal
Lock train's controls checked during a stopped load/unload operation
Override 'begin load' and 'begin unload' checked # of seconds to override

'''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations

Properties:
Trigger click to choose from list
Add Industry click to add from session list
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list

'''Power Station Rule:''' Sets up Station and Consumers

Properties:
Power Station click to choose from session Stations
Consumers(Add Object) click to choose from session list

'''Resource Check Rule:''' Check the progress of the amount of a resource and target object

Properties:
Watch industry queue or Watch vehicle fill-in choose one or the other
Note: Both have: Target Object, Queue: click to choose
Complete when designated queue fill-in equals or exceeds required amount, falls below required amount

'''Multiple Resource Check Rule:''' Checks resource for completion

Properties:
Wait for the designated queues from choose fall below, reach/exceed
Units number amount of units
Products click choose from session list
Add Object click choose from session list

'''Objective Add Rule:''' Sets up a game Objective with ID and display Name

Properties:
Priority click choose Above Normal, Below Normal, Normal, Optional, Urgent
Completion Target click to set target number
Icon click choose from list
Display Name click insert Name
Unique Objective ID click set ID
Custom Message insert typed message in text area

'''Objective Check Rule:''' Executes child rules when objective is complete

Properties:
Unique Objective ID click insert ID number
Mode click choose Wait for completion, Wait for failure, Wait for progress

'''Objective Update Rule:''' Changes progress outcome according to Property choices

Properties:
Unique Objective ID click to set ID number
Mode click Set objective as Decrement progress/Increment progress/Reset objective/Set objects as complete/Set objects as failed/Set progress/Set progress only if greater
Amount click insert number

'''Ranked Session Begin Rule:''' Begins a ranked Session

Properties:
Countdown requires a Starting Value insert hrs., min,sec
1 through 5 stars, points for each star insert number of points
Session timer mode fill-in chooses: Timer, Countdown, None

'''Ranked Session Complete Rule:''' Completes the active ranked Session

Properties:
Set the active ranked session as fill-in choose: Complete, Failed
Customize the completion message check insert text message

'''Session Complete Rule:''' Set session to a percentage of completion
Properties:

Set session to percent complete click to insert number in percent
Separate achievements for completion check

=='''Danger Rules'''==

'''ATP Speed Limiter Rule:''' Limits speed over set limit

Properties:
speed limit over the set limit mph

'''Speeding Check Rule:''' Checks to see if player control trains are over the speed

Properties:
Watch for trains travelling above the fill-in
Allow an over speed tolerance of click to insert mph over posted limit
Watch for trains travelling above a fill-in to insert custom speed limit
Warning: This method is very

'''AWS Configuration Rule:''' This rule configures the Trainz implementation of AWS

Properties:
Use modern sound set for unfitted cabs? check
Simulate AWS for unfitted cabs? check
Passive with HUD hidden fill-in
Active fill-in
Passive fill-in

'''Wait for Derailment Rule:''' Waits for a derailment to occur

Properties:
Trigger derailment watch once check to set

'''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars

Properties:
Set delay to clean up derailed train cars values

'''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule

Properties:
Respawn trains if they are abandoned check
Respawn trains fill-in choose: at their original locations, from portals from Session List

'''Coupler Breakage Check Rule:''' Checks for breaking couplers. No parameters.

Properties:
None

'''Coupler Breakage HUDRule:''' HUD displays warning about coupler stress and breakage

Properties:
Show the Coupler Breakage Display fill-in must choose one or the other
Hide the Coupler Breakage Display fill-in must choose one or the other

'''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles

Properties:
Add vehicle click to select from session list
Coupling Mask, Decoupling Mask : click to select: lock or unlock
Add All click to select all vehicle in session
Delete All click to delete all vehicle from list

'''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users

Properties:
Trigger only once check

'''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users

Properties:
Trigger only once check

'''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger

Properties:
Trigger only once check to set

'''Vehicle Physics Rule:''' Overrides the default vehicle physics properties

Properties:
Accept all trains fill-in
Cab sway level is set ? % click to insert percent of sway
Traction boost is % ? while sanding click to insert percent of boost
Tractions reduced to ? % while click to set traction percent
Maximum tractive effort adjusted by ? click to insert percent amount
Show coupler breakage in HUD Rule check to set
Couplers break when coupling above ? click to set speed
Accept trains matching specific criteria fill-in to insert specific trains
Couplers break at ? kN check to insert amount of force

=='''Navigation Rules'''==

'''DestSignTable Rule:''' Table for creating a table of destination signs

Properties:
Enable Track Marks as destinations check
Enable table of destinations check
Import destination from texture-group. name
Destination Name name
Enable industries/stations as check
Interlocking Tower Configure Path Alters settings on an interlocking tower path
Interlocking Tower choose Name and Objects
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
Show path activation message in Driver check

'''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train

Properties:
Interlocking Tower choose Names and Objects
Multiple Junction Alignment Check Checks multiple junctions are in alignment
Wait until the following junctions are choose all or anyone
Add junction click add junction from session list
Add all click add all junctions from session list
Delete all click deletes all junctions from rule list

'''Navigation Display Rule:''' Creates a navigation point

Properties:
Navigation mode choose, fill-in All points must be completed in sequence, Points will be completed in sequence, but can be skipped, All points must be completed, but in any
Note: See help icon for more
Style click choose Required Stop, Automatic, Manual
Display Text insert text
Location click choose train vehicle from session list
Train(optional) choose train from session list
Unique set ID name must be lowercase and no spaces
Icon click choose from list

'''Navigation Point Complete Rule:''' Marks a navigation point complete

Properties:
Mark navigation point click set index number
Complete in set click to set ID

'''Navigation Set Check Rule:''' Checks if a navigation point is complete/incomplete

Properties:
Checks if navigation point is set click set ID
Is click Complete, Incomplete
Navigation Set Clear Clears a navigation point set
Clear the navigation point set click to set ID
Navigation Set Hide/Show Show or hide navigation point set
The navigation point click hide, show
Navigation point set click to set ID

'''Schedule Rule:''' Allows a schedule of timed events to be applied to a train

Properties:
Insert track mark click to select from session list
Note: Both has an arrival and departure set time hr:min:sec
Current Train click to select from session list
Insert destination click to select from session list

'''Set Junctions Rule:''' Sets the selected junctions to a specific state ''Warning: not compatible with Interlocking Tower Assets''

Properties:
Add Junction click to select session junction list
Add All click
Delete All click

'''Set Signal Extended Rule:''' ''Warning: not compatible with Interlocking Tower Assets''

Properties:
Set signal click to select from session list
State ' to select state from list

'''Trigger Check Rule:''' Waits for any train to enter one of the designated triggers

Properties:
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list
Add Trigger click to choose from session list
Trigger only once check to set
Wait for child rules to complete even if check to set
Only activate when the entering click to choose forward, backward

'''Wait on Navigation Point Rule:''' Waits for a nav point to be complete

Properties:
Wait for navigation point ? click to choose from session list
in set ? to be completed click to insert ID

'''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start

Properties:
Accept all trains fill-in to set
Accept trains matching specific criteria fill-in to set and choose from session list
Wait for a train that matches the click to choose: start moving, stop moving
Trigger rule once check to set
Note: One or the other fill-ins must be

=='''Driver Rules'''==

'''Control Type Rule''' Sets control type

Properties:
Current control method is: Easy Mode, Choice one of the three

'''CPC Rule:''' Emit Train Used to Emit Trains from the Central Portal Control on

Properties:
Triggered Events. Also works with the Un-Portal Rule
Portal index form CPC value
Use UnPortal Yes/No
Delay from Trigger to Emit: Seconds value

'''Control Check Rule:''' Activates child rules based on the control method changes

Properties:
Excite child rules when: DCC mode is fill-in one or the other
Excite child rules: Every time control fill-in one or the other

'''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule

Properties:
Trigger add Trigger
Portal index from PCP value
Use UnPortal yes/no
Delay from Trigger to Emit: seconds value

'''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry

Properties:
Apply to every vehicle in the session fill-in
Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles
Note: One of the Applies will always be
Load/Unload for industry Disable/Enable choose Industry

'''Driver Command Rule:''' Specify which commands will be available for the drivers

Properties:
Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.
Navigate To TrackMarkList V2- No description.
Navigate To Station V2- No description.
Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.
Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.
Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.
Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.
Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.
Drive To Station V2- No description.
Drive To Track mark List V2- No description.
Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.
Drive To Industry- Drive to a specific industry.
Change Destination Sign-Changes the destination signs of a train.

WaitFor- Pauses the driver's schedule for a set duration of time.
Wait For Random- TRS2008: Wait for specified or optionally random period of time.
Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).
WaitUntil- No description.

VR Set Train Lamps-Driver command that sets the train lamps.
Notify- Notifies the player of schedule progress/completion.
Reverse Tram- Reverse a tram(max 2 cars).
Couple- Couple train to designate vehicle.
Decouple- Decouples the train at the specified vehicle.
UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).
Halt Train- Brings the train to a complete stop.
Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.
Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger
station before using this command.
Cab: Wait-Maintains current control state until some condition is met.
Delete Train- Causes the train and its driver to be deleted from the session.
Hornz- Driver sounds the train horn.
Cab: Set Control-Sets a cab mode control.
Headlights On/Off-Allows the driver to to switch the headlights on and off.
Interior Lights Command- Driver command to switch interior lights on or off for the current train.
Set Max Speed To- No description.

Release Junction - Lets a driver release the junction they have been holding.
Move Turntable- TRS2008: Move turntable to a stop point .

Load- Loads the train's vehicles at the industry the driver is currently at with the train.
Unload- Unload train vehicles at current industry location.
Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.
Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.
Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.

'''Driver Command Check Rule:''' Verifies the driver commands of a driver character

Properties:
Wait for driver character to have add driver, all, delete all
Trigger Rule once check
Driver character to watch the name driver

'''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar

Properties:
The Driver Main Bar choice show/hide

'''Driver Schedule Rule''' Execution of basic scheduled commands

Properties:
Note: Only one of the fill-in can be
Driver Schedule Rule assigned to name driver
Commands insert driver commands in Drive Schedule
Classic style: If there is a schedule fill-in
Killer style: If there is a schedule fill-in
Cooperative style: If there is a schedule fill-in
Active style: Emit a new schedule, only fill-in

'''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders

Properties:
Generate new Drivers for empty check
The following drivers will be available Driver's Name Add
Remove all existing Drivers first check

'''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers

Properties:
Assign Driver commands check Driver Commands
Train criteria fill in all trains
Train criteria list train only trains matching criteria

'''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted

Properties:
Config/txt file tag 'max_permitted_speed-60850 in mph or kph
Add to config.txt and kuid-table for value <KUID2:60850:88000:4
Note: Old root level config tag will

'''QuickDrive Rule:''' Change the Session settings and add consists in Driver

Properties:
Set Time to insert time
QuickDrive Consist Option List by
Rate of Change insert rate as number times
Enable gameplay Session Mode check
Enable in game help by default check
Set the default Control method to fill-in choose: Easy Mode, Realistic Mode
Prevent player from changing this check
Realistic mode requires achievement add Achievement's Name
In Asset choose Auran achievements
Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic
Prevent player from changing 10.0 check
Set the default units to fill-in choose: Imperial, Metric, Default
Open QuickDriver Window when check

'''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train

Properties:
Note: One or the other fill-ins must be
Accept trains matching specific criteria fill-in to select from session list
Accept all trains fill-in to set
Trigger rule once check to set
Wait for a driver character to get ? a click to select: On, Off

'''Wait for Driver/Train to be Locally Owned Rule:''' Waits for a specific driver or train car to be locally owned, Owned then executes child rules. If the driver/train car becomes unowned again the child rules are paused

Properties:
Wait for ownership of a specific Driver fill-in to set
Wait for ownership of Driver fill-in to set
Note: One or the other fill-in must be
Driver or Vehicle click to choose from session lists

=='''Arrangement of Session Rules:'''==

'''Ordered List Rule:''' Child rules will be executed in order once this rule starts

Properties:
Note: One of the two must be chosen
This process will repeat fill-in click to add number of repeats
This process will repeat forever fill-in

'''Progressive List Rule:''' The first child rule is executed on the first run, second child executed on second run, etc.

Properties:
After last child run is executed click to choose: First child is chosen again, It will be
used for all successive runs, Successive runs will
do nothing

'''Random List Rule:''' One of the child rules indented under this rule will be

Properties:
executed randomly
Once one of the child rule is ??

'''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle

Properties:
None

'''Simultaneous List Rule:''' Child rules are executed simultaneously once this rules

Properties:
Rules completes when click choose all rules have reached completed state,
was completed state

=='''Camera Rules:'''==

'''Cinematic Camera Rule:''' Provides several different cinematic style cameras

Properties:
Lock camera controls for the duration check
Prevent rain control for duration check
Camera target: name any of the many objects in session
Camera mode: Stationary, Circle fill-in
Initial camera values: Pitch, Yaw, Zoom value
Total time to animate: seconds value

'''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties

Properties:
Change the camera view mode to check to choose: Cab View, External View, Tracking
View, Free Roaming
Vehicle fill-in choose from session vehicles
Set the camera flags to enable/disable check to choose different properties from list
Junction fill-in choose from session junctions
Set the target objet of the camera to check
Map object fill-in choose from map objects

'''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view

Properties:
Trigger rule once check to set
Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking
View, Free Roaming View
Wait for the camera to target vehicle ? click to choose form session list

=='''Message Rules:'''==

'''Close Message Popups:'''

Properties:

'''Closes message popup:'''

Properties:

'''Custom Script'''

Properties:

'''Custom scripted rule. No Parameters'''

Properties:

'''Display Custom HUD:''' Show or hide the Custom Heads Up Display.

Properties:

'''Wait for Click on HUD Icon:'''

Properties:

'''Display HTML Pages:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.

Properties:

'''Timed limited display HTML:''' Displays an html browser window for a limited time.

Properties:

'''Display Video:''' Displays a page from a HTML assets in a browser window.

Properties:

'''End Session:''' End Session without saving.

Properties:

'''Fade in/out:''' Fade in or out within seconds, color and opacity considered.

Properties:

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

Properties:

'''Generic Tree Node Debug Window:''' No description.

Properties:

'''InputTable:''' Creating a list of message names to be used for various purposes.

Properties:

'''Message Popup:''' Displays a pop-up browser window and waits to be closed.

Properties:

'''Minimap Options:''' Sets the display options for the minimap.

Properties:

'''Play Sound:''' Plays a wav sound file.

Properties:

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

Properties:

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

Properties:

'''Set Helper Icon Size''' Sets the size of helper icons such as the junction lever arrows.

Properties:

'''Set HTML Pages:''' Instructs the Display HTML Pages rule to perform specific operations

Properties:

'''Show/Hide HUD Panel:''' Shows or hides a HUD panel.

Properties:

'''Show/Hide Layer:''' Shows or hides a layer from Driver.

Properties:

'''Show/Hide Minimap:''' Shows the Driver the minimap window.

Properties:

'''Show/hide on-screen help:''' Shows or hides On-screen help in Driver.

Properties:

'''Wait for Click on HUD Icon:''' Waits for a click on the HUD Icon.

Properties:

'''Wait on Waybill Screen/Main Screen:''' Waits for the Waybill window to be opened.

=='''Startup Rules:'''==

'''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.

Properties:

'''Startup Options''' Specifies the starting options for the session.

Properties:

=='''Time Rules:'''==

'''Clock Rule:''' Rule needed for animated clocks, you need to apply this rule to your session to make use of the animated clocks, see forum for code to include in you clock object to work with this rule.

Properties:

'''Timecheck:''' Executes child rules at a certain time.

Properties:

'''Timing Check Rule:''' Triggers sub rules if called within the time window specified.

Properties:

'''Wait:''' Wait for number of seconds'

Properties:

=='''Variable Rules:'''==

'''Variable Check:''' If variable 'score' is less than 'number' the child rules will be executed in order.

Properties:

'''Variable Modify:''' Change amount of variable score.

Properties:

'''Variable Modify Continuous:''' Adds a value to variable 'score' every second.

Properties:

'''Variable Show:''' Adds the variable 'Score the custom HUD with label ?.

Properties:

=='''Weather Rules:'''==

'''EIRS Weather Rule NE USA:''' Customize random weather rule relative to the North East Region of the United States.

Properties:

'''Weather:''' Set the weather conditions.

Session Rules By Categories With Properties

2017-09-22T15:17:38Z

Coop2:

== '''This page is under construction''' ==

List of Trainz Session Rules by Categories with Properties. '''All rules are the Copyrights of N3V Games'''

=='''Achievement Rules'''==

'''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement

Properties:
None

'''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload

Properties:
Target object ?? name of object such as Power Station, Coal Pit or Portal
Lock train's controls checked during a stopped load/unload operation
Override 'begin load' and 'begin unload' checked # of seconds to override

'''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations

Properties:
Trigger click to choose from list
Add Industry click to add from session list
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list

'''Power Station Rule:''' Sets up Station and Consumers

Properties:
Power Station click to choose from session Stations
Consumers(Add Object) click to choose from session list

'''Resource Check Rule:''' Check the progress of the amount of a resource and target object

Properties:
Watch industry queue or Watch vehicle fill-in choose one or the other
Note: Both have: Target Object, Queue: click to choose
Complete when designated queue fill-in equals or exceeds required amount, falls below required amount

'''Multiple Resource Check Rule:''' Checks resource for completion

Properties:
Wait for the designated queues from choose fall below, reach/exceed
Units number amount of units
Products click choose from session list
Add Object click choose from session list

'''Objective Add Rule:''' Sets up a game Objective with ID and display Name

Properties:
Priority click choose Above Normal, Below Normal, Normal, Optional, Urgent
Completion Target click to set target number
Icon click choose from list
Display Name click insert Name
Unique Objective ID click set ID
Custom Message insert typed message in text area

'''Objective Check Rule:''' Executes child rules when objective is complete

Properties:
Unique Objective ID click insert ID number
Mode click choose Wait for completion, Wait for failure, Wait for progress

'''Objective Update Rule:''' Changes progress outcome according to Property choices

Properties:
Unique Objective ID click to set ID number
Mode click Set objective as Decrement progress/Increment progress/Reset objective/Set objects as complete/Set objects as failed/Set progress/Set progress only if greater
Amount click insert number

'''Ranked Session Begin Rule:''' Begins a ranked Session

Properties:
Countdown requires a Starting Value insert hrs., min,sec
1 through 5 stars, points for each star insert number of points
Session timer mode fill-in chooses: Timer, Countdown, None

'''Ranked Session Complete Rule:''' Completes the active ranked Session

Properties:
Set the active ranked session as fill-in choose: Complete, Failed
Customize the completion message check insert text message

'''Session Complete Rule:''' Set session to a percentage of completion
Properties:

Set session to percent complete click to insert number in percent
Separate achievements for completion check

=='''Danger Rules'''==

'''ATP Speed Limiter Rule:''' Limits speed over set limit

Properties:
speed limit over the set limit mph

'''Speeding Check Rule:''' Checks to see if player control trains are over the speed

Properties:
Watch for trains travelling above the fill-in
Allow an over speed tolerance of click to insert mph over posted limit
Watch for trains travelling above a fill-in to insert custom speed limit
Warning: This method is very

'''AWS Configuration Rule:''' This rule configures the Trainz implementation of AWS

Properties:
Use modern sound set for unfitted cabs? check
Simulate AWS for unfitted cabs? check
Passive with HUD hidden fill-in
Active fill-in
Passive fill-in

'''Wait for Derailment Rule:''' Waits for a derailment to occur

Properties:
Trigger derailment watch once check to set

'''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars

Properties:
Set delay to clean up derailed train cars values

'''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule

Properties:
Respawn trains if they are abandoned check
Respawn trains fill-in choose: at their original locations, from portals from Session List

'''Coupler Breakage Check Rule:''' Checks for breaking couplers. No parameters.

Properties:
None

'''Coupler Breakage HUDRule:''' HUD displays warning about coupler stress and breakage

Properties:
Show the Coupler Breakage Display fill-in must choose one or the other
Hide the Coupler Breakage Display fill-in must choose one or the other

'''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles

Properties:
Add vehicle click to select from session list
Coupling Mask, Decoupling Mask : click to select: lock or unlock
Add All click to select all vehicle in session
Delete All click to delete all vehicle from list

'''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users

Properties:
Trigger only once check

'''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users

Properties:
Trigger only once check

'''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger

Properties:
Trigger only once check to set

'''Vehicle Physics Rule:''' Overrides the default vehicle physics properties

Properties:
Accept all trains fill-in
Cab sway level is set ? % click to insert percent of sway
Traction boost is % ? while sanding click to insert percent of boost
Tractions reduced to ? % while click to set traction percent
Maximum tractive effort adjusted by ? click to insert percent amount
Show coupler breakage in HUD Rule check to set
Couplers break when coupling above ? click to set speed
Accept trains matching specific criteria fill-in to insert specific trains
Couplers break at ? kN check to insert amount of force

=='''Navigation Rules'''==

'''DestSignTable Rule:''' Table for creating a table of destination signs

Properties:
Enable Track Marks as destinations check
Enable table of destinations check
Import destination from texture-group. name
Destination Name name
Enable industries/stations as check
Interlocking Tower Configure Path Alters settings on an interlocking tower path
Interlocking Tower choose Name and Objects
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
Show path activation message in Driver check

'''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train

Properties:
Interlocking Tower choose Names and Objects
Multiple Junction Alignment Check Checks multiple junctions are in alignment
Wait until the following junctions are choose all or anyone
Add junction click add junction from session list
Add all click add all junctions from session list
Delete all click deletes all junctions from rule list

'''Navigation Display Rule:''' Creates a navigation point

Properties:
Navigation mode choose, fill-in All points must be completed in sequence, Points will be completed in sequence, but can be skipped, All points must be completed, but in any
Note: See help icon for more
Style click choose Required Stop, Automatic, Manual
Display Text insert text
Location click choose train vehicle from session list
Train(optional) choose train from session list
Unique set ID name must be lowercase and no spaces
Icon click choose from list

'''Navigation Point Complete Rule:''' Marks a navigation point complete

Properties:
Mark navigation point click set index number
Complete in set click to set ID

'''Navigation Set Check Rule:''' Checks if a navigation point is complete/incomplete

Properties:
Checks if navigation point is set click set ID
Is click Complete, Incomplete
Navigation Set Clear Clears a navigation point set
Clear the navigation point set click to set ID
Navigation Set Hide/Show Show or hide navigation point set
The navigation point click hide, show
Navigation point set click to set ID

'''Schedule Rule:''' Allows a schedule of timed events to be applied to a train

Properties:
Insert track mark click to select from session list
Note: Both has an arrival and departure set time hr:min:sec
Current Train click to select from session list
Insert destination click to select from session list

'''Set Junctions Rule:''' Sets the selected junctions to a specific state ''Warning: not compatible with Interlocking Tower Assets''

Properties:
Add Junction click to select session junction list
Add All click
Delete All click

'''Set Signal Extended Rule:''' ''Warning: not compatible with Interlocking Tower Assets''

Properties:
Set signal click to select from session list
State ' to select state from list

'''Trigger Check Rule:''' Waits for any train to enter one of the designated triggers

Properties:
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list
Add Trigger click to choose from session list
Trigger only once check to set
Wait for child rules to complete even if check to set
Only activate when the entering click to choose forward, backward

'''Wait on Navigation Point Rule:''' Waits for a nav point to be complete

Properties:
Wait for navigation point ? click to choose from session list
in set ? to be completed click to insert ID

'''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start

Properties:
Accept all trains fill-in to set
Accept trains matching specific criteria fill-in to set and choose from session list
Wait for a train that matches the click to choose: start moving, stop moving
Trigger rule once check to set
Note: One or the other fill-ins must be

=='''Driver Rules'''==

'''Control Type Rule''' Sets control type

Properties:
Current control method is: Easy Mode, Choice one of the three

'''CPC Rule:''' Emit Train Used to Emit Trains from the Central Portal Control on

Properties:
Triggered Events. Also works with the Un-Portal Rule
Portal index form CPC value
Use UnPortal Yes/No
Delay from Trigger to Emit: Seconds value

'''Control Check Rule:''' Activates child rules based on the control method changes

Properties:
Excite child rules when: DCC mode is fill-in one or the other
Excite child rules: Every time control fill-in one or the other

'''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule

Properties:
Trigger add Trigger
Portal index from PCP value
Use UnPortal yes/no
Delay from Trigger to Emit: seconds value

'''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry

Properties:
Apply to every vehicle in the session fill-in
Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles
Note: One of the Applies will always be
Load/Unload for industry Disable/Enable choose Industry

'''Driver Command Rule:''' Specify which commands will be available for the drivers

Properties:
Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.
Navigate To TrackMarkList V2- No description.
Navigate To Station V2- No description.
Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.
Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.
Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.
Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.
Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.
Drive To Station V2- No description.
Drive To Track mark List V2- No description.
Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.
Drive To Industry- Drive to a specific industry.
Change Destination Sign-Changes the destination signs of a train.

WaitFor- Pauses the driver's schedule for a set duration of time.
Wait For Random- TRS2008: Wait for specified or optionally random period of time.
Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).
WaitUntil- No description.

VR Set Train Lamps-Driver command that sets the train lamps.
Notify- Notifies the player of schedule progress/completion.
Reverse Tram- Reverse a tram(max 2 cars).
Couple- Couple train to designate vehicle.
Decouple- Decouples the train at the specified vehicle.
UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).
Halt Train- Brings the train to a complete stop.
Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.
Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger
station before using this command.
Cab: Wait-Maintains current control state until some condition is met.
Delete Train- Causes the train and its driver to be deleted from the session.
Hornz- Driver sounds the train horn.
Cab: Set Control-Sets a cab mode control.
Headlights On/Off-Allows the driver to to switch the headlights on and off.
Interior Lights Command- Driver command to switch interior lights on or off for the current train.
Set Max Speed To- No description.

Release Junction - Lets a driver release the junction they have been holding.
Move Turntable- TRS2008: Move turntable to a stop point .

Load- Loads the train's vehicles at the industry the driver is currently at with the train.
Unload- Unload train vehicles at current industry location.
Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.
Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.
Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.

'''Driver Command Check Rule:''' Verifies the driver commands of a driver character

Properties:
Wait for driver character to have add driver, all, delete all
Trigger Rule once check
Driver character to watch the name driver

'''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar

Properties:
The Driver Main Bar choice show/hide

'''Driver Schedule Rule''' Execution of basic scheduled commands

Properties:
Note: Only one of the fill-in can be
Driver Schedule Rule assigned to name driver
Commands insert driver commands in Drive Schedule
Classic style: If there is a schedule fill-in
Killer style: If there is a schedule fill-in
Cooperative style: If there is a schedule fill-in
Active style: Emit a new schedule, only fill-in

'''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders

Properties:
Generate new Drivers for empty check
The following drivers will be available Driver's Name Add
Remove all existing Drivers first check

'''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers

Properties:
Assign Driver commands check Driver Commands
Train criteria fill in all trains
Train criteria list train only trains matching criteria

'''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted

Properties:
Config/txt file tag 'max_permitted_speed-60850 in mph or kph
Add to config.txt and kuid-table for value <KUID2:60850:88000:4
Note: Old root level config tag will

'''QuickDrive Rule:''' Change the Session settings and add consists in Driver

Properties:
Set Time to insert time
QuickDrive Consist Option List by
Rate of Change insert rate as number times
Enable gameplay Session Mode check
Enable in game help by default check
Set the default Control method to fill-in choose: Easy Mode, Realistic Mode
Prevent player from changing this check
Realistic mode requires achievement add Achievement's Name
In Asset choose Auran achievements
Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic
Prevent player from changing 10.0 check
Set the default units to fill-in choose: Imperial, Metric, Default
Open QuickDriver Window when check

'''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train

Properties:
Note: One or the other fill-ins must be
Accept trains matching specific criteria fill-in to select from session list
Accept all trains fill-in to set
Trigger rule once check to set
Wait for a driver character to get ? a click to select: On, Off

'''Wait for Driver/Train to be Locally Owned Rule:''' Waits for a specific driver or train car to be locally owned, Owned then executes child rules. If the driver/train car becomes unowned again the child rules are paused

Properties:
Wait for ownership of a specific Driver fill-in to set
Wait for ownership of Driver fill-in to set
Note: One or the other fill-in must be
Driver or Vehicle click to choose from session lists

=='''Arrangement of Session Rules:'''==

'''Ordered List Rule:''' Child rules will be executed in order once this rule starts

Properties:
Note: One of the two must be chosen
This process will repeat fill-in click to add number of repeats
This process will repeat forever fill-in

'''Progressive List Rule:''' The first child rule is executed on the first run, second child executed on second run, etc.

Properties:
After last child run is executed click to choose: First child is chosen again, It will be
used for all successive runs, Successive runs will
do nothing

'''Random List Rule:''' One of the child rules indented under this rule will be

Properties:
executed randomly
Once one of the child rule is ??

'''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle

Properties:
None

'''Simultaneous List Rule:''' Child rules are executed simultaneously once this rules

Properties:
Rules completes when click choose all rules have reached completed state,
was completed state

=='''Camera Rules:'''==

'''Cinematic Camera Rule:''' Provides several different cinematic style cameras

Properties:
Lock camera controls for the duration check
Prevent rain control for duration check
Camera target: name any of the many objects in session
Camera mode: Stationary, Circle fill-in
Initial camera values: Pitch, Yaw, Zoom value
Total time to animate: seconds value

'''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties

Properties:
Change the camera view mode to check to choose: Cab View, External View, Tracking
View, Free Roaming
Vehicle fill-in choose from session vehicles
Set the camera flags to enable/disable check to choose different properties from list
Junction fill-in choose from session junctions
Set the target objet of the camera to check
Map object fill-in choose from map objects

'''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view

Properties:
Trigger rule once check to set
Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking
View, Free Roaming View
Wait for the camera to target vehicle ? click to choose form session list

=='''Message Rules:'''==

'''Close Message Popups:'''

Properties:

'''Closes message popup:'''

Properties:

'''Custom Script'''

Properties:

'''Custom scripted rule. No Parameters'''

Properties:

'''Display Custom HUD:''' Show or hide the Custom Heads Up Display.

Properties:

'''Wait for Click on HUD Icon:'''

Properties:

'''Display HTML Pages:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.

Properties:

'''Timed limited display HTML:''' Displays an html browser window for a limited time.

Properties:

'''Display Video:''' Displays a page from a HTML assets in a browser window.

Properties:

'''End Session:''' End Session without saving.

Properties:

'''Fade in/out:''' Fade in or out within seconds, color and opacity considered.

Properties:

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

Properties:

'''Generic Tree Node Debug Window:''' No description.

Properties:

'''InputTable:''' Creating a list of message names to be used for various purposes.

Properties:

'''Message Popup:''' Displays a pop-up browser window and waits to be closed.

Properties:

'''Minimap Options:''' Sets the display options for the minimap.

Properties:

'''Play Sound:''' Plays a wav sound file.

Properties:

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

Properties:

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

Properties:

'''Set Helper Icon Size''' Sets the size of helper icons such as the junction lever arrows.

Properties:

'''Set HTML Pages:''' Instructs the Display HTML Pages rule to perform specific operations

Properties:

'''Show/Hide HUD Panel:''' Shows or hides a HUD panel.

Properties:

'''Show/Hide Layer:''' Shows or hides a layer from Driver.

Properties:

'''Show/Hide Minimap:''' Shows the Driver the minimap window.

Properties:

'''Show/hide on-screen help:''' Shows or hides On-screen help in Driver.

Properties:

'''Wait for Click on HUD Icon:''' Waits for a click on the HUD Icon.

Properties:

'''Wait on Waybill Screen/Main Screen:''' Waits for the Waybill window to be opened.

=='''Startup Rules:'''==

'''Multiplayer Rule:''' Enables this session to be taken online in a Multiplayer environment.

Properties:

'''Startup Options''' Specifies the starting options for the session.

Properties:

=='''Time Rules:'''==

'''Clock Rule:''' Rule needed for animated clocks, you need to apply this rule to your session to make use of the animated clocks, see forum for code to include in you clock object to work with this rule.

Properties:

'''Timecheck:''' Executes child rules at a certain time.

Properties:

'''Timing Check Rule:''' Triggers sub rules if called within the time window specified.

Properties:

'''Wait:''' Wait for number of seconds'

Properties:

=='''Variable Rules:'''==

'''Variable Check:''' If variable 'score' is less than 'number' the child rules will be executed in order.

Properties:

'''Variable Modify:''' Change amount of variable score.

Properties:

'''Variable Modify Continuous:''' Adds a value to variable 'score' every second.

Properties:

'''Variable Show:''' Adds the variable 'Score the custom HUD with label ?.

Properties:

=='''Weather Rules:'''==

'''EIRS Weather Rule NE USA:''' Customize random weather rule relative to the North East Region of the United States.

Properties:

'''Weather:''' Set the weather conditions.

Session Rules By Categories With Properties

2017-09-22T14:55:26Z

Coop2:

== '''This page is under construction''' ==

List of Trainz Session Rules by Categories with Properties. '''All rules are the Copyrights of N3V Games'''

=='''Achievement Rules'''==

'''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement

Properties:
None

'''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload

Properties:
Target object ?? name of object such as Power Station, Coal Pit or Portal
Lock train's controls checked during a stopped load/unload operation
Override 'begin load' and 'begin unload' checked # of seconds to override

'''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations

Properties:
Trigger click to choose from list
Add Industry click to add from session list
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list

'''Power Station Rule:''' Sets up Station and Consumers

Properties:
Power Station click to choose from session Stations
Consumers(Add Object) click to choose from session list

'''Resource Check Rule:''' Check the progress of the amount of a resource and target object

Properties:
Watch industry queue or Watch vehicle fill-in choose one or the other
Note: Both have: Target Object, Queue: click to choose
Complete when designated queue fill-in equals or exceeds required amount, falls below required amount

'''Multiple Resource Check Rule:''' Checks resource for completion

Properties:
Wait for the designated queues from choose fall below, reach/exceed
Units number amount of units
Products click choose from session list
Add Object click choose from session list

'''Objective Add Rule:''' Sets up a game Objective with ID and display Name

Properties:
Priority click choose Above Normal, Below Normal, Normal, Optional, Urgent
Completion Target click to set target number
Icon click choose from list
Display Name click insert Name
Unique Objective ID click set ID
Custom Message insert typed message in text area

'''Objective Check Rule:''' Executes child rules when objective is complete

Properties:
Unique Objective ID click insert ID number
Mode click choose Wait for completion, Wait for failure, Wait for progress

'''Objective Update Rule:''' Changes progress outcome according to Property choices

Properties:
Unique Objective ID click to set ID number
Mode click Set objective as Decrement progress/Increment progress/Reset objective/Set objects as complete/Set objects as failed/Set progress/Set progress only if greater
Amount click insert number

'''Ranked Session Begin Rule:''' Begins a ranked Session

Properties:
Countdown requires a Starting Value insert hrs., min,sec
1 through 5 stars, points for each star insert number of points
Session timer mode fill-in chooses: Timer, Countdown, None

'''Ranked Session Complete Rule:''' Completes the active ranked Session

Properties:
Set the active ranked session as fill-in choose: Complete, Failed
Customize the completion message check insert text message

'''Session Complete Rule:''' Set session to a percentage of completion
Properties:

Set session to percent complete click to insert number in percent
Separate achievements for completion check

=='''Danger Rules'''==

'''ATP Speed Limiter Rule:''' Limits speed over set limit

Properties:
speed limit over the set limit mph

'''Speeding Check Rule:''' Checks to see if player control trains are over the speed

Properties:
Watch for trains travelling above the fill-in
Allow an over speed tolerance of click to insert mph over posted limit
Watch for trains travelling above a fill-in to insert custom speed limit
Warning: This method is very

'''AWS Configuration Rule:''' This rule configures the Trainz implementation of AWS

Properties:
Use modern sound set for unfitted cabs? check
Simulate AWS for unfitted cabs? check
Passive with HUD hidden fill-in
Active fill-in
Passive fill-in

'''Wait for Derailment Rule:''' Waits for a derailment to occur

Properties:
Trigger derailment watch once check to set

'''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars

Properties:
Set delay to clean up derailed train cars values

'''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule

Properties:
Respawn trains if they are abandoned check
Respawn trains fill-in choose: at their original locations, from portals from Session List

'''Coupler Breakage Check Rule:''' Checks for breaking couplers. No parameters.

Properties:
None

'''Coupler Breakage HUDRule:''' HUD displays warning about coupler stress and breakage

Properties:
Show the Coupler Breakage Display fill-in must choose one or the other
Hide the Coupler Breakage Display fill-in must choose one or the other

'''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles

Properties:
Add vehicle click to select from session list
Coupling Mask, Decoupling Mask : click to select: lock or unlock
Add All click to select all vehicle in session
Delete All click to delete all vehicle from list

'''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users

Properties:
Trigger only once check

'''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users

Properties:
Trigger only once check

'''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger

Properties:
Trigger only once check to set

'''Vehicle Physics Rule:''' Overrides the default vehicle physics properties

Properties:
Accept all trains fill-in
Cab sway level is set ? % click to insert percent of sway
Traction boost is % ? while sanding click to insert percent of boost
Tractions reduced to ? % while click to set traction percent
Maximum tractive effort adjusted by ? click to insert percent amount
Show coupler breakage in HUD Rule check to set
Couplers break when coupling above ? click to set speed
Accept trains matching specific criteria fill-in to insert specific trains
Couplers break at ? kN check to insert amount of force

=='''Navigation Rules'''==

'''DestSignTable Rule:''' Table for creating a table of destination signs

Properties:
Enable Track Marks as destinations check
Enable table of destinations check
Import destination from texture-group. name
Destination Name name
Enable industries/stations as check
Interlocking Tower Configure Path Alters settings on an interlocking tower path
Interlocking Tower choose Name and Objects
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
Show path activation message in Driver check

'''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train

Properties:
Interlocking Tower choose Names and Objects
Multiple Junction Alignment Check Checks multiple junctions are in alignment
Wait until the following junctions are choose all or anyone
Add junction click add junction from session list
Add all click add all junctions from session list
Delete all click deletes all junctions from rule list

'''Navigation Display Rule:''' Creates a navigation point

Properties:
Navigation mode choose, fill-in All points must be completed in sequence, Points will be completed in sequence, but can be skipped, All points must be completed, but in any
Note: See help icon for more
Style click choose Required Stop, Automatic, Manual
Display Text insert text
Location click choose train vehicle from session list
Train(optional) choose train from session list
Unique set ID name must be lowercase and no spaces
Icon click choose from list

'''Navigation Point Complete Rule:''' Marks a navigation point complete

Properties:
Mark navigation point click set index number
Complete in set click to set ID

'''Navigation Set Check Rule:''' Checks if a navigation point is complete/incomplete

Properties:
Checks if navigation point is set click set ID
Is click Complete, Incomplete
Navigation Set Clear Clears a navigation point set
Clear the navigation point set click to set ID
Navigation Set Hide/Show Show or hide navigation point set
The navigation point click hide, show
Navigation point set click to set ID

'''Schedule Rule:''' Allows a schedule of timed events to be applied to a train

Properties:
Insert track mark click to select from session list
Note: Both has an arrival and departure set time hr:min:sec
Current Train click to select from session list
Insert destination click to select from session list

'''Set Junctions Rule:''' Sets the selected junctions to a specific state ''Warning: not compatible with Interlocking Tower Assets''

Properties:
Add Junction click to select session junction list
Add All click
Delete All click

'''Set Signal Extended Rule:''' ''Warning: not compatible with Interlocking Tower Assets''

Properties:
Set signal click to select from session list
State ' to select state from list

'''Trigger Check Rule:''' Waits for any train to enter one of the designated triggers

Properties:
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list
Add Trigger click to choose from session list
Trigger only once check to set
Wait for child rules to complete even if check to set
Only activate when the entering click to choose forward, backward

'''Wait on Navigation Point Rule:''' Waits for a nav point to be complete

Properties:
Wait for navigation point ? click to choose from session list
in set ? to be completed click to insert ID

'''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start

Properties:
Accept all trains fill-in to set
Accept trains matching specific criteria fill-in to set and choose from session list
Wait for a train that matches the click to choose: start moving, stop moving
Trigger rule once check to set
Note: One or the other fill-ins must be

=='''Driver Rules'''==

'''Control Type Rule''' Sets control type

Properties:
Current control method is: Easy Mode, Choice one of the three

'''CPC Rule:''' Emit Train Used to Emit Trains from the Central Portal Control on

Properties:
Triggered Events. Also works with the Un-Portal Rule
Portal index form CPC value
Use UnPortal Yes/No
Delay from Trigger to Emit: Seconds value

'''Control Check Rule:''' Activates child rules based on the control method changes

Properties:
Excite child rules when: DCC mode is fill-in one or the other
Excite child rules: Every time control fill-in one or the other

'''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule

Properties:
Trigger add Trigger
Portal index from PCP value
Use UnPortal yes/no
Delay from Trigger to Emit: seconds value

'''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry

Properties:
Apply to every vehicle in the session fill-in
Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles
Note: One of the Applies will always be
Load/Unload for industry Disable/Enable choose Industry

'''Driver Command Rule:''' Specify which commands will be available for the drivers

Properties:
Navigate To Track mark- Driver command that allows a driver character to take a train to a specific track mark on the map. Will attempt to route around trains to get there.
Navigate To TrackMarkList V2- No description.
Navigate To Station V2- No description.
Navigate Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will attempt to route around trans to get there.
Navigate To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will attempt to route around trains to get there.
Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule.
Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there.
Drive Via Track mark- Driver command that allows a driver character to take a train through a specific track mark for its journey. Will take the shortest path to get there.
Drive To Station V2- No description.
Drive To Track mark List V2- No description.
Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there.
Drive To Industry- Drive to a specific industry.
Change Destination Sign-Changes the destination signs of a train.

WaitFor- Pauses the driver's schedule for a set duration of time.
Wait For Random- TRS2008: Wait for specified or optionally random period of time.
Wait For Trigger- Tell a driver to wait until a trigger you selected is touched by a train you select(or any train).
WaitUntil- No description.

VR Set Train Lamps-Driver command that sets the train lamps.
Notify- Notifies the player of schedule progress/completion.
Reverse Tram- Reverse a tram(max 2 cars).
Couple- Couple train to designate vehicle.
Decouple- Decouples the train at the specified vehicle.
UnCoupler From- A new Uncouple driver Command that allows you to uncouple from vehicle number n(with 0 being the first vehicle in the consist).
Halt Train- Brings the train to a complete stop.
Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train.
Terminate Passenger Train- This command will terminate a passenger train a the current passenger station. This will cause all of the passengers to disembark from the train. You must issue a 'Drive To' command for a passenger
station before using this command.
Cab: Wait-Maintains current control state until some condition is met.
Delete Train- Causes the train and its driver to be deleted from the session.
Hornz- Driver sounds the train horn.
Cab: Set Control-Sets a cab mode control.
Headlights On/Off-Allows the driver to to switch the headlights on and off.
Interior Lights Command- Driver command to switch interior lights on or off for the current train.
Set Max Speed To- No description.

Release Junction - Lets a driver release the junction they have been holding.
Move Turntable- TRS2008: Move turntable to a stop point .

Load- Loads the train's vehicles at the industry the driver is currently at with the train.
Unload- Unload train vehicles at current industry location.
Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders.
Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded.
Instant Unload- Instantly unload a train. Useful for trains generated automatically by portal etc. Every product queue found in each industry-activated car will be unloaded.

'''Driver Command Check Rule:''' Verifies the driver commands of a driver character

Properties:
Wait for driver character to have add driver, all, delete all
Trigger Rule once check
Driver character to watch the name driver

'''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar

Properties:
The Driver Main Bar choice show/hide

'''Driver Schedule Rule''' Execution of basic scheduled commands

Properties:
Note: Only one of the fill-in can be
Driver Schedule Rule assigned to name driver
Commands insert driver commands in Drive Schedule
Classic style: If there is a schedule fill-in
Killer style: If there is a schedule fill-in
Cooperative style: If there is a schedule fill-in
Active style: Emit a new schedule, only fill-in

'''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders

Properties:
Generate new Drivers for empty check
The following drivers will be available Driver's Name Add
Remove all existing Drivers first check

'''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers

Properties:
Assign Driver commands check Driver Commands
Train criteria fill in all trains
Train criteria list train only trains matching criteria

'''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted

Properties:
Config/txt file tag 'max_permitted_speed-60850 in mph or kph
Add to config.txt and kuid-table for value <KUID2:60850:88000:4
Note: Old root level config tag will

'''QuickDrive Rule:''' Change the Session settings and add consists in Driver

Properties:
Set Time to insert time
QuickDrive Consist Option List by
Rate of Change insert rate as number times
Enable gameplay Session Mode check
Enable in game help by default check
Set the default Control method to fill-in choose: Easy Mode, Realistic Mode
Prevent player from changing this check
Realistic mode requires achievement add Achievement's Name
In Asset choose Auran achievements
Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic
Prevent player from changing 10.0 check
Set the default units to fill-in choose: Imperial, Metric, Default
Open QuickDriver Window when check

'''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train

Properties:
Note: One or the other fill-ins must be
Accept trains matching specific criteria fill-in to select from session list
Accept all trains fill-in to set
Trigger rule once check to set
Wait for a driver character to get ? a click to select: On, Off

'''Wait for Driver/Train to be Locally Owned Rule:''' Waits for a specific driver or train car to be locally owned, Owned then executes child rules. If the driver/train car becomes unowned again the child rules are paused

Properties:
Wait for ownership of a specific Driver fill-in to set
Wait for ownership of Driver fill-in to set
Note: One or the other fill-in must be
Driver or Vehicle click to choose from session lists

=='''Arrangement of Session Rules:'''==

'''Ordered List Rule:''' Child rules will be executed in order once this rule starts

Properties:
Note: One of the two must be chosen
This process will repeat fill-in click to add number of repeats
This process will repeat forever fill-in

'''Progressive List Rule:''' The first child rule is executed on the first run, second child executed on second run, etc.

Properties:
After last child run is executed click to choose: First child is chosen again, It will be
used for all successive runs, Successive runs will
do nothing

'''Random List Rule:''' One of the child rules indented under this rule will be

Properties:
executed randomly
Once one of the child rule is ??

'''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle

Properties:
None

'''Simultaneous List Rule:''' Child rules are executed simultaneously once this rules

Properties:
Rules completes when click choose all rules have reached completed state,
was completed state

=='''Camera Rules:'''==

'''Cinematic Camera Rule:''' Provides several different cinematic style cameras

Properties:
Lock camera controls for the duration check
Prevent rain control for duration check
Camera target: name any of the many objects in session
Camera mode: Stationary, Circle fill-in
Initial camera values: Pitch, Yaw, Zoom value
Total time to animate: seconds value

'''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties

Properties:
Change the camera view mode to check to choose: Cab View, External View, Tracking
View, Free Roaming
Vehicle fill-in choose from session vehicles
Set the camera flags to enable/disable check to choose different properties from list
Junction fill-in choose from session junctions
Set the target objet of the camera to check
Map object fill-in choose from map objects

'''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view

Properties:
Trigger rule once check to set
Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking
View, Free Roaming View
Wait for the camera to target vehicle ? click to choose form session list

=='''Message Rules:'''==

'''Close Message Popups:'''

Properties:

'''Closes message popup:'''

Properties:

'''Custom Script'''

Properties:

'''Custom scripted rule. No Parameters'''

Properties:

'''Display Custom HUD:''' Show or hide the Custom Heads Up Display.

Properties:

'''Display HTML Pages:''' Creates a browser to display the listed HTML files in order as a navigable sequence of pages.

Properties:

'''Display Video:''' Displays a page from a HTML assets in a browser window.

Properties:

'''End Session:''' End Session without saving.

Properties:

'''Fade in/out:''' Fade in or out within seconds, color and opacity considered.

Properties:

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

Properties:

'''Generic Tree Node Debug Window:''' No description.

Properties:

'''InputTable:''' Creating a list of message names to be used for various purposes.

Properties:

'''Message Popup:''' Displays a pop-up browser window and waits to be closed.

Properties:

'''Minimap Options:''' Sets the display options for the minimap.

Properties:

'''Play Sound:''' Plays a wav sound file.

Properties:

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

Properties:

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

Properties:

'''Set Helper Icon Size''' Sets the size of helper icons such as the junction lever arrows.

Properties:

'''Set HTML Pages:''' Instructs the Display HTML Pages rule to perform specific operations

Properties:

'''Show/Hide HUD Panel:''' Shows or hides a HUD panel.

Properties:

'''Show/Hide Layer:''' Shows or hides a layer from Driver.

Properties:

'''Show/Hide Minimap:''' Shows the Driver the minimap window.

Properties:

'''Show/hide on-screen help:''' Shows or hides On-screen help in Driver.

Properties:

'''Wait for Click on HUD Icon:''' Waits for a click on the HUD Icon.

Properties:

'''Wait on Waybill Screen/Main Screen:''' Waits for the Waybill window to be opened.

Session Rules By Categories With Properties

2017-09-22T14:29:56Z

Coop2:

Session Rules By Categories With Properties

2017-09-21T23:56:24Z

Coop2:

== '''This page is under construction''' ==

List of Trainz Session Rules by Categories with Properties. '''All rules are the Copyrights of N3V Games'''

=='''Achievement Rules'''==

'''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement

Properties:
None

'''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload

Properties:
Target object ?? name of object such as Power Station, Coal Pit or Portal
Lock train's controls checked during a stopped load/unload operation
Override 'begin load' and 'begin unload' checked # of seconds to override

'''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations

Properties:
Trigger click to choose from list
Add Industry click to add from session list
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list

'''Power Station Rule:''' Sets up Station and Consumers

Properties:
Power Station click to choose from session Stations
Consumers(Add Object) click to choose from session list

'''Resource Check Rule:''' Check the progress of the amount of a resource and target object

Properties:
Watch industry queue or Watch vehicle fill-in choose one or the other
Note: Both have: Target Object, Queue: click to choose
Complete when designated queue fill-in equals or exceeds required amount, falls below required amount

'''Multiple Resource Check Rule:''' Checks resource for completion

Properties:
Wait for the designated queues from choose fall below, reach/exceed
Units number amount of units
Products click choose from session list
Add Object click choose from session list

'''Objective Add Rule:''' Sets up a game Objective with ID and display Name

Properties:
Priority click choose Above Normal, Below Normal, Normal, Optional, Urgent
Completion Target click to set target number
Icon click choose from list
Display Name click insert Name
Unique Objective ID click set ID
Custom Message insert typed message in text area

'''Objective Check Rule:''' Executes child rules when objective is complete

Properties:
Unique Objective ID click insert ID number
Mode click choose Wait for completion, Wait for failure, Wait for progress

'''Objective Update Rule:''' Changes progress outcome according to Property choices

Properties:
Unique Objective ID click to set ID number
Mode click Set objective as Decrement progress/Increment progress/Reset objective/Set objects as complete/Set objects as failed/Set progress/Set progress only if greater
Amount click insert number

'''Ranked Session Begin Rule:''' Begins a ranked Session

Properties:
Countdown requires a Starting Value insert hrs., min,sec
1 through 5 stars, points for each star insert number of points
Session timer mode fill-in chooses: Timer, Countdown, None

'''Ranked Session Complete Rule:''' Completes the active ranked Session

Properties:
Set the active ranked session as fill-in choose: Complete, Failed
Customize the completion message check insert text message

'''Session Complete Rule:''' Set session to a percentage of completion
Properties:

Set session to percent complete click to insert number in percent
Separate achievements for completion check

=='''Danger Rules'''==

'''ATP Speed Limiter Rule:''' Limits speed over set limit

Properties:
speed limit over the set limit mph

'''Speeding Check Rule:''' Checks to see if player control trains are over the speed

Properties:
Watch for trains travelling above the fill-in
Allow an over speed tolerance of click to insert mph over posted limit
Watch for trains travelling above a fill-in to insert custom speed limit
Warning: This method is very

'''AWS Configuration Rule:''' This rule configures the Trainz implementation of AWS

Properties:
Use modern sound set for unfitted cabs? check
Simulate AWS for unfitted cabs? check
Passive with HUD hidden fill-in
Active fill-in
Passive fill-in

'''Wait for Derailment Rule:''' Waits for a derailment to occur

Properties:
Trigger derailment watch once check to set

'''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars

Properties:
Set delay to clean up derailed train cars values

'''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule

Properties:
Respawn trains if they are abandoned check
Respawn trains fill-in choose: at their original locations, from portals from Session List

'''Coupler Breakage Check Rule:''' Checks for breaking couplers. No parameters.

Properties:
None

'''Coupler Breakage HUDRule:''' HUD displays warning about coupler stress and breakage

Properties:
Show the Coupler Breakage Display fill-in must choose one or the other
Hide the Coupler Breakage Display fill-in must choose one or the other

'''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles

Properties:
Add vehicle click to select from session list
Coupling Mask, Decoupling Mask : click to select: lock or unlock
Add All click to select all vehicle in session
Delete All click to delete all vehicle from list

'''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users

Properties:
Trigger only once check

'''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users

Properties:
Trigger only once check

'''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger

Properties:
Trigger only once check to set

'''Vehicle Physics Rule:''' Overrides the default vehicle physics properties

Properties:
Accept all trains fill-in
Cab sway level is set ? % click to insert percent of sway
Traction boost is % ? while sanding click to insert percent of boost
Tractions reduced to ? % while click to set traction percent
Maximum tractive effort adjusted by ? click to insert percent amount
Show coupler breakage in HUD Rule check to set
Couplers break when coupling above ? click to set speed
Accept trains matching specific criteria fill-in to insert specific trains
Couplers break at ? kN check to insert amount of force

=='''Navigation Rules'''==

'''DestSignTable Rule:''' Table for creating a table of destination signs

Properties:
Enable Track Marks as destinations check
Enable table of destinations check
Import destination from texture-group. name
Destination Name name
Enable industries/stations as check
Interlocking Tower Configure Path Alters settings on an interlocking tower path
Interlocking Tower choose Name and Objects
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
Show path activation message in Driver check

'''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train

Properties:
Interlocking Tower choose Names and Objects
Multiple Junction Alignment Check Checks multiple junctions are in alignment
Wait until the following junctions are choose all or anyone
Add junction click add junction from session list
Add all click add all junctions from session list
Delete all click deletes all junctions from rule list

'''Navigation Display Rule:''' Creates a navigation point

Properties:
Navigation mode choose, fill-in All points must be completed in sequence, Points will be completed in sequence, but can be skipped, All points must be completed, but in any
Note: See help icon for more
Style click choose Required Stop, Automatic, Manual
Display Text insert text
Location click choose train vehicle from session list
Train(optional) choose train from session list
Unique set ID name must be lowercase and no spaces
Icon click choose from list

'''Navigation Point Complete Rule:''' Marks a navigation point complete

Properties:
Mark navigation point click set index number
Complete in set click to set ID

'''Navigation Set Check Rule:''' Checks if a navigation point is complete/incomplete

Properties:
Checks if navigation point is set click set ID
Is click Complete, Incomplete
Navigation Set Clear Clears a navigation point set
Clear the navigation point set click to set ID
Navigation Set Hide/Show Show or hide navigation point set
The navigation point click hide, show
Navigation point set click to set ID

'''Schedule Rule:''' Allows a schedule of timed events to be applied to a train

Properties:
Insert track mark click to select from session list
Note: Both has an arrival and departure set time hr:min:sec
Current Train click to select from session list
Insert destination click to select from session list

'''Set Junctions Rule:''' Sets the selected junctions to a specific state ''Warning: not compatible with Interlocking Tower Assets''

Properties:
Add Junction click to select session junction list
Add All click
Delete All click

'''Set Signal Extended Rule:''' ''Warning: not compatible with Interlocking Tower Assets''

Properties:
Set signal click to select from session list
State ' to select state from list

'''Trigger Check Rule:''' Waits for any train to enter one of the designated triggers

Properties:
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list
Add Trigger click to choose from session list
Trigger only once check to set
Wait for child rules to complete even if check to set
Only activate when the entering click to choose forward, backward

'''Wait on Navigation Point Rule:''' Waits for a nav point to be complete

Properties:
Wait for navigation point ? click to choose from session list
in set ? to be completed click to insert ID

'''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start

Properties:
Accept all trains fill-in to set
Accept trains matching specific criteria fill-in to set and choose from session list
Wait for a train that matches the click to choose: start moving, stop moving
Trigger rule once check to set
Note: One or the other fill-ins must be

=='''Driver Rules'''==

'''Control Type Rule''' Sets control type

Properties:
Current control method is: Easy Mode, Choice one of the three

'''CPC Rule:''' Emit Train Used to Emit Trains from the Central Portal Control on

Properties:
Triggered Events. Also works with the Un-Portal Rule
Portal index form CPC value
Use UnPortal Yes/No
Delay from Trigger to Emit: Seconds value

'''Control Check Rule:''' Activates child rules based on the control method changes

Properties:
Excite child rules when: DCC mode is fill-in one or the other
Excite child rules: Every time control fill-in one or the other

'''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule

Properties:
Trigger add Trigger
Portal index from PCP value
Use UnPortal yes/no
Delay from Trigger to Emit: seconds value

'''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry

Properties:
Apply to every vehicle in the session fill-in
Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles
Note: One of the Applies will always be
Load/Unload for industry Disable/Enable choose Industry

'''Driver Command Rule:''' Specify which commands will be available for the drivers

Properties:
Navigate To Track mark- Driver
Release Junction - Lets a driver release
Notify- Notifies the player of schedule
NavigateToTrackMarkList V2- No
NavigateToStation V2- No description
ReverseTram- Reverse a tram(max 2
Navigate Via Track mark- Driver
UnCouplerFrom- A new Uncouple driver
Navigate To- Allows a driver character
Halt Train- Brings the train to a
Run Around- Instructs the driver to
Terminate Passenger Train- This station before using this command
MoveTurntable- TRS2008: Move
Unload- Unload train vehicles at current
VR Set Train Lamps-Driver command
WaitFor- Pauses the driver's schedule or
WaitForRandom- TRS2008: Wait for
WaitForTrigger- Tell a driver to wait
WaitUntil- No description
Set Max Speed To- No description
Drive Via Track mark- Driver command
Load- Loads the train's vehicles at the ??
Cab: Wait-Maintains current control state until some condition is met
Change Destination Sign-Changes the destination signs of a train
Couple- Couple train to designate vehicle
Decouple- Decouples the train at the specified vehicle
Delete Train- Causes the train and its driver to be deleted from the session
Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by the train's schedule
Drive To- Allows a driver character to take a train either to a destination industry or a specific track in a destination industry. Will take the shortest path to get there
Hornz- Driver sounds the train horn
Drive to Track mark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will take the shortest path to get there
Cab: Set Control Sets a cab mode control
Drive To Station V2- No description
Drive To Track mark List V2- No description
Headlights On/Off-Allows the driver to to switch the headlights on and off
Instant Load Command- Instantly load a train with a random product selected from its product que. Will not load locos or loco tenders
Instant Load Locos- Instantly load all locos in a train. Useful for trains generated automatically by portal etc. All locos with product queues(eg Phil_C's diesels) and all tenders will have all available queues loaded
InstantUnload- Instantly unload a train. Useful for trains generated automtially by portal etc. Every product queue found in each industry-activated car wil be unloaded
Interior Lights Command- Driver command to switch interior lights on or off for the current train
Drive To Industry- Drive to a specific industry

'''Driver Command Check Rule:''' Verifies the driver commands of a driver character

Properties:
Wait for driver character to have add driver, all, delete all
Trigger Rule once check
Driver character to watch the name driver

'''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar

Properties:
The Driver Main Bar choice show/hide

'''Driver Schedule Rule''' Execution of basic scheduled commands

Properties:
Note: Only one of the fill-in can be
Driver Schedule Rule assigned to name driver
Commands insert driver commands in Drive Schedule
Classic style: If there is a schedule fill-in
Killer style: If there is a schedule fill-in
Cooperative style: If there is a schedule fill-in
Active style: Emit a new schedule, only fill-in

'''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders

Properties:
Generate new Drivers for empty check
The following drivers will be available Driver's Name Add
Remove all existing Drivers first check

'''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers

Properties:
Assign Driver commands check Driver Commands
Train criteria fill in all trains
Train criteria list train only trains matching criteria

'''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted

Properties:
Config/txt file tag 'max_permitted_speed-60850 in mph or kph
Add to config.txt and kuid-table for value <KUID2:60850:88000:4
Note: Old root level config tag will

'''QuickDrive Rule:''' Change the Session settings and add consists in Driver

Properties:
Set Time to insert time
QuickDrive Consist Option List by
Rate of Change insert rate as number times
Enable gameplay Session Mode check
Enable in game help by default check
Set the default Control method to fill-in choose: Easy Mode, Realistic Mode
Prevent player from changing this check
Realistic mode requires achievement add Achievement's Name
In Asset choose Auran achievements
Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic
Prevent player from changing 10.0 check
Set the default units to fill-in choose: Imperial, Metric, Default
Open QuickDriver Window when check

'''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train

Properties:
Note: One or the other fill-ins must be
Accept trains matching specific criteria fill-in to select from session list
Accept all trains fill-in to set
Trigger rule once check to set
Wait for a driver character to get ? a click to select: On, Off

'''Wait for Driver/Train to be Locally Owned Rule:''' Waits for a specific driver or train car to be locally owned, Owned then executes child rules. If the driver/train car becomes unowned again the child rules are paused

Properties:
Wait for ownership of a specific Driver fill-in to set
Wait for ownership of Driver fill-in to set
Note: One or the other fill-in must be
Driver or Vehicle click to choose from session lists

=='''Arrangement of Session Rules:'''==

'''Ordered List Rule:''' Child rules will be executed in order once this rule starts

Properties:
Note: One of the two must be chosen
This process will repeat fill-in click to add number of repeats
This process will repeat forever fill-in

'''Progressive List Rule:''' The first child rule is executed on the first run, second child executed on second run, etc.

Properties:
After last child run is executed click to choose: First child is chosen again, It will be
used for all successive runs, Successive runs will
do nothing

'''Random List Rule:''' One of the child rules indented under this rule will be

Properties:
executed randomly
Once one of the child rule is ??

'''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle

Properties:
None

'''Simultaneous List Rule:''' Child rules are executed simultaneously once this rules

Properties:
Rules completes when click choose all rules have reached completed state,
was completed state

=='''Camera Rules:'''==

'''Cinematic Camera Rule:''' Provides several different cinematic style cameras

Properties:
Lock camera controls for the duration check
Prevent rain control for duration check
Camera target: name any of the many objects in session
Camera mode: Stationary, Circle fill-in
Initial camera values: Pitch, Yaw, Zoom value
Total time to animate: seconds value

'''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties

Properties:
Change the camera view mode to check to choose: Cab View, External View, Tracking
View, Free Roaming
Vehicle fill-in choose from session vehicles
Set the camera flags to enable/disable check to choose different properties from list
Junction fill-in choose from session junctions
Set the target objet of the camera to check
Map object fill-in choose from map objects

'''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view

Properties:
Trigger rule once check to set
Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking
View, Free Roaming View
Wait for the camera to target vehicle ? click to choose form session list

=='''Message Rules:'''==

Session Rules By Categories With Properties

2017-09-20T17:34:48Z

Coop2:

== '''This page is under construction''' ==

List of Trainz Session Rules by Categories with Properties. '''All rules are the Copyrights of N3V Games'''

=='''Achievement Rules'''==

'''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement

Properties:
None

'''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload

Properties:
Target object ?? name of object such as Power Station, Coal Pit or Portal
Lock train's controls checked during a stopped load/unload operation
Override 'begin load' and 'begin unload' checked # of seconds to override

'''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations

Properties:
Trigger click to choose from list
Add Industry click to add from session list
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list

'''Power Station Rule:''' Sets up Station and Consumers

Properties:
Power Station click to choose from session Stations
Consumers(Add Object) click to choose from session list

'''Resource Check Rule:''' Check the progress of the amount of a resource and target object

Properties:
Watch industry queue or Watch vehicle fill-in choose one or the other
Note: Both have: Target Object, Queue: click to choose
Complete when designated queue fill-in equals or exceeds required amount, falls below required amount

'''Multiple Resource Check Rule:''' Checks resource for completion

Properties:
Wait for the designated queues from choose fall below, reach/exceed
Units number amount of units
Products click choose from session list
Add Object click choose from session list

'''Objective Add Rule:''' Sets up a game Objective with ID and display Name

Properties:
Priority click choose Above Normal, Below Normal, Normal, Optional, Urgent
Completion Target click to set target number
Icon click choose from list
Display Name click insert Name
Unique Objective ID click set ID
Custom Message insert typed message in text area

'''Objective Check Rule:''' Executes child rules when objective is complete

Properties:
Unique Objective ID click insert ID number
Mode click choose Wait for completion, Wait for failure, Wait for progress

'''Objective Update Rule:''' Changes progress outcome according to Property choices

Properties:
Unique Objective ID click to set ID number
Mode click Set objective as Decrement progress/Increment progress/Reset objective/Set objects as complete/Set objects as failed/Set progress/Set progress only if greater
Amount click insert number

'''Ranked Session Begin Rule:''' Begins a ranked Session

Properties:
Countdown requires a Starting Value insert hrs., min,sec
1 through 5 stars, points for each star insert number of points
Session timer mode fill-in chooses: Timer, Countdown, None

'''Ranked Session Complete Rule:''' Completes the active ranked Session

Properties:
Set the active ranked session as fill-in choose: Complete, Failed
Customize the completion message check insert text message

'''Session Complete Rule:''' Set session to a percentage of completion
Properties:

Set session to percent complete click to insert number in percent
Separate achievements for completion check

=='''Danger Rules'''==

'''ATP Speed Limiter Rule:''' Limits speed over set limit

Properties:
speed limit over the set limit mph

'''Speeding Check Rule:''' Checks to see if player control trains are over the speed

Properties:
Watch for trains travelling above the fill-in
Allow an over speed tolerance of click to insert mph over posted limit
Watch for trains travelling above a fill-in to insert custom speed limit
Warning: This method is very

'''AWS Configuration Rule:''' This rule configures the Trainz implementation of AWS

Properties:
Use modern sound set for unfitted cabs? check
Simulate AWS for unfitted cabs? check
Passive with HUD hidden fill-in
Active fill-in
Passive fill-in

'''Wait for Derailment Rule:''' Waits for a derailment to occur

Properties:
Trigger derailment watch once check to set

'''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars

Properties:
Set delay to clean up derailed train cars values

'''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule

Properties:
Respawn trains if they are abandoned check
Respawn trains fill-in choose: at their original locations, from portals from Session List

'''Coupler Breakage Check Rule:''' Checks for breaking couplers. No parameters.

Properties:
None

'''Coupler Breakage HUDRule:''' HUD displays warning about coupler stress and breakage

Properties:
Show the Coupler Breakage Display fill-in must choose one or the other
Hide the Coupler Breakage Display fill-in must choose one or the other

'''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles

Properties:
Add vehicle click to select from session list
Coupling Mask, Decoupling Mask : click to select: lock or unlock
Add All click to select all vehicle in session
Delete All click to delete all vehicle from list

'''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users

Properties:
Trigger only once check

'''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users

Properties:
Trigger only once check

'''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger

Properties:
Trigger only once check to set

'''Vehicle Physics Rule:''' Overrides the default vehicle physics properties

Properties:
Accept all trains fill-in
Cab sway level is set ? % click to insert percent of sway
Traction boost is % ? while sanding click to insert percent of boost
Tractions reduced to ? % while click to set traction percent
Maximum tractive effort adjusted by ? click to insert percent amount
Show coupler breakage in HUD Rule check to set
Couplers break when coupling above ? click to set speed
Accept trains matching specific criteria fill-in to insert specific trains
Couplers break at ? kN check to insert amount of force

=='''Navigation Rules'''==

'''DestSignTable Rule:''' Table for creating a table of destination signs

Properties:
Enable Track Marks as destinations check
Enable table of destinations check
Import destination from texture-group. name
Destination Name name
Enable industries/stations as check
Interlocking Tower Configure Path Alters settings on an interlocking tower path
Interlocking Tower choose Name and Objects
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
Show path activation message in Driver check

'''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train

Properties:
Interlocking Tower choose Names and Objects
Multiple Junction Alignment Check Checks multiple junctions are in alignment
Wait until the following junctions are choose all or anyone
Add junction click add junction from session list
Add all click add all junctions from session list
Delete all click deletes all junctions from rule list

'''Navigation Display Rule:''' Creates a navigation point

Properties:
Navigation mode choose, fill-in All points must be completed in sequence, Points will be completed in sequence, but can be skipped, All points must be completed, but in any
Note: See help icon for more
Style click choose Required Stop, Automatic, Manual
Display Text insert text
Location click choose train vehicle from session list
Train(optional) choose train from session list
Unique set ID name must be lowercase and no spaces
Icon click choose from list

'''Navigation Point Complete Rule:''' Marks a navigation point complete

Properties:
Mark navigation point click set index number
Complete in set click to set ID

'''Navigation Set Check Rule:''' Checks if a navigation point is complete/incomplete

Properties:
Checks if navigation point is set click set ID
Is click Complete, Incomplete
Navigation Set Clear Clears a navigation point set
Clear the navigation point set click to set ID
Navigation Set Hide/Show Show or hide navigation point set
The navigation point click hide, show
Navigation point set click to set ID

'''Schedule Rule:''' Allows a schedule of timed events to be applied to a train

Properties:
Insert track mark click to select from session list
Note: Both has an arrival and departure set time hr:min:sec
Current Train click to select from session list
Insert destination click to select from session list

'''Set Junctions Rule:''' Sets the selected junctions to a specific state ''Warning: not compatible with Interlocking Tower Assets''

Properties:
Add Junction click to select session junction list
Add All click
Delete All click

'''Set Signal Extended Rule:''' ''Warning: not compatible with Interlocking Tower Assets''

Properties:
Set signal click to select from session list
State ' to select state from list

'''Trigger Check Rule:''' Waits for any train to enter one of the designated triggers

Properties:
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list
Add Trigger click to choose from session list
Trigger only once check to set
Wait for child rules to complete even if check to set
Only activate when the entering click to choose forward, backward

'''Wait on Navigation Point Rule:''' Waits for a nav point to be complete

Properties:
Wait for navigation point ? click to choose from session list
in set ? to be completed click to insert ID

'''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start

Properties:
Accept all trains fill-in to set
Accept trains matching specific criteria fill-in to set and choose from session list
Wait for a train that matches the click to choose: start moving, stop moving
Trigger rule once check to set
Note: One or the other fill-ins must be

=='''Driver Rules'''==

'''Control Type Rule''' Sets control type

Properties:
Current control method is: Easy Mode, Choice one of the three

'''CPC Rule:''' Emit Train Used to Emit Trains from the Central Portal Control on

Properties:
Triggered Events. Also works with the Un-Portal Rule
Portal index form CPC value
Use UnPortal Yes/No
Delay from Trigger to Emit: Seconds value

'''Control Check Rule:''' Activates child rules based on the control method changes

Properties:
Excite child rules when: DCC mode is fill-in one or the other
Excite child rules: Every time control fill-in one or the other

'''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule

Properties:
Trigger add Trigger
Portal index from PCP value
Use UnPortal yes/no
Delay from Trigger to Emit: seconds value

'''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry

Properties:
Apply to every vehicle in the session fill-in
Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles
Note: One of the Applies will always be
Load/Unload for industry Disable/Enable choose Industry

'''Driver Command Rule:''' Specify which commands will be available for the drivers

Properties:
Navigate To Track mark- Driver
Release Junction - Lets a driver release
Notify- Notifies the player of schedule
NavigateToTrackMarkList V2- No
NavigateToStation V2- No description
ReverseTram- Reverse a tram(max 2
Navigate Via Track mark- Driver
UnCouplerFrom- A new Uncouple driver
Navigate To- Allows a driver character
Halt Train- Brings the train to a
Run Around- Instructs the driver to
Terminate Passenger Train- This station before using this command
MoveTurntable- TRS2008: Move
Unload- Unload train vehicles at current
VR Set Train Lamps-Driver command
WaitFor- Pauses the driver's schedule or
WaitForRandom- TRS2008: Wait for
WaitForTrigger- Tell a driver to wait
WaitUntil- No description
Set Max Speed To- No description
Drive Via Track mark- Driver command
Load- Loads the train's vehicles at the ??
Cab Wait maintains current control state until some condition is met
Change Destination Sign Changes signs of a train
Couple- Couple train to designate
Decouple- Decouples the train at the
Delete Train- Causes the train and its
Drive Schedule- Driver command that
Drive To- Allows a driver character to
Hornz- Driver sounds the train horn
Drive to Track mark- Driver command
Cab Set Control cab mode control
Drive To Station V2- No description
Drive To Track mark List V2- No
Headlights On/Off-Allows the driver to
Instant Load Command- Instantly load a
Instant Load Locos- Instantly load all
InstantUnload- Instantly unload a train-
Interior Lights Command- Driver
Drive To Industry- Drive to a specific

'''Driver Command Check Rule:''' Verifies the driver commands of a driver character

Properties:
Wait for driver character to have add driver, all, delete all
Trigger Rule once check
Driver character to watch the name driver

'''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar

Properties:
The Driver Main Bar choice show/hide

'''Driver Schedule Rule''' Execution of basic scheduled commands

Properties:
Note: Only one of the fill-in can be
Driver Schedule Rule assigned to name driver
Commands insert driver commands in Drive Schedule
Classic style: If there is a schedule fill-in
Killer style: If there is a schedule fill-in
Cooperative style: If there is a schedule fill-in
Active style: Emit a new schedule, only fill-in

'''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders

Properties:
Generate new Drivers for empty check
The following drivers will be available Driver's Name Add
Remove all existing Drivers first check

'''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers

Properties:
Assign Driver commands check Driver Commands
Train criteria fill in all trains
Train criteria list train only trains matching criteria

'''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted

Properties:
Config/txt file tag 'max_permitted_speed-60850 in mph or kph
Add to config.txt and kuid-table for value <KUID2:60850:88000:4
Note: Old root level config tag will

'''QuickDrive Rule:''' Change the Session settings and add consists in Driver

Properties:
Set Time to insert time
QuickDrive Consist Option List by
Rate of Change insert rate as number times
Enable gameplay Session Mode check
Enable in game help by default check
Set the default Control method to fill-in choose: Easy Mode, Realistic Mode
Prevent player from changing this check
Realistic mode requires achievement add Achievement's Name
In Asset choose Auran achievements
Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic
Prevent player from changing 10.0 check
Set the default units to fill-in choose: Imperial, Metric, Default
Open QuickDriver Window when check

'''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train

Properties:
Note: One or the other fill-ins must be
Accept trains matching specific criteria fill-in to select from session list
Accept all trains fill-in to set
Trigger rule once check to set
Wait for a driver character to get ? a click to select: On, Off

'''Wait for Driver/Train to be Locally Owned Rule:''' Waits for a specific driver or train car to be locally owned, Owned then executes child rules. If the driver/train car becomes unowned again the child rules are paused

Properties:
Wait for ownership of a specific Driver fill-in to set
Wait for ownership of Driver fill-in to set
Note: One or the other fill-in must be
Driver or Vehicle click to choose from session lists

=='''Arrangement of Session Rules:'''==

'''Ordered List Rule:''' Child rules will be executed in order once this rule starts

Properties:
Note: One of the two must be chosen
This process will repeat fill-in click to add number of repeats
This process will repeat forever fill-in

'''Progressive List Rule:''' The first child rule is executed on the first run, second child executed on second run, etc.

Properties:
After last child run is executed click to choose: First child is chosen again, It will be
used for all successive runs, Successive runs will
do nothing

'''Random List Rule:''' One of the child rules indented under this rule will be

Properties:
executed randomly
Once one of the child rule is ??

'''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle

Properties:
None

'''Simultaneous List Rule:''' Child rules are executed simultaneously once this rules

Properties:
Rules completes when click choose all rules have reached completed state,
was completed state

=='''Camera Rules:'''==

'''Cinematic Camera Rule:''' Provides several different cinematic style cameras

Properties:
Lock camera controls for the duration check
Prevent rain control for duration check
Camera target: name any of the many objects in session
Camera mode: Stationary, Circle fill-in
Initial camera values: Pitch, Yaw, Zoom value
Total time to animate: seconds value

'''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties

Properties:
Change the camera view mode to check to choose: Cab View, External View, Tracking
View, Free Roaming
Vehicle fill-in choose from session vehicles
Set the camera flags to enable/disable check to choose different properties from list
Junction fill-in choose from session junctions
Set the target objet of the camera to check
Map object fill-in choose from map objects

'''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view

Properties:
Trigger rule once check to set
Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking
View, Free Roaming View
Wait for the camera to target vehicle ? click to choose form session list

=='''Message Rules:'''==

Session Rules By Categories With Properties

2017-09-20T17:18:37Z

Coop2:

== '''This page is under construction''' ==

List of Trainz Session Rules by Categories with Properties. '''All rules are the Copyrights of N3V Games'''

=='''Achievement Rules'''==

'''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement

[[Properties:]]
None

'''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload

[[Properties:]]
Target object ?? name of object such as Power Station, Coal Pit or Portal
Lock train's controls checked during a stopped load/unload operation
Override 'begin load' and 'begin unload' checked # of seconds to override

'''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations

[[Properties:]]
Trigger click to choose from list
Add Industry click to add from session list
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list

'''Power Station Rule:''' Sets up Station and Consumers

[[Properties:]]
Power Station click to choose from session Stations
Consumers(Add Object) click to choose from session list

'''Resource Check Rule:''' Check the progress of the amount of a resource and target object

[[Properties:]]
Watch industry queue or Watch vehicle fill-in choose one or the other
Note: Both have: Target Object, Queue: click to choose
Complete when designated queue fill-in equals or exceeds required amount, falls below required amount

'''Multiple Resource Check Rule:''' Checks resource for completion

[[Properties:]]
Wait for the designated queues from choose fall below, reach/exceed
Units number amount of units
Products click choose from session list
Add Object click choose from session list

'''Objective Add Rule:''' Sets up a game Objective with ID and display Name

[[Properties:]]
Priority click choose Above Normal, Below Normal, Normal, Optional, Urgent
Completion Target click to set target number
Icon click choose from list
Display Name click insert Name
Unique Objective ID click set ID
Custom Message insert typed message in text area

'''Objective Check Rule:''' Executes child rules when objective is complete

[[Properties:]]
Unique Objective ID click insert ID number
Mode click choose Wait for completion, Wait for failure, Wait for progress

'''Objective Update Rule:''' Changes progress outcome according to Property choices

[[Properties:]]
Unique Objective ID click to set ID number
Mode click Set objective as Decrement progress/Increment progress/Reset objective/Set objects as complete/Set objects as failed/Set progress/Set progress only if greater
Amount click insert number

'''Ranked Session Begin Rule:''' Begins a ranked Session

[[Properties:]]
Countdown requires a Starting Value insert hrs., min,sec
1 through 5 stars, points for each star insert number of points
Session timer mode fill-in chooses: Timer, Countdown, None

'''Ranked Session Complete Rule:''' Completes the active ranked Session

[[Properties:]]
Set the active ranked session as fill-in choose: Complete, Failed
Customize the completion message check insert text message

'''Session Complete Rule:''' Set session to a percentage of completion

[[Properties:]]
Set session to percent complete click to insert number in percent
Separate achievements for completion check

=='''Danger Rules'''==

'''ATP Speed Limiter Rule:''' Limits speed over set limit

[[Properties:]]
speed limit over the set limit mph

'''Speeding Check Rule:''' Checks to see if player control trains are over the speed

[[Properties:]]
Watch for trains travelling above the fill-in
Allow an over speed tolerance of click to insert mph over posted limit
Watch for trains travelling above a fill-in to insert custom speed limit
Warning: This method is very

'''AWS Configuration Rule:''' This rule configures the Trainz implementation of AWS

[[Properties:]]
Use modern sound set for unfitted cabs? check
Simulate AWS for unfitted cabs? check
Passive with HUD hidden fill-in
Active fill-in
Passive fill-in

'''Wait for Derailment Rule:''' Waits for a derailment to occur

[[Properties:]]
Trigger derailment watch once check to set

'''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars

[[Properties:]]
Set delay to clean up derailed train cars values

'''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule

[[Properties:]]
Respawn trains if they are abandoned check
Respawn trains fill-in choose: at their original locations, from portals from Session List

'''Coupler Breakage Check Rule:''' Checks for breaking couplers. No parameters.

[[Properties:]]
None

'''Coupler Breakage HUDRule:''' HUD displays warning about coupler stress and breakage

[[Properties:]]
Show the Coupler Breakage Display fill-in must choose one or the other
Hide the Coupler Breakage Display fill-in must choose one or the other

'''Set Coupler Masks Rule:''' Set the coupling/decoupling masks on the selected vehicles

[[Properties:]]
Add vehicle click to select from session list
Coupling Mask, Decoupling Mask : click to select: lock or unlock
Add All click to select all vehicle in session
Delete All click to delete all vehicle from list

'''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users

[[Properties:]]
Trigger only once check

'''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users

[[Properties:]]
Trigger only once check

'''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger

[[Properties:]]
Trigger only once check to set

'''Vehicle Physics Rule:''' Overrides the default vehicle physics properties

[[Properties:]]
Accept all trains fill-in
Cab sway level is set ? % click to insert percent of sway
Traction boost is % ? while sanding click to insert percent of boost
Tractions reduced to ? % while click to set traction percent
Maximum tractive effort adjusted by ? click to insert percent amount
Show coupler breakage in HUD Rule check to set
Couplers break when coupling above ? click to set speed
Accept trains matching specific criteria fill-in to insert specific trains
Couplers break at ? kN check to insert amount of force

=='''Navigation Rules'''==

'''DestSignTable Rule:''' Table for creating a table of destination signs

[[Properties:]]
Enable Track Marks as destinations check
Enable table of destinations check
Import destination from texture-group. name
Destination Name name
Enable industries/stations as check
Interlocking Tower Configure Path Alters settings on an interlocking tower path
Interlocking Tower choose Name and Objects
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
Show path activation message in Driver check

'''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train

[[Properties:]]
Interlocking Tower choose Names and Objects
Multiple Junction Alignment Check Checks multiple junctions are in alignment
Wait until the following junctions are choose all or anyone
Add junction click add junction from session list
Add all click add all junctions from session list
Delete all click deletes all junctions from rule list

'''Navigation Display Rule:''' Creates a navigation point

[[Properties:]]
Navigation mode choose, fill-in All points must be completed in sequence, Points will be completed in sequence, but can be skipped, All points must be completed, but in any
Note: See help icon for more
Style click choose Required Stop, Automatic, Manual
Display Text insert text
Location click choose train vehicle from session list
Train(optional) choose train from session list
Unique set ID name must be lowercase and no spaces
Icon click choose from list

'''Navigation Point Complete Rule:''' Marks a navigation point complete

[[Properties:]]
Mark navigation point click set index number
Complete in set click to set ID

'''Navigation Set Check Rule:''' Checks if a navigation point is complete/incomplete

[[Properties:]]
Checks if navigation point is set click set ID
Is click Complete, Incomplete
Navigation Set Clear Clears a navigation point set
Clear the navigation point set click to set ID
Navigation Set Hide/Show Show or hide navigation point set
The navigation point click hide, show
Navigation point set click to set ID

'''Schedule Rule:''' Allows a schedule of timed events to be applied to a train

[[Properties:]]
Insert track mark click to select from session list
Note: Both has an arrival and departure set time hr:min:sec
Current Train click to select from session list
Insert destination click to select from session list

'''Set Junctions Rule:''' Sets the selected junctions to a specific state ''Warning: not compatible with Interlocking Tower Assets''

[[Properties:]]
Add Junction click to select session junction list
Add All click
Delete All click

'''Set Signal Extended Rule:''' ''Warning: not compatible with Interlocking Tower Assets''

[[Properties:]]
Set signal click to select from session list
State ' to select state from list

'''Trigger Check Rule:''' Waits for any train to enter one of the designated triggers

[[Properties:]]
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list
Add Trigger click to choose from session list
Trigger only once check to set
Wait for child rules to complete even if check to set
Only activate when the entering click to choose forward, backward

'''Wait on Navigation Point Rule:''' Waits for a nav point to be complete

[[Properties:]]
Wait for navigation point ? click to choose from session list
in set ? to be completed click to insert ID

'''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start

[[Properties:]]
Accept all trains fill-in to set
Accept trains matching specific criteria fill-in to set and choose from session list
Wait for a train that matches the click to choose: start moving, stop moving
Trigger rule once check to set
Note: One or the other fill-ins must be

=='''Driver Rules'''==

'''Control Type Rule''' Sets control type

[[Properties:]]
Current control method is: Easy Mode, Choice one of the three

'''CPC Rule:''' Emit Train Used to Emit Trains from the Central Portal Control on

[[Properties:]]
Triggered Events. Also works with the Un-Portal Rule
Portal index form CPC value
Use UnPortal Yes/No
Delay from Trigger to Emit: Seconds value

'''Control Check Rule:''' Activates child rules based on the control method changes

[[Properties:]]
Excite child rules when: DCC mode is fill-in one or the other
Excite child rules: Every time control fill-in one or the other

'''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule

[[Properties:]]
Trigger add Trigger
Portal index from PCP value
Use UnPortal yes/no
Delay from Trigger to Emit: seconds value

'''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry

[[Properties:]]
Apply to every vehicle in the session fill-in
Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles
Note: One of the Applies will always be
Load/Unload for industry Disable/Enable choose Industry

'''Driver Command Rule:''' Specify which commands will be available for the drivers

[[Properties:]]
Navigate To Track mark- Driver
Release Junction - Lets a driver release
Notify- Notifies the player of schedule
NavigateToTrackMarkList V2- No
NavigateToStation V2- No description
ReverseTram- Reverse a tram(max 2
Navigate Via Track mark- Driver
UnCouplerFrom- A new Uncouple driver
Navigate To- Allows a driver character
Halt Train- Brings the train to a
Run Around- Instructs the driver to
Terminate Passenger Train- This station before using this command
MoveTurntable- TRS2008: Move
Unload- Unload train vehicles at current
VR Set Train Lamps-Driver command
WaitFor- Pauses the driver's schedule or
WaitForRandom- TRS2008: Wait for
WaitForTrigger- Tell a driver to wait
WaitUntil- No description
Set Max Speed To- No description
Drive Via Track mark- Driver command
Load- Loads the train's vehicles at the ??
Cab Wait maintains current control state until some condition is met
Change Destination Sign Changes signs of a train
Couple- Couple train to designate
Decouple- Decouples the train at the
Delete Train- Causes the train and its
Drive Schedule- Driver command that
Drive To- Allows a driver character to
Hornz- Driver sounds the train horn
Drive to Track mark- Driver command
Cab Set Control cab mode control
Drive To Station V2- No description
Drive To Track mark List V2- No
Headlights On/Off-Allows the driver to
Instant Load Command- Instantly load a
Instant Load Locos- Instantly load all
InstantUnload- Instantly unload a train-
Interior Lights Command- Driver
Drive To Industry- Drive to a specific

'''Driver Command Check Rule:''' Verifies the driver commands of a driver character

[[Properties:]]
Wait for driver character to have add driver, all, delete all
Trigger Rule once check
Driver character to watch the name driver

'''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar

[[Properties:]]
The Driver Main Bar choice show/hide

'''Driver Schedule Rule''' Execution of basic scheduled commands

[[Properties:]]
Note: Only one of the fill-in can be
Driver Schedule Rule assigned to name driver
Commands insert driver commands in Drive Schedule
Classic style: If there is a schedule fill-in
Killer style: If there is a schedule fill-in
Cooperative style: If there is a schedule fill-in
Active style: Emit a new schedule, only fill-in

'''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders

[[Properties:]]
Generate new Drivers for empty check
The following drivers will be available Driver's Name Add
Remove all existing Drivers first check

'''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers

[[Properties:]]
Assign Driver commands check Driver Commands
Train criteria fill in all trains
Train criteria list train only trains matching criteria

'''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted

[[Properties:]]
Config/txt file tag 'max_permitted_speed-60850 in mph or kph
Add to config.txt and kuid-table for value <KUID2:60850:88000:4
Note: Old root level config tag will

'''QuickDrive Rule:''' Change the Session settings and add consists in Driver

[[Properties:]]
Set Time to insert time
QuickDrive Consist Option List by
Rate of Change insert rate as number times
Enable gameplay Session Mode check
Enable in game help by default check
Set the default Control method to fill-in choose: Easy Mode, Realistic Mode
Prevent player from changing this check
Realistic mode requires achievement add Achievement's Name
In Asset choose Auran achievements
Set the default derailment realism level fill-in choose: Nome, Arcade, Realistic
Prevent player from changing 10.0 check
Set the default units to fill-in choose: Imperial, Metric, Default
Open QuickDriver Window when check

'''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train

[[Properties:]]
Note: One or the other fill-ins must be
Accept trains matching specific criteria fill-in to select from session list
Accept all trains fill-in to set
Trigger rule once check to set
Wait for a driver character to get ? a click to select: On, Off

'''Wait for Driver/Train to be Locally Owned Rule:''' Waits for a specific driver or train car to be locally owned, Owned then executes child rules. If the driver/train car becomes unowned again the child rules are paused

[[Properties:]]
Wait for ownership of a specific Driver fill-in to set
Wait for ownership of Driver fill-in to set
Note: One or the other fill-in must be
Driver or Vehicle click to choose from session lists

=='''Arrangement of Session Rules:'''==

'''Ordered List Rule:''' Child rules will be executed in order once this rule starts

[[Properties:]]
Note: One of the two must be chosen
This process will repeat fill-in click to add number of repeats
This process will repeat forever fill-in

'''Progressive List Rule:''' The first child rule is executed on the first run, second child executed on second run, etc.

[[Properties:]]
After last child run is executed click to choose: First child is chosen again, It will be
used for all successive runs, Successive runs will
do nothing

'''Random List Rule:''' One of the child rules indented under this rule will be

[[Properties:]]
executed randomly
Once one of the child rule is ??

'''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle

[[Properties:]]
None

'''Simultaneous List Rule:''' Child rules are executed simultaneously once this rules

[[Properties:]]
Rules completes when click choose all rules have reached completed state,
was completed state

=='''Camera Rules:'''==

'''Cinematic Camera Rule:''' Provides several different cinematic style cameras

[[Properties:]]
Lock camera controls for the duration check
Prevent rain control for duration check
Camera target: name any of the many objects in session
Camera mode: Stationary, Circle fill-in
Initial camera values: Pitch, Yaw, Zoom value
Total time to animate: seconds value

'''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties

[[Properties:]]
Change the camera view mode to check to choose: Cab View, External View, Tracking
View, Free Roaming
Vehicle fill-in choose from session vehicles
Set the camera flags to enable/disable check to choose different properties from list
Junction fill-in choose from session junctions
Set the target objet of the camera to check
Map object fill-in choose from map objects

'''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view

[[Properties:]]
Trigger rule once check to set
Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking
View, Free Roaming View
Wait for the camera to target vehicle ? click to choose form session list

=='''Message Rules:'''==

Session Rules By Categories With Properties

2017-09-20T16:41:18Z

Coop2:

Session Rules By Categories With Properties

2017-09-20T16:10:33Z

Coop2:

Session Rules By Categories With Properties

2017-09-19T23:47:00Z

Coop2:

Session Rules By Categories With Properties

2017-09-19T23:22:27Z

Coop2:

Session Rules By Categories With Properties

2017-09-19T23:06:17Z

Coop2:

Session Rules By Categories With Properties

2017-09-19T23:05:11Z

Coop2:

Session Rules By Categories With Properties

2017-09-19T23:03:16Z

Coop2:

Session Rules By Categories With Properties

2017-09-18T23:56:13Z

Coop2:

== '''This page is under construction''' ==

List of Trainz Session Rules by Categories with Properties. '''All rules are the Copyrights of N3V Games'''

==Achievement Rules==

‘’Achievement Check Rule:’’ This rule allows you to customize session gameplay based on whether the player has received an achievement

Properties:
None

‘’Advanced Industry Load Configuration Rule:’’ Names industry, lock train's controls?, overrides begin load and begin unload

Properties:
Target object ?? name of object such as Power Station, Coal Pit or Portal
Lock train's controls checked during a stopped load/unload operation
Override 'begin load' and 'begin unload' checked # of seconds to override

‘’Multiple Resource Check Rule:’’ Checks resource for completion

Properties
Wait for the designated queues from choose fall below, reach/exceed
Units number amount of units
Products click choose from session list
Add Object click choose from session list

‘’Objective Add Rule:’’ Sets up a game Objective with ID and display Name

Properties:
Priority click choose Above Normal, Below Normal, Normal, Optional, Urgent
Completion Target click to set target number
Icon click choose from list
Display Name click insert Name
Unique Objective ID click set ID
Custom Message insert typed message in text area

‘’’Objective Check Rule:’’’ Executes child rules when objective is complete
Properties:
Unique Objective ID click insert ID number
Mode click choose Wait for completion, Wait for failure, Wait for progress

‘’Objective Update Rule:’’ Changes progress outcome according to Property choices

Properties:
Unique Objective ID click to set ID number
Mode click Set objective as Decrement progress/Increment progress/Reset objective/Set objects as complete/Set objects as failed/Set progress/Set progress only if greater
Amount click insert number

‘’Power Station Rule:’’ Sets up Station and Consumers

Properties:
Power Station click to choose from session Stations
Consumers(Add Object) click to choose from session list

‘’Ranked Session Begin Rule:’’ Begins a ranked Session

Properties:
Countdown requires a Starting Value insert hrs., min,sec
1 through 5 stars, points for each star insert number of points
Session timer mode fill-in chooses: Timer, Countdown, None

‘’’Ranked Session Complete Rule:’’’ Completes the active ranked Session

Properties:
Set the active ranked session as fill-in choose: Complete, Failed
Customize the completion message check insert text message

‘’Resource Check Rule:’’ Check the progress of the amount of a resource and target object

Properties:
Watch industry queue or Watch vehicle fill-in choose one or the other
Note: Both have: Target Object, Queue: click to choose
Complete when designated queue fill-in equals or exceeds required amount, falls below required amount

‘’Session Complete Rule:’’ Set session to a percentage of completion

Set session to percent complete click to insert number in percent
Separate achievements for completion check

‘’Station Visited Check Rule:’’ Waits for any train to call at one of the designated stations

Properties:
Trigger click to choose from list
Add Industry click to add from session list
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list

==Danger Rules==

‘’ATP Speed Limiter Rule:’’ Limits speed over set limit

Properties:
speed limit over the set limit mph

‘’AWS Configuration Rule:’’ This rule configures the Trainz implementation of AWS

Properties:
Use modern sound set for unfitted cabs? check
Simulate AWS for unfitted cabs? check
Passive with HUD hidden fill-in
Active fill-in
Passive fill-in

‘’Clean UP Derailed Trains Rule:’’ Cleans up derailed train cars

Properties:
Set delay to clean up derailed train cars values

‘’Coupler Breakage Check Rule:’’ Checks for breaking couplers. No parameters.

Properties:
None

‘’Coupler Breakage HUDRule:’’ HUD displays warning about coupler stress and breakage

Properties:
Show the Coupler Breakage Display fill-in must choose one or the other
Hide the Coupler Breakage Display fill-in must choose one or the other

‘’Replace Missing Vehicles Rule:’’ Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule

Properties:
Respawn trains if they are abandoned check
Respawn trains fill-in choose: at their original locations, from portals from Session
List

‘’Safety System Engaged Check Rule:’’ Checks for safety systems making penalty applications on users

Properties:
Trigger only once check

‘’Safety System Isolated Check Rule:’’ Checks for safety systems being isolated by users

Properties:
Trigger only once check

‘’Set Coupler Masks Rule:’’ Set the coupling/decoupling masks on the selected vehicles

Properties:
Add vehicle click to select from session list
Coupling Mask, Decoupling Mask : click to select: lock or unlock
Add All click to select all vehicle in session
Delete All click to delete all vehicle from list

‘’Signal Passed At Danger Check Rule:’’ Checks for Drivers passing signals at danger

Properties:
Trigger only once check to set

‘’Speeding Check Rule:’’ Checks to see if player control trains are over the speed

Properties:
Watch for trains travelling above the fill-in
Allow an over speed tolerance of click to insert mph over posted limit
Watch for trains travelling above a fill-in to insert custom speed limit
Warning: This method is very

‘’Vehicle Physics Rule:’’ Overrides the default vehicle physics properties

Properties:
Accept all trains fill-in
Cab sway level is set ? % click to insert percent of sway
Traction boost is % ? while sanding click to insert percent of boost
Tractions reduced to ? % while click to set traction percent
Maximum tractive effort adjusted by ? click to insert percent amount
Show coupler breakage in HUD Rule check to set
Couplers break when coupling above ? click to set speed
Accept trains matching specific criteria fill-in to insert specific trains
Couplers break at ? kN check to insert amount of force

‘’Wait for Derailment Rule:’’ Waits for a derailment to occur

Properties:
Trigger derailment watch once check to set

==Navigation Rules==

Session Rules By Categories With Properties

2017-09-18T23:55:25Z

Coop2:

== '''This page is under construction''' ==

List of Trainz Session Rules by Categories with Properties. '''All rules are the Copyrights of N3V Games'''

==‘’’Achievement Rules'''==

‘’Achievement Check Rule:’’ This rule allows you to customize session gameplay based on whether the player has received an achievement

Properties:
None

‘’Advanced Industry Load Configuration Rule:’’ Names industry, lock train's controls?, overrides begin load and begin unload

Properties:
Target object ?? name of object such as Power Station, Coal Pit or Portal
Lock train's controls checked during a stopped load/unload operation
Override 'begin load' and 'begin unload' checked # of seconds to override

‘’Multiple Resource Check Rule:’’ Checks resource for completion

Properties
Wait for the designated queues from choose fall below, reach/exceed
Units number amount of units
Products click choose from session list
Add Object click choose from session list

‘’Objective Add Rule:’’ Sets up a game Objective with ID and display Name

Properties:
Priority click choose Above Normal, Below Normal, Normal, Optional, Urgent
Completion Target click to set target number
Icon click choose from list
Display Name click insert Name
Unique Objective ID click set ID
Custom Message insert typed message in text area

‘’’Objective Check Rule:’’’ Executes child rules when objective is complete
Properties:
Unique Objective ID click insert ID number
Mode click choose Wait for completion, Wait for failure, Wait for progress

‘’Objective Update Rule:’’ Changes progress outcome according to Property choices

Properties:
Unique Objective ID click to set ID number
Mode click Set objective as Decrement progress/Increment progress/Reset objective/Set objects as complete/Set objects as failed/Set progress/Set progress only if greater
Amount click insert number

‘’Power Station Rule:’’ Sets up Station and Consumers

Properties:
Power Station click to choose from session Stations
Consumers(Add Object) click to choose from session list

‘’Ranked Session Begin Rule:’’ Begins a ranked Session

Properties:
Countdown requires a Starting Value insert hrs., min,sec
1 through 5 stars, points for each star insert number of points
Session timer mode fill-in chooses: Timer, Countdown, None

‘’’Ranked Session Complete Rule:’’’ Completes the active ranked Session

Properties:
Set the active ranked session as fill-in choose: Complete, Failed
Customize the completion message check insert text message

‘’Resource Check Rule:’’ Check the progress of the amount of a resource and target object

Properties:
Watch industry queue or Watch vehicle fill-in choose one or the other
Note: Both have: Target Object, Queue: click to choose
Complete when designated queue fill-in equals or exceeds required amount, falls below required amount

‘’Session Complete Rule:’’ Set session to a percentage of completion

Set session to percent complete click to insert number in percent
Separate achievements for completion check

‘’Station Visited Check Rule:’’ Waits for any train to call at one of the designated stations

Properties:
Trigger click to choose from list
Add Industry click to add from session list
Accept all trains fill-in
Accept trains matching specific criteria fill-in to choose from session list

==‘’’Danger Rules'''==

‘’ATP Speed Limiter Rule:’’ Limits speed over set limit

Properties:
speed limit over the set limit mph

‘’AWS Configuration Rule:’’ This rule configures the Trainz implementation of AWS

Properties:
Use modern sound set for unfitted cabs? check
Simulate AWS for unfitted cabs? check
Passive with HUD hidden fill-in
Active fill-in
Passive fill-in

‘’Clean UP Derailed Trains Rule:’’ Cleans up derailed train cars

Properties:
Set delay to clean up derailed train cars values

‘’Coupler Breakage Check Rule:’’ Checks for breaking couplers. No parameters.

Properties:
None

‘’Coupler Breakage HUDRule:’’ HUD displays warning about coupler stress and breakage

Properties:
Show the Coupler Breakage Display fill-in must choose one or the other
Hide the Coupler Breakage Display fill-in must choose one or the other

‘’Replace Missing Vehicles Rule:’’ Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule

Properties:
Respawn trains if they are abandoned check
Respawn trains fill-in choose: at their original locations, from portals from Session
List

‘’Safety System Engaged Check Rule:’’ Checks for safety systems making penalty applications on users

Properties:
Trigger only once check

‘’Safety System Isolated Check Rule:’’ Checks for safety systems being isolated by users

Properties:
Trigger only once check

‘’Set Coupler Masks Rule:’’ Set the coupling/decoupling masks on the selected vehicles

Properties:
Add vehicle click to select from session list
Coupling Mask, Decoupling Mask : click to select: lock or unlock
Add All click to select all vehicle in session
Delete All click to delete all vehicle from list

‘’Signal Passed At Danger Check Rule:’’ Checks for Drivers passing signals at danger

Properties:
Trigger only once check to set

‘’Speeding Check Rule:’’ Checks to see if player control trains are over the speed

Properties:
Watch for trains travelling above the fill-in
Allow an over speed tolerance of click to insert mph over posted limit
Watch for trains travelling above a fill-in to insert custom speed limit
Warning: This method is very

‘’Vehicle Physics Rule:’’ Overrides the default vehicle physics properties

Properties:
Accept all trains fill-in
Cab sway level is set ? % click to insert percent of sway
Traction boost is % ? while sanding click to insert percent of boost
Tractions reduced to ? % while click to set traction percent
Maximum tractive effort adjusted by ? click to insert percent amount
Show coupler breakage in HUD Rule check to set
Couplers break when coupling above ? click to set speed
Accept trains matching specific criteria fill-in to insert specific trains
Couplers break at ? kN check to insert amount of force

‘’Wait for Derailment Rule:’’ Waits for a derailment to occur

Properties:
Trigger derailment watch once check to set

==‘’’Navigation Rules'''==