Revision as of 16:12, 10 February 2023

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

1 What are Track Triggers?
2 Route or Session?
3 Adding a Track Trigger
- 3.1 In Surveyor Classic (S10)
- 3.2 In Surveyor 2.0 (S20)
4 Creating a Track Trigger Event
5 Adding an Instruction to the Trigger Event
- 5.1 Adding a Child Rule
- 5.2 Configuring the Message and Testing
6 Alternatives to the Trigger Check Rule
7 Related Links
8 Trainz Wiki

In Summary:
	Track Triggers are track markers that are invisible in Driver Mode but visible in Surveyor Mode
	Track triggers are used to activate Session Rules and some Driver Commands
	Track Triggers can be placed in a Route layer or in a Session layer

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 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:

	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.

Information on Route and Session layers can be found at:-

How to Use Layers

Adding a Track Trigger

Notes:

A Track Trigger has two important properties:-

its name which is needed for all commands and rules that use the Track Trigger, and
its Trigger Radius (the green "wings" shown in the image above with the radius value, in metres, shown below the trigger name). This controls how closely an AI train has to approach the trigger to activate it (smaller radius = closer to the trigger)

The direction that a Track Trigger is pointing has NO EFFECT on its operation

In Surveyor Classic (S10)

Steps:

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.

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:

	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 Using Layers for information on layers) To confirm the changes click on the icon on the bottom right of the window

(Optional) Set the Trigger Detection Radius:

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).

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

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.

In Surveyor 2.0 (S20)

Surveyor 2.0 is currently only available for Trainz Plus Standard and Trainz Plus Gold subscription members.

Adding a Track Trigger

In the Asset Palette either:-

Left click the Track Mesh Filter icon

Track mesh

OR

Left click the Content Drop-down Box

Filter List
Then select Track Objects

Notes:

If the Assets Palette is not shown on the screen, then:-

1.	open the Window Menu from the menu icons at the top of the screen
2.	Left click on the Assets Palette name
to add a tick and make it visible.

Shortcut If you already have a Track Trigger placed in your route then:-
	move the tool pointer over the existing track trigger object and hold down the Alt key. The object name will appear in a ToolTip attached to the pointer
	while holding down the Alt key Left click on the track trigger to identify it in the Assets Palette and to select the Placement Tool. Release the key.
Jump to Step below.

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.

Left click on the item name Trigger.

If you are not sure about an asset then double-click on the name to bring up its image and description.

Place the Track Trigger on the track.

Notes:

To delete a Track Trigger (or any asset):-

select either the:-
- Free Move Tool (or press S ) or
- Fine Adjustment Tool (or press D )
Left click on the Track Trigger
press the Delete key

If you need to rotate the Track Trigger to face the opposite direction then:-

Left click on its Context Tool (or press the T key if the asset has already been selected)
from the popup menu select Rotate Trackside

Note: the direction it faces has no effect on its operation.

Steps:

	Select the Placement Tool (or press the E key) from the Tools Palette
	Left click on the track at the position where you want to place the Track Trigger

The Track Trigger can be easily moved if needed - see below.

Tools and keymap for S20

Set the Track Trigger Properties

Change Its Name


	Steps: Left click on the Context Tool ( in the image on the left or press the T key if the asset has already been selected) to open up the object property and control menu Left click on the Edit Properties option in the popup menu enter a name for the Track Trigger click the to accept the change or the to reject it

Set its Trigger Radius
The Trigger Radius controls how closely an AI train has to approach the trigger to activate it (smaller radius = closer to the trigger).


	Steps: Left click and hold down the mouse button on the Green Dot next to the Track Trigger ( in the images above and below) While holding down the Left mouse button, move the mouse Forward or Backward to increase or reduce the trigger radius

Move the Track Trigger

Move it Along the Track


	Steps: Left click and hold down the mouse button on the Yellow Dot next to the Track Trigger ( in the images above and below) While holding down the Left mouse button, move the mouse Forward or Backward to drag the Track Trigger along the track

Reposition it Up/Down

This feature allows a Track Trigger to be physically placed above the track so that it will not be hidden if a consist is parked on the Track Trigger.


	Steps: Select the Fine Adjustment Tool (or press the D key) Left click and hold down the mouse button on the Blue Vertical Axis Line above the Track Trigger ( in the image on the left) While holding down the Left mouse button, move the mouse Forward or Backward to move the Track Trigger Up or Down

If you need to return the Track Trigger to its original position then:-

Left click on its Context Tool (or press the T key if the asset has already been selected)
from the popup menu select Reattach to Track

Reposition it Left/Right
This feature allows a Track Trigger to be physically placed left or right alongside the track so that it will not be hidden if a consist is parked on the Track Trigger.

Steps:

Select the Fine Adjustment Tool (or press the D key)
Left click and hold down the mouse button on the Red Horizontal Axis Line on the Track Trigger ( in the image above)
While holding down the Left mouse button, move the mouse Forward or Backward to move the Track Trigger Left or Right of the track

Notes:

The Green Horizontal Axis Line shown as in the image above pointing forward from the Track Trigger will move the Track Trigger forward/backward regardless of whether it is on the track or not. It has the same effect as Move it Along the Track. However, by using this tool it is possible to move the Track Trigger beyond the end of the track if that is ever required.

If you need to return the Track Trigger to its original position then:-

Left click on its Context Tool (or press the T key if the asset has already been selected)
from the popup menu select Reattach to Track

Assign a Track Trigger to a New Layer

The Info Palette will show the layer assigned to the currently selected object. To the left of the layer name is a small arrow object.

Info palette

Layer control

Steps:

click the small arrow next to the layer name. This will open the layer properties for the selected object
click the Layer drop down box to select a new layer for the object
if required, click the Binding drop down box to select a new binding layer for the object
if required, click the Lock Layer button to lock the selected layer. If the layer is already locked then this will be shown as an Unlock Layer button

WARNING:

You will not be allowed to place a track object in a layer that is higher up the list than the layer containing the track.

Information on layers can be found at:-

How to Use Layers

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:-

Trigger Check Rule

Steps

Open the Session Editor:

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 later Trainz versions (shown below right)
Select the option Edit Session from the drop down menu list

Add the Trigger Check Rule:

In the Edit Session window (shown below left):- Click the Add button	In the Rule Selection window (shown below right):- Scroll down the list to select the Trigger Check rule Click on the icon

This will add the Trigger Check rule to the session.

Open the Trigger Check Rule Properties:

With the Trigger Check rule highlighted (shown below):- Click the Edit button. This will open the rule properties window

Configure the Rule:

For this example we will leave all settings unchanged and simply identify the track trigger to be used.

In the Trigger Properties window (shown below):-

Click the Add trigger link

More information on the settings and options in this rule can be found on the Trainz Wiki Rules Page at:-

Trigger Check Rule

Select the Trigger:

The Trigger Selection Window will list all the Track Triggers in your layout. Select the trigger you have just added Click on the icon at the bottom of the selection window

Once the trigger has been added to the rule, click on the icon in the Trigger Check properties window to accept the change.

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:

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 icon

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.

Indent the Popup Message Rule:

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. With the Message Popup Rule highlighted:- Click the Indent (right arrow) button. This should indent the Message Popup rule one level inwards (as shown below).

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.

Configuring the Message and Testing

Steps

Open the Message Popup Rule for Editing:

With the Message Popup Rule highlighted and indented (as shown above):- Click the Edit button. The Message Popup Rule properties window will appear (as shown below)

Configure the Message:

Set the properties as shown:-

Check ON Close previous message popup windows
Select Option Button Custom text
Enter a short text message

More information on this rule can be found on the Trainz Wiki Page at:-

How to Use Message Popup Rule

(Optional) Add a Message Icon:

Click the link click here to set (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 icon

click on the icon to exit the Message Popup Rule and return to the Session Editor

The completed Message Popup Rule

Test the Trigger:

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

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.

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.

@@ Line 37: / Line 37: @@
 </table>								<!-- END Nav Buttons Table -->
 ='''What are Track Triggers?'''=
-<table cellpadding=4 bgcolor=#c1e7e7>
-<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.
+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.<br>
 <table>
@@ Line 49: / Line 46: @@
 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
+* The "5.00m" shown below the trigger name is the trigger detection radius</td>
 </tr>
 </table>
@@ Line 186: / Line 183: @@
 *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)
+*Leave the "Bound Layer" at ''&lt;none&gt;''. (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>
@@ Line 203: / Line 200: @@
 <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">
 <td width=340>[[file:TrackTriggerRadius.JPG|link=]]</td>
@@ Line 423: / Line 420: @@
 </table>
 <br>
 ===<span style="color: white; background-color: blue;">&#160;Set the Track Trigger Properties&#160;</span>===
 <table width=900>
@@ Line 495: / Line 491: @@
 <table width=900>
 <tr valign="top">
-<td>[[image:TriggerFineAdjust_S20.png|link=]]<td>
+<td>[[image:TriggerFineAdjust_S20.png|link=]]</td>
 <td>[[image:DotPoint6Blue.png|link=]] <span style="font-weight: 700; font-size: 17px;">Reposition it Up/Down</span><br>
 This feature allows a '''Track Trigger''' to be physically placed above the track so that it will not be hidden if a consist is parked on the '''Track Trigger'''.<br>
@@ Line 691: / Line 687: @@
 <tr valign="top">
 <td>[[file:EditSessionMenu.JPG|link=]]</td>
-<td>[[file:SessionEditMenuSP1.png|link=]]<br>
+<td>[[file:SessionEditMenuSP1.png|link=]]<br></td>
 </tr>
 <tr>
@@ Line 759: / Line 755: @@
 <tr valign="top">
 <td>[[file:TriggerCheckProperties.JPG|link=]]</td>
-<td>
+<td></td>
-</td>
 </tr>
 <tr>
@@ Line 796: / Line 791: @@
 </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.
+<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.</td>
+</tr>
 <tr>
 <td colspan="2">
@@ Line 877: / Line 873: @@
 =='''Configuring the Message and Testing'''==
-<table cellpadding=4 bgcolor=#ffffff> 								<!-- BEGIN Step table -->
+<table cellpadding=4 bgcolor=#ffffff width=1000> 								<!-- BEGIN Step table -->
 <tr valign="top">
-<td>[[file:Steps.PNG|link=]]<br><br>
+<td width=50>[[file:Steps.PNG|link=]]<br><br>
 <span style="font-size: 17px; font-weight: 700;">Steps</span></td>
-<td>[[file:DotPoint1.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">Open the Message Popup Rule for Editing:</span><br>
+<td width=640>[[file:DotPoint1.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">Open the Message Popup Rule for Editing:</span><br>
 <table> 																<!-- BEGIN Step 1 table -->
 <tr valign="top">
@@ Line 894: / Line 890: @@
 </td>
 </tr>
+</table>
+<table width=1000>
 <tr valign="top">
-<td>&nbsp;</td>
 <td>[[file:DotPoint2.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">Configure the Message:</span><br>
 <table> 																<!-- BEGIN Step 2 table -->
@@ Line 927: / Line 924: @@
 </table> 																<!-- END Step 2 table -->
 </td>
-</tr>
-<tr valign="top">
-<td>&nbsp;</td>
 <td>[[file:DotPoint3.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">(Optional) Add a Message Icon:</span><br>
 <table> 																<!-- BEGIN Step 3 table -->
@@ Line 937: / Line 931: @@
 :*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 [[image:Tick.PNG|link=]] icon</td>
 </tr>
 <tr valign="top">
@@ Line 944: / Line 938: @@
 <tr valign="top">
 <td>
-*click on the [[file:Tick.PNG|link=]] icon to exit the '''Message Popup Rule''' and return to the '''Session Editor'''<br>
+*click on the [[file:Tick.PNG|link=]] icon to exit the '''Message Popup Rule''' and return to the '''Session Editor'''</td>
-The completed Message Popup Rule<br>
-[[file:MessagePopupStop.JPG|link=]]
-<tr>
-<td colspan="2">
-----</td>
 </tr>
-</table> 																<!-- END Step 3 table -->
+</table>
 </td>
 </tr>
+</table>
+<br>
+<table width=1000>
 <tr valign="top">
-<td>&nbsp;</td>
+<td>The completed Message Popup Rule<br>
+[[file:MessagePopupStop.JPG|link=]]</td>
 <td>[[file:DotPoint4.JPG|link=]]&nbsp;<span style="font-size: 17px; font-weight: 700;">Test the Trigger:</span><br>
 <table> 																<!-- BEGIN Step 4 table -->
@@ Line 961: / Line 954: @@
 <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 968: / Line 962: @@
 </tr>
 </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)]]'''.
-<br>
 </td>
 </tr>
 </table>																<!-- END Steps Table -->
+<br>
+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>						<!-- BEGIN Nav Buttons Table -->

How to Use Track Triggers

Revision as of 16:12, 10 February 2023

Contents

What are Track Triggers?

Route or Session?

Adding a Track Trigger

In Surveyor Classic (S10)

In Surveyor 2.0 (S20)

Adding a Track Trigger

Set the Track Trigger Properties

Move the Track Trigger

Assign a Track Trigger to a New Layer

Creating a Track Trigger Event

Adding an Instruction to the Trigger Event

Adding a Child Rule

Configuring the Message and Testing

Alternatives to the Trigger Check Rule

Related Links

Trainz Wiki

Views

Personal tools

Navigation

Search

Toolbox