Session Rule List with Parameters
Session Rule List (Work in progress) This is a list of the Trainz Session Rules: These rules can be copied and pasted to show how you're programming your Session
Achievement Check Rule: This rule allows you to customize session gameplay based on whether the player has received an achievement.
Parameters: ??
Advanced Industry Load Configuration Rule: Names industry, lock train's controls, overrides begin load and begin unload
Parameters:
Target Object: value: name the object such as Power Station, Coal Pit, Portal, etc. Lock train's controls: value: checked, during a stopped load/unload operation Override 'begin load' and 'begin unload' durations to_seconds: value: check, number of seconds to override
ATP Speed Limited: This rule limits speed over set limit
Parameters:
Speed limit over the set limit: value: mph
AWS Configuration: This rule configures the Trainz implementation AWS
Parameters:
Active: value: fill-in Passive: value: fill-in Passive with HUD hidden: value: fill-in Simulate AWS for unfitted cabs?: value: check Use modern sound set for unfitted cabs?: value: check
Cab Controls HUD: This rule is OBSOLETE! Cab-mode control HUD now integrated into Driver
Cinematic Camera: This Rule provides several different cinematic style cameras
Parameters:
Lock camera controls for the duration: value: check Prevent train control for duration: value: check Camera target: value: name, any of the many objects in the session Camera mode: value: fill-in, Stationary, Circle targeted object, Move from one point to another(zoom, pan,etc) Initial Camera Values: number: value, Pitch, Yaw, Zoom Total time to animate: value: number in seconds
Clean Up Derailed Trains: This rule cleans up derailed traincars
Parameters:
Set delay to clean up derailed train cars to: value: hrs, min,sec
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
Parameters:
Scripted clocks: value: ?? This rule send message to update the clocks on your map, only scripted clocks will work with this rule
Close Message Popups: This rule closes message popup
Parameters:
None
Consist Check: Checks for a specific train, can be disabled
Parameters:
Enforce strict exclusive testing: value: check
Rule Disabled: value: fill-in
Complete whenever a train matching the description exists: consist list: fill-in
Note: one of the fill-ins must be indicated
ConsistDataHandler Rule: Helps to place on a route a consist. Consist databundle datahandler. This rule is used by the QuickDrive Rule to add consists on routes while thery are running in Driver Mode. This rule has no input/outputs of its own, please refer to the QuickDrive rule to acces its funtionality.
Parameters:
None
Control Check Rule: Activates child rules based on the control method changes
Parameters:
Execute child rules when: DCC mode is selected or Cab mode is selected: value: fill-in Execute child rules: Every time control method is set or once only: fill-in Note: must choose one or the other
Control Type: Sets control types
Parameters:
Current control method is: Easy Mode, Ask User, Realistic Mode: value: Choice Note: One of the three
Coupler Breakage Check: Checks for breaking coupiers
Parameters:
None
Coupler Breakage HUD: HUD displays warning about coupler stress and breakage
Parameters:
Show the Coupler Breakage Display: value: fill-in Hide the Coupler Breakage Display: value: fill-in Note: must choose one or the other
CPC:Emit Train: Used to emit trains from the Central Portal Control on Triggered Events. Also works with the Un-Portal Rule
Parameters:
Portal Index from CPC: value: number Use Unportal: value: yes/no Delay from Trigger to Emit: value: number in seconds
CPC:Emit Train on Trigger: Used to emit trains fromthe Central Portal Control on Triggers. Also works with the Un-Portal Rule
Parameters:
Portal Index from PCP: value: number Use Un-Portal: value: yes/no Delay from Trigger to Emit: value: number in seconds Trigger: value: add Trigger
Custom Script: Custom scripted rule
Parameters:
None
Destination Sign Table: Table for creating a table of destination signs
Parameters:
Destination Name: value: Name Import destination from texture-group: Select texture-group: value: Name Enable industries/stations as destinations: value: check Enable Track Marks as destinations: value: check Enable table of destinations: value: check
Disable/Enable Industry: Disables vehicle load/unload for industry
Parameters:
Load/Unload for industry: value: Disable/Enable value: choose Industry Apply to every vehicle in the session: value: fill-in Apply only to a specific vehicle list: value: fill-in values: Add vehicle/Add all vehicles/ Remove all vehicles Note: One of the Applies must be selected
Display Custom HUD: Show or hide the Custom Heads Up Display
Parameters:
Show the Custom Heads Up Display: value: fill-in Hide the Custom Heads Up Display: value: fill-in Note: One must be chosen
Display HTML Pages: Creates a browser to display the listed HTML files in order as a navigatable sequence of pages
Parameters:
Add Page: value: From Source Asset Add All: value: From Source Asset Delete All: value: From Source Asset Set browser parameters: Prevent user from exiting browser until all pages viewed: value: check Disable closing of browser window by user: value: check Disable browser window scrolling: value: check Make browser window invisible: value: check Set position-Under Construction!!!: value: check Set size-Under Construction!!!: value: check Use the page Index html: value: page name From asset HTML Click to select: value: HTML Assets as the hidden button
Display Video: Displays a page from a HTML asset in a browser window
Parameters:
Display page index html: value: HTML page Name of html assets value: click, select type Note: also can give the video a Name
Driver Command: Specify which commands will be available for the drivers
Parameters:
Cab: Set Control- Sets a cab node control Cab: Wait- Maintains current control state until some condition is met Change Destination Sign- Changes the destination signs of a train Couple- Couple train to designated vehicle Decouple- Decouples the train at the specified vehicle Delete Train- Causes the train and its driver to be deleted from the session Drive Schedule- Driver command that causes the driver character to carry out the tasks specified by his 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 To Industry- Drive to a specific Industry 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 Via Track mark- Driver command that allows a driver character to take a train through a specific trackmark for its journey. Will take the shortest path to get there Drive To Station V2- No description Drive To Track mark Kist V2- No description Halt Train- Brings the train to a complete stop Headlights On/Off-Allows the driver to switch the headlights on and off Hornz- Driver sounds the train horn Instant Load Command- Instantly load a train with a random product selected from its product que. InstanLoad will not load locos or loco tenders Instant Load Locos- Instantly load all locos in a train-useful for trains generated automatically by portals etc. All locos with product queues(eg Phil_Cs) and all tenders will have all available ques loaded InstantUnload- Instantly unload a train-useful for trains generated automatically by portal etc. Every product que found in each industry-activated car will be unloaded. InstantUnload will not unload locos or loco tenders Interior Lights Command- Driver command to switch interior lights on or off for the current train Load- Loads the train's vehicles at the industry the driver is currently at with the train MoveTurntable- TRS2008: Move turntable to a stop point Navigate To- Allows a driver character to take a train either to a destination iindustry or a specific track in a destinatin industry. Will attempt to route around trains to get there Navigate To Trackmark- Driver command that allows a driver character to take a train to a specific trackmark on the map. Will attempt to route around trains to get there Navigate Via Trackmark- Driver command that allows a driver character to take a train through a specific trackmark for its journey. Will attempt to route around trains to get there NavigateToStation V2- No description NavigateToTrackMarkList V2- Noi description Notify- Notifies the player of schedule progress/completion ReleaseJuncion- Lets a driver release the junction they have been holding ReverseTram- Reverse a tram(max 2 cars) Run Around- Instructs the driver to uncouple his locomotive from and run-around it to recouple up to the other end of the train Set Max Speed To- No description Terminate Passenger Train- This command wil terminate a passenger train at the current passenger station. This will cause all of the passengers to disembark for the traiin. You must issue a 'Drive To' command for a passenger station before using this command UnCouplerFrom- A new Uncople driver command that allows you to uncouple from vehicle number (with 0 being the first vehicle in the consist) Unload- Unload train vehicles at current industry location VR Set Train Lamps-Driver command that sets the train lamps WaitFor- Pauses the driver's scheule or optionally random period of time WaitForRandom- TRS2008: Wait for specified or optionally random period of time WaitForTrigger- Tell a driver to wait until a trigger you select is touched by a train you select(or any train) WaitUntil- No description
Driver Command Check: Verifies the driver comands of a driver character
Parameters:
Trigger rule once: Value: check Driver character to watch the commands list of: value: name Driver Wait for a driver character to have a command list that matches this: Add Driver command: Value: add driver command, Add All, Delete All
Driver Main Menu Options: Show the Driver Main Menu Bar
Parameters:
The Driver Main Bar: Value: Show/Hide choice
Driver Schedule Rule: Execution of basic scheduled commands
Parameters:
Driver Schedule Rule assigned to: Value: Name Driver Commands: Value: Insert Driver Commands in Drive Schedule Classic style: If there is a schedule running, do not emit a new schedule: value: fill-in Killer style: If there is a schedule running, clean it and emit a new one: value: fill-in Cooperative style: If there is a schedule running, append the new one: value: fill-in Active style: Emit a new schedule, only if already there is a schedule running: value: Fill-in NOTE: Only one of the fill-in can be choosen
Driver Setup: Create the list of drivers for this session, and assign them their orders
Parameters:
The following drivers will be available: Value: Add drivers name Remove all existing Drivers first: Value: check Generate new Drivers for empty trains(In addition to those detailed above, new drivers will be generated for any empty trains): Value: check
EIRS Weather Rule NE USA: Customise random weather rule relative to the north east region of the United States
Parameters:
Set season to Summer/Winter/Fall/Spring : value: Choice Change every minutes: value: number of minutes Environmental impact Disable/Enable: Value: Choice
Enable/Disable Driver Commands: enable/Disable specific driver commandson certain drivers
Parameters:
The following driver commands for all driver characters on trains the match the criteria below: Value: Check Driver Commands Train criteria, All trains: Value: fill-in Train criteria, Only trains matching criteria: Value: List train criteria
End Session: End the session without saving session
Parameters:
End the session. Fade out over seconds: Value: number of seconds
Fade in/out: Fade in or out within seconds, color and opacity considered
Parameters:
Red percentage: value: percent amount Green percentage: value: percent amount Blue percentage: value: percent amount Alpha percentage(opacity): percent amount Fading duration: value: number of seconds NOTE: Sets or removes overlay color, black = 0% all colors, white = 100% of all colors, fade out = alpha near 100%, fade in = alpha at 0%, make one rule to fade in and another rule to fade out
Flash HUD icon: Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop flashing
Parameters:
Flash HUD Panel selection: value: Bottom Right Menu, Camera Controls, DCC Controls, Driver Main Menu Icon: value: depends on HUD Panel selection Time duration in seconds: value: number of seconds Start/Stop: value: Start or Stop Select HUD Panel: value: see above Icon: value: depends on HUD Panel selection Note: Either Flash or Start/Stop must be choosen
Generic TreeNode Debug Window: No description
Parameters:
None
InputTable: Creating a list of messages names to be used for various purposes
Parameters:
Add: Value: Message Name
Interlocking Tower Configuration Path: Alters settings on an interlocking tower path
Parameters:
Interlocking Tower: Value: Set name and objects
Interlocking Tower Path Selection UI: Will automatically react to messages from interlocking Towers and display a path selection dialog to the player. If you wish to disable teh interface simply remove this rule from your
session
Parameters:
Show path activation messages in Driver: Value: Check
Interlocking Tower Set Path: Will set the stae of an interlocking tower path for a train
Parameters:
Interlocking Tower: Value: Name and Objects
MaxPermittedSpeed: Controls AI behavior, when active AI trains only go as fast as permitted
Parameters:
Config.txt file: Value: Set the 'max_permitted_speed-60850 tag in mph or kph Add: Value: <KUID2:60850:88000:4> to config.txt and kuid-table for compatible. Old root level config tag will show warning in CMP and problems in foreign language builds
Message Popup: Displays a pop-up message in a browser window and waits for it to be closed
Parameters:
Pause game while message is displayed: Value: Check
Close previous message popup windows: Value: Check
Message location: Value: Top Lift, Top Right, Bottom Left, Bottom Right
Message source: Custom text/ A pre-defined HTML page(advanced), A pre-defined string-table entry from a HTML asset(advanced): Value: Choose one
Note: Choices of source determine multiple inputs. Can write custom text in textbox
Minimap Options: Sets the options for the minimap
Parameters:
Types of items to display on the Minimap when viewed: Value: Map Textures, Gradients, Junctions, Signals, Triggers, Markers, Trackside Labels, Terrian Objects, Industry Names, Named Objects, Consists Note: All can be checked or unchecked
Multiplayer Rule: Enables this session to be taken online in a Multiplayer environment
Parameters:
Suggested maximum number of players for this session: Value: number Maximum number of drivers per player: Value: number Players are permitted to claim drivers: Value: check Automatically target an available train on clients: Value: check
Multiple Junction Alignment Check: Checks multiple junctions are in alignment
Parameters:
Wait until the following junctions are set to its corresponding set state: Value: all or anyone Add Junction: Value: click, Add Junction to list Add All: Value: click, Adds all available junctions to the list Deletes all: Value: click, Deletes all junctions from list
Multiple Resource Check: Checks resource for completion
Parameters:
Wait for the designated queues from the listed vehicles/industries to collectively: Value: fall below, reach/exceed having units: Value: number products: Value: click to choose product from list Add Object: Value: Click, choose from session list
Navigation Display: Creates a navigation point
Parameters:
Unique set ID: Value: Name(must be lowercase and no spaces) Train(optional): Value: Train vehicle from session list Navigation mode: Value: Fillin, choose one, All points must be completed in sequence, Points will be completed in sequence, but can be skipped, All points must be completed, but in any order Location: Value: Click, Choose Train vehicle from session list Icon: Value: Click, Choose from list Display text: Value: Type text Style: Value: Click, Required Stop/Automatic/Manual Note: See help icon for more information
Navigation Point Complete: Marks a navigation point complete
Parameters:
Mark navigation point: Value: click to set index number Complete in set: Value: click to set ID
Navigation Set Check: Checks if a navigation point is complete/incomplete
Parameters:
Checks if navigation point set: Value: click to set ID Is: Value: complete/incomplete
Navigation Set Clear: Clears a navigation point set
Parameters:
Clear the navigation point set: Value: click to set ID
Navigation Set Hide/Show: Show or hide navigation point set
Parameters:
The navigation point: Value: click to set hide/show Navigation point set: Value: click to set ID
Objective Add: Sets up a game Objective with ID and display name
Parameters:
Unique objective ID: Value: click to set ID Display Name: Value: click to set Name Icon: Value: click to set Icon, choose from list Priority: Value: click to set, Above normal, Below normal, Normal, Optional, Urgent Completion target: click to set target number Custom message: Value: Type message in text area
Objective Check: Executes children rules when objective is completed
Parameters:
Unique objective ID: Value: click to insert ID number Mode: Value: click to choose, Wait for completion/Wait for failure/Wait for progress
Objective UpDate:
