View source for How to Use Track Triggers

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

__TOC__
='''What are Track Triggers?'''=
<table cellpadding="4" bgcolor=#c1e7e7>
<tr>
<td>[[file:DotPoint.JPG|link=]]</td>
<td>'''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'''</td>
</tr>
</table>

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 [[file:WikiLink.PNG|link=]] '''[[Session_Rule_List_with_Parameters#Trigger_Check_Rule|Trigger Check Rule]]''' (or a similar rule) or a '''Driver Command''' that is monitoring the track trigger. 

<table>
<tr valign="top">
<td>[[file:TrackTrigger.JPG|link=]]</td>
<td><br>
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
</tr>
</table>
<br>

='''Route or Session?'''=

<table cellpadding="4" bgcolor=#c1e7e7>
<tr valign="top">
<td>[[file:DotPoint.JPG|link=]]</td>
<td>'''Track Triggers can be placed in a Route layer or in a Session layer'''</td>
</tr>
</table>
<br>
<table cellpadding="4" bgcolor=#ffffb0>
<tr valign="top">
<td>[[file:NotePad.PNG|link=]]</td>
<td><span style="font-size: 17px; font-weight: 700;">Notes:'''</span><br>
*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.
*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>
<br>
<table cellpadding="4" bgcolor="Aquamarine">
<tr valign="top">
<td>[[file:LinkWiki.PNG|link=]]</td>
<td>Information on Route and Session layers can be found at:-<br>
* '''[[How to Use Layers]]'''
</td>
</tr>
</table>
<br>
<table width="100%">
<tr valign="top">
<td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
</tr>
</table>
<br>

='''Adding a Track Trigger'''=

<table>
<tr valign="top">
<td>[[file:TrackTriggerMode.JPG|link=]]</td>
<td><br>
<table cellpadding="4" bgcolor=#ffffff>
<tr>
<td colspan="2">
----</td>
</tr>
<tr valign="top">
<td>[[file:Steps.PNG|link=]]</td>
<td><span style="font-size: 17px;">'''Steps:'''</span><br>
A '''Track Trigger''' is placed on the track by:-
#clicking the '''Track''' tool,
#clicking the '''Trackmark Mode''' button,
#selecting the '''Trigger''' object from the list of installed objects,
#clicking the '''Add Object''' button,
#clicking the track position where the track trigger is to be placed.</td>
</tr>
<tr>
<td colspan="2">
----</td>
</tr>
</table></td>
</tr>
</table>
<br>
<table width="100%">
<tr valign="top">
<td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
</tr>
</table>

='''Configuring a Track Trigger'''=

As soon as a new track trigger has been placed, its properties window (shown below) will open on the screen. It will be given a default name and assigned to the currently active layer.

<table>
<tr valign="top">
<td>[[file:TrackTriggerProperties.JPG|link=]]</td>
<td>
<table cellpadding="4" bgcolor=#ffffff>
<tr>
<td colspan="2">
----</td>
</tr>
<tr valign="top">
<td>[[file:Steps.PNG|link=]]</td>
<td><span style="font-size: 17px;">'''Steps:'''</span><br>
*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>
<td colspan="2">
----</td>
</tr>
</table></td>
</tr>
</table>

Track triggers have a "detection radius" that controls how close a train has to approach to trigger the event. 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).

<table>
<tr valign="top">
<td>[[file:TrackTriggerRadius.JPG|link=]]</td>
<td><br>
<table cellpadding="4" bgcolor=#ffffff>
<tr>
<td colspan="2">
----</td>
</tr>
<tr valign="top">
<td>[[file:Steps.PNG|link=]]</td>
<td><span style="font-size: 17px;">'''Steps:'''</span><br>
#Click the '''Advanced Tab''' to open its properties. 
#Enter a new radius value in metres.
#Click the '''Set Trigger Radius''' button
#Click on the track trigger to assign its new radius.
</td>
</tr>
<tr>
<td colspan="2">
----</td>
</tr>
</table>
<br>
<table cellpadding="4" bgcolor=#ffffb0>
<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></td>
</tr>
</table>
<br>
<table width="100%">
<tr valign="top">
<td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
</tr>
</table>

='''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>

<table cellpadding="4" bgcolor="Aquamarine">
<tr valign="top">
<td>[[file:LinkWiki.PNG|link=]]</td>
<td>
More information on the '''Trigger Check 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>
</table>
<br>
<table>
<tr valign="top">
<td valign="top">[[file:EditSessionMenu.JPG|link=]]</td>
<td>[[file:SessionEditMenuSP1.png|link=]]<br>
<table cellpadding="4" bgcolor=#ffffff>
<tr>
<td colspan="2">
----</td>
</tr>
<tr valign="top">
<td>[[file:Steps.PNG|link=]]</td>
<td><span style="font-size: 17px;">'''Steps:'''</span><br>
To add the '''Trigger Check Rule''' to a session:-
#Open the '''Surveyor Main Menu''' in '''TANE''' and '''TRS19''' (shown left) or the '''Surveyor Edit Menu''' in '''TRS19 SP1''' and '''Trainz Plus''' (shown above).
#Select the option '''Edit Session''' from the drop down menu list.</td>
</tr>
<tr>
<td colspan="2">
----</td>
</tr>
</table></td>
</tr>
</table>
<table>
<tr valign="top">
<td rowspan="2">[[file:EditSessionWindowX.JPG|link=]]</td>
<td><br>
<table cellpadding="4" bgcolor=#ffffff>
<tr>
<td colspan="2">
----</td>
</tr>
<tr valign="top">
<td>[[file:Steps.PNG|link=]]</td>
<td><span style="font-size: 17px;">'''Steps:'''</span><br>
In the Edit Session window (shown left):-
*Click the '''Add''' button
In the Rule Selection window (shown below):-
#Scroll down the list to select the '''Trigger Check''' rule
#Click on the [[file:Tick.PNG|link=]] icon</td>
</tr>
<tr>
<td colspan="2">
----</td>
</tr>
</table></td>
</tr>
<tr valign="top">
<td>[[file:RuleSelect.JPG|link=]]</td>
</tr>
</table>
<br>
This will add the '''Trigger Check''' rule to the session.
<table>
<tr valign="top">
<td>[[file:TriggerCheck.JPG|link=]]</td>
<td><br>
<table cellpadding="4" bgcolor=#ffffff>
<tr>
<td colspan="2">
----</td>
</tr>
<tr valign="top">
<td>[[file:Steps.PNG|link=]]</td>
<td><span style="font-size: 17px;">'''Steps:'''</span><br>
With the '''Trigger Check''' rule highlighted (shown left):-
*Click the '''Edit''' button. This will open its properties window.</td>
</tr>
<tr>
<td colspan="2">
----</td>
</tr>
</table></td>
</tr>
</table>
<br>
For this example we will leave all settings unchanged and simply identify the track trigger to be used. 
<table>
<tr valign="top">
<td rowspan="2" width="640">[[file:TriggerCheckProperties.JPG|link=]]<br>
<br>
Once the trigger has been identified, click on the [[file:Tick.PNG|link=]] icon in the '''Trigger Check''' properties window (shown above) to accept the change.</td>
<td><br>
<table cellpadding="4" bgcolor=#ffffff>
<tr>
<td colspan="2">
----</td>
</tr>
<tr valign="top">
<td>[[file:Steps.PNG|link=]]</td>
<td><span style="font-size: 17px;">'''Steps:'''</span><br>
In the Trigger Properties window (shown left):-
*Click the '''''<span style="text-decoration: underline;">Add trigger</span>''''' link
In the Trigger Selection window (shown below):-
#Select the trigger you have just added
#Click on the [[file:Tick.PNG|link=]] icon on the selection list</td>
</tr>
<tr>
<td colspan="2">
----</td>
</tr>
</table></td>
</tr>
<tr valign="top">
<td>[[file:TriggerList.JPG|link=]]
</td>
</tr>
</table>
<br>
<table width="100%">
<tr valign="top">
<td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
</tr>
</table>

='''Adding an Instruction to the Trigger Event'''=
To test your trigger event you will need to add at least one rule.<br><br>

==Adding a Child Rule==

<table>
<tr valign="top">
<td rowspan="2">[[file:TriggerAddMesPopup.JPG|link=]]</td>
<td>
<table cellpadding="4" bgcolor=#ffffff>
<tr>
<td colspan="2">
----</td>
</tr>
<tr valign="top">
<td>[[file:Steps.PNG|link=]]</td>
<td><span style="font-size: 17px;">'''Steps:'''</span><br>
When you are back in the '''Session Editor''' window:-
#Click the '''Add''' button to add a 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>
<td colspan="2">
----</td>
</tr>
</table></td>
</tr>
</table>
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.<br>

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>
<table>
<tr valign="top">
<td rowspan="2" width="640">[[file:SessionRuleIndent.JPG|link=]]
<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>
<td>
<table cellpadding="4" bgcolor=#ffffff>
<tr>
<td colspan="2">
----</td>
</tr>
<tr valign="top">
<td>[[file:Steps.PNG|link=]]</td>
<td><span style="font-size: 17px;">'''Steps:'''</span><br>
With the '''Message Popup Rule''' highlighted (shown left):-
*Click the '''''Indent''''' (''right arrow'') button.
This should indent the '''Message Popup''' rule one level inwards (shown below).</td>
</tr>
<tr>
<td colspan="2">
----</td>
</tr>
</table>
</td>
</tr>
<tr>
<td>[[file:SessionRuleIndented.JPG|link=]]
</td>
</tr>
</table>
<br>

==Configuring the Message==

<table cellpadding="4" bgcolor=#ffffff>
<tr valign="top">
<td>[[file:Steps.PNG|link=]]</td>
<td><span style="font-size: 17px;">'''Steps:'''</span><br>
With the '''Message Popup Rule''' highlighted and indented (as shown above):-
*Click the '''Edit''' button. The '''Message Popup Rule''' properties window will appear (shown below).</td>
</tr>
<tr>
<td colspan="2">
----</td>
</tr>
</table>

<table>
<tr valign="top">
<td width="640">[[file:MessagePopupText.JPG|link=]]<br><br>
The finished '''Message Popup'''.<br>
[[file:MessagePopupStop.JPG|link=]]
</td>
<td>
<table cellpadding="4" bgcolor=#ffffff>
<tr>
<td colspan="2">
----</td>
</tr>
<tr valign="top">
<td>[[file:Steps.PNG|link=]]</td>
<td><span style="font-size: 17px;">'''Steps:'''</span><br>
Set the properties as shown:-
#Check '''ON''' ''Close previous message popup windows''
#Select '''Option Button''' ''Custom text''
#Enter a short text message (you are limited to about 6 lines of text)
To add an icon to the message:-
*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>
</tr>
<tr>
<td colspan="2">
----</td>
</tr>
</table>
[[file:IconStop.JPG|link=]]
</td>
</tr>
</table>
<br>
<table cellpadding="4" bgcolor="Aquamarine">
<tr valign="top">
<td>[[file:LinkWiki.PNG|link=]]</td>
<td>
More information on this rule can be found on the '''Trainz Wiki Page''' at:-<br>
* '''[[How to Use Message Popup Rule]]'''<br>
</td>
</tr>
</table>
<br>
<table cellpadding="4" bgcolor=#ffffff>
<tr>
<td colspan="2">
----</td>
</tr>
<tr valign="top">
<td>[[file:Steps.PNG|link=]]</td>
<td><span style="font-size: 17px;">'''Steps:'''</span><br>
*Again, click on the [[file:Tick.PNG|link=]] icon to exit the '''Message Popup Rule''' then 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>
</tr>
<tr>
<td colspan="2">
----</td>
</tr>
</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)]]'''.
<br>
<table width="100%">
<tr valign="top">
<td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
</tr>
</table>

='''Alternatives to the Trigger Check Rule'''=

<table cellpadding="4" bgcolor=#ffffff>
<tr valign="top">
<td width="50">[[file:RulesWiki.PNG|link=]]</td>
<td width="640">
There are other '''rules''' that can be used in place of the '''Trigger Check Rule''' and triggers. A few possibilities are listed below:-</td>
</tr>
</table>

*'''[[Session_Rule_List_with_Parameters#Directional_Trigger_Check_Rule|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''' [[file:WikiLink.PNG|link=]] '''[[How to Control Signals in Sessions|Controlling Signals in Sessions]]'''.
*'''[[Session_Rule_List_with_Parameters#Trackside_Check_Rule|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.
*'''[[Session_Rule_List_with_Parameters#Multiple Resource Check Rule|Multiple Resource Check Rule]]''' - monitors and acts on changes in multiple industry or multiple wagon resource (commodity) levels.
*'''[[Session_Rule_List_with_Parameters#Resource Verify Rule (fixed)|Resource Verify Rule]]''' - monitors and acts on changes in a single industry or wagon resource (commodity) level.
*'''[[Session_Rule_List_with_Parameters#Timecheck Rule|Timecheck Rule]]''' - triggers an event at a set time.<br>
<br>
<table cellpadding="4" bgcolor=#ffffff>
<tr valign="top">
<td width="50">[[file:CommandsWiki.png|link=]]</td>
<td width="640">
There is a '''driver command''' that can be used in place of the '''Trigger Check Rule'''.</td>
</tr>
</table>

*'''[[Driver_Commands_List#WaitForTrigger|Wait For Trigger]]''' - forces an AI controlled train to wait until a specified trigger has been activated by another train.
<br>

='''Related Links'''=

<table cellpadding="4" bgcolor=#ffffff>
<tr valign="top">
<td>[[file:LinkWiki.PNG|link=]]</td>
<td>
* '''[[How to Use Track Direction Markers]]'''
* '''[[How to Use Track Markers]]'''
* '''[[How to Use Track Priority Markers]]'''
</td>
</tr>
</table>
<br>
<table width="100%">
<tr valign="top">
<td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
</tr>
</table>
----
----

='''Trainz Wiki'''=
<table cellpadding="4" bgcolor=#ffffff>
<tr valign="top">
<td>[[file: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>
----
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]]