Session Rules By Categories With Properties

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
m (Driver Rules)
m (Driver Rules)
Line 452: Line 452:
 
     '''( ) Every time control method is set'''
 
     '''( ) Every time control method is set'''
 
     '''( ) Once only'''
 
     '''( ) Once only'''
 
  
 
'''Control Type Rule''' Sets control type
 
'''Control Type Rule''' Sets control type
Line 469: Line 468:
 
   '''Delay from Trigger to Emit ''<seconds>''''' - click to set number of seconds
 
   '''Delay from Trigger to Emit ''<seconds>''''' - click to set number of seconds
 
   '''Add Trigger ''<select>''''' - click to add Trigger from Session List
 
   '''Add Trigger ''<select>''''' - click to add Trigger from Session List
 
  
 
'''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry
 
'''Disable/Enable Industry Rule:''' Disables vehicle load/unload for industry
Line 489: Line 487:
  
 
  '''Properties'''
 
  '''Properties'''
   '''Trigger rule once <Click>'''
+
   '''[Check box] Trigger rule once''' - check to allow the rule to execute only once
    ''-to set''
+
   '''Driver character to watch the command list of ''<click to select>''' - select a driver name from the Session List''
   '''Driver character to watch the command list of <Click.'''
+
   '''Wait for driver character to have a command list that matches this:'''
    ''to select Driver from Session List''
+
    '''''<add driver command>''''' - add a driver command from the session list. More commands can be added. Commands can be deleted.
   '''Wait for driver character to have a command list that matches this:''' add driver, all, delete all
+
    '''''<add all>''''' - adds ALL driver commands in the session list. Individual commands can be removed.
  '''Add Driver Command <Select>'''
+
    '''''<delete all>''''' - deletes all entered driver commands from the session rule
      ''-to add a Driver Command''
+
  '''Add all <Click>'''
+
      ''Click to add all Driver Commands''
+
    '''Delete all <Click>'''
+
      ''-to delete Driver Command List''
+
  
'''Driver Main Menu Options Rule:''' Show the Driver Main Menu Bar
+
'''Driver Main Menu Options Rule:''' Show/Hide the Driver Main Menu Bar
  
 
  '''Properties'''
 
  '''Properties'''
   '''The Driver Main Bar <Click>'''
+
   '''''<select>'' the Driver Main Menu Bar''' - click to choose one of:-
     ''-to Show or Hide''
+
     '''Show'''
 +
    '''Hide'''
  
 
'''Driver Schedule Rule''' Execution of basic scheduled commands
 
'''Driver Schedule Rule''' Execution of basic scheduled commands

Revision as of 22:04, 17 October 2017

This page is under construction

TRAINZ A New Era SP2-List of Trainz Session Rules by Categories with Properties. All rules are the Copyright of N3V Games


Contents

Achievement Rules

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

Properties:
 None

Advanced Industry Load Configuration Rule: Locks train controls when loading/unloading at an industry, overrides time settings for begin load and begin unload operations

Properties:
  Target object <click to select> - select industry object from session list
  [Check box] Lock the train's controls during a stopped load/unload operation - check to disable driver controls while train is stopped and loading/unloading
  [Check box] Override 'begin load' and 'begin unload' durations to <value> seconds - if checked enter number of seconds to override
Note: Times are Trainz clock time, not real time

Multiple Resource Check Rule: If specified resources in a selected industries or vehicles reaches set levels, then executes any following child rules

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
 <Click to select> - select a product from session list of products
 <Add object> - click to select a source or target object. Multiple objects and their queues can be added to the rule. 
    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 Rule: Sets up a game Objective with ID and display Name

Properties:
  Priority <Click to 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 Rule: Checks if an objective created with the Objective Add Rule is complete, then executes any following child rules

Properties:
 Unique Objective ID <value> - enter the unique ID created with the Objective Add Rule 
 Mode <select> - select one of three options:-
    Wait for completion
    Wait for failure
    Wait for progress

Objective Update Rule: Changes 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

Power Station Rule: Sets up a Power Station and its electricity consumers

Properties:
 <select> - add a Power Station from session list.
 <select> - add power consumers from session list

Ranked Session Begin Rule: Begins 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 <Option buttons> - select one of three options:-
    ( ) Timer
    ( ) Countdown Starting value <value> - enter time hh:mm:ss
    ( ) None
Note: Times are Trainz clock time, not real time

Ranked Session Complete Rule: Completes the active ranked Session

Properties:
 Set the active ranked session as <Option buttons> - select one of two options:-
    ( ) Complete
    ( ) Failed
 [Check box] Customize the completion message <text> - enter a text message

Resource Check Rule: Check the progress of the amount of a resource and target object, then executes any following child rules. This rule has been superseded by the Multiple Resource Check Rule

Properties:
 <Option buttons> - select one of two options:-
        ( ) Watch industry queue
           Target Object <click to select> - select an industry from the session list
           Queue <click to select> - select a product queue from the selected industry
           Product <click to select> - select a product from the selected queue
           Amount <value> - enter a quantity
           <Option buttons> - select one of two options:-
              ( ) Complete when designated queue equals or exceeds required amount
              ( ) Complete when designated queue falls below required amount
        ( ) Watch vehicle
          Target Object <click to select> - select a rolling stock asset from the session list
           Queue <click to select> - select a product queue from the selected rolling stock
           Product <click to select> - select a product from the selected queue
           Amount <value> - enter a quantity
           <Option buttons> - select one of two options:-
              ( ) Complete when designated queue equals or exceeds required amount
              ( ) Complete when designated queue falls below required amount

Session Complete Rule: Set 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

Station Visited Check Rule: Waits for a designated train or any train to call at one of the designated stations or industries, then executes any following child rules

Properties:
  Trigger: <selection> - 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
  <Option buttons> - select one of two options:-
     ( ) Accept all trains - all trains will trigger the rule
     ( ) Accept trains matching specific criteria - only specific vehicles, specific vehicle types, specific drivers will trigger the rule

Danger Rules

ATP Speed Limiter Rule: Limits speed over set limit

Properties:
   Limits the speed to <value> mph over the set limit - enter speed value in mph

AWS Configuration Rule: This rule configures the Trainz implementation of the Automatic Warning System when approaching signals

Properties:
   <Option buttons> - select one of three options:-
      ( ) 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 Rule: Cleans 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
Note: Time is Trainz clock time, not real time.

Coupler Breakage Check Rule: Checks for breaking couplers and, if found, then executes any following child rules.

Properties:
   None

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

Properties:
   <Option buttons> - select one of two options:-
      ( ) Show the Coupler Breakage Display
      ( ) Hide the Coupler Breakage Display

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

Properties:
   [Check box] Respawn trains if they are abandoned for 10 minutes
   If checked:-
      <Option buttons> - select one of two options:-
         ( ) 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 Rule: Checks for safety systems making penalty applications on users and, if found, then executes any following child rules.

Properties:
   [Check box] Trigger only once

Safety System Isolated Check Rule: Checks for safety systems being isolated by users and, if found, then executes any following child rules.

Properties:
   [Check box] Trigger only once

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

Properties:
   <Add vehicle> - click to select a vehicle from the session list
   <Add All> - click to add all vehicles in the session list
   <Delete All> - click to remove all added vehicles from this rule
      For each selected vehicle:-
      Coupling Mask
         Front 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 Rule: Checks for Drivers passing signals at danger (stop) and, if found, then executes any following child rules.

Properties:
   [Check box] Trigger only once

Speeding Check Rule: If player controlled trains are over the local speed limit or over a set (custom) speed, then executes any following child rules

Properties:
   <Option buttons> - 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 Rule: Overrides the default vehicle physics properties

Properties:  
   <Option buttons> - select one of two options:-
      ( ) Accept all trains
      ( ) Accept trains matching specific criteria from list of train assets 
   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 Rule: Waits for a derailment to occur, then executes any following child rules

Properties:
 [Check Box] Trigger derailment, Watch Once

Navigation Rules

DestSignTable Rule: Creates 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

Interlocking Tower Configure Path Alters settings on an interlocking tower path

Properties
  Interlocking Tower <select> - to 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. Disable by removing rule from session

Properties
  [Checkbox] Show path activation message in Driver

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

Properties:
  Interlocking Tower <select> - to set Name and Objects

Interlocking Tower Enhanced Manager Rule (SP2 and later): rule by pguy. Provides more management and control options for interlocking towers.

Properties:

Multiple Junction Alignment Check Rule Checks junctions are set or in alignment, then executes any following child rules

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

Navigation Display Rule: Creates a set of navigation points. Multiple sets can be created by adding additional copies of this rule. This rule creates the navigation set, it does not display it. Use the Navigation set hide/show rule to make a set visible. Navigation sets can be completed (terminated) by the Navigation Set Clear Rule, individual navigation points can be manually completed by the Navigation Point Complete Rule. Click the help icon at the top of the properties box for in game instructions.

Properties:
   Unique set ID: <click here to set> - enter a unique name for the navigation set. Name must be in lowercase and have no spaces.
   Train (optional): <click here to set> - select a rolling stock asset from the session list shown.
   <Option buttons> - select one of three options:-
   ( ) All points must be completed in sequence:
      - the first uncompleted navigation point will be shown and must be completed next.
      - the next point (if any) will also be shown but at a lower opacity.
   ( ) 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.

Navigation Point Complete Rule: Manually completes a navigation point in a set

Properties:
   Mark navigation point <click here to set> - enter the navigation point number to be completed
   complete in set <click here to set> - enter the unique name for the navigation set created using the Navigation display rule.
      Name must be in lowercase and have no spaces.
Known Issues:
   The rule will NOT check to see if the named navigation set and point exists or not.

Navigation Set Check Rule: Checks if a navigation set is complete or incomplete, then executes any following child rules

Properties:
   Checks if navigation point set <click to select>: - enter the unique name for the navigation set created using the Navigation display rule.
      Name must be in lowercase and have no spaces.
   is <Complete/Incomplete> - click to select one
Known Issues:
   The rule will NOT check to see if the named navigation set exists or not.

Navigation Set Clear Rule: Clears a navigation set removing any uncompleted navigation points

Properties:
   <Click here to set> - enter the unique name for the navigation set created using the Navigation display rule.
 Name must be in lowercase and have no spaces.
Known Issues:
   The rule will NOT check to see if the named navigation set exists or not.

Navigation Set Hide/Show: Shows and hides navigation sets. You can have multiple sets visible and hidden at the same time.

Properties:
   <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.
Known Issues:
   The rule will NOT check to see if the named navigation set exists or not.

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

Properties:
 Insert track mark <Click> - select a track mark from the Session List
 Arrival and Departure Time <Select> - set time
    hh:mm:ss - in  hours/minutes/seconds
 Current Train <Click> - select from session list
 Insert destination <Click> - select from session list
Note: Times are Trainz clock times, not real time

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

Properties:
   Add Junction - click to select a junction from the session junction list
   Add All - click to add ALL junctions in the session junction list
   Delete All - click to remove ALL entered junctions from the rule
      Junction Options: - for each selected junction:-
         <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 Rule: Sets the state of a selected signal Warning: not compatible with Interlocking Tower Assets

Properties:
   Select signal - click to select a signal from the session list
      <signal state> - click to select a state from the list

Trigger Check Rule: - Waits for any train to enter one of the designated triggers, then executes any following child rules. This rule replaces the older and less versatile "Trigger Rule".

Properties:
   <Option buttons> - select one of two options:-
      ( )click to accept all trains
      ( )click to accept trains matching specific criteria and choose from session Assets list
   <select> - select a trigger from the session list'
   [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 
   '<Click> Train Heading - choose forward or backward

Wait on Navigation Point Rule: Waits for a navigation point to be completed, then executes any following child rules

Properties:
   navigation point <click here to set> - enter the number of the navigation point to be completed
   in set <click here to set> - enter the unique name for the navigation set created using the Navigation display rule.
      Name must be in lowercase and have no spaces.
Known Issues:
   The rule will NOT check to see if the named navigation set and point exists or not.

Wait on Train Stop/Start Rule: Wait for a train to stop or start, then executes any following child rules

Properties:
   [Check box] Trigger rule once 
   <Click> Wait for a train that matches the following criteria to start moving/stop moving
   <Option buttons> - select one of two options:-
      ( )click to accept all trains
      ( )click to accept trains matching specific criteria and choose from session list

Driver Rules

Control Check Rule: Checks if the control method changes, then executes any following child rules

Properties:
 Execute child rules when: <Option buttons> - select one of two options:-
    ( ) DCC mode is Selected
    ( ) Cab mode is Selected
 Execute child rules: <Option buttons> - select one of two options:-
    ( ) Every time control method is set
    ( ) Once only

Control Type Rule Sets control type

Properties:
 Current control method is: <select> - click to select one of
    Easy Mode
    Ask User
    Realistic Mode

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

Properties:
 Portal index from PCP <value> - click to enter (Un)Portal Index
 Use UnPortal <Yes/No> - click to select Yes or No
 Delay from Trigger to Emit <seconds> - click to set number of seconds
 Add Trigger <select> - click to add Trigger from Session List

Disable/Enable Industry Rule: 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 <Option buttons> - select one of two options:-
     ( ) Apply to every vehicle in the session
     ( ) Apply only to a specific vehicles from Session List

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

Properties:
   For each installed Driver Command:-
   [Check box] Name of Diver Command and Description (if available) - check to make that command available to the driver

Driver Command Check Rule: Verifies the driver commands of a driver character, then executes any following child rules

Properties
 [Check box] Trigger rule once - check to allow the rule to execute only once
 Driver character to watch the command list of <click to 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 Main Menu Options Rule: Show/Hide the Driver Main Menu Bar

Properties
 <select> the Driver Main Menu Bar - click to choose one of:-
    Show
    Hide

Driver Schedule Rule Execution of basic scheduled commands

Properties: 
 Driver Schedule Rule assigned to <Click>
    -to name driver from Session List
 Commands <Click>
    -to insert driver commands in Drive Schedule
 Style: <Option Buttons>
    -Classic style: If there is a schedule do not emit a new schedule
    -Killer style: If there is a schedule clean it and emit a new one
    -Cooperative style: If there is a schedule append the new one
    -Active style: Emit a new schedule, only if already a schedule running

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

Properties
 The following drivers will be available <click> 
    -To add Driver, Driver Commands, Assets, Type of Engineer, or Remove Driver
 Remove all existing Drivers first <Check Box>
    -to set
 Generate new Drivers for empty Trains <Check Box>
    -to set
 

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

Properties
 Driver Commands <Click>
    -to select Enable or Disable
Driver Command criteria to match <Check Box>
   -to select each Driver Command
Trains to use <Option Buttons>
   -Accept all trains
   -Accept trains matching above criteria 


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

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

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

Properties
 Set Time <Click>
   -insert time
 QuickDrive Consist Option List by 
  Rate of Change <value> - insert rate as number times
 [Check Box] Enable gameplay Session Mode
   -to set
 [Check Box] Enable in game help by default
 Set the default Control method to <Option buttons> - select one of two options:-
  ( ) 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, then executes any following child rules

Properties
 Trigger Rule Once [Check Box]
  -to set 
 Accept trains <Option buttons> - select one of two options:-
   ( ) matching specific criteria, select from session list
   ( ) all trains
 Wait for a driver character to get <select> - select On' or Off

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

Properties
 Assets Ownership <Option buttons> - select one of two options:-
  ( ) Wait for ownership of a specific Driver
  ( ) Wait for ownership of Driver
 Driver or Vehicle <select> - choose from session list

Arrangement of Session Rules:

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

Properties
 <Option buttons> - select one of two options:-
  ( ) 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 Rule: The first child rule will be executed on the first run of this rule, the second child executed on the second run, etc.

Properties
  After last child has been executed ...
  <successive runs will do nothing/the first child is chosen again> - click to select one

Random List Rule: One of the child rules indented under this rule will be randomly selected and executed. The rule will not repeat to randomly select another child rule

Properties
  None

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

Properties
  None

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

Properties
  Rule completes when ...
    <one of the child rules has completed/all child rules have reached a completed state/all child rules have reached a "was completed" state> - click to select one

Camera Rules:

Cinematic Camera Rule: Provides several different cinematic style cameras

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

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

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

Wait for Camera View Mode Rule: Waits for the camera to be changed to the designated view, then executes any following child rules

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

Message Rules:

Close Message Popup Rule: Closes open message popups

Properties:
  None
Known Issues:
  This rule only appears to work if it is a child of the rule that triggered the Message Popup Rule

Custom Script Rule:

Properties
  None.

Display Custom HUD Rule: Show or hide the Custom Heads Up Display.

Properties
  Show the Custom Heads up Display- fill-in to choose.
  Hide the Custom Heads up Display- fill-in to choose.
  Note: One or the other will be chosen by default.

Wait for Click on HUD Icon Rule: Waits for the HUD to be clicked, then executes any following child rules

Properties
  Trigger rule once-check to choose.
  HUD Panel- click to choose from list.
  Wait for click on- click to choose; choice depends on HUD Panel chosen.

Display HTML Pages Rule: Creates a browser to display the listed HTML files in order as a navigable sequence of pages. 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 <click to 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
  

Timed limited display HTML Rule: Displays an HTML browser window for a limited time.

Properties
  HTML Asset Name-

Display Video Rule: Displays a page from a HTML assets in a browser window.

Properties

End Session Rule: End Session without saving.

Properties

Fade in/out Rule: Fade in or out within seconds, color and opacity considered.

Properties

Flash HUD Icon Rule: Flashes a HUD panel icon for a set duration of time or instructs a HUD panel icon to start/stop.

Properties

Generic Tree Node Debug Window Rule: No description.

Properties

InputTable Rule: Creating a list of message names to be used for various purposes.

Properties

Message Popup Rule: Displays a pop-up browser window and waits for it to be closed. Closure can be manual (by the user) or by another rule.

Properties
[Check Box] Pause game while message is displayed - stops the game until this message is switched off
[Check Box] Close previous popup windows - closes any Message Popups currently displayed
Message location <Top Left/Top Right/Bottom Left/Bottom Right> - select one to position the browser window on the screen
Message Source: <Option buttons> - select one of three options:-
  ( ) Custom text - the simplest and easiest option
     Icon <Click here to set> - shows a list of message icons. Select one to be displayed with the message
     Icon <Clear icon> - clears any currently displayed message icon
     Custom text box Enter text to be displayed. You will be limited to about 6 lines of text. 
        For longer messages or to include graphics, use the A predefined HTML page option.
  ( ) 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> - <function unknown at present>
     <HTML Wave> - (optional) select the name of the HTML file containing the wave file to be played. 
        The page must be in the HTML asset identified above. Filename is not case sensitive. Extension ".html" is optional.
     <Wave Name> - (optional) enter the name of a wave (.wav) sound file to be played. 
        The sound file must be in the HTML asset identified above. Filename is not case sensitive. Extension ".wav" is optional
     [Check Box] Autoplay Wave: - plays the .wav sound file as soon as message is displayed. 
        If unchecked sound will not be played.

Minimap Options Rule: Sets the display options for the minimap.

Properties Default: all checked
 Map Textures [Check Box]
   Check to select
 Gradients  [Check Box]
   Check to select
 Junctions [Check Box]
   Check to select
 Signals [Check Box]
   Check to select
 Triggers [Check Box]
   Check to select
 Markers [Check Box]
   Check to select
 Trackside Labels [Check Box]
   Check to select
 Terrain Objects [Check Box]
   Check to select
 Industrial Names [Check Box]
   Check to select
 Named Objects [Check Box]
   Check to select
 Consists [Check Box]
   Check to select 

Play Sound Rule: Plays a wav sound file.

Properties
  Default HTML <Click>
    to enter Sound File Name
  HTML Assets <Click>
    to select HTML asset
  Rule Completes <Click>
    to select 'sound has just started
    to select 'sound has finished playing

Session Debug Rule: Executes the first child if debug mode is selected. Otherwise the second child. Once this child is complete, this rule will be complete.

Properties
  None

Session Metadata Rule: Sets session metadata in the config file. Info can be read by other systems and displayed to the player.

Properties
  Type <Click>
    to select simulation
    to select Challenge
  Length <Click>
    to enter number of minutes, default 30 minutes
  Difficulty <Click>
    to choose Normal(default), Tutorial, Easy, Hard, Expert

Set Helper Icon Size Rule: Sets the size of helper icons such as the junction lever arrows.

Properties
  Junction Arrows Size <Click>
    to set scale ratio smaller than default, default 100%

Set HTML Page Rule: Instructs 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
  <Option buttons> - select one of five options:-
    ( ) 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 HUD Panel Rule: Shows or hides a HUD panel.

Properties

Show/Hide Layer Rule: Shows 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.
Known Bugs:
TANE (all versions) - layers set to Hide when a game is saved will be Shown when the game is reloaded

Show/Hide Minimap Rule: Shows the Driver the minimap window.

Properties
   Minimap Window-click to choose Show,Hide

Show/hide on-screen help Rule: Shows or hides On-screen help in Driver.

Properties
   Junction Overlays: - fill-in to choose: Show, Hide, Leave unchanged. by default one is chosen
   On Screen Vehicle Name: - Fill-in to choose: Show, Hide, Leave unchanged. By default one is chosen 

Wait for Click on HUD Icon Rule: Waits for a click on the HUD Icon, then executes any following child rules

Properties
   (Check Box) Trigger Once: -to choose
   HUD Panel: - Click to choose from list: Bottom Right Menu, Camera Controls, DCC Controls
   Icon: - Choose from list. Selections depends on HUD Panel chosen

Wait on Waybill Screen/Main Screen Rule: Waits for the Waybill window to be opened, then executes any following child rules

 Properties

Startup Rules:

Multiplayer Rule: Enables this session to be taken online in a Multiplayer environment.

Properties

Startup Options Rule Specifies the starting options for the session.

Properties

Time Rules:

Clock Rule: Rule needed for animated clocks, you need to apply this rule to your session to make use of the animated clocks, see forum for code to include in you clock object to work with this rule.

Properties

Timecheck Rule: Executes child rules at a set time.

Properties
   <hh:mm:ss> - enter execution time as hours (0-23), minutes (0-59) and seconds (0-59).
   [Check box] Execution time is on the day after the start time - when checked delays execution until the following day.
Note:
   Times and days are Trainz clock times not real time.

Timing Check Rule: Triggers sub rules if called within the time window specified.

Properties

Wait Rule: Wait for number of seconds before executing any following child rules

Properties
   <click to set> - enter the number of seconds for the wait delay
   Note: Seconds is in Trainz clock time, not real time

Variable Rules:

Variable Check Rule: If the specified variable matches the specified conditions then the child rules will be executed in order.

Properties
<variable-name> - enter a variable-name. Variable name is case sensitive.
<is less than/is less than or equal to/is equal to/is greater than or equal to/is greater than/is not equal to/is between x and y> - select one
<This condition will be evaluated only once .../This condition will be evaluated once every second> - click to select one
   Test condition option: is between x and y - Enter minimum (x) and maximum (y) test values
   Test condition option: (all other options) - Enter test value
   Evaluation option: This condition will be evaluated only once ... - any changes to the variable that occur after it has been checked will not change the result of this rule
   Evaluation option: This condition will be evaluated evaluated once every second - the rule will be rerun and the variable rechecked every second

Variable Modify Rule: Change the value of a specified variable. This rule can also used to create a new variable and set its initial value by using the "Change variable" option.

Properties
Change <Add to variable/Subtract from variable/Change variable> - select one
   [Check box] (optional) Set the minimum value of <variable-name> to <value> - enter variable-name
      (this will already be set by the change option) and a value. Variable-name is case sensitive.
   [Check box] (optional) Set the maximum value of <variable-name> to <value> - enter variable-name
      (this will already be set by the change option) and a value. Variable-name is case sensitive.
      Change option: Add to variable
         Add <value> to variable <variable-name> - enter value to add to variable, enter variable-name. Variable-name is case sensitive.
         <Do not undo the alteration if the rule is stopped/Undo the alteration if the rule is stopped> - click to select one.
      Change option: Subtract from variable
         Subtract <value> from variable <variable-name> - enter value to subtract from variable, enter variable-name.
            Variable-name is case sensitive.
         <Do not undo the alteration if the rule is stopped/Undo the alteration if the rule is stopped> - click to select one.
      Change option: Change variable
         Change variable <variable-name> to <value> - enter variable-name, enter new value. 
            Variable-name is case sensitive. This change cannot be undone if the rule is stopped. 
  

Variable Modify Continuous Rule: Adds, subtracts or sets a value to a specified variable every second.

Properties
  <Add/Subtract/Change variable to> - select one.
     <value> - enter value to add, subtract or apply to <variable-name>
     <variable-name> - enter variable-name. Variable-name is case sensitive.

Variable Show Rule: Adds or removes a specified variable and a descriptive label to the custom HUD. This rule does not make the custom HUD appear on the screen.

Properties
  [Check box] Add
     <variable-name> - enter variable-name to add to HUD. Variable-name is case sensitive.
     <label> - (optional) enter a short label to be displayed on the HUD in front of the variable value.
  [Check box] Remove
     <variable-name> - enter variable-name to remove from HUD. Variable-name is case sensitive.

Variables are saved in the session file and persist from one saved game to another. They can be accessed/modified by the following driver commands:

Driver Commands by trev999:

Set S-Variable driver command: 
Skip if session-variable driver command: 
Wait until S-variable driver command: 

Driver Commands by atilabarut

ChangeSVariables driver command: 
WaitUntilSVariable driver command: 

Weather Rules:

EIRS Weather Rule NE USA Rule: Customize random weather rule relative to the North East Region of the United States.

Properties


Weather Rule: Set the weather conditions.

Properties
Personal tools