Revision as of 20:30, 28 November 2023

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

	Track Triggers are track markers that are invisible in Driver but visible in Surveyor
	They are used to activate some Session Rules and Driver Commands
	They 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 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:-

they are visible in Surveyor and invisible in Driver

the "green wings" show their Effect Radius, the region where a consist will trigger an "event". The number in brackets show that radius in metres

	the Directional Track Trigger will normally only be triggered if the consist is moving in the direction indicated by the arrow
	the standard Track Trigger will be triggered regardless of the direction of movement

"Standard" Track Trigger

Directional Track Trigger

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

A "standard" Track Trigger has no visible direction and, while it can be rotated, this has NO EFFECT on its operation. The Directional Track Trigger does have a direction because it is only triggered by trains travelling in a specific direction

In Surveyor Classic (S10)

Adding a Track Trigger (S10)

Steps: To add a Trigger Mark:-
	Open the Tracks Tool Flyout or press the F4 key
	Left Click on the Trackmark Mode button or press the V key
	Left Click on the Trigger shown in the asset list
	Left Click the + Add Object button - it may already be selected - or press the A key
	Left Click on the track location where the marker is to be placed
This will place the Track Trigger on the track and open its properties window.

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)

	To change the track trigger name Left Click on the name text entry box, delete the highlighted default name and enter a new name
	To change its assigned layer Left Click on the layer text entry box (or use its scroll arrowheads) and select a new layer - see the Trainz Wiki Page How to Use layers for more details on layers
	To confirm the changes Left Click on the icon or the Save Changes button (depending on your Trainz version) at the bottom of the window

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.

Steps: To set a Track Trigger Effect Radius:-

In the Track Tools flyout, Left Click on the Advanced button to open the Radius tools and properties. You will have a choice of 4 methods to set and adjust the Effect Radius

Options: Choose one of:-

To copy the Effect Radius of an existing Track Trigger

	Left Click the Get Effect Radius icon
	Left Click on the Track Trigger whose radius you want to copy - the radius will be copied into the Effect Radius Value text box (the default value is 20.00 metres)
	To apply the new value see option below

To manually alter the Effect Radius value

	Type the new value (in metres) into the Effect Radius Value text box
	To apply the new value see option below

To apply a value in the Effect Radius Value text box (from methods

,

or

) to another Track Trigger

	Left Click the Copy Radius Value icon
	Left Click on the Track Trigger that is to receive the new value (you can click on more than one)

To adjust the Effect Radius value up or down

	Left Click the Adjust Effect Radius button
	Select the Track Trigger
	Left Click and Drag Forward (to increase the value) or Backward (to reduce the value)
	The new value will be immediately applied to the selected Track Trigger as the mouse moves (but only one Track Trigger at a time)

Once you have an Effect Radius entered in the value box, you can apply it to any number of Track Triggers by using method

shown above

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

Left Click on the Track Mesh Filter icon

Track mesh

OR

Left Click on the Content Drop-down Box

Filter List
Then select Track Objects

Notes:

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

Steps: To display palettes:-

open the

Window Menu from the menu icons at the top of the screen

	visible palettes have ticks next to their names
	invisible (hidden) palettes have no ticks next to their names

if the Assets Palette, or any required palette, does not have a tick next to its name then Left Click on the name of the palette or on the empty

box next to its name. This will add a

and make the palette visible

There is a Trainz Wiki Page specifically covering the S20 Palettes at
How to Use the Surveyor 2.0 Palettes

Shortcut If you already have a Track Trigger Mark placed in your route then:-
	move the tool pointer over the existing trigger object and hold down the Alt key. The object name will appear in a ToolTip attached to the pointer
	Alt + Left Click (hold down the Alt key and Left Click on the trigger mark 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 Left Click on the name to bring up its image and description.

Place the Track Trigger on the track.

	Notes:
	To add a track trigger, or any object, you will need to select the Placement Tool
	To edit a track trigger once it has been placed you will usually use either the Free Move Tool or the Fine Adjustment Tool

Steps: To add a Track Trigger:-
	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 trigger
Once placed a Track Trigger can be easily moved if needed.

Notes:

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

Steps:

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 (and this would apply only to Directional Track Triggers) then:-

Steps:
	select the Track Trigger and Left Click on its Context Menu Icon (or press the T key)
	from the popup menu select the Rotate Trackside option

Note: the direction a "standard" Track Trigger faces has no effect on its operation

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.

Steps: To change the name of a Track Trigger:-
	using either the Free Move Tool or the Fine Adjustment Tool select (Left Click on) the Track Trigger to be renamed
	in the Info Palette (you may need to make this palette visible - see the Notes: for Step 1 above) Left Click in the Name: entry box. Enter a name for the Track Trigger and press the Enter key

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.

Steps: To adjust the effect radius of a Track Trigger:-
	Left Click and Drag Forward or Backward on the Green Dot next to the Track Trigger to increase or reduce its Trigger Effect Radius

Move a Track Trigger Along the Track (S20)

Priority Marks can be moved along the track or to other tracks.

Steps: To move the Priority Mark:-
	Left Click and Drag Forward or Backward on the Yellow Dot next to the Priority Mark to move it along the track or to another track

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.

Steps: To move a Track Trigger vertically:-

This option is only available with the Fine Adjustment Tool - the D key

Left Click and Drag Forward or Backward on the Blue Vertical Axis Line above the Track Trigger to it up or down

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

Steps: To correctly reattach the Track Trigger to the track:-
	select the object and open (Left Click on) its Context Menu Icon (or press the T key)
	from the popup menu select Reattach to Track

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.

Steps: To move a Track Trigger horizontally:-

This option is only available with the Fine Adjustment Tool - the D key

Left Click and Drag Forward or Backward on the Red Horizontal Axis Line attached to the track Trigger to move it left or right

Left Click and Drag Forward or Backward on the Green Horizontal Axis Line attached to the Track Trigger to move it forward or back

If you need to return the Priority Mark to its original position then:-

Steps: To correctly reattach the Track Trigger to the track:-
	select the object and open (Left Click on) its Context Menu Icon (or press the T key)
	from the popup menu select Reattach to Track

Notes:

The Green Horizontal Axis Line shown as

in the image pointing forward from the TrackTrigger will move it forward/backward regardless of whether it is on the track or not. It has the same effect as

Move a Track Trigger 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.

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.

Steps: To assign a Track Trigger to a layer:-
In the Info Palette:-
	Left Click the small arrowhead next to the layer name. This will open the layer properties for the selected object
	Left Click the Layer drop down box to select a new layer for the object
	if required, Left Click the Binding drop down box to select a new binding layer for the object. It cannot be bound to its own layer
	if required, Left 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
	Moving an object from one layer group to another (e.g. from the Route Layer Group to the Session Layer Group) will change where the object is saved (in the Route or in the Session)

Information on layers can be found at:-

How to Use Layers

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

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) Left Click on the Add button

In the Rule Selection window (shown below right):-

	Scroll down the list to select the Trigger Check rule, and
	Left 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) Left 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):-

Left Click on 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 open and list all the Track Triggers in your Route.

	Select the Track Trigger you have just added
	Left Click on the icon at the bottom of the selection window

	Once the Track Trigger has been added to the rule, Left Click on the icon in the Trigger Check properties window to accept the change and close the Session Editor.

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:

When you are back in the Session Editor window:-

	Make sure that the new Trigger Check Rule is selected (highlighted)
	Left Click the Add button to add another new rule
	Scroll down the rule selection window to find and select the Message Popup rule

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

The 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) Left 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

(Optional) Add a Message Icon:

Left 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

Left Click on the

icon to select the icon

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

How to Use 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

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

	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

Related Links

This page was created by Trainz user pware in May 2018 and was last updated as shown below.

@@ Line 1,200: / Line 1,200: @@
 <td width=50>&#160;</td> <!-- Skip Up -->
 <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|Next Up]]</td>
 <td width=75>[[image:NextDown.png|link=#stepAlternatives|alt=Next Down|Next Down]]</td>
 <td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
@@ Line 1,447: / Line 1,447: @@
 <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=75>[[image:NextUp.png|link=#stepEvent|alt=Next Up|Top]]</td>
+<td width=75>[[image:NextUp.png|link=#stepEvent|alt=Next Up|Next Up]]</td>
 <td width=75>&#160;</td>
 <td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
@@ Line 1,501: / Line 1,501: @@
 </tr>
 </table>
-<br>
-='''Related Links'''=
-<table cellpadding=2 bgcolor=#ffffff>
-<tr valign="top">
-<td>[[image: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=1000>						<!-- BEGIN Nav Buttons Table -->
 <tr valign="top">
 <td width=729><span id="bottom"></span>&#160;</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=#stepAlternatives|alt=Next Up|Next Up]]</td>
 <td width=75>&#160;</td>
 <td width=75>&#160;</td>
@@ Line 1,527: / Line 1,513: @@
 ----
 ----
 ='''Trainz Wiki'''=
-<table cellpadding=2 bgcolor=#ffffff>
+<table width=1000>
+<tr valign="top">
+<td>
+<table width=500 cellpadding=2 bgcolor=#ffffff>
 <tr valign="top">
-<td>[[image:TrainzWiki.png|link=]]</td>
+<td width=80>[[image:TrainzWiki.png|link=]]</td>
 <td>
 <span style="font-size: 17px;">'''More Tutorials and Guides to Using Trainz'''</span><br>
@@ Line 1,538: / Line 1,526: @@
 *'''[[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>
+</td>
+<td>
+<table width=500 cellpadding=4 bgcolor="aquamarine">
+<tr valign="top">
+<td width=50>[[image:LinkWiki.PNG|link=]]</td>
+<td>
+<span style="font-size: 17px;">'''Related Links'''</span><br>
+* '''[[How to Use Track Direction Markers]]'''
+* '''[[How to Use Track Markers]]'''
+* '''[[How to Use Track Priority Markers]]'''
+</td>
+</tr>
+</table>
 </td>
 </tr>

How to Use Track Triggers

Revision as of 20:30, 28 November 2023

Contents

What are Track Triggers?

Route or Session?

Adding a Track Trigger

In Surveyor Classic (S10)

Adding a Track Trigger (S10)

Set the Trigger Name and Layer (S10)

Set the Effect Radius (S10)

In Surveyor 2.0 (S20)

Adding a Track Trigger (S20)

Change Its Name (S20)

Set its Effect Radius (S20)

Move a Track Trigger Along the Track (S20)

Move the Track Trigger Vertically (S20)

Move the Track Trigger Horizontally (S20)

Assign a Track Trigger to a New Layer (S20)

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

Trainz Wiki

Views

Personal tools

Navigation

Search

Toolbox