Session Rule List with Parameters

Revision as of 23:43, 1 September 2017

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