How to Use Track Triggers
(Updated for latest Surveyor 2.0 and to latest page formatting) |
m |
||
Line 1: | Line 1: | ||
The information in this Wiki Page applies to '''TANE''', '''TRS19''', '''Trainz Plus''' and '''TRS22'''. | The information in this Wiki Page applies to '''TANE''', '''TRS19''', '''Trainz Plus''' and '''TRS22'''. | ||
+ | <table width=1000> <!-- BEGIN Nav Buttons Table NO SKIPS --> | ||
+ | <tr valign="top"> | ||
+ | <td width=629> </td> | ||
+ | <td width=50> </td> <!-- Skip Down --> | ||
+ | <td width=50> </td> <!-- Skip Up --> | ||
+ | <td width=46> </td> | ||
+ | <td width=75> </td> | ||
+ | <td width=75>[[image:NextDown.png|link=#stepWhat|alt=Next Down|Next Down]]</td> | ||
+ | <td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td> | ||
+ | </tr> | ||
+ | </table> <!-- END Nav Buttons Table --> | ||
<table width=1000> | <table width=1000> | ||
<tr valign="top"> | <tr valign="top"> | ||
Line 13: | Line 24: | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[image:BlueDot10x10.png|link=]]</td> | <td>[[image:BlueDot10x10.png|link=]]</td> | ||
− | <td>They are used to activate '''Session Rules''' and | + | <td>They are used to activate some '''Session Rules''' and '''Driver Commands'''</td> |
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
Line 24: | Line 35: | ||
</table> | </table> | ||
<br> | <br> | ||
− | <table width=1000> <!-- BEGIN Nav Buttons Table --> | + | <table width=1000> <!-- BEGIN Nav Buttons Table NO SKIPS --> |
<tr valign="top"> | <tr valign="top"> | ||
− | <td width= | + | <td width=629><span id="stepWhat"></span> |
+ | ='''What are Track Triggers?'''= | ||
+ | </td> | ||
+ | <td width=50> </td> <!-- Skip Down --> | ||
+ | <td width=50> </td> <!-- Skip Up --> | ||
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td> | <td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td> | ||
− | <td width=75>& | + | <td width=75> </td> |
<td width=75>[[image:NextDown.png|link=#stepRoute|alt=Next Down|Next Down]]</td> | <td width=75>[[image:NextDown.png|link=#stepRoute|alt=Next Down|Next Down]]</td> | ||
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td> | <td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td> | ||
</tr> | </tr> | ||
</table> <!-- END Nav Buttons Table --> | </table> <!-- END Nav Buttons Table --> | ||
− | |||
<table width=1000> | <table width=1000> | ||
Line 78: | Line 92: | ||
</table> | </table> | ||
<br> | <br> | ||
− | <table width=1000> <!-- BEGIN Nav Buttons Table --> | + | <table width=1000> <!-- BEGIN Nav Buttons Table NO SKIPS --> |
<tr valign="top"> | <tr valign="top"> | ||
− | <td width= | + | <td width=629><span id="stepRoute"></span> |
+ | ='''Route or Session?'''= | ||
+ | </td> | ||
+ | <td width=50> </td> <!-- Skip Down --> | ||
+ | <td width=50> </td> <!-- Skip Up --> | ||
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td> | <td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td> | ||
− | <td width=75>[[image:NextUp.png|link=#stepWhat|alt=Next Up| | + | <td width=75>[[image:NextUp.png|link=#stepWhat|alt=Next Up|Next Up]]</td> |
<td width=75>[[image:NextDown.png|link=#stepAdding|alt=Next Down|Next Down]]</td> | <td width=75>[[image:NextDown.png|link=#stepAdding|alt=Next Down|Next Down]]</td> | ||
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td> | <td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td> | ||
</tr> | </tr> | ||
</table> <!-- END Nav Buttons Table --> | </table> <!-- END Nav Buttons Table --> | ||
− | |||
<table width=1000 bgcolor="lightcyan" cellpadding=2> | <table width=1000 bgcolor="lightcyan" cellpadding=2> | ||
Line 128: | Line 145: | ||
</table> | </table> | ||
<br> | <br> | ||
− | <table width=1000> <!-- BEGIN Nav Buttons Table --> | + | <table width=1000> <!-- BEGIN Nav Buttons Table SECTION w SKIPS --> |
<tr valign="top"> | <tr valign="top"> | ||
− | <td width= | + | <td width=629><span id="stepAdding"></span> |
+ | ='''Adding a Track Trigger'''= | ||
+ | </td> | ||
+ | <td width=50>[[image:SkipDown.png|link=#skipAddS10|Skip Down]]</td> | ||
+ | <td width=50> </td> | ||
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td> | <td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td> | ||
− | <td width=75>[[image:NextUp.png|link=#stepRoute|alt=Next Up| | + | <td width=75>[[image:NextUp.png|link=#stepRoute|alt=Next Up|Next Up]]</td> |
<td width=75>[[image:NextDown.png|link=#stepCreating|alt=Next Down|Next Down]]</td> | <td width=75>[[image:NextDown.png|link=#stepCreating|alt=Next Down|Next Down]]</td> | ||
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td> | <td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td> | ||
</tr> | </tr> | ||
</table> <!-- END Nav Buttons Table --> | </table> <!-- END Nav Buttons Table --> | ||
− | |||
− | |||
<table bgcolor=#000000 width=900> | <table bgcolor=#000000 width=900> | ||
Line 170: | Line 189: | ||
</table> | </table> | ||
<br> | <br> | ||
− | + | <table width=1000> <!-- BEGIN Nav Buttons Table SKIPS NO SECTIONS --> | |
+ | <tr valign="top"> | ||
+ | <td width=629><span id="skipAddS10"></span> | ||
=='''In Surveyor Classic (S10)'''== | =='''In Surveyor Classic (S10)'''== | ||
+ | </td> | ||
+ | <td width=50>[[image:SkipDown.png|link=#skipAddS20|Skip Down]]</td> <!-- skip Down --> | ||
+ | <td width=50>[[image:SkipUp.png|link=#stepAdding|Skip Up]]</td> <!-- skip Up --> | ||
+ | <td width=46> </td> | ||
+ | <td width=75> </td> | ||
+ | <td width=75> </td> | ||
+ | <td width=75> </td> | ||
+ | </tr> | ||
+ | </table> <!-- END Nav Buttons Table --> | ||
===Adding a Track Trigger (S10)=== | ===Adding a Track Trigger (S10)=== | ||
Line 380: | Line 410: | ||
</table> | </table> | ||
<br> | <br> | ||
+ | <table width=1000> <!-- BEGIN Nav Buttons Table SKIPS NO SECTIONS --> | ||
+ | <tr valign="top"> | ||
+ | <td width=629><span id="skipAddS20"></span> | ||
=='''In Surveyor 2.0 (S20)'''== | =='''In Surveyor 2.0 (S20)'''== | ||
+ | </td> | ||
+ | <td width=50>[[image:SkipDown.png|link=#stepCreating|Skip Down]]</td> <!-- skip Down --> | ||
+ | <td width=50>[[image:SkipUp.png|link=#skipAddS10|Skip Up]]</td> <!-- skip Up --> | ||
+ | <td width=46> </td> | ||
+ | <td width=75> </td> | ||
+ | <td width=75> </td> | ||
+ | <td width=75> </td> | ||
+ | </tr> | ||
+ | </table> <!-- END Nav Buttons Table --> | ||
'''Surveyor 2.0''' is currently only available for '''Trainz Plus''' and '''TRS22 Platinum'''.<br> | '''Surveyor 2.0''' is currently only available for '''Trainz Plus''' and '''TRS22 Platinum'''.<br> | ||
Line 964: | Line 1,006: | ||
</table> | </table> | ||
<br> | <br> | ||
− | <table width=1000> <!-- BEGIN Nav Buttons Table --> | + | <table width=1000> <!-- BEGIN Nav Buttons Table SECTION w SKIPS --> |
<tr valign="top"> | <tr valign="top"> | ||
− | <td width= | + | <td width=629><span id="stepCreating"></span> |
+ | ='''Creating a Track Trigger Event'''= | ||
+ | </td> | ||
+ | <td width=50> </td> | ||
+ | <td width=50>[[image:SkipUp.png|link=#skipAddS20|Skip Up]]</td> | ||
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td> | <td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td> | ||
− | <td width=75>[[image:NextUp.png|link=#stepAdding|alt=Next Up| | + | <td width=75>[[image:NextUp.png|link=#stepAdding|alt=Next Up|Next Up]]</td> |
<td width=75>[[image:NextDown.png|link=#stepEvent|alt=Next Down|Next Down]]</td> | <td width=75>[[image:NextDown.png|link=#stepEvent|alt=Next Down|Next Down]]</td> | ||
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td> | <td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td> | ||
</tr> | </tr> | ||
</table> <!-- END Nav Buttons Table --> | </table> <!-- END Nav Buttons Table --> | ||
− | |||
<table width=1000> | <table width=1000> | ||
Line 1,149: | Line 1,194: | ||
<table width=1000> <!-- BEGIN Nav Buttons Table --> | <table width=1000> <!-- BEGIN Nav Buttons Table --> | ||
<tr valign="top"> | <tr valign="top"> | ||
− | <td width= | + | <td width=629><span id="stepEvent"></span> |
+ | ='''Adding an Instruction to the Trigger Event'''= | ||
+ | </td> | ||
+ | <td width=50>[[image:SkipDown.png|link=#skipConfigure|Skip Down]]</td> | ||
+ | <td width=50> </td> <!-- Skip Up --> | ||
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td> | <td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td> | ||
<td width=75>[[image:NextUp.png|link=#stepCreating|alt=Next Up|Top]]</td> | <td width=75>[[image:NextUp.png|link=#stepCreating|alt=Next Up|Top]]</td> | ||
Line 1,156: | Line 1,205: | ||
</tr> | </tr> | ||
</table> <!-- END Nav Buttons Table --> | </table> <!-- END Nav Buttons Table --> | ||
− | |||
− | |||
=='''Adding a Child Rule'''== | =='''Adding a Child Rule'''== | ||
+ | |||
+ | To test your trigger event you will need to add some Session Rules. | ||
<table width=1000 cellpadding=2> | <table width=1000 cellpadding=2> | ||
Line 1,230: | Line 1,279: | ||
</table> | </table> | ||
<br> | <br> | ||
+ | <table width=1000> <!-- BEGIN Nav Buttons Table SKIPS NO SECTIONS --> | ||
+ | <tr valign="top"> | ||
+ | <td width=629><span id="skipConfigure"></span> | ||
=='''Configuring the Message and Testing'''== | =='''Configuring the Message and Testing'''== | ||
+ | </td> | ||
+ | <td width=50>[[image:SkipDown.png|link=#stepAlternatives|Skip Down]]</td> <!-- skip Down --> | ||
+ | <td width=50>[[image:SkipUp.png|link=#stepEvent|Skip Up]]</td> <!-- skip Up --> | ||
+ | <td width=46> </td> | ||
+ | <td width=75> </td> | ||
+ | <td width=75> </td> | ||
+ | <td width=75> </td> | ||
+ | </tr> | ||
+ | </table> <!-- END Nav Buttons Table --> | ||
<table width=1000 cellpadding=2> | <table width=1000 cellpadding=2> | ||
Line 1,355: | Line 1,416: | ||
<table width=1000> | <table width=1000> | ||
<tr valign="top"> | <tr valign="top"> | ||
− | <td>[[image:DotPoint5.JPG|link=]]& | + | <td>[[image:DotPoint5.JPG|link=]] <span style="font-size: 17px; font-weight: 700;">Test the Trigger:</span><br> |
<table> <!-- BEGIN Step 4 table --> | <table> <!-- BEGIN Step 4 table --> | ||
<tr valign="top"> | <tr valign="top"> | ||
Line 1,380: | Line 1,441: | ||
<table width=1000> <!-- BEGIN Nav Buttons Table --> | <table width=1000> <!-- BEGIN Nav Buttons Table --> | ||
<tr valign="top"> | <tr valign="top"> | ||
− | <td width= | + | <td width=629><span id="stepAlternatives"></span> |
+ | ='''Alternatives to the Trigger Check Rule'''= | ||
+ | </td> | ||
+ | <td width=50> </td> | ||
+ | <td width=50>[[image:SkipUp.png|link=#skipConfigure|Skip Up]]</td> | ||
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td> | <td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td> | ||
<td width=75>[[image:NextUp.png|link=#stepEvent|alt=Next Up|Top]]</td> | <td width=75>[[image:NextUp.png|link=#stepEvent|alt=Next Up|Top]]</td> | ||
− | <td width=75>& | + | <td width=75> </td> |
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td> | <td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td> | ||
</tr> | </tr> | ||
</table> <!-- END Nav Buttons Table --> | </table> <!-- END Nav Buttons Table --> | ||
− | |||
− | |||
<table cellpadding=2 bgcolor=#ffffff> | <table cellpadding=2 bgcolor=#ffffff> | ||
Line 1,455: | Line 1,518: | ||
<table width=1000> <!-- BEGIN Nav Buttons Table --> | <table width=1000> <!-- BEGIN Nav Buttons Table --> | ||
<tr valign="top"> | <tr valign="top"> | ||
− | <td width=729><span id="bottom"></span>& | + | <td width=729><span id="bottom"></span> </td> |
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td> | <td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td> | ||
<td width=75>[[image:NextUp.png|link=#stepEvent|alt=Next Up|Top]]</td> | <td width=75>[[image:NextUp.png|link=#stepEvent|alt=Next Up|Top]]</td> | ||
− | <td width=75>& | + | <td width=75> </td> |
− | <td width=75>& | + | <td width=75> </td> |
</tr> | </tr> | ||
</table> <!-- END Nav Buttons Table --> | </table> <!-- END Nav Buttons Table --> |
Revision as of 19:58, 29 September 2023
The information in this Wiki Page applies to TANE, TRS19, Trainz Plus and TRS22.
|
|
What are Track Triggers? |
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 below left is a standard Track Trigger and below right is a Directional Track Trigger. They are just two examples of several types of track triggers. In both cases:-
|
||||||||
|
Route or Session? |
Track Triggers can be placed in a Route Layer or in a Session Layer |
|
Information on Route and Session layers can be found at:- |
Adding a Track Trigger |
|
In Surveyor Classic (S10) |
Adding a Track Trigger (S10)
|
As soon as a new track trigger has been placed, its properties window will open on the screen. It will initially be given a default name and assigned to the currently active layer. |
Set the Trigger Name and Layer (S10)
|
Set the Effect Radius (S10)
At the bottom of the Track Tools flyout menu is an Advanced button. Left Click this button to open the advanced tools.
The Effect Radius sets the size of green "effect wings" attached both ends of the marker. This sets how close a consist has to approach the marker to trigger its "event". The smaller the radius the closer it must approach. |
|
|
In Surveyor 2.0 (S20) |
Surveyor 2.0 is currently only available for Trainz Plus and TRS22 Platinum.
Adding a Track Trigger (S20)
In the Asset Palette either:-
|
OR |
|
|
|
To narrow down the filter list, type "trig" (UPPER/lower case does not matter) in the Search Text Box
This will list all the Track Objects containing the text "trig" in the filter list.
|
Place the Track Trigger on the track.
|
|
|
Change Its Name (S20)
The name of the marker is only useful for finding it in the route. It is not used for any operational purpose.
|
Set its Effect Radius (S20)
The Effect Radius sets the size of green "effect wings" attached both ends of the marker. This sets how close a consist has to approach the marker to trigger its "event". The smaller the radius the closer it must approach. |
|
Move a Track Trigger Along the Track (S20)
Priority Marks can be moved along the track or to other tracks.
|
Move the Track Trigger Vertically (S20)
Track Triggers can be physically placed above (or below) the track. This feature allows them to be placed, for example, above the track so that they will not be hidden in Surveyor if a consist is parked on a marker. |
|
Move the Track Trigger Horizontally (S20)
Track Triggers can be physically placed left or right alongside the track. This feature allows them to be placed, for example, beside the track so that they will not be hidden in Surveyor if a consist is parked on a marker. |
|
|
Assign a Track Trigger to a New Layer (S20)
The Info Palette will show the layer assigned to the currently selected object. To the left of the layer name is a small arrowhead object. | |||||||||||||||||||||||
|
Creating a Track Trigger Event |
When a consist enters the Effect Radius of a Track Trigger it will create an "event" that can be detected and responded to by some Session Rules and some Driver Commands. One such rule is the Trigger Check 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: | ||||||||||
|
|
This will add the Trigger Check rule to the session. |
Open the Trigger Check Rule Properties:
|
Configure the Rule:
|
Select the Trigger: The Trigger Selection Window will open and list all the Track Triggers in your Route.
|
Adding an Instruction to the Trigger Event |
Adding a Child Rule
To test your trigger event you will need to add some Session Rules.
Steps: | ||||||||||||||
Add A Message Popup Rule:
|
Indent the Popup Message Rule:
|
Configuring the Message and Testing |
Steps: | |||||
Open the Message Popup Rule for Editing:
|
|
|
Left Click on the icon to exit the Message Popup Rule and return to the Session Editor |
The completed Message Popup Rule |
More information on this rule can be found on the Trainz Wiki Page at:- |
Test the Trigger:
|
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 |
There are other Session Rules that can be used in place of the Trigger Check Rule and triggers. A few possibilities are listed below:-
|
There is a driver command that can be used in place of the Trigger Check Rule:-
|
Related Links
Trainz Wiki
More Tutorials and Guides to Using Trainz |
This page was created by Trainz user pware in May 2018 and was last updated as shown below.