Session Rules By Categories With Properties
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
Contents |
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
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
