Session Rules By Categories With Properties
m (→Achievement Rules) |
(→Achievement Rules) |
||
Line 22: | Line 22: | ||
---- | ---- | ||
=='''Achievement Rules'''== | =='''Achievement Rules'''== | ||
− | + | ||
− | + | ||
− | + | ||
==='''Achievement Check Rule'''=== | ==='''Achievement Check Rule'''=== | ||
Revision as of 21:15, 14 July 2018
TRAINZ A New Era (TANE) SP2. List of Trainz Session Rules by Categories with Properties. All rules are the Copyright of N3V Games
This page is always under construction. As new rules appear they will be added to this list.
Only rules supplied with TANE or on the DLS are covered in this document.
Also available Session Rule List (Alphabetical) with Parameters
Description Key:
- <kuid number> is for the rule version at the time of writing. This number will change if the rule is updated.
- DLS Rule must be downloaded and installed from the DLS.
- Base Rule and Built-in Rule is installed with TANE.
- Parent Rule will execute child rules if it returns a true result.
- Obsolete Rule is no longer required (explanation given).
- Legacy Rule has been replaced by another rule (new rule will be identified).
Achievement RulesAchievement Check RuleExecutes child rules when achievement conditions have been met
Properties: <Not configured, click here to select an achievement asset> - click to select an Achievement Asset from those installed When an Achievement Asset has been selected, the following will appear:- Achievement KUID: <selected asset name> - click to change the selected Achievement Asset Achievement name: <not set> - click to select the achievement name from the selected asset Trigger if achievement: <select> - choose one of:- has been gained - the rule will be triggered when this achievement has been gained has not been gained - the rule will be triggered when this achievement has NOT been gained
Consist Check RuleExecutes child rules when a matching consist is found. The order of the vehicles in the consists is not important.
Properties: [Check Box] Enforce strict exclusive testing - check to only accept an exact match with no unspecified vehicles in the consist. - leave unchecked to accept any consist that contains the specified vehicles. Select one of two option buttons:- ( ) Rule disabled - select to disable the operation of this rule ( ) Complete whenever a train matching the description exists - When selected, enter the consist description:- Specific vehicle - identify the specific vehicle(s) that will trigger the rule + - click to add a specific vehicle from the session list x - click to remove the specific vehicle from the rule Vehicle types - identify the type of vehicle(s) that will trigger the rule + - click to add a type of vehicle from the session list x - click to remove the type of vehicle from the rule Drivers - identify the driver(s) that will trigger the rule + - click to add a driver from the session list x - click to remove a driver from the rule
Multiple Resource Check RuleExecutes child rules if industries or vehicles reach set commodity levels. This rule replaces the older Resource Check Rule
Properties: <Product Level> - click to select a product test from two choices:- Reach/Exceed - sets an upper limit for the resources being monitored. For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon reaches or exceeds a specified level. The initial level in the object must be below the set upper limit. Fall below - sets a lower limit for the resources being monitored. For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon falls below a specified level. The initial level in the object must be above the set lower limit. To test when a resource level reaches zero (i.e. is empty) set the lower limit to a very low value but not zero as the level can never fall below zero. <value> - enter required quantity value <select> - select a product from session list of products <Add object> - click to select a source or target object. Multiple objects and their queues can be added to the rule. ALL the entered products must reach/exceed or fall below the specified value for the rule to be triggered. For each object:- <Object> - click to select session active industry or product enabled rail vehicle <Queue> - select product queue (there may be only one available) <Remove> - removes the object and its product queue from the rule
Objective Add RuleSets up a game Objective with ID and display Name
Properties: Priority <Select> - select one of:- Above Normal Below Normal Normal Optional Urgent Completion Target Number <value> - to set Completion Target Number Icon <select> - to select Icon from list Display Name <enter> - to insert Name Unique Objective ID <enter> - enter a unique objective ID Custom Message <Text Box> - insert typed message in text area
Objective Check RuleExecutes child rules if an objective created with the Objective Add Rule is complete.
Properties: Unique Objective ID <value> - enter the unique ID created with the Objective Add Rule Mode <select> - select one of three:- Wait for completion Wait for failure Wait for progress
Objective Update RuleChanges 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
Ranked Session Begin RuleBegins 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: - select one of three option buttons:- ( ) Timer ( ) Countdown Starting value <value> - enter time hh:mm:ss ( ) None
Ranked Session Complete RuleCompletes the active ranked Session
Properties: Set the active ranked session as: - select one of two option buttons:- ( ) Complete ( ) Failed [Check Box] Customize the completion message <text> - enter a text message
Resource Check RuleExecutes child rules if a selected industry or vehicle reaches a set commodity level. This rule has been superseded by the Multiple Resource Check Rule
Properties: Select one of two option buttons:- ( ) Watch industry queue Target Object <select> - select an industry from the session list Queue <select> - select a product queue from the selected industry Product <select> - select a product from the selected queue Amount <value> - enter a quantity Select one of two option buttons:- ( ) Complete when designated queue equals or exceeds required amount ( ) Complete when designated queue falls below required amount ( ) Watch vehicle Target Object <select> - select a rolling stock asset from the session list Queue <select> - select a product queue from the selected rolling stock Product <select> - select a product from the selected queue Amount <value> - enter a quantity Select one of two option buttons:- ( ) Complete when designated queue equals or exceeds required amount ( ) Complete when designated queue falls below required amount
Resource Verify Rule (fixed)Executes child rules if a selected industry or vehicle reaches a set commodity level. The rule resets when all child rules have completed.
Properties: Select one of two option buttons:- ( ) Watch industry queue Target object <click to select> - click to select an industry from the session list. Product <click to select> - click to select an industry product. Amount <value> - enter a quantity for the selected product. Select one of two option buttons:- ( ) Complete when designated queue equals or exceeds designated amount ( ) Complete when designated queue falls below designated amount ( ) Watch vehicle queue Target object <click to select> - click to select a rolling stock vehicle from the session list. Product <click to select> - click to select a commodity product. Amount <value> - enter a quantity for the selected product. Select one of two option buttons:- ( ) Complete when designated queue equals or exceeds designated amount ( ) Complete when designated queue falls below designated amount
Station Visited Check RuleExecutes child rules if specific trains call at set stations or industries
Properties: Trigger: <select> - click to select one of the following Never - stopping at the selected industries will never trigger the rule. Once only - the rule is triggered on the first visit only to any one of the selected industries Once per industry - the rule is triggered on the first visit to each industry with each individual product Once per visit - the rule is triggered on the first visit to each industry regardless of the product Once per vehicle - each vehicle can only trigger the rule once. <select industry> - select industry or industries from session list Select one of two option buttons:- ( ) click to accept all trains ( ) click to accept trains matching specific criteria Selecting the second option will produce the following selection controls:- Specific vehicle - identify the specific vehicle or set of specific vehicles that will trigger the rule + - click to add a specific vehicle from the session list x - click to remove the specific vehicle from the rule Vehicle types - identify the type of vehicle or a set of vehicle types that will trigger the rule + - click to add a type of vehicle from the session list x - click to remove the type of vehicle from the rule Drivers - identify the drivers that will trigger the rule + - click to add a driver from the session list x - click to remove a driver from the rule
Camera RulesCinematic Camera RuleProvides several different cinematic style cameras with animations. Best used at the start of a session. Use the Trackside Camera (tracking view) found in the Set Camera Rule during session play.
Properties: [Check Box] Lock camera controls for the duration - if checked user cannot alter camera view [Check Box] Prevent train control for duration - if checked user cannot control train Camera target: <click to select> - click to select the object from the session list that will be the camera target Camera mode: - select one of three option buttons:- ( ) Stationary ( ) Circle targeted object ( ) Move from one point to another (zoom, pan, etc) Initial camera values: [Check Box] Pitch: <value> - check to select then click value to enter a pitch value [Check Box] Yaw: <value> - check to select then click value to enter a yaw value [Check Box] Zoom: <value> - check to select then click value to enter a zoom value Total time to animate: <value> - enter an animation time in seconds
Focus Camera RuleSets the initial camera view and starting vehicle for a session.
Properties: Focus camera to: - select one of two option buttons ( ) Map object ( ) Vehicle Named <?????> - enter name of object or vehicle from session list Additionally: [Check Box] set view mode to - check to select one of four option buttons ( ) Internal view ( ) External view ( ) Tracking view ( ) Roaming view [Check Box] restrict user to manipulate the camera - check to set user limits on camera controls [Check Box] allow internal view [Check Box] allow external view [Check Box] allow tracking view [Check Box] allow roaming view [Check Box] allow change of view mode [Check Box] allow change vehicle in train [Check Box] allow change trains [Check Box] allow adjust camera viewpoint [Check Box] set camera angles - check to set the initial camera view point Yaw (90 = look at front of train): <value> degrees - enter yaw angle Pitch (-90 = down, 90 = up): <value> degrees - enter pitch angle Distance from the focused object: <value> metres - enter distance from camera to object
Set Camera RuleSets the target object and properties of the camera.
Properties: [Check Box] Set the target object of the camera to: - if checked, select one of three option buttons:- ( ) Vehicle <click to select> - select a vehicle from the Session list ( ) Junction <click to select> - select a junction from the Session list ( ) Map Object <click to select> - select a named map object from the Session list [Check Box] Change the camera view mode to <click to select> - if checked, select one camera view mode from Cab View External View Tracking View Free Roaming [Check Box] Set the camera flags to enable/disable user access to - if checked, select as many of the following check boxes as needed [Check Box] Internal view mode - check to enable, uncheck to disable [Check Box] External view mode - check to enable, uncheck to disable [Check Box] Tracking view mode - check to enable, uncheck to disable [Check Box] Roaming view mode - check to enable, uncheck to disable [Check Box] View switching - check to enable, uncheck to disable [Check Box] Vehicle view switching - check to enable, uncheck to disable [Check Box] Train view switching - check to enable, uncheck to disable [Check Box] Camera adjustments (pan, zoom, etc) - check to enable, uncheck to disable
Wait for Camera View Mode RuleExecutes child rules when the camera view is changed to a selected view
Properties: [Check Box] Trigger rule once - check to set Wait for the camera to change to the <click to select> - select one camera view mode from:- Cab View External View Tracking View Free Roaming [Check Box] Wait for the camera to target vehicle <click to select> - if checked, select a vehicle from the Session list
Danger, Derailment and Safety RulesATP Speed Limiter RuleLimits allowable speed over set limit
Properties: Limits the speed to <value> mph over the set limit - enter speed value in mph Related Rules: AWS Configuration Rule - configures the Trainz implementation of the Automatic Warning System when approaching signals AWS Configuration RuleThis rule configures the Trainz implementation of the Automatic Warning System when approaching signals
Properties: Select one of three option buttons:- ( ) Active ( ) Passive ( ) Passive with HUD hidden [Check Box] Simulate AWS for unfitted cabs? [Check Box] Use modern sound set for unfitted cabs? Clean Up Derailed Trains RuleCleans 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
Coupler Breakage Check RuleExecutes child rules if there is a coupler breakage
Properties: None
Coupler Breakage HUD RuleHUD displays warning about coupler stress and breakage
Properties: Select one of two option buttons:- ( ) Show the Coupler Breakage Display ( ) Hide the Coupler Breakage Display
Junction Derailment Prevention RuleSets opposing (trailing) junctions ahead of a train to prevent derailments. Works with both AI and manually driven trains.
Properties: None
Replace Missing Vehicles RuleProduces new trains to replace missing vehicles that have been removed from the session by the Clean Up Derailed Trains Rule
Properties: [Check Box] Respawn trains if they are abandoned for 10 minutes If checked:- Select one of two option buttons:- ( ) Respawn trains at their original locations ( ) Respawn trains from portals <+ Add a new portal> - click to enter the name of a portal, there can be more than one portal. Entered portal names that appear in red have not been found in the session
Safety System Engaged Check RuleExecutes child rules if safety systems are applied.
Properties: [Check Box] Trigger only once
Safety System Isolated Check RuleExecutes child rules if safety systems are isolated (disengaged).
Properties: [Check Box] Trigger only once
Set Coupler Masks RuleSet 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 RuleExecutes child rules if a signal or stop mark is Passed at Danger (STOP).
Properties: [Check Box] Trigger only once
Speeding Check RuleExecutes child rules if player controlled trains are over the local speed limit or over a set (custom) speed
Properties: Select one of two options to set a speed limit to be observed ( ) Watch for trains travelling above the posted speed limit <speed value> - click to enter a new overspeed tolerance value <speed units> - click to select one from the list:- Km/h - Kilometres per hour MPH - Miles per hour mps - metres per second ( ) Watch for trains travelling above a custom speed <speed value> - click to enter a new custom speed value <speed units> - click to select one from the list:- Km/h - Kilometres per hour MPH - Miles per hour mps - metres per second Warning: This option is very performance intensive and should only be used in sessions with few trains
Vehicle Physics RuleOverrides the default vehicle physics properties for all vehicles or for those matching set criteria
Properties: Select one of two option buttons:- ( ) click to accept all trains ( ) click to accept trains matching specific criteria Selecting the second option will produce the following selection controls:- Specific vehicle - identify the specific vehicle or set of specific vehicles that will trigger the rule + - click to add a specific vehicle from the session list x - click to remove the specific vehicle from the rule Vehicle types - identify the type of vehicle or a set of vehicle types that will trigger the rule + - click to add a type of vehicle from the session list x - click to remove the type of vehicle from the rule Drivers - identify the drivers that will trigger the rule + - click to add a driver from the session list x - click to remove a driver from the rule Coupler Parameters: Couplers break at <value> kN expansion force - enter force value Couplers break at when coupling above <value> kph - enter speed value [Check Box] Show coupler breakage in HUD - check to display breakage in on-screen HUD Wheelslip Parameters: Maximum tractive effort adjusted by <value> % - enter adjustment as a % Traction is reduced to <value> % while wheelslipping - enter value as a % Traction boost is <value> % while sanding - enter value as a % Sway Parameters: Cab sway level is set to <value> % - enter value as a % Wait for Derailment RuleExecutes child rules when a derailment occurs
Properties: [Check Box] Trigger derailment watch once - check to execute the rule once only
Driver RulesAI Start RuleRestarts all halted AI controlled trains. Drivers will continue with the commands in their driver command list.
Properties: None
AI Stop RuleHalts all AI controlled trains but does not delete their driver commands. AI trains can be restarted with the AI Start Rule or by issuing individual Continue Schedule commands.
Properties: None
Control Check RuleExecutes child rules if the train control method has been altered or a specific method has been selected.
Properties: Execute child rules when: - select one of two option buttons:- ( ) DCC mode is Selected ( ) Cab mode is Selected Execute child rules: - select one of two option buttons:- ( ) Every time control method is set ( ) Once only
Control Type RuleSets the control method
Properties: Current control method is: <select> - click to select one of Easy Mode - DCC (standard keyboard and mouse) control Ask User - let the user decide Realistic Mode - Cab controls (on screen levers, throttles, buttons, etc)
Disallow AI RuleCancels (deletes) all current and waiting AI commands for all drivers
Properties: None
Driver Command Check RuleExecutes child rules if the driver commands match a set list.
Properties: [Check Box] Trigger rule once - check to allow the rule to execute only once Driver character to watch the command list of <select> - select a driver name from the Session List Wait for driver character to have a command list that matches this: <add driver command> - add a driver command from the session list. More commands can be added. Commands can be deleted. <add all> - adds ALL driver commands in the session list. Individual commands can be removed. <delete all> - deletes all entered driver commands from the session rule
Driver Command RuleSpecifies which commands will be available for the drivers
Properties:: For each installed Driver Command:- [Check Box] Name of Driver Command and Description (if available) - check to make that command available to the drivers
Driver Main Menu Options RuleShow/Hide the Driver Main Menu Bar
Properties: <Show/Hide> the Driver Main Menu Bar - click Show or Hide to select Driver Schedule RuleSets up a list of basic scheduled commands
Properties: Driver Schedule Assigned to name of driver <icon> - click icon to select a driver from those assigned in the Driver Setup Rule Next commands, will be executed >> - click to enter driver commands from those specified in the Driver Command Rule Style: - select one of four option buttons:- ( ) Classic style: If there is a schedule do not emit a new schedule - any currently assigned set of driver commands will not be replaced ( ) Killer style: If there is a schedule clean it and emit a new one - replace any currently assigned driver commands with the new commands ( ) Cooperative style: If there is a schedule append the new one - add the new driver commands to the end of any existing commands ( ) Active style: Emit a new schedule, only if already a schedule running - only add the new commands if commands are currently running
Driver Setup RuleCreates the list of drivers for this session and assigns them their orders
Properties: <driver icon> - click to select a new driver from the list of installed and built in drivers <loco> - click to select a new locomotive from the session list and assign it to this driver. Locos displayed in red have not been found in the session list <driver name> - click to enter a new name for the selected driver <driver mode> - click to select one of:- Autodetect - the program will detect the driver mode to be used. For example, if driver commands have been entered for this driver then the AI driver mode will be selected First Human Player - the driver will be assigned to the user or multiplayer who accesses her/him first AI driver - the AI will be given control even if no commands are present Multiplayer Driver - the driver will be assigned to a multiplayer user <remove> - this driver will be removed from the rule >> - click to enter driver commands from those specified in the Driver Command Rule --> Scroll down to the bottom of the list of entered drivers for more options <Add another driver> - click to add another driver [Check Box] Remove all existing Drivers first - see Known Issues below [Check Box] Generate new Drivers for empty Trains - when checked all newly added locos will automatically be given drivers
Enable/Disable Driver Commands RuleEnable/Disable specific driver commands on certain drivers. Multiple copies of the rule can be used to give different drivers or consists different command lists
Properties: <Enable/Disable> the following driver commands ... - click to select Enable or Disable For each driver command:- [Check Box] command name - check to enable or disable [Check Box] command name - check to enable or disable [Check Box] command name - check to enable or disable etc Select one of two option buttons:- ( ) click to accept all trains ( ) click to accept trains matching specific criteria Selecting the second option will produce the following selection controls:- Specific vehicle - identify the specific vehicle or set of specific vehicles that will trigger the rule + - click to add a specific vehicle from the session list x - click to remove the specific vehicle from the rule Vehicle types - identify the type of vehicle or a set of vehicle types that will trigger the rule + - click to add a type of vehicle from the session list x - click to remove the type of vehicle from the rule Drivers - identify the drivers that will trigger the rule + - click to add a driver from the session list x - click to remove a driver from the rule
JTG Correct Vehicle LightsCorrects the brightness of vehicle headlights. Now obsolete.
Properties: None Quick Portal Manager Standard Edition Rule (SP2 and later)Manages portals and adds flexible timetables.
Properties: Target date is day-of-week <dd/mm/yyyy> - day-of-week and date shown are for today's date. Click dd/mm/yyyy to change date. <Copy rule data to Clipboard> - click to copy the currently entered data to a special clipboard area used by the rules created by pguy. This is NOT the standard OS clipboard. <Paste rule data from Clipboard> - if data is held in the special clipboard area, then click to paste that data into the rule. This is NOT the standard OS clipboard. [Check Box] This rule is enabled - check to activate (enable) the rule. [Check Box] Avoid duplicated driver if possible - check to prevent the same driver being used again. If a driver name is reused, the rule will select a different driver name. [Check Box] Disable locomotives/vehicles enhanced mode - check to save vehicle properties when a train is removed by a portal. These properties will be restored if the same train is emitted by a portal. If checked then a new command will appear: <for all vehicles/for only locomotives/for only tagged vehicles> - click to select one. Portal selected: <portal name> [...] - select a portal to manage by clicking <portal name> or [...] and selecting a portal from the Session list. Portal output link: <[no link]> [...] - leave blank. Portal input link: <[no link]> [...] - leave blank unless you want to connect to a Global Input Queue. Click to select an input queue from the Session list. Default schedule for input trains is named: <schedule> - click to enter a schedule name. Today's schedule: <Insert new schedule> - click to enter a new schedule For each schedule:- <hh:mm> - click to set the time when a train will be emitted from the portal. Times use the 24hr clock. <train name> - click to enter the train name <mission code> - click to enter the Mission Code created by the MissionCode Manager Rule (SP2 and later). <schedule> - click to enter the re-occurrence schedule in hh:mm (24hr clock) where, for example: 02:30 means every 2 hrs 30 minutes, 00:00 means once only, 24:00 means once each day. <driver> - click to select a driver name or select auto-driver to let the rule select a driver. Current driver order bar is named <schedule> - click to enter a name for the order (Driver Command) bar used in this schedule. <hud> - click to select a HUD for this train. HUDs must be created using the Quick CustomHud Manager Rule (SP2 and later). Driver Command Bar - enter driver commands for this train. Choose one of two consist sets: <mono consist> consist for every day - if selected the same consist will be used each day. <no consist selected> - click to select a consist from those saved in your install. <multi consists> - if selected a different consist will be used each day. For each day of the week: Day-of-week <no consist selected> - click to select a consist from those saved in your install.
QuickDrive RuleChanges the Session settings.
Properties: Open QuickDrive window when session is started [Check Box] - check to set Set time to <hours:minutes> with a rate of <speed x> - set start time and rate at which time advances Enable gameplay Session Mode [Check Box] - check to set. Gameplay mode restricts the players options Enable in game help by default [Check Box] - check to allow help options to be displayed Set the default Control method to: - select one of two option buttons:- ( ) Easy Mode ( ) Realistic Mode [Check Box] Prevent player from changing this setting - check to set Realistic mode requires achievement: <text> in asset <asset name> - enter achievement name and select an asset from Aurans Achievements Set the default derailment realism to: - select one of three option buttons:- ( ) None ( ) Arcade ( ) Realistic [Check Box] Prevent player from changing this setting - check to set Set the default units to: - select one of three option buttons:- ( ) Imperial ( ) Metric ( ) Default
Schedule RuleAllows 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
Wait for Driver On/Off Train RuleExecutes child rules when a driver gets on or off a train
Properties: [Check Box] Trigger Rule Once - click to set Wait for a driver character to get <On/Off> a train that matches the following criteria - select On or Off Select one of two option buttons:- ( ) click to accept all trains ( ) click to accept trains matching specific criteria Selecting the second option will produce the following selection controls:- Specific vehicle - identify the specific vehicle or set of specific vehicles that will trigger the rule + - click to add a specific vehicle from the session list x - click to remove the specific vehicle from the rule Vehicle types - identify the type of vehicle or a set of vehicle types that will trigger the rule + - click to add a type of vehicle from the session list x - click to remove the type of vehicle from the rule Drivers - identify the drivers that will trigger the rule + - click to add a driver from the session list x - click to remove a driver from the rule
Wait for Driver/Train to be Locally Owned RuleExecutes child rules when a specific driver or vehicle is locally owned. If the driver/vehicle becomes unowned again the child rules are paused
Properties: Assets Ownership: - select one of two option buttons:- ( ) Wait for ownership of a specific Driver ( ) Wait for ownership of Driver Driver or Vehicle <select> - choose from session list
HUD (Heads Up Display) RulesCab Controls HUD RuleWas used to provide the HUD controls for the cabin view. Now obsolete.
Properties: None Coupler Breakage HUD RuleHUD displays warning about coupler stress and breakage
Properties: Select one of two option buttons:- ( ) Show the Coupler Breakage Display ( ) Hide the Coupler Breakage Display
Display Custom HUD RuleShow or hide the Custom Heads Up Display.
Properties: Show or Hide the Custom Heads up Display - select one of two option buttons:- ( ) Show the Custom Heads up Display ( ) Hide the Custom Heads up Display
Flash HUD Icon RuleFlashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.
Properties: Select one of two option buttons:- ( ) Flash the <click to select> icon on the <click to select> HUD panel for a period of <value> seconds TIP: Select the HUD panel first (the second <click to select> link). Available HUD panels are (select one):- Bottom Right Menu Camera Controls DCC Controls Driver Main Menu Available icons will depend on the HUD panel selected. ( ) <Start/Stop> flashing the <click to select> icon on the <click to select> HUD panel TIP: Select the HUD panel first (the second <click to select> link). Available HUD panels are (select one):- Bottom Right Menu Camera Controls DCC Controls Driver Main Menu Available icons will depend on the HUD panel selected.
mc Display Custom HUD V2 Rule (SP2 and later)Shows or hides a graphical HUD which includes junction direction for the junction ahead. This rule has been superseded by the Quick CustomHUD Manager Rule (SP2 and later)
Properties: Show or Hide the Custom Heads up Display - select one of two option buttons:- ( ) Show the Custom Heads up Display ( ) Hide the Custom Heads up Display
Quick CustomHud Manager Rule (SP2 and later)Allows the creation of new graphical heads up displays which are assigned to the drivers in Driver Mode. Replaces the mc Display Custom HUD V2 Rule (SP2 and later)
Properties: <Copy rule to data Clipboard> - click to copy the data from the selected HUD to a special clipboard area used by the rules created by pguy. This is NOT the standard OS clipboard. <Paste rule data from Clipboard> - if data is held in the special clipboard area, then click to paste that data into the selected HUD. This is NOT the standard OS clipboard. Current HUD Parameters HUD to select: <HUD name> - click to select a HUD from those available. One or two default HUDs will be supplied. new HUD - click to create a new HUD display with default properties. You will be required to enter a name for the new HUD clone HUD - click to create a new HUD using the properties of the currently selected HUD. You will be required to enter a name for the new HUD copy HUD - copies (overwrites) the currently selected HUD with the properties of another HUD. You will be required to enter the name of the HUD to be copied For new, cloned or copied HUDs, additional commands will be shown: rename HUD - rename the selected HUD. You will be required to enter a new name for the HUD delete HUD - delete the currently displayed HUD In Driver Mode an additional command will be shown: Assign hud to current train - click to assign the currently selected HUD to the currently selected driver [Check Box] hud is displayed (on) - check to display HUD in Driver Mode hud items nb entries max: <value> - enter the maximum number of items to be displayed in the HUD. Maximum is 30. hud view limit: <value> - enter the maximum look-ahead distance in metres for the HUD. Minimum value is 1000, maximum value is 10000. [Check Box] display data in a centred window above orderbar - check to display the HUD centred on the screen just above the driver command bar in Driver Mode For each individual HUD property: [Check Box] HUD property - check to add this property to the HUD
Show/Hide HUD Panel RuleShows or hides a HUD panel.
Properties: <Show/Hide> the <click to select> HUD panel - select Show or Hide and then select the HUD panel
Variable Show RuleAdds 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.
Wait for Click on HUD Icon RuleExecutes child rules when the user clicks on a selected HUD icon
Properties: [Check Box] Trigger Once HUD Panel <Click> - click choose from list:- Bottom Right Menu Camera Controls DCC Controls Icon <Click> - click to choose from list. Selections depends on HUD Panel chosen
Industry RulesAdvanced Industry Load Configuration RuleLocks train controls when loading/unloading at an industry, overrides time settings for begin load and begin unload operations
Properties: Target object <select> - select industry object from session list [Check Box] Lock the train's controls during a stopped load/unload operation - check to disable driver controls while train is stopped and loading/unloading [Check Box] Override 'begin load' and 'begin unload' durations to <value> seconds - if checked enter number of seconds to override
Disable/Enable Industry RuleEnables/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: - select one of two option buttons:- ( ) Apply to every vehicle in the session ( ) Apply only to a specific vehicles from Session List DisplayIndustryStatus Rule (color modified)Displays a summary of industry product levels when the "k" key is pressed.
Properties: None
ExTrainz Manager Rule - TANE SP2Provides information on consists, industries and products in both Surveyor and Driver modes. Once activated, the rule creates an additional short menu bar below the main menu bar.
Properties: Diagnostic mode is <On/Off> - click to select On or Off. When set On diagnostic messages will be added to the Trainz Log file. Turn on message overlay <Yes/No> - click to select Yes or No. When set to Yes the message overlay (lower left of screen) will be active. Show rolling stock in Driver mode <Yes/No> - click to select Yes or No. When set to Yes rolling stock can be searched in Driver. Search only rolling stock already in session <Yes/No> - click to select Yes or No. When set to Yes only those rolling stock assets installed in the session can be searched. Graphic colours: <When Red, the industry does not require service/When Green, the industry does not require service> - click to switch between the two colour options. Industry page size: <value> - enter the number of industries to be displayed in the Industry List window (maximum 250). The following industries are excluded: <Add an industry to be excluded> - name can be complete (e.g. "Coal Mine 2") which will exclude that specific industry from the management list, or partial (e.g. "Coal") which will exclude all industries with the word "Coal" in their names. Entries are not case sensitive. Once industries have been excluded, additional commands will appear for each excluded industry:- <delete> <industry name begins with/class name begins with> <name> - click delete to remove this entry. - click industry name begins with/class name begins with to select between the two (see notes below). - click name to edit the name.
Multiple Resource Check RuleExecutes child rules if industries or vehicles reach set commodity levels. This rule replaces the older Resource Check Rule
Properties: <Product Level> - click to select a product test from two choices:- Reach/Exceed - sets an upper limit for the resources being monitored. For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon reaches or exceeds a specified level. The initial level in the object must be below the set upper limit. Fall below - sets a lower limit for the resources being monitored. For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon falls below a specified level. The initial level in the object must be above the set lower limit. To test when a resource level reaches zero (i.e. is empty) set the lower limit to a very low value but not zero as the level can never fall below zero. <value> - enter required quantity value <select> - select a product from session list of products <Add object> - click to select a source or target object. Multiple objects and their queues can be added to the rule. ALL the entered products must reach/exceed or fall below the specified value for the rule to be triggered. For each object:- <Object> - click to select session active industry or product enabled rail vehicle <Queue> - select product queue (there may be only one available) <Remove> - removes the object and its product queue from the rule
Power Station RuleSets 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 Resource Check RuleExecutes child rules if a selected industry or vehicle reaches a set commodity level. This rule has been superseded by the Multiple Resource Check Rule
Properties: Select one of two option buttons:- ( ) Watch industry queue Target Object <select> - select an industry from the session list Queue <select> - select a product queue from the selected industry Product <select> - select a product from the selected queue Amount <value> - enter a quantity Select one of two option buttons:- ( ) Complete when designated queue equals or exceeds required amount ( ) Complete when designated queue falls below required amount ( ) Watch vehicle Target Object <select> - select a rolling stock asset from the session list Queue <select> - select a product queue from the selected rolling stock Product <select> - select a product from the selected queue Amount <value> - enter a quantity Select one of two option buttons:- ( ) Complete when designated queue equals or exceeds required amount ( ) Complete when designated queue falls below required amount
Resource Verify Rule (fixed)Executes child rules if a selected industry or vehicle reaches a set commodity level. The rule resets when all child rules have completed.
Properties: Select one of two option buttons:- ( ) Watch industry queue Target object <click to select> - click to select an industry from the session list. Product <click to select> - click to select an industry product. Amount <value> - enter a quantity for the selected product. Select one of two option buttons:- ( ) Complete when designated queue equals or exceeds designated amount ( ) Complete when designated queue falls below designated amount ( ) Watch vehicle queue Target object <click to select> - click to select a rolling stock vehicle from the session list. Product <click to select> - click to select a commodity product. Amount <value> - enter a quantity for the selected product. Select one of two option buttons:- ( ) Complete when designated queue equals or exceeds designated amount ( ) Complete when designated queue falls below designated amount
Station Visited Check RuleExecutes child rules if specific trains call at set stations or industries
Properties: Trigger: <select> - click to select one of the following Never - stopping at the selected industries will never trigger the rule. Once only - the rule is triggered on the first visit only to any one of the selected industries Once per industry - the rule is triggered on the first visit to each industry with each individual product Once per visit - the rule is triggered on the first visit to each industry regardless of the product Once per vehicle - each vehicle can only trigger the rule once. <select industry> - select industry or industries from session list Select one of two option buttons:- ( ) click to accept all trains ( ) click to accept trains matching specific criteria Selecting the second option will produce the following selection controls:- Specific vehicle - identify the specific vehicle or set of specific vehicles that will trigger the rule + - click to add a specific vehicle from the session list x - click to remove the specific vehicle from the rule Vehicle types - identify the type of vehicle or a set of vehicle types that will trigger the rule + - click to add a type of vehicle from the session list x - click to remove the type of vehicle from the rule Drivers - identify the drivers that will trigger the rule + - click to add a driver from the session list x - click to remove a driver from the rule
Interlocking Tower, Junction and Signal RulesInterlocking Tower Configure Path RuleAlters settings on an interlocking tower path
Properties: Interlocking Tower <select> - to set Name and Objects
Interlocking Tower Path Selection UI RuleWill 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 RuleWill 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)Provides more management and control options for interlocking towers.
Properties: <towers> - click to select interlocking towers from the session list <do full check again> - click to run an error check on all interlocking towers List of all available interlocking towers - for each tower:- <view details> - click to view and edit the tower properties <copy from> - click to copy properties from another tower selected from the session list <debug log> - click to set the debug log properties
Junction Derailment Prevention RuleSets opposing (trailing) junctions ahead of a train to prevent derailments. Works with both AI and manually driven trains.
Properties: None
Lock All Junctions RuleLocks all junctions against user actions. AI operations are not affected. Once the AI releases a junction, it will be returned to its previous locked state.
Properties: None
MissionCode Manager Rule (SP2 and later)Enables the addition, editing and management of Mission Codes used to auto select paths in Interlocking Towers.
ENTRY UNDER CONSTRUCTION
MissionCode Stops and Timetable Manager Rule (SP2 and later)Enables the creation, editing and management of stop zones and timetables for trains following a path defined using mission codes.
ENTRY UNDER CONSTRUCTION
Multiple Junction Alignment Check RuleExecutes child rules if specific junctions are set.
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
Set Cleared Junctions RuleSets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control) while they are unoccupied. If a junction is occupied it waits until the junction is cleared. Warning: not compatible with Interlocking Tower Assets
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 Junctions RuleSets selected junctions to specific states (direction, locked/unlocked, allow/prevent AI control). 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 RuleSets the state of a selected signal Warning: not compatible with Interlocking Tower Assets
Properties: <Select signal> to <signal state> - click to select a signal from the session list and click to select a state from the list - Automatic Stop Stop then Continue Caution Left Caution Right Caution Advance Caution Left Advance Caution Right Advance Caution Proceed Left Proceed Right Proceed Slow Medium
Trigger Multiple Signals RuleSets selected signals to DANGER (STOP) when selected triggers are activated. Signals will be at AUTOMATIC when the triggers are not activated.
Properties: <add signal> - select a signal from the Session List. More than one signal can be added. <delete> - remove a signal from the rule. <add trigger> - select a trigger from the Session List. More than one trigger can be added. <delete> - remove a trigger from the rule.
Message RulesClose Message Popup RuleCloses open message popups
Properties: None
DestSign Table RuleCreates 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 Display HTML Pages RuleCreates 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 <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
Display Video RuleDisplays a page containing a video clip from a HTML asset in a browser window.
Properties: Display page <index.html> of html asset <click to select> in a new browser window index.html - enter the filename of a HTML page in the selected HTML asset. The .html is optional in the filename. <click to select> - select the HTML asset from those installed.
DisplayIndustryStatus Rule (color modified)Displays a summary of industry product levels when the "k" key is pressed.
Properties: None
ExTrainz Manager Rule - TANE SP2Provides information on consists, industries and products in both Surveyor and Driver modes. Once activated, the rule creates an additional short menu bar below the main menu bar.
Properties: Diagnostic mode is <On/Off> - click to select On or Off. When set On diagnostic messages will be added to the Trainz Log file. Turn on message overlay <Yes/No> - click to select Yes or No. When set to Yes the message overlay (lower left of screen) will be active. Show rolling stock in Driver mode <Yes/No> - click to select Yes or No. When set to Yes rolling stock can be searched in Driver. Search only rolling stock already in session <Yes/No> - click to select Yes or No. When set to Yes only those rolling stock assets installed in the session can be searched. Graphic colours: <When Red, the industry does not require service/When Green, the industry does not require service> - click to switch between the two colour options. Industry page size: <value> - enter the number of industries to be displayed in the Industry List window (maximum 250). The following industries are excluded: <Add an industry to be excluded> - name can be complete (e.g. "Coal Mine 2") which will exclude that specific industry from the management list, or partial (e.g. "Coal") which will exclude all industries with the word "Coal" in their names. Entries are not case sensitive. Once industries have been excluded, additional commands will appear for each excluded industry:- <delete> <industry name begins with/class name begins with> <name> - click delete to remove this entry. - click industry name begins with/class name begins with to select between the two (see notes below). - click name to edit the name.
Fade In/Out RuleFade in or out within seconds, using specified color and opacity values.
Properties: Red percentage: <value> - enter the final % of red (0 = none, 100 = maximum) Green percentage: <value> - enter the final % of green Blue percentage: <value> - enter the final % of blue Alpha percentage (opacity): <value> - enter the final % of opacity (0 = invisible, 100 = solid) Fading duration: <value> - enter the number of seconds required for the fade <help> - click to bring up help instructions
Hide Product Overlays RuleHides the commodity or product bar graphs that appear on active industries
Properties: None InputTable RuleCreates a list of message names to be used for various purposes including passing data to Driver Commands
Properties: <add> - click to add a new entry to the table Each new entry will require an input message <short message> - enter a message. The message must be in a format that is specific for each purpose For the MoveTurntable driver command the message must be formatted as:- turntable,name_of_turntable,number_of_connecting_roads - the first entry must be the word turntable in lower case. name_of_turntable is the name of the turntable, number_of_connecting_roads is the number of tracks connecting to the turntable For the WaitUntilTime driver command the message must be formatted as:- time,hour,minute - the first entry must be the word time in lower case, hour must be from 0 to 23, minute must be from 0 to 59. For the WaitUntilSVariable driver command the message must be formatted as:- svar,svar_name,svar_condition,value - the first entry must be the word svar in lower case, svar_name is the name of the session variable, svar_condition is an equality (eg eq for equal, gt for greater than, etc) value is an integer value to be compared to the session variable. Each entry in the table will be followed by the commands:- cp - click to copy this entry to a new entry up - click to move this entry up one level dn - click to move this entry down one level rm - click to remove this entry from the table Message Popup RuleDisplays 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 closed [Check Box] Close previous popup windows - closes any Message Popups currently displayed before this message is shown Message location <Top Left/Top Right/Bottom Left/Bottom Right> - select one to position the browser window on the screen Message Source: - select one of three option buttons:- ( ) Custom text - the simplest and easiest option Icon <Click here to set> - (optional) shows a list of message icons. Select one to be displayed with the message Icon <Clear icon> - clears any currently displayed message icon Custom text box Enter text to be displayed. You will be limited to about 6 lines of text. For longer messages or to include graphics, use the A predefined HTML page option. <HTML Wave> - (optional) select the name of the HTML asset from the list shown that contains the wave file to be played. <Wave Name> - (optional) enter the name of a wave (.wav) sound file to be played. The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension ".wav" is optional [Check Box] Autoplay Wave: - plays the .wav sound file as soon as message is displayed. If unchecked the sound will not be played. ( ) A predefined HTML page - requires a working knowledge of HTML <HTML Asset> - select the name of the HTML asset that contains the required HTML page from the list shown. <HTML Page> - enter the filename of the HTML page to be displayed. The page must be in the HTML asset identified above. Filename is not case sensitive. Extension ".html" is optional. <HTML Wave> - (optional) select the name of the HTML file containing the wave file to be played. The page must be in the HTML asset identified above. Filename is not case sensitive. Extension ".html" is optional. <Wave Name> - (optional) enter the name of a wave (.wav) sound file to be played. The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension ".wav" is optional [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> - enter the "tag name" of the text in the string-table of the HTML assets config.txt file. <HTML Wave> - (optional) select the name of the HTML file containing the wave file to be played. The page must be in the HTML asset identified above. Filename is not case sensitive. Extension ".html" is optional. <Wave Name> - (optional) enter the name of a wave (.wav) sound file to be played. The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension ".wav" is optional [Check Box] Autoplay Wave: - plays the .wav sound file as soon as message is displayed. If unchecked sound will not be played.
Minimap Options RuleSets the display options for the minimap.
Properties: Default values - all checked [Check Box] Map Textures [Check Box] Gradients [Check Box] Junctions [Check Box] Signals [Check Box] Triggers [Check Box] Markers [Check Box] Trackside Labels [Check Box] Terrain Objects [Check Box] Industrial Names [Check Box] Named Objects [Check Box] Consists
Play Sound RulePlays a wav sound file.
Properties: Default HTML <Click> - click to to enter Sound File Name HTML Assets <Click> - click to select HTML asset Rule Completes <Click> - to select one of:- sound has just started sound has finished playing
Session Metadata RuleSets session metadata in the config file. Info can be read by other systems and displayed to the player.
Properties: Type <Click> - click to select one of:- Simulation Challenge Length <value> - to enter number of minutes, default is 30 minutes Difficulty <Click> - click to select one of:- Normal - default Tutorial Easy Hard Expert
Set Helper Icon Size RuleSets the size of helper icons such as the junction lever arrows.
Properties: Junction Arrows Size <Click> - to set scale ratio smaller than default, default is 100% Set HTML Pages RuleInstructs 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 Select one of six option buttons:- ( ) to instruct the sequence browser to <select> - to choose page operations ( ) to instruct the sequence browser to open the page <select> - enter the HTML page name ( ) to set browser parameters <select> - choose one of:- to Enable/Disable closing of the browser window by the user to Enable/Disable scrolling on the sequence browser window to Show/Hide the sequence browser window ( ) Set the following flag for the page named <select> - enter the HTML page name [Check Box] Hide/Close window on 'done' action [Check Box] Window has no 'done' button [Check Box] Disable scrolling(not implemented yet) [Check Box] Spare setting 1 [Check Box] Spare setting 2 [Check Box] Spare setting 3 [Check Box] Spare setting 4 [Check Box] Spare setting 5 ( ) Use the page <select> (enter HTML page name) from the HTML asset <select> (select HTML asset) ( ) Use the string table entry <select> (enter Index) from the HTML asset <select> (select HTML asset)
Show/Hide Layer RuleShows 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.
Show/Hide Minimap RuleShows the minimap window in Driver.
Properties: <Show/Hide> the driver Minimap Window - click to switch between Show and Hide.
Show/Hide On-screen Help RuleShows or hides On-screen help in Driver.
Properties: On screen help (junction overlays, etc) - select one of three option buttons:- ( ) Show ( ) Hide ( ) Leave Unchanged On Screen Vehicle Names: - - select one of three option buttons:- ( ) Show ( ) Hide ( ) Leave Unchanged Timed Limited Display HTML Rule (SP2 and later)Displays an HTML browser window for a limited time.
Properties: HTML Asset Name : <[Click to select HTML asset]> - click to select an HTML asset from those installed Page filename : <value> - click to enter the filename of the HTML page in the selected HTML asset. The .html filename extension is optional. Play duration (SessVar or duration in seconds) : <value> - enter a SessVar name or the number of seconds. Browser left position (SessVar or position) : <value> - enter a SessVar name or the number of pixels from the left screen edge. Browser top position (SessVar or position) : <value> - enter a SessVar name or the number of pixels from the top screen edge. Browser width (SessVar or position) : <value> - enter a SessVar name or the width in pixels. Browser height (SessVar or position) : <value> - enter a SessVar name or the browser height. [Check Box] <Alert is not reshowable on request/Alert is showable on request> - check or click to allow or prevent the user viewing the page again.
Wait on Waybill Screen/Main Screen RuleExecutes child rules when the Waybill window is opened or closed
Properties: [Check Box] Trigger rule once - check to trigger the rule once only Wait for the Waybill window to be <opened/closed> - select either opened or closed.
Miscellaneous RulesSome of these rules have no user accessible functions but may be used by other rules. Others do not fit in any other category. ConsistDataHandler RuleWas used by the QuickDrive Rule to place consists onto a route. Now obsolete.
Properties: None Custom Script RuleNo description
Properties: None Generic TreeNode Debug Window RuleNo description.
Properties: None Session Debug RuleExecutes the first child if Debug mode is selected. Otherwise executes the second child rule.
Properties: None
Directional Trigger Check RuleExecutes child rules when a set train enters a set trigger in a set direction. Adds direction to the Trigger Check Rule.
Properties: [Check Box] Trigger only once [Check Box] Wait for child rules to complete even if no trains are present in rule trigger [Check Box] Only activate when the entering vehicle of the train is heading <select direction> into the trigger - select one of two directions:- forward backward Triggers List <add trigger> - select a trigger from the session list <delete trigger> - delete a selected trigger from the rule Select one of two option buttons:- ( ) click to accept all trains ( ) click to accept trains matching specific criteria Selecting the second option will produce the following selection controls:- Specific vehicle - identify the specific vehicle(s) that will trigger the rule + - click to add a specific vehicle from the session list x - click to remove the specific vehicle from the rule Vehicle types - identify the type of vehicle(s) that will trigger the rule + - click to add a type of vehicle from the session list x - click to remove the type of vehicle from the rule Drivers - identify the driver(s) that will trigger the rule + - click to add a driver from the session list x - click to remove a driver from the rule
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.
Properties: Unique set ID: <click here to set> - enter a unique name for the navigation set. Name must be in lowercase and have no spaces. Train (optional): <click here to set> - select a rolling stock asset from the session list shown. Select one of three option buttons:- ( ) All points must be completed in sequence: - the first uncompleted navigation point will be shown and must be completed next. - the next point (if any) will also be shown partly transparent. ( ) Points will be completed in sequence, but can be skipped: - navigation points can be skipped but must be completed in order. - you cannot go back to complete a missed point. ( ) All points must be completed, but in any order: - all uncompleted navigation points will be shown. - you may complete them in any order. For each navigation point: <Click here to set> - select an item (trigger, trackmark, track object, rolling stock) from the session list to become the navigation point. <Display text> - enter a text message to display with the navigation point. You are limited to 25 characters. Icon <icon list> - select an icon for the navigation point. <Style> - click to select one from three choices Automatic - the navigation point will be completed as soon as the consist reaches the point. Manual - the navigation point must be set as complete by using the Navigation point complete rule or the Navigation set clear rule. The Manual style option allows you to execute other rules (e.g. consist check, wait, etc) before completing the navigation point. Require Stop - the navigation point will be completed when the consist comes to a complete stop on the point.
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.
Executes child rules if a navigation set created with the Navigation Display Rule is complete (or incomplete).
Properties: Checks if navigation point set <name>: - enter the unique name for the navigation set created using the Navigation Display Rule. Name must be in lowercase and have no spaces. is <Complete/Incomplete> - click to select one
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.
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.
Schedule RuleAllows 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
Trackside Check RuleExecutes child rules when a set train enters a set trigger. Similar to the Trigger Check Rule but provides different options.
Properties: Applies to: - select one of three option buttons:- ( ) Junction ( ) Trigger ( ) Trackmark Trackside object name: <specify> - select object name from session list Wait for train to: - select one of three option buttons:- ( ) Enter ( ) Stop at ( ) Leave [Check Box] Auto reset this rule - check to execute the rule continuously Applies to train containing: <Add vehicle> - click to select a rail vehicle from the session list del - click to remove a selected vehicle from the rule
Trigger Check RuleExecutes child rules when a set train enters a set trigger. This rule replaces the older and less versatile Trigger Rule.
Properties: [Check Box] Trigger only once [Check Box] Wait for child rules to complete even if no trains are present in rule trigger [Check Box] Only activate when the entering vehicle of the train is heading <select direction> into the trigger - select one of two directions:- forward backward Triggers List <add trigger> - select a trigger from the session list <delete trigger> - delete a selected trigger from the rule Select one of two option buttons:- ( ) click to accept all trains ( ) click to accept trains matching specific criteria Selecting the second option will produce the following selection controls:- Specific vehicle - identify the specific vehicle(s) that will trigger the rule + - click to add a specific vehicle from the session list x - click to remove the specific vehicle from the rule Vehicle types - identify the type of vehicle(s) that will trigger the rule + - click to add a type of vehicle from the session list x - click to remove the type of vehicle from the rule Drivers - identify the driver(s) that will trigger the rule + - click to add a driver from the session list x - click to remove a driver from the rule
Executes child rules when a specific navigation point is completed
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.
Wait on Train Stop/Start RuleExecutes child rules when a train stops or starts moving
Properties: [Check Box] Trigger rule once Wait for a train that matches the following criteria to <select> - select one of:- start moving stop moving Select one of two option buttons:- ( ) click to accept all trains ( ) click to accept trains matching specific criteria Selecting the second option will produce the following selection controls:- Specific vehicle - identify the specific vehicle or set of specific vehicles that will trigger the rule + - click to add a specific vehicle from the session list x - click to remove the specific vehicle from the rule Vehicle types - identify the type of vehicle or a set of vehicle types that will trigger the rule + - click to add a type of vehicle from the session list x - click to remove the type of vehicle from the rule Drivers - identify the drivers that will trigger the rule + - click to add a driver from the session list x - click to remove a driver from the rule
Resources RulesDisplayIndustryStatus Rule (color modified)Displays a summary of industry product levels when the "k" key is pressed.
Properties: None
ExTrainz Manager Rule - TANE SP2Provides information on consists, industries and products in both Surveyor and Driver modes. Once activated, the rule creates an additional short menu bar below the main menu bar.
Properties: Diagnostic mode is <On/Off> - click to select On or Off. When set On diagnostic messages will be added to the Trainz Log file. Turn on message overlay <Yes/No> - click to select Yes or No. When set to Yes the message overlay (lower left of screen) will be active. Show rolling stock in Driver mode <Yes/No> - click to select Yes or No. When set to Yes rolling stock can be searched in Driver. Search only rolling stock already in session <Yes/No> - click to select Yes or No. When set to Yes only those rolling stock assets installed in the session can be searched. Graphic colours: <When Red, the industry does not require service/When Green, the industry does not require service> - click to switch between the two colour options. Industry page size: <value> - enter the number of industries to be displayed in the Industry List window (maximum 250). The following industries are excluded: <Add an industry to be excluded> - name can be complete (e.g. "Coal Mine 2") which will exclude that specific industry from the management list, or partial (e.g. "Coal") which will exclude all industries with the word "Coal" in their names. Entries are not case sensitive. Once industries have been excluded, additional commands will appear for each excluded industry:- <delete> <industry name begins with/class name begins with> <name> - click delete to remove this entry. - click industry name begins with/class name begins with to select between the two (see notes below). - click name to edit the name.
Hide Product Overlays RuleHides the commodity or product bar graphs that appear on active industries
Properties: None Multiple Resource Check RuleExecutes child rules if industries or vehicles reach set commodity levels. This rule replaces the older Resource Check Rule
Properties: <Product Level> - click to select a product test from two choices:- Reach/Exceed - sets an upper limit for the resources being monitored. For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon reaches or exceeds a specified level. The initial level in the object must be below the set upper limit. Fall below - sets a lower limit for the resources being monitored. For example: the rule will be triggered if the quantity of coal in a coal loader stockpile or a coal wagon falls below a specified level. The initial level in the object must be above the set lower limit. To test when a resource level reaches zero (i.e. is empty) set the lower limit to a very low value but not zero as the level can never fall below zero. <value> - enter required quantity value <select> - select a product from session list of products <Add object> - click to select a source or target object. Multiple objects and their queues can be added to the rule. ALL the entered products must reach/exceed or fall below the specified value for the rule to be triggered. For each object:- <Object> - click to select session active industry or product enabled rail vehicle <Queue> - select product queue (there may be only one available) <Remove> - removes the object and its product queue from the rule
Resource Check RuleExecutes child rules if a selected industry or vehicle reaches a set commodity level. This rule has been superseded by the Multiple Resource Check Rule
Properties: Select one of two option buttons:- ( ) Watch industry queue Target Object <select> - select an industry from the session list Queue <select> - select a product queue from the selected industry Product <select> - select a product from the selected queue Amount <value> - enter a quantity Select one of two option buttons:- ( ) Complete when designated queue equals or exceeds required amount ( ) Complete when designated queue falls below required amount ( ) Watch vehicle Target Object <select> - select a rolling stock asset from the session list Queue <select> - select a product queue from the selected rolling stock Product <select> - select a product from the selected queue Amount <value> - enter a quantity Select one of two option buttons:- ( ) Complete when designated queue equals or exceeds required amount ( ) Complete when designated queue falls below required amount
Resource Verify Rule (fixed)Executes child rules if a selected industry or vehicle reaches a set commodity level. The rule resets when all child rules have completed.
Properties: Select one of two option buttons:- ( ) Watch industry queue Target object <click to select> - click to select an industry from the session list. Product <click to select> - click to select an industry product. Amount <value> - enter a quantity for the selected product. Select one of two option buttons:- ( ) Complete when designated queue equals or exceeds designated amount ( ) Complete when designated queue falls below designated amount ( ) Watch vehicle queue Target object <click to select> - click to select a rolling stock vehicle from the session list. Product <click to select> - click to select a commodity product. Amount <value> - enter a quantity for the selected product. Select one of two option buttons:- ( ) Complete when designated queue equals or exceeds designated amount ( ) Complete when designated queue falls below designated amount
Session Sequence RulesOrdered List RuleExecutes child rules in order once this rule starts
Properties: Select one of two option buttons:- ( ) This process will repeat <value> time(s) - enter the number of times this rule is to be repeated ( ) This process will repeat forever
Progressive List RuleExecutes the first child rule on the first run, the second child on the second run, the third child on the third 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 RuleExecutes ONE randomly selected child rule once only. The rule will not repeat to randomly select another child rule
Properties: None
Reset List RuleExecutes ALL child rules continuously in an ongoing infinite cycle
Properties: None
Simultaneous List RuleExecutes child rules simultaneously once this rule starts
Properties: Rule completes when ... - click to chose one of the following:- one of the child rules has completed all child rules have reached a completed state all child rules have reached a "was completed" state
Speed RulesATP Speed Limiter RuleLimits allowable speed over set limit
Properties: Limits the speed to <value> mph over the set limit - enter speed value in mph Speeding Check RuleExecutes child rules if player controlled trains are over the local speed limit or over a set (custom) speed
Properties: Select one of two options to set a speed limit to be observed ( ) Watch for trains travelling above the posted speed limit <speed value> - click to enter a new overspeed tolerance value <speed units> - click to select one from the list:- Km/h - Kilometres per hour MPH - Miles per hour mps - metres per second ( ) Watch for trains travelling above a custom speed <speed value> - click to enter a new custom speed value <speed units> - click to select one from the list:- Km/h - Kilometres per hour MPH - Miles per hour mps - metres per second Warning: This option is very performance intensive and should only be used in sessions with few trains
MaxPermittedSpeed RuleSets the maximum permitted speed of locomotives under AI control
Properties: None
Startup and Termination RulesEnd Session RuleEnd the Session with a fade out.
Properties: Fade out over <value> seconds - enter number of seconds for fade out.
Multiplayer RuleEnables the session to be taken online in a Multiplayer environment.
Properties: Suggested maximum number of players for this session <value> - enter a number Maximum number of drivers per player <value> - enter a number Players are permitted to claim drivers [Check Box] - check to allow players to select a driver Players can see each other's driver orders [Check Box] - check to allow players to view orders for other players Automatically target an available train on clients [Check Box] - automatically assign a driver to each player Randomize RuleGenerates a different set of random numbers each time the session is run.
Properties: None
Session Complete RuleSet 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
Startup Options RuleSpecifies the starting options for the session. The weather settings will set the initial conditions, including the variability. To manually change the weather during play, use the Weather Rule.
Properties: Current control method is <select> - select one from:- Easy Mode - DCC (standard keyboard and mouse) control Ask User - let the user decide Realistic Mode - Cab controls (on screen levers, throttles, buttons, etc) Set weather to <select mode> with <select frequency> changeability - select Weather mode: - select one of:- Clear Cloudy Drizzle Rain Stormy Light Snow Medium Snow Heavy Snow Changeability: - select one of:- Off - the weather will not change from the mode selected above Periodic - slow gradual changes to the weather Extreme - rapid and extreme changes to the weather Set time to <hours>:<minutes> with a rate of <select speed> - set the starting time and the speed at which the Trainz clock will run Set derailment realism to <select reality level> - select one of:- None - no train derailments will occur Arcade - train derailments will be exaggerated (beyond normal) Realistic - train derailments will occur as realistically as possible [Check Box] Show in game help - check to switch on help options Use <select measurement system> units in Driver - select one of:- Metric - kilometres, metres. This will override the default settings in a session Imperial - miles, feet. This will override the default settings in a session Default - uses the measurement system specified in the session
Time RulesClock RuleRule needed for animated clocks.
Properties: None
Time and Rate RuleSets the session start time and the rate at which time passes.
Properties: Set time to <hours:minutes> - enter the clock starting time as hours (0-23) and minutes (0-59) with a rate of <1x> - select a speed at which time will pass from 1x (normal) to 1440x (extremely fast)
Timecheck RuleExecutes 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.
Wait RuleExecutes child rules after waiting for set number of seconds
Properties: <click to set> - enter the number of seconds for the wait delay
Variable RulesQuick Session Variables RuleAllows the editing of session variables
Properties: <local> - click to edit local variables <add new session variable> - click to enter the name of new local variable for each variable:- <variable-name> - click to change variable name <type> - click to select one of:- string - text characters int - integer float - real (decimal) numbers bool - boolean (true/false) stringset - meaning not known at this time stringlist - meaning not known at this time tkmlist - trackmark list (no longer supported in TANE SP2) platformlist - platform list (no longer supported in TANE SP2) del - delete variable edit - edit variable <trains> - click to edit a train variable <train selected> - click to select a train from the session list. Initially none is selected <select train> - click to select a locomotive <select vehicle> - click to select a rail vehicle for the selected loco/vehicle:- <Add new session variable> - click to enter the name of a new variable for the entered variable:- <variable-name> - click to change variable name <type> - click to select type (see list above) <objects> - no longer supported in TANE SP2 <global> - no longer supported in TANE SP2
Variable Check RuleExecutes child rules when a specific variable matches set conditions
Properties: <variable-name> - enter a variable-name. Variable name is case sensitive. Mathematical relationship, select one of:- is less than - enter a <value> to test against is less than or equal to - enter a <value> to test against is equal to - enter a <value> to test against is greater than or equal to - enter a <value> to test against is greater than - enter a <value> to test against is not equal to - enter a <value> to test against is between x and y - enter a minimum <x-value> and a maximum <y-value> Evaluation type. Select one from:- <This condition will be evaluated only once ...> - any changes to the variable that occur after it has been checked will not change the result of this rule <This condition will be evaluated once every second> - the rule will be rerun and the variable rechecked every second
Variable Modify Continuous RuleAdds, 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 Modify RuleChange 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> - click to select one from:- Add to variable Add <value> to variable <variable-name> - enter value to add to variable, enter variable-name. Variable-name is case sensitive. <Do not undo the alteration if the rule is stopped/Undo the alteration if the rule is stopped> - click to select one. Subtract from variable Subtract <value> from variable <variable-name> - enter value to subtract from variable, enter variable-name. Variable-name is case sensitive. <Do not undo the alteration if the rule is stopped/Undo the alteration if the rule is stopped> - click to select one. Change variable Change variable <variable-name> to <value> - enter variable-name, enter new value. Variable-name is case sensitive. This change cannot be undone if the rule is stopped. [Check Box] (optional) Set the minimum value of <variable-name> to <value> - enter variable-name (this will already be set by the change option) and a value. Variable-name is case sensitive. [Check Box] (optional) Set the maximum value of <variable-name> to <value> - enter variable-name (this will already be set by the change option) and a value. Variable-name is case sensitive.
Variable Random RuleAssigns a random integer value to a variable.
Properties: Random variable <name> in minimum to maximum interval - enter name of variable. Variable-name is case sensitive. The minimum possible value of variable_name is <value> - enter the minimum value The maximum possible value of variable_name is <value> - enter the maximum value
Variable Show RuleAdds 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.
Weather RulesEIRS Weather Rule NE USA RuleCustomize random weather rule relative to the North East Region of the United States.
Properties: Season <select> - select one of:- Summer Fall Winter Spring Random Changeability (minutes) <value> - select one of:- 2/5/10/15/20/30/45/60 - minutes Environment Settings <select> - select one of:- Disable/Enable
Random Weather Rule v2Randomly changes the weather conditions between set values over a set duration.
Properties: Starting weather <select> - select one of:- Clear weather, no clouds, rain or snow Cloudy weather, no rain Drizzle, light rain Rain Stormy weather that includes lightning and thunder Snowing lightly Medium snowfall Heavy snow Best weather <select> - select one of:- Clear weather, no clouds, rain or snow Cloudy weather, no rain Drizzle, light rain Rain Stormy weather that includes lightning and thunder Snowing lightly Medium snowfall Heavy snow Worst weather <select> - select one of:- Clear weather, no clouds, rain or snow Cloudy weather, no rain Drizzle, light rain Rain Stormy weather that includes lightning and thunder Snowing lightly Medium snowfall Heavy snow Changing about every: <value> mins - enter number of minutes between weather changes
Weather RuleChanges the weather conditions during Session play.
Properties: Set weather to <select mode> with <select frequency> changeability - select Weather mode: - select one of:- Clear Cloudy Drizzle Rain Stormy Light Snow Medium Snow Heavy Snow Changeability: - select one of:- Off - the weather will not change from the mode selected above Periodic - slow gradual changes to the weather Extreme - rapid and extreme changes to the weather
|