Parent Rule List

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
m (added Trainz Wiki Links)
 
(56 intermediate revisions by one user not shown)
Line 1: Line 1:
Parent Rules are session rules that can have one or more sub-rules or '''Child Rules''' indented under them. Only certain rules can be Parent Rules.
+
The information in this Wiki Page applies to '''TANE''', '''TRS19''', '''Trainz Plus''' and '''TRS22'''.
  
==='''Parent Rules that Apply a Logic Test Before Executing Child Rules'''===
+
<table width=1000 bgcolor="lightcyan" cellpadding=2>
 +
<tr valign="top">
 +
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
 +
<td>'''Parent Rules''' are session rules that can have one or more sub-rules or '''Child Rules''' indented under them</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlueDot10x10.png|link=]]</td>
 +
<td>'''Parent Rules''' are the "decision makers" in interactive Sessions, they decide when and how the '''Child Rule''' will be executed</td>
 +
</tr>
 +
<tr valign="top">
 +
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
 +
<td>Only certain rules can be '''Parent Rules'''</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table> <!-- BEGIN Nav Buttons Table -->
 +
<tr valign="top">
 +
<td width=729>&nbsp;</td>
 +
<td width=46>&nbsp;</td>
 +
<td width=75>&nbsp;</td>
 +
<td width=75>&nbsp;</td>
 +
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 +
</tr>
 +
</table> <!-- END Nav Buttons Table -->
  
*'''Achievement Check Rule'''. Executes Child Rules when set achievement levels have been reached.
+
='''Parent Rules that Apply a Logic Test Before Executing Child Rules'''=
*'''Consist Check Rule'''. Executes Child Rules when a consist contains specific vehicles or vehicle types.
+
<table cellpadding=4 bgcolor=#ffffff>
*'''Control Check Rule'''. Executes Child Rules when the driver control method has changed or a specific control method has been set.
+
<tr valign="top">
*'''Coupler Breakage Rule'''. Executes Child Rules when a coupler has been broken.
+
<td width="58">[[image:RulesWiki.PNG|link=]]</td>
*'''Driver Command Check Rule'''. Executes Child Rules when the driver commands match a predefined list.
+
<td><span style="font-size: 17px;">'''Rules List:'''</span><br>
*'''Multiple Junction Alignment Check Rule'''. Executes Child Rules when specified junctions have been set.
+
*'''Multiple Resource Check Rule'''. Executes Child Rules when specified vehicles or industries have reached set commodity (product) levels.
+
*'''Navigation Set Check Rule'''. Executes Child Rules when a navigation set is complete or incomplete.
+
*'''Objective Check Rule'''. Executes Child Rules when set session objectives have been achieved (or not achieved).
+
*'''Resource Check Rule'''. Executes Child Rules when a specified vehicle or industry has reached set commodity (product) levels.
+
*'''Resource Verify Rule'''. Executes Child Rules when a specified vehicle or industry has reached set commodity (product) levels.
+
*'''Safety System Engaged Check Rule'''. Executes Child Rules when the safety system has been engaged.
+
*'''Safety System Isolated Check Rule'''. Executes Child Rules when the safety system has been isolated.
+
*'''Session Debug Rule'''. Executes the first Child Rule if the user selects ''Debug Mode'' otherwise executes the second Child Rule.
+
*'''Signal Passed at Danger Check Rule'''. Executes Child Rules when a consist passes a signal set to Stop.
+
*'''Speeding Check Rule'''. Executes Child Rules when a consist exceeds a set speed.
+
*'''Station Visited Check Rule'''. Executes Child Rules when specified consists stop at specific stations or industries.
+
*'''Time Check Rule'''. Executes Child Rules at a specific Trainz clock time.
+
*'''Trackside Check Rule'''. Executes Child Rules when a consist enters the range of a specific trigger.
+
*'''Trigger Check Rule'''. Executes Child Rules when a consist enters the range of a specific trigger.
+
*'''Variable Check Rule'''. Executes Child Rules when a variable passes a specific logic test.
+
*'''Wait for Camera View Mode Rule'''. Executes Child Rules when the camera is changed to a set view.
+
*'''Wait for Click on HUD Icon Rule'''. Executes Child Rules when a specific HUD icon is clicked.
+
*'''Wait for Derailment Rule'''. Executes Child Rules when a consist is derailed.
+
*'''Wait for Driver On/Off Train Rule'''. Executes Child Rules when a driver gets on or off a train.
+
*'''Wait for Driver/Train to be Locally Owned Rule'''. Executes child rules when a specific driver or vehicle is locally owned.
+
*'''Wait on Navigation Point Rule'''. Executes child rules when a specific navigation point is completed.
+
*'''Wait on Train Stop/Start Rule'''. Executes child rules when a train stops or starts moving.
+
*'''Wait on Waybill Screen/Main Screen Rule'''. Executes child rules when the Waybill window is opened or closed.
+
*'''Wait Rule'''. Executes child rules after waiting for set number of seconds.
+
  
==='''Parent Rules that Do Not Apply a Logic Test Before Executing Child Rules'''===
+
*'''[[Session_Rule_List_with_Parameters#Achievement_Check_Rule|Achievement Check Rule]]'''. Executes Child Rules when set achievement levels have been reached.
 +
*'''[[Session_Rule_List_with_Parameters#Consist_Check_Rule|Consist Check Rule]]'''. Executes Child Rules when a consist contains specific vehicles or vehicle types has been formed.
 +
*'''[[Session_Rule_List_with_Parameters#Control_Check_Rule|Control Check Rule]]'''. Executes Child Rules when the driver control method has changed or a specific control method has been set.
 +
*'''[[Session_Rule_List_with_Parameters#Coupler_Breakage_Check_Rule|Coupler Breakage Check Rule]]'''. Executes Child Rules when a coupler has been broken.
 +
*'''[[Session_Rule_List_with_Parameters#Directional Trigger Check Rule|Directional Trigger Check Rule]]'''. Executes Child Rules when activated by a train moving in a set direction.
 +
*'''[[Session_Rule_List_with_Parameters#Driver Command Check Rule|Driver Command Check Rule]]'''. Executes Child Rules when the driver commands match a predefined list.
 +
*'''[[Session_Rule_List_with_Parameters#Multiple Junction Alignment Check Rule|Multiple Junction Alignment Check Rule]]'''. Executes Child Rules when specified junctions have been set.
 +
*'''[[Session_Rule_List_with_Parameters#Multiple Resource Check Rule|Multiple Resource Check Rule]]'''. Executes Child Rules when specified vehicles or industries have reached set commodity (product) levels.
 +
*'''[[Session_Rule_List_with_Parameters#Navigation Set Check Rule|Navigation Set Check Rule]]'''. Executes Child Rules when a navigation set is complete or incomplete.
 +
*'''[[Session_Rule_List_with_Parameters#Objective Check Rule|Objective Check Rule]]'''. Executes Child Rules when set session objectives have been achieved (or not achieved).
 +
*'''[[Session_Rule_List_with_Parameters#Resource Check Rule|Resource Check Rule]]'''. Executes Child Rules when a specified vehicle or industry has reached set commodity (product) levels.
 +
*'''[[Session_Rule_List_with_Parameters#Resource Verify Rule (fixed)|Resource Verify Rule]]'''. Executes Child Rules when a specified vehicle or industry has reached set commodity (product) levels.
 +
*'''[[Session_Rule_List_with_Parameters#Safety System Engaged Check Rule|Safety System Engaged Check Rule]]'''. Executes Child Rules when the safety system has been engaged.
 +
*'''[[Session_Rule_List_with_Parameters#Safety System Isolated Check Rule|Safety System Isolated Check Rule]]'''. Executes Child Rules when the safety system has been isolated.
 +
*'''[[Session_Rule_List_with_Parameters#Session Debug Rule|Session Debug Rule]]'''. Executes the first Child Rule if the user selects ''Debug Mode'' otherwise executes the second Child Rule.
 +
*'''[[Session_Rule_List_with_Parameters#Signal Passed At Danger Check Rule|Signal Passed at Danger Check Rule]]'''. Executes Child Rules when a consist passes a signal set to Stop.
 +
*'''[[Session_Rule_List_with_Parameters#Speeding Check Rule|Speeding Check Rule]]'''. Executes Child Rules when a consist exceeds a set speed.
 +
*'''[[Session_Rule_List_with_Parameters#Station Visited Check Rule|Station Visited Check Rule]]'''. Executes Child Rules when specified consists stop at specific stations or industries.
 +
*'''[[Session_Rule_List_with_Parameters#Timecheck Rule|Timecheck Rule]]'''. Executes Child Rules at a specific Trainz clock time.
 +
*'''[[Session_Rule_List_with_Parameters#Trackside Check Rule|Trackside Check Rule]]'''. Executes Child Rules when a consist enters the range of a specific trigger.
 +
*'''[[Session_Rule_List_with_Parameters#Trigger Check Rule|Trigger Check Rule]]'''. Executes Child Rules when a consist enters the range of a specific trigger.
 +
*'''[[Session_Rule_List_with_Parameters#Variable Check Rule|Variable Check Rule]]'''. Executes Child Rules when a variable passes a specific logic test.
 +
*'''[[Session_Rule_List_with_Parameters#Wait for Camera View Mode Rule|Wait for Camera View Mode Rule]]'''. Executes Child Rules when the camera is changed to a set view.
 +
*'''[[Session_Rule_List_with_Parameters#Wait for Click on HUD Icon Rule|Wait for Click on HUD Icon Rule]]'''. Executes Child Rules when a specific HUD icon is clicked.
 +
*'''[[Session_Rule_List_with_Parameters#Wait for Derailment Rule|Wait for Derailment Rule]]'''. Executes Child Rules when a consist is derailed.
 +
*'''[[Session_Rule_List_with_Parameters#Wait for Driver On/Off Train Rule|Wait for Driver On/Off Train Rule]]'''. Executes Child Rules when a driver gets on or off a train.
 +
*'''[[Session_Rule_List_with_Parameters#Wait for Driver/Train to be Locally Owned Rule|Wait for Driver/Train to be Locally Owned Rule]]'''. Executes child rules when a specific driver or vehicle is locally owned.
 +
*'''[[Session_Rule_List_with_Parameters#Wait on Navigation Point Rule|Wait on Navigation Point Rule]]'''. Executes child rules when a specific navigation point is completed.
 +
*'''[[Session_Rule_List_with_Parameters#Wait on Train Stop/Start Rule|Wait on Train Stop/Start Rule]]'''. Executes child rules when a train stops or starts moving.
 +
*'''[[Session_Rule_List_with_Parameters#Wait on Waybill Screen/Main Screen Rule|Wait on Waybill Screen/Main Screen Rule]]'''. Executes child rules when the Waybill window is opened or closed.
 +
*'''[[Session_Rule_List_with_Parameters#Wait Rule|Wait Rule]]'''. Executes child rules after waiting for set number of seconds.</td>
 +
</tr>
 +
</table>
 +
<br>
  
*'''Ordered List Rule'''. Executes all Child Rules individually in sequential order.
+
='''Parent Rules that Do Not Apply a Logic Test Before Executing Child Rules'''=
*'''Progressive List Rule'''. Executes Child Rules progessively each time the list is run.
+
<table cellpadding=4 bgcolor=#ffffff>
*'''Random List Rule'''. Executes once only and randomly selects one Child Rule to execute.
+
<tr valign="top">
*'''Reset List Rule'''. Executes all Child Rules in order and continuosly.
+
<td width="58">[[image:RulesWiki.PNG|link=]]</td>
*'''Simultaneous List Rule'''. Executes all Child Rules simultaneously.
+
<td><span style="font-size: 17px;">'''Rules List:'''</span><br>
  
==='''Related Trainz Wiki Links:'''===
+
*'''[[Session_Rule_List_with_Parameters#Ordered List Rule|Ordered List Rule]]'''. Executes all Child Rules individually in '''sequential order'''.
*'''[[Controlling Junctions in Sessions]]'''
+
*'''[[Session_Rule_List_with_Parameters#Progressive List Rule|Progressive List Rule]]'''. Executes Child Rules '''progressively''' each time the list is run.
*'''[[Message Popup Rule Applications]]'''
+
*'''[[Session_Rule_List_with_Parameters#Random List Rule|Random List Rule]]'''. Executes once only and '''randomly selects one Child Rule''' to execute.
*'''[[Message Popup Example|Message Popup Rule Examples]]'''
+
*'''[[Session_Rule_List_with_Parameters#Reset List Rule|Reset List Rule]]'''. Executes '''all''' Child Rules in order and '''continuously'''.
*'''[[Navigation Point Applications]]'''
+
*'''[[Session_Rule_List_with_Parameters#Simultaneous List Rule|Simultaneous List Rule]]'''. Executes '''all''' Child Rules '''simultaneously'''.</td>
*'''[[Navigation Point Rules Examples]]'''
+
</tr>
*'''[[Parent and Child Rules]]'''
+
</table>
*'''[[Using Variables in Sessions - Examples]]'''
+
<br>
 +
<table> <!-- BEGIN Nav Buttons Table -->
 +
<tr valign="top">
 +
<td width=729><span id="bottom"></span>&nbsp;</td>
 +
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>&nbsp;</td>
 +
<td width=75>&nbsp;</td>
 +
<td width=75>&nbsp;</td>
 +
</tr>
 +
</table> <!-- END Nav Buttons Table -->
 +
----
 +
----
 +
='''Trainz Wiki'''=
 +
<table width=1000>
 +
<tr valign="top">
 +
<td>
 +
<table width=500 cellpadding=2 bgcolor=#ffffff>
 +
<tr valign="top">
 +
<td width=80>[[image:TrainzWiki.png|link=]]</td>
 +
<td>
 +
<span style="font-size: 17px;">'''More Tutorials and Guides to Using Trainz'''</span><br>
 +
*'''<span class="plainlinks">[http://online.ts2009.com/mediaWiki/index.php/HowTo How to Guides]</span>'''
 +
*'''[[Driver Commands List]]'''
 +
*'''[[Session Rule List with Parameters|Session Rules List (Alphabetical) with Parameters]]'''
 +
*'''[[Session Rules By Categories With Properties|Session Rules List (Categories) With Parameters]]'''
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
<td>
 +
<table width=500 cellpadding=4 bgcolor="aquamarine">
 +
<tr valign="top">
 +
<td width=50>[[image:LinkWiki.PNG|link=]]</td>
 +
<td>
 +
<span style="font-size: 17px;">'''Related Links'''</span><br>
 +
*'''[[How to Use Parent and Child Rules|How to Use Parent and Child Rules]]'''
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
----
 +
This page was created by Trainz user '''<span class="plainlinks">[http://online.ts2009.com/mediaWiki/index.php/User:Pware pware]</span>''' in May 2018 and was last updated as shown below.
 +
----
 +
[[Category:How-to guides]][[Category:Rules]]

Latest revision as of 22:12, 23 November 2023

The information in this Wiki Page applies to TANE, TRS19, Trainz Plus and TRS22.

BlueDot10x10.png Parent Rules are session rules that can have one or more sub-rules or Child Rules indented under them
BlueDot10x10.png Parent Rules are the "decision makers" in interactive Sessions, they decide when and how the Child Rule will be executed
BlueDot10x10.png Only certain rules can be Parent Rules


        Bottom

[edit] Parent Rules that Apply a Logic Test Before Executing Child Rules

RulesWiki.PNG Rules List:


[edit] Parent Rules that Do Not Apply a Logic Test Before Executing Child Rules

RulesWiki.PNG Rules List:


  Top      


[edit] Trainz Wiki

TrainzWiki.png

More Tutorials and Guides to Using Trainz

LinkWiki.PNG

Related Links


This page was created by Trainz user pware in May 2018 and was last updated as shown below.


Personal tools