How to Use Track Triggers
(→Configuring the Message: reorganised) |
m |
||
(10 intermediate revisions by one user not shown) | |||
Line 1: | Line 1: | ||
− | The information in this Wiki Page applies to '''TANE''', '''TRS19''' | + | The information in this Wiki Page applies to '''TANE''', '''TRS19''', '''Trainz Plus''' and '''TRS22'''. |
__TOC__ | __TOC__ | ||
+ | <table> <!-- BEGIN Nav Buttons Table --> | ||
+ | <tr valign="top"> | ||
+ | <td width=729><span id="stepWhat"></span> </td> | ||
+ | <td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td> | ||
+ | <td width=75> </td> | ||
+ | <td width=75>[[file:NextDown.png|link=#stepRoute|alt=Next Down|Next Down]]</td> | ||
+ | <td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td> | ||
+ | </tr> | ||
+ | </table> <!-- END Nav Buttons Table --> | ||
='''What are Track Triggers?'''= | ='''What are Track Triggers?'''= | ||
− | <table cellpadding= | + | <table cellpadding=4 bgcolor=#c1e7e7> |
<tr> | <tr> | ||
<td>[[file:DotPoint.JPG|link=]]</td> | <td>[[file:DotPoint.JPG|link=]]</td> | ||
Line 20: | Line 29: | ||
</table> | </table> | ||
<br> | <br> | ||
− | + | <table> <!-- BEGIN Nav Buttons Table --> | |
+ | <tr valign="top"> | ||
+ | <td width=729><span id="stepRoute"></span> </td> | ||
+ | <td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td> | ||
+ | <td width=75>[[file:NextUp.png|link=#stepWhat|alt=Next Up|Top]]</td> | ||
+ | <td width=75>[[file:NextDown.png|link=#stepAdding|alt=Next Down|Next Down]]</td> | ||
+ | <td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td> | ||
+ | </tr> | ||
+ | </table> <!-- END Nav Buttons Table --> | ||
='''Route or Session?'''= | ='''Route or Session?'''= | ||
− | <table cellpadding= | + | <table cellpadding=4 bgcolor=#c1e7e7> |
<tr valign="top"> | <tr valign="top"> | ||
<td>[[file:DotPoint.JPG|link=]]</td> | <td>[[file:DotPoint.JPG|link=]]</td> | ||
Line 30: | Line 47: | ||
</table> | </table> | ||
<br> | <br> | ||
− | <table | + | <table bgcolor=#000000 width=900> |
+ | <tr valign="top"> | ||
+ | <td> | ||
+ | <table bgcolor=#ffffb0 width=896> | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[file:NotePad.PNG|link=]]</td> | <td>[[file:NotePad.PNG|link=]]</td> | ||
<td><span style="font-size: 17px; font-weight: 700;">Notes:'''</span><br> | <td><span style="font-size: 17px; font-weight: 700;">Notes:'''</span><br> | ||
− | + | ---- | |
− | + | <table cellpadding=4> | |
+ | <tr valign="top"> | ||
+ | <td>[[image:DotPoint.JPG|link=]]</td> | ||
+ | <td>Placing Track Triggers in a '''Route layer''' (e.g. in the same layer as the track) means that they will be available in '''all Sessions''' created using that particular Route.</td> | ||
+ | </tr> | ||
+ | <tr valign="top"> | ||
+ | <td>[[image:DotPoint.JPG|link=]]</td> | ||
+ | <td>Placing Track Triggers in a '''Session layer''' means that they will only be available in that Session. This can be useful if two or more Sessions are being created and you want to use different Track Triggers in each Session. | ||
+ | </td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | </td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | </td> | ||
</tr> | </tr> | ||
</table> | </table> | ||
<br> | <br> | ||
− | <table cellpadding= | + | <table cellpadding=4 bgcolor="Aquamarine"> |
<tr valign="top"> | <tr valign="top"> | ||
<td>[[file:LinkWiki.PNG|link=]]</td> | <td>[[file:LinkWiki.PNG|link=]]</td> | ||
Line 47: | Line 81: | ||
</tr> | </tr> | ||
</table> | </table> | ||
− | + | <br> | |
− | <table | + | <table> <!-- BEGIN Nav Buttons Table --> |
<tr valign="top"> | <tr valign="top"> | ||
− | <td | + | <td width=729><span id="stepAdding"></span> </td> |
+ | <td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td> | ||
+ | <td width=75>[[file:NextUp.png|link=#stepRoute|alt=Next Up|Top]]</td> | ||
+ | <td width=75>[[file:NextDown.png|link=#stepConfiguring|alt=Next Down|Next Down]]</td> | ||
+ | <td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td> | ||
</tr> | </tr> | ||
− | </table> | + | </table> <!-- END Nav Buttons Table --> |
='''Adding a Track Trigger'''= | ='''Adding a Track Trigger'''= | ||
Line 60: | Line 98: | ||
<td>[[file:TrackTriggerMode.JPG|link=]]</td> | <td>[[file:TrackTriggerMode.JPG|link=]]</td> | ||
<td><br> | <td><br> | ||
− | <table cellpadding= | + | <table cellpadding=4 bgcolor=#ffffff> |
<tr> | <tr> | ||
<td colspan="2"> | <td colspan="2"> | ||
Line 83: | Line 121: | ||
</table> | </table> | ||
<br> | <br> | ||
− | <table | + | <table> <!-- BEGIN Nav Buttons Table --> |
<tr valign="top"> | <tr valign="top"> | ||
− | <td | + | <td width=729><span id="stepConfiguring"></span> </td> |
+ | <td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td> | ||
+ | <td width=75>[[file:NextUp.png|link=#stepAdding|alt=Next Up|Top]]</td> | ||
+ | <td width=75>[[file:NextDown.png|link=#stepCreating|alt=Next Down|Next Down]]</td> | ||
+ | <td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td> | ||
</tr> | </tr> | ||
− | </table> | + | </table> <!-- END Nav Buttons Table --> |
− | + | ||
='''Configuring 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. | 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= | + | <table cellpadding=4 bgcolor=#ffffff> <!-- BEGIN Step table --> |
<tr> | <tr> | ||
<td colspan="2"> | <td colspan="2"> | ||
Line 134: | Line 175: | ||
#Click on the track trigger to assign its new radius | #Click on the track trigger to assign its new radius | ||
<br> | <br> | ||
− | <table | + | <table bgcolor=#000000 width=500> |
+ | <tr valign="top"> | ||
+ | <td> | ||
+ | <table bgcolor=#ffffe0 width=496> | ||
<tr valign="top"> | <tr valign="top"> | ||
<td>[[file:PencilTips.PNG|link=]]</td> | <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> | + | <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> | ||
+ | </td> | ||
</tr> | </tr> | ||
</table> <!-- END Step 2 Tip Table --> | </table> <!-- END Step 2 Tip Table --> | ||
Line 150: | Line 198: | ||
</tr> | </tr> | ||
</table> <!-- END Steps Table --> | </table> <!-- END Steps Table --> | ||
− | <table | + | <br> |
+ | <table> <!-- BEGIN Nav Buttons Table --> | ||
<tr valign="top"> | <tr valign="top"> | ||
− | <td | + | <td width=729><span id="stepCreating"></span> </td> |
+ | <td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td> | ||
+ | <td width=75>[[file:NextUp.png|link=#stepConfiguring|alt=Next Up|Top]]</td> | ||
+ | <td width=75>[[file:NextDown.png|link=#stepEvent|alt=Next Down|Next Down]]</td> | ||
+ | <td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td> | ||
</tr> | </tr> | ||
− | </table> | + | </table> <!-- END Nav Buttons Table --> |
− | + | ||
='''Creating a Track Trigger Event'''= | ='''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 [[file:WikiLink.PNG|link=]] '''[[How to Use Session Editor|Session Editor]]'''.<br> | Track trigger events are handled by the '''Trigger Check Rule''' (or a similar rule) which is added to a Session in the [[file:WikiLink.PNG|link=]] '''[[How to Use Session Editor|Session Editor]]'''.<br> | ||
− | <table cellpadding= | + | <table cellpadding=4 bgcolor="Aquamarine"> |
<tr valign="top"> | <tr valign="top"> | ||
<td>[[file:LinkWiki.PNG|link=]]</td> | <td>[[file:LinkWiki.PNG|link=]]</td> | ||
Line 170: | Line 222: | ||
</table> | </table> | ||
<br> | <br> | ||
− | <table cellpadding= | + | <table cellpadding=4 bgcolor=#ffffff> <!-- BEGIN Step table --> |
<tr> | <tr> | ||
<td colspan="2"> | <td colspan="2"> | ||
Line 183: | Line 235: | ||
<td colspan=2> | <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''' (shown below left) or the '''Surveyor Edit Menu''' in '''TRS19''' and '''Trainz | + | #Open the '''Surveyor Main Menu''' in '''TANE''' (shown below left) or the '''Surveyor Edit Menu''' in '''TRS19''' and later '''Trainz''' versions (shown below right) |
#Select the option '''Edit Session''' from the drop down menu list | #Select the option '''Edit Session''' from the drop down menu list | ||
</td> | </td> | ||
Line 262: | Line 314: | ||
<tr> | <tr> | ||
<td> | <td> | ||
− | <table cellpadding= | + | <table cellpadding=4 bgcolor="Aquamarine"> <!-- BEGIN Table 4 Wiki Table --> |
<tr valign="top"> | <tr valign="top"> | ||
<td>[[file:LinkWiki.PNG|link=]]</td> | <td>[[file:LinkWiki.PNG|link=]]</td> | ||
Line 300: | Line 352: | ||
</tr> | </tr> | ||
</table> <!-- END Step 5 table --> | </table> <!-- END Step 5 table --> | ||
− | <table | + | </td> |
+ | </tr> | ||
+ | </table> <!-- END Step Table --> | ||
+ | <br> | ||
+ | <table> <!-- BEGIN Nav Buttons Table --> | ||
<tr valign="top"> | <tr valign="top"> | ||
− | <td | + | <td width=729><span id="stepEvent"></span> </td> |
+ | <td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td> | ||
+ | <td width=75>[[file:NextUp.png|link=#stepCreating|alt=Next Up|Top]]</td> | ||
+ | <td width=75>[[file:NextDown.png|link=#stepAlternatives|alt=Next Down|Next Down]]</td> | ||
+ | <td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td> | ||
</tr> | </tr> | ||
− | </table> | + | </table> <!-- END Nav Buttons Table --> |
− | + | ||
='''Adding an Instruction to the Trigger Event'''= | ='''Adding an Instruction to the Trigger Event'''= | ||
− | To test your trigger event you will need to add at least one rule. | + | To test your trigger event you will need to add at least one rule. |
==Adding a Child Rule== | ==Adding a Child Rule== | ||
− | <table cellpadding= | + | <table cellpadding=4 bgcolor=#ffffff> <!-- BEGIN Step table --> |
<tr valign="top"> | <tr valign="top"> | ||
<td>[[file:Steps.PNG|link=]]<br><br> | <td>[[file:Steps.PNG|link=]]<br><br> | ||
Line 366: | Line 425: | ||
</tr> | </tr> | ||
</table> <!-- END Steps Table --> | </table> <!-- END Steps Table --> | ||
− | + | ==Configuring the Message and Testing== | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | ==Configuring the Message== | + | |
− | <table cellpadding= | + | <table cellpadding=4 bgcolor=#ffffff> <!-- BEGIN Step table --> |
<tr valign="top"> | <tr valign="top"> | ||
<td>[[file:Steps.PNG|link=]]<br><br> | <td>[[file:Steps.PNG|link=]]<br><br> | ||
Line 399: | Line 452: | ||
#Check '''ON''' ''Close previous message popup windows'' | #Check '''ON''' ''Close previous message popup windows'' | ||
#Select '''Option Button''' ''Custom text'' | #Select '''Option Button''' ''Custom text'' | ||
− | #Enter a short text message | + | #Enter a short text message |
</td> | </td> | ||
</tr> | </tr> | ||
Line 407: | Line 460: | ||
<tr> | <tr> | ||
<td> | <td> | ||
− | <table cellpadding= | + | <table cellpadding=4 bgcolor="Aquamarine"> <!-- BEGIN Step 2 Wikilink Table --> |
<tr valign="top"> | <tr valign="top"> | ||
<td>[[file:LinkWiki.PNG|link=]]</td> | <td>[[file:LinkWiki.PNG|link=]]</td> | ||
Line 415: | Line 468: | ||
</td> | </td> | ||
</tr> | </tr> | ||
− | </table> | + | </table> <!-- END Step 2 Wikilink Table --> |
</td> | </td> | ||
</tr> | </tr> | ||
Line 432: | Line 485: | ||
<td> | <td> | ||
*Click the link '''''<span style="text-decoration: underline;">click here to set</span>''''' (shown left) and either | *Click the link '''''<span style="text-decoration: underline;">click here to set</span>''''' (shown left) and either | ||
− | : | + | :*Scroll down the Texture Asset Selection List (shown below) to find a suitable icon, or |
− | : | + | :*Simply type "icon stop" in the text box to use one of the builtin icons. |
*Click on the [[file:Tick.PNG|link=]] icon</td> | *Click on the [[file:Tick.PNG|link=]] icon</td> | ||
</tr> | </tr> | ||
Line 440: | Line 493: | ||
</tr> | </tr> | ||
<tr valign="top"> | <tr valign="top"> | ||
− | <td>The completed Message Popup Rule<br> | + | <td> |
+ | *click on the [[file:Tick.PNG|link=]] icon to exit the '''Message Popup Rule''' and return to the '''Session Editor'''<br> | ||
+ | The completed Message Popup Rule<br> | ||
[[file:MessagePopupStop.JPG|link=]] | [[file:MessagePopupStop.JPG|link=]] | ||
<tr> | <tr> | ||
Line 451: | Line 506: | ||
<tr valign="top"> | <tr valign="top"> | ||
<td> </td> | <td> </td> | ||
− | <td>[[file: | + | <td>[[file:DotPoint4.JPG|link=]] <span style="font-size: 17px; font-weight: 700;">Test the Trigger:</span><br> |
− | <table> <!-- BEGIN Step | + | <table> <!-- BEGIN Step 4 table --> |
<tr valign="top"> | <tr valign="top"> | ||
<td> | <td> | ||
− | * | + | *Exit the '''Session Editor''' |
*Add a consist to your layout a short distance from the track trigger (but further away than its radius), save the Surveyor Session, and then test in '''Driver Mode'''</td> | *Add a consist to your layout a short distance from the track trigger (but further away than its radius), save the Surveyor Session, and then test in '''Driver Mode'''</td> | ||
</tr> | </tr> | ||
Line 462: | Line 517: | ||
----</td> | ----</td> | ||
</tr> | </tr> | ||
− | </table> <!-- END Step | + | </table> <!-- END Step 4 table --> |
Another example of using the '''Trigger Check Rule''' can be found in the '''Trainz Wiki Page''' [[file:WikiLink.PNG|link=]] '''[[How to Use Message Popup Rule (Applications)]]'''. | Another example of using the '''Trigger Check Rule''' can be found in the '''Trainz Wiki Page''' [[file:WikiLink.PNG|link=]] '''[[How to Use Message Popup Rule (Applications)]]'''. | ||
<br> | <br> | ||
Line 468: | Line 523: | ||
</tr> | </tr> | ||
</table> <!-- END Steps Table --> | </table> <!-- END Steps Table --> | ||
− | + | <br> | |
− | <table | + | <table> <!-- BEGIN Nav Buttons Table --> |
<tr valign="top"> | <tr valign="top"> | ||
− | <td | + | <td width=729><span id="stepAlternatives"></span> </td> |
+ | <td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td> | ||
+ | <td width=75>[[file:NextUp.png|link=#stepEvent|alt=Next Up|Top]]</td> | ||
+ | <td width=75> </td> | ||
+ | <td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td> | ||
</tr> | </tr> | ||
− | </table> | + | </table> <!-- END Nav Buttons Table --> |
='''Alternatives to the Trigger Check Rule'''= | ='''Alternatives to the Trigger Check Rule'''= | ||
− | <table cellpadding= | + | <table cellpadding=4 bgcolor=#ffffff> |
<tr valign="top"> | <tr valign="top"> | ||
<td width="50">[[file:RulesWiki.PNG|link=]]</td> | <td width="50">[[file:RulesWiki.PNG|link=]]</td> | ||
Line 492: | Line 551: | ||
*'''[[Session_Rule_List_with_Parameters#Timecheck Rule|Timecheck Rule]]''' - triggers an event at a set time.<br> | *'''[[Session_Rule_List_with_Parameters#Timecheck Rule|Timecheck Rule]]''' - triggers an event at a set time.<br> | ||
<br> | <br> | ||
− | <table cellpadding= | + | <table cellpadding=4 bgcolor=#ffffff> |
<tr valign="top"> | <tr valign="top"> | ||
<td width="50">[[file:CommandsWiki.png|link=]]</td> | <td width="50">[[file:CommandsWiki.png|link=]]</td> | ||
Line 505: | Line 564: | ||
='''Related Links'''= | ='''Related Links'''= | ||
− | <table cellpadding= | + | <table cellpadding=4 bgcolor=#ffffff> |
<tr valign="top"> | <tr valign="top"> | ||
<td>[[file:LinkWiki.PNG|link=]]</td> | <td>[[file:LinkWiki.PNG|link=]]</td> | ||
Line 516: | Line 575: | ||
</table> | </table> | ||
<br> | <br> | ||
− | <table | + | <table> <!-- BEGIN Nav Buttons Table --> |
<tr valign="top"> | <tr valign="top"> | ||
− | <td | + | <td width=729><span id="bottom"></span> </td> |
+ | <td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td> | ||
+ | <td width=75>[[file:NextUp.png|link=#stepAlternatives|alt=Next Up|Top]]</td> | ||
+ | <td width=75> </td> | ||
+ | <td width=75> </td> | ||
</tr> | </tr> | ||
− | </table> | + | </table> <!-- END Nav Buttons Table --> |
---- | ---- | ||
---- | ---- | ||
='''Trainz Wiki'''= | ='''Trainz Wiki'''= | ||
− | <table cellpadding= | + | <table cellpadding=4 bgcolor=#ffffff> |
<tr valign="top"> | <tr valign="top"> | ||
<td>[[file:TrainzWiki.png|link=]]</td> | <td>[[file:TrainzWiki.png|link=]]</td> |
Revision as of 09:33, 23 March 2022
The information in this Wiki Page applies to TANE, TRS19, Trainz Plus and TRS22.
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 |
|
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 Event
To test your trigger event you will need to add at least one rule.
Adding a Child Rule
Steps |
Add A Message Popup Rule:
|
|||||
Indent the Popup Message Rule:
|
Configuring the Message and Testing
Steps |
Open the Message Popup Rule for Editing:
|
|||||||
Configure the Message:
|
||||||||
(Optional) Add a Message Icon:
|
||||||||
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 rules that can be used in place of the Trigger Check Rule and triggers. A few possibilities are listed below:- |
- Directional Trigger Check Rule - identical to the Trigger Check Rule but adds the ability to test the train direction. Requires the use of a special Directional Trigger. For an example of its use see the Trainz Wiki Page Controlling Signals in Sessions.
- Trackside Check Rule - very similar to the Trigger Check Rule but provides some different options.
- Navigation Points (see the How to Guides link below) are more complex but provide more advanced controls and options.
- Multiple Resource Check Rule - monitors and acts on changes in multiple industry or multiple wagon resource (commodity) levels.
- Resource Verify Rule - monitors and acts on changes in a single industry or wagon resource (commodity) level.
- Timecheck Rule - triggers an event at a set time.
There is a driver command that can be used in place of the Trigger Check Rule. |
- Wait For Trigger - forces an AI controlled train to wait until a specified trigger has been activated by another train.
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.