Session Rules By Categories With Properties

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
Line 9: Line 9:
 
'''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement
 
'''Achievement Check Rule:''' This rule allows you to customize session gameplay based on whether the player has received an achievement
  
−
Properties:
+
[[Properties:]]
 
   None
 
   None
  
 
'''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload
 
'''Advanced Industry Load Configuration Rule:''' Names industry, lock train's controls?, overrides begin load and begin unload
  
−
Properties:
+
[[Properties:]]
 
   Target object ?? name of object such as Power Station, Coal Pit or Portal
 
   Target object ?? name of object such as Power Station, Coal Pit or Portal
 
   Lock train's controls checked during a stopped load/unload operation
 
   Lock train's controls checked during a stopped load/unload operation
Line 21: Line 21:
 
'''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations
 
'''Station Visited Check Rule:''' Waits for any train to call at one of the designated stations
  
−
Properties:
+
[[Properties:]]
 
   Trigger click to choose from list
 
   Trigger click to choose from list
 
   Add Industry click to add from session list
 
   Add Industry click to add from session list
Line 29: Line 29:
 
'''Power Station Rule:''' Sets up Station and Consumers
 
'''Power Station Rule:''' Sets up Station and Consumers
  
−
Properties:
+
[[Properties:]]
 
   Power Station click to choose from session Stations
 
   Power Station click to choose from session Stations
 
   Consumers(Add Object) click to choose from session list
 
   Consumers(Add Object) click to choose from session list
Line 35: Line 35:
 
'''Resource Check Rule:''' Check the progress of the amount of a resource and target object
 
'''Resource Check Rule:''' Check the progress of the amount of a resource and target object
  
−
Properties:
+
[[Properties:]]
 
   Watch industry queue or Watch vehicle fill-in choose one or the other
 
   Watch industry queue or Watch vehicle fill-in choose one or the other
 
   Note: Both have: Target Object, Queue: click to choose
 
   Note: Both have: Target Object, Queue: click to choose
Line 43: Line 43:
 
'''Multiple Resource Check Rule:''' Checks resource for completion
 
'''Multiple Resource Check Rule:''' Checks resource for completion
  
−
Properties
+
[[Properties:]]
 
   Wait for the designated queues from choose fall below, reach/exceed
 
   Wait for the designated queues from choose fall below, reach/exceed
 
   Units number amount of units
 
   Units number amount of units
Line 51: Line 51:
 
'''Objective Add Rule:''' Sets up a game Objective with ID and display Name
 
'''Objective Add Rule:''' Sets up a game Objective with ID and display Name
  
−
Properties:
+
[[Properties:]]
 
   Priority click choose Above Normal, Below Normal, Normal, Optional, Urgent
 
   Priority click choose Above Normal, Below Normal, Normal, Optional, Urgent
 
   Completion Target click to set target number
 
   Completion Target click to set target number
Line 61: Line 61:
 
'''Objective Check Rule:''' Executes child rules when objective is complete
 
'''Objective Check Rule:''' Executes child rules when objective is complete
  
−
Properties:
+
[[Properties:]]
 
   Unique Objective ID click insert ID number
 
   Unique Objective ID click insert ID number
 
   Mode click choose Wait for completion, Wait for failure, Wait for progress
 
   Mode click choose Wait for completion, Wait for failure, Wait for progress
Line 67: Line 67:
 
'''Objective Update Rule:''' Changes progress outcome according to Property choices
 
'''Objective Update Rule:''' Changes progress outcome according to Property choices
  
−
Properties:
+
[[Properties:]]
 
   Unique Objective ID click to set ID number
 
   Unique Objective ID click to set ID number
 
   Mode click Set objective as Decrement progress/Increment progress/Reset objective/Set objects as complete/Set objects as failed/Set progress/Set progress only if greater
 
   Mode click Set objective as Decrement progress/Increment progress/Reset objective/Set objects as complete/Set objects as failed/Set progress/Set progress only if greater
Line 75: Line 75:
 
'''Ranked Session Begin Rule:''' Begins a ranked Session
 
'''Ranked Session Begin Rule:''' Begins a ranked Session
  
−
Properties:
+
[[Properties:]]
 
   Countdown requires a Starting Value insert hrs., min,sec
 
   Countdown requires a Starting Value insert hrs., min,sec
 
   1 through 5 stars, points for each star insert number of points
 
   1 through 5 stars, points for each star insert number of points
Line 82: Line 82:
 
'''Ranked Session Complete Rule:''' Completes the active ranked Session
 
'''Ranked Session Complete Rule:''' Completes the active ranked Session
  
−
Properties:
+
[[Properties:]]
 
   Set the active ranked session as fill-in choose: Complete, Failed
 
   Set the active ranked session as fill-in choose: Complete, Failed
 
   Customize the completion message check insert text message
 
   Customize the completion message check insert text message
Line 89: Line 89:
 
'''Session Complete Rule:''' Set session to a percentage of completion
 
'''Session Complete Rule:''' Set session to a percentage of completion
  
 +
[[Properties:]]
 
   Set session to percent complete click to insert number in percent
 
   Set session to percent complete click to insert number in percent
 
   Separate achievements for completion check
 
   Separate achievements for completion check
Line 97: Line 98:
 
'''ATP Speed Limiter Rule:''' Limits speed over set limit
 
'''ATP Speed Limiter Rule:''' Limits speed over set limit
  
−
Properties:
+
[[Properties:]]
 
   speed limit over the set limit mph
 
   speed limit over the set limit mph
  
 
'''Speeding Check Rule:''' Checks to see if player control trains are over the speed  
 
'''Speeding Check Rule:''' Checks to see if player control trains are over the speed  
  
−
Properties:
+
[[Properties:]]
 
   Watch for trains travelling above the fill-in
 
   Watch for trains travelling above the fill-in
 
   Allow an over speed tolerance of click to insert mph over posted limit
 
   Allow an over speed tolerance of click to insert mph over posted limit
Line 110: Line 111:
 
'''AWS Configuration Rule:''' This rule configures the Trainz implementation of AWS
 
'''AWS Configuration Rule:''' This rule configures the Trainz implementation of AWS
  
−
Properties:
+
[[Properties:]]
 
   Use modern sound set for unfitted cabs? check
 
   Use modern sound set for unfitted cabs? check
 
   Simulate AWS for unfitted cabs? check
 
   Simulate AWS for unfitted cabs? check
Line 119: Line 120:
 
'''Wait for Derailment Rule:''' Waits for a derailment to occur
 
'''Wait for Derailment Rule:''' Waits for a derailment to occur
  
−
Properties:
+
[[Properties:]]
 
   Trigger derailment watch once check to set
 
   Trigger derailment watch once check to set
  
 
'''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars
 
'''Clean UP Derailed Trains Rule:''' Cleans up derailed train cars
  
−
Properties:
+
[[Properties:]]
 
   Set delay to clean up derailed train cars values
 
   Set delay to clean up derailed train cars values
  
 
'''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule
 
'''Replace Missing Vehicles Rule:''' Produce new trains to replace missing vehicles that have been removed from the session by the cleanup derailed vehicles rule
  
−
Properties:
+
[[Properties:]]
 
   Respawn trains if they are abandoned check
 
   Respawn trains if they are abandoned check
 
   Respawn trains fill-in choose: at their original locations, from portals from Session List
 
   Respawn trains fill-in choose: at their original locations, from portals from Session List
Line 135: Line 136:
 
'''Coupler Breakage Check Rule:''' Checks for breaking couplers. No parameters.
 
'''Coupler Breakage Check Rule:''' Checks for breaking couplers. No parameters.
  
−
Properties:
+
[[Properties:]]
 
   None
 
   None
  
 
'''Coupler Breakage HUDRule:''' HUD displays warning about coupler stress and breakage
 
'''Coupler Breakage HUDRule:''' HUD displays warning about coupler stress and breakage
  
−
Properties:
+
[[Properties:]]
 
   Show the Coupler Breakage Display fill-in must choose one or the other
 
   Show the Coupler Breakage Display fill-in must choose one or the other
 
   Hide the Coupler Breakage Display fill-in must choose one or the other
 
   Hide the Coupler Breakage Display fill-in must choose one or the other
Line 146: Line 147:
 
'''Set Coupler Masks Rule:''' Set the coupling/decoupling  masks on the selected vehicles
 
'''Set Coupler Masks Rule:''' Set the coupling/decoupling  masks on the selected vehicles
  
−
Properties:
+
[[Properties:]]
 
   Add vehicle click to select from session list
 
   Add vehicle click to select from session list
 
   Coupling Mask, Decoupling Mask : click to select: lock or unlock
 
   Coupling Mask, Decoupling Mask : click to select: lock or unlock
Line 154: Line 155:
 
'''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users
 
'''Safety System Engaged Check Rule:''' Checks for safety systems making penalty applications on users
  
−
Properties:
+
[[Properties:]]
 
   Trigger only once check
 
   Trigger only once check
  
 
'''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users
 
'''Safety System Isolated Check Rule:''' Checks for safety systems being isolated by users
  
−
Properties:  
+
[[Properties:]]
 
   Trigger only once check
 
   Trigger only once check
  
 
'''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger
 
'''Signal Passed At Danger Check Rule:''' Checks for Drivers passing signals at danger
  
−
Properties:
+
[[Properties:]]
 
   Trigger only once check to set
 
   Trigger only once check to set
  
 
'''Vehicle Physics Rule:''' Overrides the default vehicle physics properties
 
'''Vehicle Physics Rule:''' Overrides the default vehicle physics properties
  
−
Properties:
+
[[Properties:]]
 
   Accept all trains fill-in
 
   Accept all trains fill-in
 
   Cab sway level is set ? % click to insert percent of sway
 
   Cab sway level is set ? % click to insert percent of sway
Line 187: Line 188:
 
'''DestSignTable Rule:''' Table for creating a table of destination signs
 
'''DestSignTable Rule:''' Table for creating a table of destination signs
  
−
Properties:
+
[[Properties:]]
 
   Enable Track Marks as destinations check
 
   Enable Track Marks as destinations check
 
   Enable table of destinations check
 
   Enable table of destinations check
Line 202: Line 203:
 
'''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train
 
'''Interlocking Tower Set Path Rule:''' Will set the state of an interlocking tower path for a train
  
−
Properties:
+
[[Properties:]]
 
   Interlocking Tower choose Names and Objects
 
   Interlocking Tower choose Names and Objects
 
   Multiple Junction Alignment Check Checks multiple junctions are in alignment
 
   Multiple Junction Alignment Check Checks multiple junctions are in alignment
Line 212: Line 213:
 
'''Navigation Display Rule:''' Creates a navigation point
 
'''Navigation Display Rule:''' Creates a navigation point
  
−
Properties:
+
[[Properties:]]
 
   Navigation mode choose, fill-in All points must be completed in sequence, Points will be completed in sequence, but can be skipped, All points must be completed, but in any
 
   Navigation mode choose, fill-in All points must be completed in sequence, Points will be completed in sequence, but can be skipped, All points must be completed, but in any
 
   Note: See help icon for more  
 
   Note: See help icon for more  
Line 224: Line 225:
 
'''Navigation Point Complete Rule:''' Marks a navigation point complete
 
'''Navigation Point Complete Rule:''' Marks a navigation point complete
  
−
Properties:
+
[[Properties:]]
 
   Mark navigation point click set index number
 
   Mark navigation point click set index number
 
   Complete in set click to set ID
 
   Complete in set click to set ID
Line 230: Line 231:
 
'''Navigation Set Check Rule:''' Checks if a navigation point is complete/incomplete
 
'''Navigation Set Check Rule:''' Checks if a navigation point is complete/incomplete
  
−
Properties:
+
[[Properties:]]
 
   Checks if navigation point is set click set ID
 
   Checks if navigation point is set click set ID
 
   Is click Complete, Incomplete
 
   Is click Complete, Incomplete
Line 241: Line 242:
 
'''Schedule Rule:''' Allows a schedule of timed events to be applied to a train
 
'''Schedule Rule:''' Allows a schedule of timed events to be applied to a train
  
−
Properties:
+
[[Properties:]]
 
   Insert track mark click to select from session list
 
   Insert track mark click to select from session list
 
   Note: Both has an arrival and departure set time hr:min:sec
 
   Note: Both has an arrival and departure set time hr:min:sec
Line 249: Line 250:
 
'''Set Junctions Rule:''' Sets the selected junctions to a specific state ''Warning: not compatible with Interlocking Tower Assets''
 
'''Set Junctions Rule:''' Sets the selected junctions to a specific state ''Warning: not compatible with Interlocking Tower Assets''
  
−
Properties:
+
[[Properties:]]
 
   Add Junction click to select session junction list
 
   Add Junction click to select session junction list
 
   Add All click
 
   Add All click
Line 256: Line 257:
 
'''Set Signal Extended Rule:''' ''Warning: not compatible with Interlocking Tower Assets''
 
'''Set Signal Extended Rule:''' ''Warning: not compatible with Interlocking Tower Assets''
  
−
Properties:
+
[[Properties:]]
 
   Set signal click to select from session list
 
   Set signal click to select from session list
 
   State ' to select state from list
 
   State ' to select state from list
Line 262: Line 263:
 
'''Trigger Check Rule:''' Waits for any train to enter one of the designated triggers
 
'''Trigger Check Rule:''' Waits for any train to enter one of the designated triggers
  
−
Properties:
+
[[Properties:]]
 
   Accept all trains fill-in
 
   Accept all trains fill-in
 
   Accept trains matching specific criteria fill-in to choose from session list
 
   Accept trains matching specific criteria fill-in to choose from session list
Line 272: Line 273:
 
'''Wait on Navigation Point Rule:''' Waits for a nav point to be complete
 
'''Wait on Navigation Point Rule:''' Waits for a nav point to be complete
  
−
Properties:
+
[[Properties:]]
 
   Wait for navigation point ? click to choose from session list
 
   Wait for navigation point ? click to choose from session list
 
   in set ? to be completed click to insert ID
 
   in set ? to be completed click to insert ID
Line 278: Line 279:
 
'''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start
 
'''Wait on Train Stop/Start Rule:''' Wait for a train to stop or start
  
−
Properties:
+
[[Properties:]]
 
   Accept all trains fill-in to set
 
   Accept all trains fill-in to set
 
   Accept trains matching specific criteria fill-in to set and choose from session list
 
   Accept trains matching specific criteria fill-in to set and choose from session list
Line 289: Line 290:
 
'''Control Type Rule''' Sets control type
 
'''Control Type Rule''' Sets control type
  
−
Properties:
+
[[Properties:]]
 
   Current control method is: Easy Mode, Choice one of the three
 
   Current control method is: Easy Mode, Choice one of the three
 
 
 
'''CPC Rule:''' Emit Train Used to Emit Trains from the Central Portal Control on  
 
'''CPC Rule:''' Emit Train Used to Emit Trains from the Central Portal Control on  
  
−
Properties:
+
[[Properties:]]
 
   Triggered Events.  Also works with the Un-Portal Rule
 
   Triggered Events.  Also works with the Un-Portal Rule
 
   Portal index form CPC value
 
   Portal index form CPC value
 
   Use UnPortal Yes/No
 
   Use UnPortal Yes/No
 
   Delay from Trigger to Emit: Seconds value
 
   Delay from Trigger to Emit: Seconds value
 +
 +
'''Control Check Rule:''' Activates child rules based on the control method changes
 +
 +
[[Properties:]]
 +
  Excite child rules when: DCC mode is fill-in one or the other
 +
  Excite child rules: Every time control fill-in one or the other
 +
  
 
'''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule
 
'''CPC Rule:''' Emit Train On Trigger Used to Emit Trains from the Central Portal Control on Triggers, Also works with the Un-Portal Rule
  
−
Properties:
+
[[Properties:]]
 
   Trigger add Trigger
 
   Trigger add Trigger
 
   Portal index from PCP value
 
   Portal index from PCP value
Line 310: Line 318:
 
'''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry
 
'''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry
  
−
Properties:
+
[[Properties:]]
 
   Apply to every vehicle in the session fill-in
 
   Apply to every vehicle in the session fill-in
 
   Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles
 
   Apply only to a specific vehicle list fill-in Add vehicle/Add all vehicles/Remove all vehicles
Line 318: Line 326:
 
'''Driver Command Rule:''' Specify which commands will be available for the drivers
 
'''Driver Command Rule:''' Specify which commands will be available for the drivers
  
−
Properties:
+
[[Properties:]]
 
   Navigate To Track mark- Driver  
 
   Navigate To Track mark- Driver  
 
   Release Junction - Lets a driver release  
 
   Release Junction - Lets a driver release  
Line 362: Line 370:
 
'''Driver Command Check Rule:''' Verifies the driver commands of a driver character
 
'''Driver Command Check Rule:''' Verifies the driver commands of a driver character
  
−
Properties:
+
[[Properties:]]
 
   Wait for driver character to have add driver, all, delete all
 
   Wait for driver character to have add driver, all, delete all
 
   Trigger Rule once check
 
   Trigger Rule once check
Line 369: Line 377:
 
'''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar
 
'''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar
  
−
Properties:
+
[[Properties:]]
 
   The Driver Main Bar choice show/hide
 
   The Driver Main Bar choice show/hide
  
 
'''Driver Schedule Rule''' Execution of basic scheduled commands
 
'''Driver Schedule Rule''' Execution of basic scheduled commands
  
−
Properties:
+
[[Properties:]]
 
   Note: Only one of the fill-in can be  
 
   Note: Only one of the fill-in can be  
 
   Driver Schedule Rule assigned to name driver
 
   Driver Schedule Rule assigned to name driver
Line 385: Line 393:
 
'''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders
 
'''Driver Setup Rule:''' Create the list of drivers for this session and assign them their orders
  
−
Properties:
+
[[Properties:]]
 
   Generate new Drivers for empty check
 
   Generate new Drivers for empty check
 
   The following drivers will be available Driver's Name Add
 
   The following drivers will be available Driver's Name Add
Line 392: Line 400:
 
'''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers
 
'''Enable/Disable Driver Commands Rule:''' Enable/Disable specific driver commands on certain drivers
  
−
Properties:
+
[[Properties:]]
 
   Assign Driver commands check Driver Commands
 
   Assign Driver commands check Driver Commands
 
   Train criteria fill in all trains
 
   Train criteria fill in all trains
Line 399: Line 407:
 
'''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted
 
'''MaxPermittedSpeed Rule:''' Controls AI behavior. When active AI Trains only go as fast as permitted
  
−
Properties:
+
[[Properties:]]
 
   Config/txt file tag 'max_permitted_speed-60850 in mph or kph
 
   Config/txt file tag 'max_permitted_speed-60850 in mph or kph
 
   Add to config.txt and kuid-table for value <KUID2:60850:88000:4
 
   Add to config.txt and kuid-table for value <KUID2:60850:88000:4
Line 406: Line 414:
 
'''QuickDrive Rule:''' Change the Session settings and add consists in Driver
 
'''QuickDrive Rule:''' Change the Session settings and add consists in Driver
  
−
Properties:
+
[[Properties:]]
 
   Set Time to insert time
 
   Set Time to insert time
 
   QuickDrive Consist Option List by  
 
   QuickDrive Consist Option List by  
Line 423: Line 431:
 
'''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train
 
'''Wait for Driver On/Off Train Rule:''' Waits for a Driver to get off of a train
  
−
Properties:
+
[[Properties:]]
 
   Note: One or the other fill-ins must be  
 
   Note: One or the other fill-ins must be  
 
   Accept trains matching specific criteria fill-in to select from session list
 
   Accept trains matching specific criteria fill-in to select from session list
Line 432: Line 440:
 
'''Wait for Driver/Train to be Locally Owned Rule:''' Waits for a specific driver or train car to be locally owned, Owned then executes child rules. If the driver/train car becomes unowned again the child rules are paused
 
'''Wait for Driver/Train to be Locally Owned Rule:''' Waits for a specific driver or train car to be locally owned, Owned then executes child rules. If the driver/train car becomes unowned again the child rules are paused
  
−
Properties:
+
[[Properties:]]
 
   Wait for ownership of a specific Driver fill-in to set
 
   Wait for ownership of a specific Driver fill-in to set
 
   Wait for ownership of Driver fill-in to set
 
   Wait for ownership of Driver fill-in to set
Line 439: Line 447:
  
 
=='''Arrangement of Session Rules:'''==
 
=='''Arrangement of Session Rules:'''==
 +
 +
'''Ordered List Rule:''' Child rules will be executed in order once this rule starts
 +
 +
[[Properties:]]
 +
  Note: One of the two must be chosen
 +
  This process will repeat fill-in click to add number of repeats
 +
  This process will repeat forever fill-in
 +
 +
'''Progressive List Rule:''' The first child rule is executed on the first run, second child executed on second run, etc.
 +
 +
[[Properties:]]
 +
  After last child run is executed click to choose: First child is chosen again, It will be
 +
  used for all successive runs, Successive runs will
 +
  do nothing
 +
 +
'''Random List Rule:''' One of the child rules indented under this rule will be
 +
 +
[[Properties:]]
 +
  executed randomly
 +
  Once one of the child rule is ??
 +
 +
'''Reset List Rule:''' Resets and starts all child rules in an ongoing infinite cycle
 +
 +
[[Properties:]]
 +
  None
 +
 +
'''Simultaneous List Rule:''' Child rules are executed simultaneously once this rules
 +
 +
[[Properties:]]
 +
  Rules completes when click choose all rules have reached completed state,
 +
  was completed state
 +
 +
=='''Camera Rules:'''==
 +
 +
'''Cinematic Camera Rule:''' Provides several different cinematic style cameras
 +
 +
[[Properties:]]
 +
  Lock camera controls for the duration check
 +
  Prevent rain control for duration check
 +
  Camera target: name any of the many objects in session
 +
  Camera mode: Stationary, Circle fill-in
 +
  Initial camera values: Pitch, Yaw, Zoom value
 +
  Total time to animate: seconds value
 +
 +
'''Set Camera Rule:''' Sets the target object and properties of the camera. Preforming the selected properties
 +
 +
[[Properties:]]
 +
  Change the camera view mode to check to choose: Cab View, External View, Tracking
 +
  View, Free Roaming
 +
  Vehicle fill-in choose from session vehicles
 +
  Set the camera flags to enable/disable check to choose different properties from list
 +
  Junction fill-in choose from session junctions
 +
  Set the target objet of the camera to check
 +
  Map object fill-in choose from map objects
 +
 +
'''Wait for Camera View Mode Rule:''' Waits for the camera to be changed to the designated view
 +
 +
[[Properties:]]
 +
  Trigger rule once check to set
 +
  Wait for the camera to change to the ? click to choose: Cab View, External View, Tracking
 +
  View, Free Roaming View
 +
  Wait for the camera to target vehicle ? click to choose form session list
 +
 +
=='''Message Rules:'''==

Revision as of 03:18, 21 September 2017

Contents

This page is under construction

List of Trainz Session Rules by Categories with Properties. All rules are the Copyrights of N3V Games

Achievement Rules

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

Properties: 

 None

Advanced Industry Load Configuration Rule: Names industry, lock train's controls?, overrides begin load and begin unload

Properties: 

 Target object	??	name of object such as Power Station, Coal Pit or Portal
 Lock train's controls	checked	during a stopped load/unload operation
 Override 'begin load' and 'begin unload'	checked	# of seconds to override

Station Visited Check Rule: Waits for any train to call at one of the designated stations

Properties: 

 Trigger	click	to choose from list
 Add Industry	click	to add from session list
 Accept all trains	fill-in
 Accept trains matching specific criteria	fill-in	to choose from session list

Power Station Rule: Sets up Station and Consumers

Properties: 

 Power Station	click	to choose from session Stations
 Consumers(Add Object)	click	to choose from session list

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

Properties: 

 Watch industry queue or Watch vehicle 	fill-in	choose one or the other
 Note: Both have: Target Object, Queue:	click	to choose
 Complete when designated queue	fill-in	equals or exceeds required amount, falls below required amount


Multiple Resource Check Rule: Checks resource for completion

Properties: 

 Wait for the designated queues from 	choose	fall below, reach/exceed
 Units	number	amount of units
 Products	click	choose from session list
 Add Object	click	choose from session list

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

Properties: 

 Priority	click	choose Above Normal, Below Normal, Normal, Optional, Urgent
 Completion Target	click	to set target number
 Icon	click	choose from list
 Display Name	click	insert Name
 Unique Objective ID	click	set ID
 Custom Message	insert	typed message in text area

Objective Check Rule: Executes child rules when objective is complete

Properties: 

 Unique Objective ID	click	insert ID number
 Mode	click	choose Wait for completion, Wait for failure, Wait for progress

Objective Update Rule: Changes progress outcome according to Property choices

Properties: 

 Unique Objective ID	click	to set ID number
 Mode	click	Set objective as Decrement progress/Increment progress/Reset objective/Set objects as complete/Set objects as failed/Set progress/Set progress only if greater
 Amount	click	insert number


Ranked Session Begin Rule: Begins a ranked Session

Properties: 

 Countdown requires a Starting Value	insert	hrs., min,sec
 1 through 5 stars, points for each star	insert	number of points
 Session timer mode	fill-in	chooses: Timer, Countdown, None

Ranked Session Complete Rule: Completes the active ranked Session

Properties: 

  Set the active ranked session as	fill-in	choose: Complete, Failed
  Customize the completion message	check	insert text message


Session Complete Rule: Set session to a percentage of completion

Properties: 

 Set session to percent complete	click	to insert number in percent
 Separate achievements for completion 	check


Danger Rules

ATP Speed Limiter Rule: Limits speed over set limit

Properties: 

 speed limit over the set limit	mph

Speeding Check Rule: Checks to see if player control trains are over the speed

Properties: 

 Watch for trains travelling above the 	fill-in
 Allow an over speed tolerance of	click	to insert mph over posted limit
 Watch for trains travelling above a 	fill-in	to insert custom speed limit
 Warning: This method is very

AWS Configuration Rule: This rule configures the Trainz implementation of AWS

Properties: 

 Use modern sound set for unfitted cabs?	check
 Simulate AWS for unfitted cabs?	check
 Passive with HUD hidden	fill-in
 Active	fill-in
 Passive	fill-in

Wait for Derailment Rule: Waits for a derailment to occur

Properties: 

 Trigger derailment watch once	check	to set

Clean UP Derailed Trains Rule: Cleans up derailed train cars

Properties: 

 Set delay to clean up derailed train cars 	values

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

Properties: 

 Respawn trains if they are abandoned 	check
 Respawn trains	fill-in	choose: at their original locations, from portals from Session List

Coupler Breakage Check Rule: Checks for breaking couplers. No parameters.

Properties: 

 None

Coupler Breakage HUDRule: HUD displays warning about coupler stress and breakage

Properties: 

 Show the Coupler Breakage Display	fill-in	must choose one or the other
 Hide the Coupler Breakage Display	fill-in	must choose one or the other

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

Properties: 

 Add vehicle	click	to select from session list
 Coupling Mask, Decoupling Mask : 	click	to select: lock or unlock
 Add All	click	to select all vehicle in session
 Delete All	click	to delete all vehicle from list

Safety System Engaged Check Rule: Checks for safety systems making penalty applications on users

Properties: 

 Trigger only once	check

Safety System Isolated Check Rule: Checks for safety systems being isolated by users

Properties: 

 Trigger only once	check

Signal Passed At Danger Check Rule: Checks for Drivers passing signals at danger

Properties: 

 Trigger only once	check	to set

Vehicle Physics Rule: Overrides the default vehicle physics properties

Properties: 

 Accept all trains	fill-in
 Cab sway level is set ? %	click	to insert percent of sway
 Traction boost is % ? while  sanding	click	to insert percent of boost
 Tractions reduced to ? % while 	click	to set traction percent
 Maximum tractive effort adjusted by ?	click	to insert percent amount
 Show coupler breakage in HUD Rule	check	to set
 Couplers break when coupling above ? 	click	to set speed
 Accept trains matching specific criteria	fill-in	to insert specific trains
 Couplers break at ? kN	check	to insert amount of force


Navigation Rules

DestSignTable Rule: Table for creating a table of destination signs

Properties: 

 Enable Track Marks as destinations	check
 Enable table of destinations	check
 Import destination from texture-group. 	name
 Destination Name	name
 Enable industries/stations as 	check
 Interlocking Tower Configure Path	Alters settings on an interlocking tower path
 Interlocking Tower	choose	Name and Objects
 Interlocking Tower Path Selection UI	Will automatically react to messages from Interlocking 
 Towers and display a path selection dialog to the player.  
 Disable by removing rule from session
 Show path activation message in Driver	check

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

Properties: 

 Interlocking Tower	choose	Names and Objects
 Multiple Junction Alignment Check	Checks multiple junctions are in alignment
 Wait until the following junctions are 	choose	all or anyone
 Add junction	click	add junction from session list
 Add all	click	add all junctions from session list
 Delete all	click	deletes all junctions from rule list

Navigation Display Rule: Creates a navigation point

Properties: 

 Navigation mode	choose, fill-in	All points must be completed in sequence, Points will be completed in sequence, but can be skipped, All points must be completed, but in any
 Note: See help icon for more 
 Style	click	choose Required Stop, Automatic, Manual
 Display Text	insert	text
 Location	click	choose train vehicle from session list
 Train(optional)	choose	train from session list
 Unique set ID	name	must be lowercase and no spaces
 Icon	click	choose from list

Navigation Point Complete Rule: Marks a navigation point complete

Properties: 

 Mark navigation point	click	set index number
 Complete in set	click	to set ID

Navigation Set Check Rule: Checks if a navigation point is complete/incomplete

Properties: 

 Checks if navigation point is set	click	set ID
 Is	click	Complete, Incomplete
 Navigation Set Clear	Clears a navigation point set
 Clear the navigation point set	click	to set ID
 Navigation Set Hide/Show	Show or hide navigation point set
 The navigation point	click	hide, show
 Navigation point set	click	to set ID

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

Properties: 

 Insert track mark	click	to select from session list
 Note: Both has an arrival and departure 	set time	hr:min:sec
 Current Train	click	to select from session list
 Insert destination	click	to select from session list

Set Junctions Rule: Sets the selected junctions to a specific state Warning: not compatible with Interlocking Tower Assets

Properties: 

 Add Junction	click	to select session junction list
 Add All	click
 Delete All	click

Set Signal Extended Rule: Warning: not compatible with Interlocking Tower Assets

Properties: 

 Set signal	click	to select from session list
 State	'	to select state from list

Trigger Check Rule: Waits for any train to enter one of the designated triggers

Properties: 

 Accept all trains	fill-in
 Accept trains matching specific criteria	fill-in	to choose from session list
 Add Trigger	click	to choose from session list
 Trigger only once	check	to set
 Wait for child rules to complete even if 	check	to set
 Only activate when the entering 	click	to choose forward, backward

Wait on Navigation Point Rule: Waits for a nav point to be complete

Properties: 

 Wait for navigation point ?	click	to choose from session list
 in set ? to be completed	click	to insert ID

Wait on Train Stop/Start Rule: Wait for a train to stop or start

Properties: 

 Accept all trains	fill-in	to set
 Accept trains matching specific criteria	fill-in	to set and choose from session list
 Wait for a train that matches the 	click	to choose: start moving, stop moving
 Trigger rule once	check	to set
 Note: One or the other fill-ins must be

Driver Rules

Control Type Rule Sets control type

Properties: 

 Current control method is: Easy Mode, 	Choice	one of the three

CPC Rule: Emit Train Used to Emit Trains from the Central Portal Control on

Properties: 

 Triggered Events.  Also works with the Un-Portal Rule
 Portal index form CPC	value
 Use UnPortal	Yes/No
 Delay from Trigger to Emit: Seconds	value

Control Check Rule: Activates child rules based on the control method changes

Properties: 

 Excite child rules when: DCC mode is 	fill-in	one or the other
 Excite child rules: Every time control 	fill-in	one or the other


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

Properties: 

 Trigger	add Trigger
 Portal index from PCP	value
 Use UnPortal	yes/no
 Delay from Trigger to Emit: seconds	value

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

Properties: 

 Apply to every vehicle in the session	fill-in
 Apply only to a specific vehicle list	fill-in	Add vehicle/Add all vehicles/Remove all vehicles
 Note: One of the Applies will always be 
 Load/Unload for industry	Disable/Enable	choose Industry

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

Properties: 

 Navigate To Track mark- Driver 
 Release Junction - Lets a driver release 
 Notify- Notifies the player of schedule 
 NavigateToTrackMarkList V2- No 
 NavigateToStation V2- No description
 ReverseTram- Reverse a tram(max 2 
 Navigate Via Track mark- Driver 
 UnCouplerFrom- A new Uncouple driver 
 Navigate To- Allows a driver character 
 Halt Train- Brings the train to a 
 Run Around- Instructs the driver to 
 Terminate Passenger Train- This 	station before using this command
 MoveTurntable- TRS2008: Move 
 Unload- Unload train vehicles at current
 VR Set Train Lamps-Driver command 
 WaitFor- Pauses the driver's schedule or 
 WaitForRandom- TRS2008: Wait for 
 WaitForTrigger- Tell a driver to wait 
 WaitUntil- No description
 Set Max Speed To- No description
 Drive Via Track mark- Driver command 
 Load- Loads the train's vehicles at the ??
 Cab	Wait	maintains current control state until some condition is met
 Change Destination Sign	Changes signs	of a train
 Couple- Couple train to designate 
 Decouple- Decouples the train at the 
 Delete Train- Causes the train and its 
 Drive Schedule- Driver command that 
 Drive To- Allows a driver character to 
 Hornz- Driver sounds the train horn
 Drive to Track mark- Driver command 
 Cab	Set  Control	cab mode control
 Drive To Station V2- No description
 Drive To Track mark List V2- No 
 Headlights On/Off-Allows the driver to 
 Instant Load Command- Instantly load a
 Instant Load Locos- Instantly load all 
 InstantUnload- Instantly unload a train-
 Interior Lights Command- Driver 
 Drive To Industry- Drive to a specific

Driver Command Check Rule: Verifies the driver commands of a driver character

Properties: 

 Wait for driver character to have 	add	driver, all, delete all
 Trigger Rule once	check
 Driver character to watch the 	name driver

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

Properties: 

 The Driver Main Bar	choice	show/hide

Driver Schedule Rule Execution of basic scheduled commands

Properties: 

 Note: Only one of the fill-in can be 
 Driver Schedule Rule assigned to	name driver
 Commands	insert	driver commands in Drive Schedule
 Classic style: If there is a schedule 	fill-in
 Killer style: If there is a schedule 	fill-in
 Cooperative style: If there is a schedule 	fill-in
 Active style: Emit a new schedule, only 	fill-in

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

Properties: 

 Generate new Drivers for empty 	check
 The following drivers will be available	Driver's Name	Add
 Remove all existing Drivers first	check

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

Properties: 

 Assign Driver commands	check	Driver Commands
 Train criteria	fill in	all trains
 Train criteria	list train	only trains matching criteria

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

Properties: 

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

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

Properties: 

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

Wait for Driver On/Off Train Rule: Waits for a Driver to get off of a train

Properties: 

 Note: One or the other fill-ins must be 
 Accept trains matching specific criteria	fill-in	to select from session list
 Accept all trains	fill-in	to set
 Trigger rule once	check	to set
 Wait for a driver character to get ? a 	click	to select: On, Off

Wait for Driver/Train to be Locally Owned Rule: Waits for a specific driver or train car to be locally owned, Owned then executes child rules. If the driver/train car becomes unowned again the child rules are paused

Properties: 

 Wait for ownership of a specific Driver	fill-in	to set
 Wait for ownership of Driver 	fill-in	to set
 Note: One or the other fill-in must be 
 Driver or Vehicle	click	to choose from session lists

Arrangement of Session Rules:

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

Properties: 

 Note: One of the two must be chosen
 This process will repeat	fill-in	click to add number of repeats
 This process will repeat forever	fill-in

Progressive List Rule: The first child rule is executed on the first run, second child executed on second run, etc.

Properties: 

 After last child run is executed	click	to choose: First child is chosen again, It will be 
 used for all successive runs, Successive runs will 
 do nothing

Random List Rule: One of the child rules indented under this rule will be

Properties: 

 executed randomly
 Once one of the child rule is ??

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

Properties: 

 None

Simultaneous List Rule: Child rules are executed simultaneously once this rules

Properties: 

 Rules completes when	click	choose all rules have reached completed state, 
 was completed state

Camera Rules:

Cinematic Camera Rule: Provides several different cinematic style cameras

Properties: 

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

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

Properties: 

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

Wait for Camera View Mode Rule: Waits for the camera to be changed to the designated view

Properties: 

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

Message Rules:

Retrieved from "https://online.ts2009.com/mediaWiki/index.php?title=Session_Rules_By_Categories_With_Properties&oldid=10074"
Personal tools