How to Use Parent and Child Rules
m (added Trainz Plus where needed, replaced references to multiple Trainz versions with "Trainz") |
m (→Related Links) |
||
| Line 269: | Line 269: | ||
</tr> | </tr> | ||
</table> | </table> | ||
| − | + | [[file:BackToTop.png|link=#top|alt=Top|Top]] | |
---- | ---- | ||
---- | ---- | ||
Revision as of 08:52, 25 November 2019
The information in this Wiki Page applies to TANE, TRS19 and Trainz Plus.
Contents |
What Are Parent and Child Rules?
 |
Rules that act as Parent Rules can have one or more sub-rules or Child Rules under them |
|
Rules are edited and managed by the Session Editor in Surveyor |
 |
More information on the Session Editor can be found on the Trainz Wiki Page at:- |
Most Parent Rules are used as "decision makers" in TANE/TRS19 Sessions. They decide if or when other rules, the Child Rules, will be executed. Some Parent Rules control how those Child Rules are executed.
 |
Session rules can be arranged in a hierarchical fashion, in a series of levels as shown in the example on the left. A Parent Rule can be used to group together a set of rules at a lower level in the hierarchy. The rules that are grouped together under a Parent Rule are the Child Rules. Child Rules can also be Parent Rules that group together other rules at an even lower level. This creates multiple levels in the hierarchy. |
 |
Notes:
|
|
Rules that act as Child Rules are indented under a Parent Rule. |
 |
 |
||||||
Parent/Child Rule Example
 |
In the screenshot above, the
- Trigger Check Rule is a Parent Rule. It has rules indented below it.
- Simultaneous List Rule is indented under the Trigger Check Rule so it is a Child of that rule. It is also a Parent Rule as it has rules indented below it
- Message Popup Rule is indented under the Simultaneous List Rule so it is a Child of that rule.
- Wait Rule is indented under the Simultaneous List Rule so it is a Child of that rule. It is also a Parent Rule as it has rules indented below it
- Close Message Popup Rule is indented under the Wait Rule so it is a Child of that rule.
- Simultaneous List Rule is indented under the Trigger Check Rule so it is a Child of that rule. It is also a Parent Rule as it has rules indented below it
Sequence of Events
- When the consist identified in the Trigger Check Rule, a Parent Rule, reaches the set trigger, the Trigger Event is activated and its Child Rules are executed.
- The Simultaneous List Rule, a Parent Rule, is then executed. It executes all its Child Rules immediately and simultaneously.
- The Message Popup Rule is executed. At the same time ...
- The Wait Rule is executed. This is set to force a 20 second wait, after which its Child Rule ...
- The Close Message Popup Rule is executed. This closes the Message window created by the Message Popup Rule. Since it is the last rule under the Simultaneous List Rule it terminates that Parent Rule. Since it is the last rule under the Trigger Check Rule, it also terminates that Parent Rule.
- The Simultaneous List Rule, a Parent Rule, is then executed. It executes all its Child Rules immediately and simultaneously.
Ordered Lists vs Simultaneous Lists
The majority of sibling Child Rules, rules that are at the same indent level under a Parent Rule, will be executed in order (an Ordered List) or simultaneously (a Simultaneous List).
Ordered Lists
Rule details can be found at 
Ordered List Rule
|
Ordered Lists are shown with numbered icons on each Child Rule which indicates the order in which they will be executed. |
 |
|
||||||
|
Each Child Rule in the sequence must be completed before the next Child Rule can be executed. |
|
Notes:
|
Simultaneous Lists
Rule details can be found at Simultaneous List Rule
|
Simultaneous Lists are shown with equality ("=") icons on each Child Rule which indicates that they will be executed at the same time. |
 |
|
||||||
Other Types of Lists
Progressive Lists
Rule details can be found at Progressive List Rule
|
On the first run of a Progressive List, only the first Child Rule is executed. On the second run, the second Child Rule is executed, on the third run the third Child Rule is executed, etc. |
 |
|
||||||
Random Lists
Rule details can be found at Random List Rule
|
A Random List will run ONLY ONCE and will randomly select a single Child Rule to execute. |
 |
Reset Lists
Rule details can be found at Reset List Rule
|
A Reset List will execute continuously, it will never terminate. Each time through the list all the Child Rules will be reset and executed again. |
 |
Related Links
|
Trainz Wiki
 |
More Tutorials and Guides to Using Trainz |
