How to Use Track Triggers
m (→Trainz Wiki) |
m (→Route or Session?) |
||
(7 intermediate revisions by one user not shown) | |||
Line 47: | Line 47: | ||
</tr> | </tr> | ||
</table> | </table> | ||
− | + | ||
<table width="100%"> | <table width="100%"> | ||
<tr valign="top"> | <tr valign="top"> | ||
Line 53: | Line 53: | ||
</tr> | </tr> | ||
</table> | </table> | ||
− | |||
='''Adding a Track Trigger'''= | ='''Adding a Track Trigger'''= | ||
Line 92: | Line 91: | ||
='''Configuring a Track Trigger'''= | ='''Configuring a Track Trigger'''= | ||
− | As soon as a new track trigger has been placed, its properties window | + | As soon as a new track trigger has been placed, its properties window will open on the screen. It will be given a default name and assigned to the currently active layer. |
− | + | <table cellpadding="4" bgcolor=#ffffff> <!-- BEGIN Step table --> | |
− | + | ||
− | + | ||
− | + | ||
− | <table cellpadding="4" bgcolor=#ffffff> | + | |
<tr> | <tr> | ||
<td colspan="2"> | <td colspan="2"> | ||
Line 104: | Line 99: | ||
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
− | <td>[[file:Steps.PNG|link=]]</td> | + | <td>[[file:Steps.PNG|link=]]<br><br> |
− | <td><span style="font-size: 17px;"> | + | <span style="font-size: 17px; font-weight: 700;">Steps</span></td> |
− | *To change the track trigger name click on the name box, delete the highlighted default name and enter a new name | + | <td>[[file:DotPoint1.JPG|link=]] <span style="font-size: 17px; font-weight: 700;">Name the Trigger:</span><br> |
− | *To change the assigned layer click on the layer box and select a new layer | + | <table> <!-- BEGIN Step 1 table --> |
− | *Leave the "Bound Layer" at ''<none>''. (See the '''Trainz Wiki Page''' [[file:WikiLink.PNG|link=]] '''[[How to Use Layers|Using Layers]]''' for information on layers) | + | <tr valign="top"> |
− | *To confirm the changes click on the [[file:Tick.PNG|link=]] icon on the bottom right of the window | + | <td>[[file:TrackTriggerProperties.JPG|link=]]</td> |
+ | <td> | ||
+ | *To change the track trigger name click on the name box, delete the highlighted default name and enter a new name | ||
+ | *To change the assigned layer click on the layer box and select a new layer | ||
+ | *Leave the "Bound Layer" at ''<none>''. (See the '''Trainz Wiki Page''' [[file:WikiLink.PNG|link=]] '''[[How to Use Layers|Using Layers]]''' for information on layers) | ||
+ | *To confirm the changes click on the [[file:Tick.PNG|link=]] icon on the bottom right of the window | ||
+ | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
Line 115: | Line 116: | ||
----</td> | ----</td> | ||
</tr> | </tr> | ||
− | </table></td> | + | </table> <!-- END Step 1 table --> |
+ | </td> | ||
</tr> | </tr> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
<tr valign="top"> | <tr valign="top"> | ||
− | <td>[[file: | + | <td> </td> |
− | < | + | <td>[[file:DotPoint2.JPG|link=]] <span style="font-size: 17px; font-weight: 700;">(Optional) Set the Trigger Detection Radius:</span><br> |
− | <table | + | <table> <!-- BEGIN Step 2 table --> |
+ | <tr valign="top"> | ||
+ | <td colspan=2>Track triggers have a "detection radius" that controls how close a train has to approach to trigger the event. The default radius is 20 metres. The smaller the radius the closer the train has to be to the track trigger to be detected. This radius is set in the '''Advanced Properties''' section of the '''Tools''' window (shown below).</td> | ||
<tr> | <tr> | ||
− | |||
− | |||
− | |||
<tr valign="top"> | <tr valign="top"> | ||
− | <td>[[file: | + | <td width=340>[[file:TrackTriggerRadius.JPG|link=]]</td> |
− | <td | + | <td> |
− | #Click the '''Advanced Tab''' to open its properties | + | #Click the '''Advanced Tab''' to open its properties |
− | #Enter a new radius value in metres | + | #Enter a new radius value in metres |
#Click the '''Set Trigger Radius''' button | #Click the '''Set Trigger Radius''' button | ||
− | #Click on the track trigger to assign its new radius. | + | #Click on the track trigger to assign its new radius |
+ | <br> | ||
+ | <table cellpadding="4" bgcolor=#ffffb0> <!-- BEGIN Step 2 Tip Table --> | ||
+ | <tr valign="top"> | ||
+ | <td>[[file:PencilTips.PNG|link=]]</td> | ||
+ | <td>A small radius should only be used for slower moving trains. Short fast trains may pass over a small radius track trigger without being detected.</td> | ||
+ | </tr> | ||
+ | </table> <!-- END Step 2 Tip Table --> | ||
</td> | </td> | ||
</tr> | </tr> | ||
Line 143: | Line 146: | ||
----</td> | ----</td> | ||
</tr> | </tr> | ||
− | </table> | + | </table> <!-- END Step 2 table --> |
− | + | </td> | |
− | <table | + | |
− | + | ||
− | + | ||
− | + | ||
</tr> | </tr> | ||
− | </table>< | + | </table> <!-- END Steps Table --> |
− | + | <table width="100%"> <!-- BEGIN Back-To-Top Table --> | |
− | + | ||
− | + | ||
− | <table width="100%"> | + | |
<tr valign="top"> | <tr valign="top"> | ||
<td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td> | <td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td> | ||
</tr> | </tr> | ||
− | </table> | + | </table> <!-- END Back-To-Top Table --> |
='''Creating a Track Trigger Event'''= | ='''Creating a Track Trigger Event'''= | ||
Line 174: | Line 170: | ||
</table> | </table> | ||
<br> | <br> | ||
− | + | <table cellpadding="4" bgcolor=#ffffff> <!-- BEGIN Step table --> | |
− | + | ||
− | + | ||
− | + | ||
− | <table cellpadding="4" bgcolor=#ffffff> | + | |
<tr> | <tr> | ||
<td colspan="2"> | <td colspan="2"> | ||
Line 184: | Line 176: | ||
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
− | <td>[[file:Steps.PNG|link=]]</td> | + | <td>[[file:Steps.PNG|link=]]<br><br> |
− | <td><span style="font-size: 17px;"> | + | <span style="font-size: 17px; font-weight: 700;">Steps</span></td> |
+ | <td>[[file:DotPoint1.JPG|link=]] <span style="font-size: 17px; font-weight: 700;">Open the Session Editor:</span><br> | ||
+ | <table> <!-- BEGIN Step 1 table --> | ||
+ | <tr valign="top"> | ||
+ | <td colspan=2> | ||
To add the '''Trigger Check Rule''' to a session:- | To add the '''Trigger Check Rule''' to a session:- | ||
− | #Open the '''Surveyor Main Menu''' in '''TANE | + | #Open the '''Surveyor Main Menu''' in '''TANE''' (shown below left) or the '''Surveyor Edit Menu''' in '''TRS19''' and '''Trainz Plus''' (shown below right) |
− | #Select the option '''Edit Session''' from the drop down menu list.</td> | + | #Select the option '''Edit Session''' from the drop down menu list |
+ | </td> | ||
+ | </tr> | ||
+ | <tr valign="top"> | ||
+ | <td>[[file:EditSessionMenu.JPG|link=]]</td> | ||
+ | <td>[[file:SessionEditMenuSP1.png|link=]]<br> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
Line 194: | Line 195: | ||
----</td> | ----</td> | ||
</tr> | </tr> | ||
− | </table></td> | + | </table> <!-- END Step 1 table --> |
+ | </td> | ||
</tr> | </tr> | ||
− | |||
− | |||
<tr valign="top"> | <tr valign="top"> | ||
− | <td | + | <td> </td> |
− | < | + | <td>[[file:DotPoint2.JPG|link=]] <span style="font-size: 17px; font-weight: 700;">Add the Trigger Check Rule:</span><br> |
− | <table | + | <table> <!-- BEGIN Step 2 table --> |
− | < | + | |
− | + | ||
− | ---- | + | |
− | + | ||
<tr valign="top"> | <tr valign="top"> | ||
− | <td> | + | <td>In the Edit Session window (shown below left):- |
− | + | ||
− | In the Edit Session window (shown left):- | + | |
*Click the '''Add''' button | *Click the '''Add''' button | ||
− | In the Rule Selection window (shown below):- | + | </td> |
− | #Scroll down the list to select the '''Trigger Check''' rule | + | <td> |
− | #Click on the [[file:Tick.PNG|link=]] icon</td> | + | In the Rule Selection window (shown below right):- |
+ | :#Scroll down the list to select the '''Trigger Check''' rule | ||
+ | :#Click on the [[file:Tick.PNG|link=]] icon | ||
+ | </td> | ||
+ | </tr> | ||
+ | <tr valign="top"> | ||
+ | <td width=490>[[file:EditSessionWindowX.JPG|link=|480px]]</td> | ||
+ | <td>[[file:RuleSelect.JPG|link=]]</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td colspan= | + | <td colspan=2><br>This will add the '''Trigger Check''' rule to the session.</td> |
+ | </tr> | ||
+ | <tr> | ||
+ | <td colspan=2> | ||
----</td> | ----</td> | ||
</tr> | </tr> | ||
− | </table></td> | + | </table> <!-- END Step 2 table --> |
+ | </td> | ||
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
− | <td>[[file: | + | <td> </td> |
+ | <td>[[file:DotPoint3.JPG|link=]] <span style="font-size: 17px; font-weight: 700;">Open the Trigger Check Rule Properties:</span><br> | ||
+ | <table> <!-- BEGIN Step 3 table --> | ||
+ | <tr valign="top"> | ||
+ | <td>With the '''Trigger Check''' rule highlighted (shown below):- | ||
+ | *Click the '''Edit''' button. This will open the rule properties window | ||
+ | </td> | ||
</tr> | </tr> | ||
− | |||
− | |||
− | |||
− | |||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[file:TriggerCheck.JPG|link=]]</td> | <td>[[file:TriggerCheck.JPG|link=]]</td> | ||
− | < | + | </tr> |
− | + | ||
<tr> | <tr> | ||
<td colspan="2"> | <td colspan="2"> | ||
----</td> | ----</td> | ||
+ | </tr> | ||
+ | </table> <!-- END Step 3 table --> | ||
+ | </td> | ||
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
− | <td>[[file: | + | <td> </td> |
− | + | <td>[[file:DotPoint4.JPG|link=]] <span style="font-size: 17px; font-weight: 700;">Configure the Rule:</span><br> | |
− | + | <table> <!-- BEGIN Step 4 table --> | |
− | *Click the ''' | + | <tr valign="top"> |
+ | <td colspan=2>For this example we will leave all settings unchanged and simply identify the track trigger to be used.<br> | ||
+ | In the Trigger Properties window (shown below):- | ||
+ | *Click the '''''<span style="text-decoration: underline;">Add trigger</span>''''' link | ||
+ | </td> | ||
+ | </tr> | ||
+ | <tr valign="top"> | ||
+ | <td>[[file:TriggerCheckProperties.JPG|link=]]</td> | ||
+ | <td> | ||
+ | </td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td | + | <td> |
− | ----</td> | + | <table cellpadding="4" bgcolor="Aquamarine"> <!-- BEGIN Table 4 Wiki Table --> |
+ | <tr valign="top"> | ||
+ | <td>[[file:LinkWiki.PNG|link=]]</td> | ||
+ | <td> | ||
+ | More information on the settings and options in this rule can be found on the '''Trainz Wiki Rules Page''' at:-<br> | ||
+ | * '''[[Session_Rule_List_with_Parameters#Trigger_Check_Rule|Trigger Check Rule]]'''<br> | ||
+ | </td> | ||
</tr> | </tr> | ||
− | </table></td> | + | </table> <!-- END Table 4 Wiki Table --> |
+ | </td> | ||
</tr> | </tr> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<tr> | <tr> | ||
<td colspan="2"> | <td colspan="2"> | ||
----</td> | ----</td> | ||
+ | </tr> | ||
+ | </table> <!-- END Step 4 table --> | ||
+ | </td> | ||
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
− | <td>[[file: | + | <td> </td> |
− | + | <td>[[file:DotPoint5.JPG|link=]] <span style="font-size: 17px; font-weight: 700;">Select the Trigger:</span><br> | |
− | + | <table> <!-- BEGIN Step 5 table --> | |
− | + | <tr valign="top"> | |
− | + | <td>The '''Trigger Selection Window''' will list all the '''Track Triggers''' in your layout. | |
#Select the trigger you have just added | #Select the trigger you have just added | ||
− | #Click on the [[file:Tick.PNG|link=]] icon | + | #Click on the [[file:Tick.PNG|link=]] icon at the bottom of the selection window |
+ | </td> | ||
+ | </tr> | ||
+ | <tr valign="top"> | ||
+ | <td>[[file:TriggerList.JPG|link=]]</td> | ||
</tr> | </tr> | ||
+ | <tr> | ||
+ | <td>Once the trigger has been added to the rule, click on the [[file:Tick.PNG|link=]] icon in the '''Trigger Check''' properties window to accept the change. | ||
<tr> | <tr> | ||
<td colspan="2"> | <td colspan="2"> | ||
----</td> | ----</td> | ||
</tr> | </tr> | ||
− | </table>< | + | </table> <!-- END Step 5 table --> |
− | + | <table width="100%"> <!-- BEGIN Back-To-Top Table --> | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | <table width="100%"> | + | |
<tr valign="top"> | <tr valign="top"> | ||
<td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td> | <td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td> | ||
</tr> | </tr> | ||
− | </table> | + | </table> <!-- END Back-To-Top Table --> |
='''Adding an Instruction to the Trigger Event'''= | ='''Adding an Instruction to the Trigger Event'''= | ||
Line 294: | Line 311: | ||
==Adding a Child Rule== | ==Adding a Child Rule== | ||
− | <table> | + | <table cellpadding="4" bgcolor=#ffffff> <!-- BEGIN Step table --> |
<tr valign="top"> | <tr valign="top"> | ||
− | <td | + | <td>[[file:Steps.PNG|link=]]<br><br> |
− | < | + | <span style="font-size: 17px; font-weight: 700;">Steps</span></td> |
− | < | + | <td>[[file:DotPoint1.JPG|link=]] <span style="font-size: 17px; font-weight: 700;">Add A Message Popup Rule:</span><br> |
− | < | + | <table> <!-- BEGIN Step 1 table --> |
− | <td | + | <tr valign="top"> |
− | ----</td> | + | <td>When you are back in the '''Session Editor''' window:- |
+ | #Make sure that the new '''Trigger Check Rule''' is selected (highlighted) | ||
+ | #Click the '''Add''' button to add another new rule | ||
+ | #Scroll down the rule selection window to find and select the '''Message Popup''' rule | ||
+ | #Click on the [[file:Tick.PNG|link=]] icon | ||
+ | </td> | ||
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
− | <td>[[file: | + | <td>[[file:TriggerAddMesPopup.JPG|link=]]</td> |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
− | <td | + | <td>The '''Message Popup Rule''' should now appear directly below the '''Trigger Check''' rule. It will display a red cross because it has not yet been configured. |
− | + | </td> | |
</tr> | </tr> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<tr> | <tr> | ||
<td colspan="2"> | <td colspan="2"> | ||
----</td> | ----</td> | ||
+ | </tr> | ||
+ | </table> <!-- END Step 1 table --> | ||
+ | </td> | ||
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
− | <td>[[file: | + | <td> </td> |
− | + | <td>[[file:DotPoint2.JPG|link=]] <span style="font-size: 17px; font-weight: 700;">Indent the Popup Message Rule:</span><br> | |
− | With the '''Message Popup Rule''' highlighted | + | <table> <!-- BEGIN Step 2 table --> |
+ | <tr valign="top"> | ||
+ | <td>The '''Message Popup Rule''' has to be ''indented'' so that it becomes a ''Child'' of the '''Trigger Check Rule''' and is controlled by that rule.<br> | ||
+ | [[file:SessionRuleIndent.JPG|link=]]<br> | ||
+ | With the '''Message Popup Rule''' highlighted:- | ||
*Click the '''''Indent''''' (''right arrow'') button. | *Click the '''''Indent''''' (''right arrow'') button. | ||
− | This should indent the '''Message Popup''' rule one level inwards (shown below).</td> | + | This should indent the '''Message Popup''' rule one level inwards (as shown below). |
+ | </td> | ||
+ | </tr> | ||
+ | <tr valign="top"> | ||
+ | <td>[[file:SessionRuleIndented.JPG|link=]]</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td><br> | ||
+ | This '''Message Popup Rule''' is now a '''Child Rule''' of the '''Trigger Check Rule''' and will only be executed ''after'' the track trigger has been activated by a train.</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
Line 344: | Line 362: | ||
----</td> | ----</td> | ||
</tr> | </tr> | ||
− | </table> | + | </table> <!-- END Step 2 table --> |
</td> | </td> | ||
</tr> | </tr> | ||
− | <tr> | + | </table> <!-- END Steps Table --> |
− | <td>[[file: | + | <table width="100%"> <!-- BEGIN Back-To-Top Table --> |
− | </td> | + | <tr valign="top"> |
+ | <td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td> | ||
</tr> | </tr> | ||
− | </table> | + | </table> <!-- END Back-To-Top Table --> |
− | < | + | |
==Configuring the Message== | ==Configuring the Message== |
Revision as of 14:45, 13 February 2020
The information in this Wiki Page applies to TANE, TRS19 and Trainz Plus.
Contents |
What are Track Triggers?
Track triggers are track markers that are invisible in Driver Mode but visible in Surveyor Mode. They are used to activate Session Rules and some Driver Commands |
Track triggers can be programmed to respond when a train (any train or a specific train) passes over them in Driver Mode. The response comes from executing a set of Session Rules that have been attached to a Trigger Check Rule (or a similar rule) or a Driver Command that is monitoring the track trigger.
Shown at left is a Track Trigger placed on a track in Surveyor Mode. It is NOT visible in Driver Mode. The "5.00m" shown below the trigger name is the trigger detection radius |
Route or Session?
Track Triggers can be placed in a Route layer or in a Session layer |
Notes:
|
Information on Route and Session layers can be found at:- |
Adding a Track Trigger
|
Configuring a Track Trigger
As soon as a new track trigger has been placed, its properties window will open on the screen. It will be given a default name and assigned to the currently active layer.
|
|||||||||
Steps |
Name the Trigger:
|
||||||||
(Optional) Set the Trigger Detection Radius:
|
Creating a Track Trigger Event
Track trigger events are handled by the Trigger Check Rule (or a similar rule) which is added to a Session in the Session Editor.
More information on the Trigger Check Rule can be found on the Trainz Wiki Rules Page at:- |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
Steps |
Open the Session Editor:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Add the Trigger Check Rule:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
Open the Trigger Check Rule Properties:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
Configure the Rule:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
Select the Trigger:
Adding an Instruction to the Trigger EventTo test your trigger event you will need to add at least one rule. Adding a Child Rule
Configuring the Message
Another example of using the Trigger Check Rule can be found in the Trainz Wiki Page How to Use Message Popup Rule (Applications).
Alternatives to the Trigger Check Rule
Related Links
Trainz Wiki
This page was created by Trainz user pware in May 2018 and was last updated as shown below. |