How to Use Track Triggers: Difference between revisions

From TrainzOnline
Jump to navigationJump to search
Pware (talk | contribs)
Pware (talk | contribs)
Line 1,167: Line 1,167:
<table width=1000>
<table width=1000>
<tr valign="top">
<tr valign="top">
<td width=480>[[image:TriggerFineAdjustHorizontal_S20.png|link=]]</td>
<td width=370>[[image:TriggerFineAdjustHorizontal_S20.png|link=]]</td>
<td>
<td>
<table bgcolor=#000000 cellpadding=2>
<table bgcolor=#000000 cellpadding=2>
Line 1,203: Line 1,203:
</table>
</table>
<br>
<br>
===Assign it to a New Layer (S20)===
===Assign it to a New Layer (S20)===



Revision as of 01:41, 10 July 2026

Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 The information in this Wiki Page describes how to install, configure and use Track Triggers in T:ANE, TRS19, TRS22 and Trainz Plus.


          Next Down Bottom
Track Triggers are 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?

    Top   Next Down Bottom
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 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:-
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 they are visible in Surveyor and invisible in Driver
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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?

    Top Next Up Next Down Bottom
Track Triggers can be placed in a Route Layer or in a Session Layer


Notes:

Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Placing a Track Trigger 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
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Placing a Track Trigger 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 Trigger in each Session


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


Adding a Track Trigger

Skip Down   Top Next Up Next Down Bottom
Notes:

A Track Trigger has two important properties:-

Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 its name which is needed for all commands and rules that use the Track Trigger, and
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 its Effect Radius (the green "wings" shown in the image above with the radius value, in metres, shown below the Track Trigger name). This controls how closely an AI train has to approach the Track Trigger to activate it (smaller radius = closer to the Track 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)

Skip Down Skip Up        

Adding a Track Trigger (S10)

Track Triggers are Track Objects and have to be attached to a track segment.



Steps: To add a Track Trigger:-
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 Track 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 Track Trigger is to be placed
This will place the Track Trigger on the track and open its properties window.


Avoid placing a Track Trigger on a junction. You could accidentally place the Track Trigger on the wrong junction branch which means that it will have no effect if the targetted train is directed to the other branch


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.


Change its Direction (S10)

Except for the Directional Track Trigger, the direction the Track Trigger is pointing has no effect on its operation.


Steps: To Reverse the Direction of a Track Trigger:-
In the Track Tools Flyout (the  F4  key) select Trackmark Mode (the  V  key)
Then select the Rotate Trackmark Tool (the  R  key)
 Left Click  on the Track Trigger
 


Set its Name and Layer (S10)

The name of a Track Trigger is important.


Enter a useful descriptive name for each Track Trigger - the name will be needed for session rules and driver commands. Many creators base the name on the location (e.g. "Maintown Approach North")
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 its Effect Radius (S10)

The Effect Radius sets how close a consist has to approach the marker to activate its operation. The default value is 20m.


The methods described below are NOT available in Surveyor Classic (S10) in versions of Trainz that have the Surveyor 2.0 (S20) interface as an option (TRS22PE and Trainz Plus). For these versions switch to Surveyor 2.0 and use the methods described in the  Set its Effect Radius (S20) section below.


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 Track Trigger. This sets how close a consist has to approach to Track Trigger its "event". The smaller the radius the closer it must approach.



Other Track Objects that have an Effect Radius include:-
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127  Track Direction Markers
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127  Track Markers
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127  Priority Markers
Steps: To set a Track Triggers 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 Trigger by using method shown above


In Surveyor 2.0 (S20)

Skip Down Skip Up        
Surveyor 2.0 is only available in Trainz Plus and TRS22 Platinum


Adding a Track Trigger (S20)

Track Triggers are Track Objects and have to be attached to a track segment. The Track Trigger object can be moved off the track (left, right, above, below) but its attachment point is always connected to a track segment.


Steps: To add a Track Trigger:-
In the Filter Palette either:-
Left Click on the Track Objects icon

OR
Left Click on the Content Drop Down Box


Then select Track Objects

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

If the Filter Palette and the Assets Palette are not shown on the screen, then:-

Windows Menu
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 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


In the Assets Palette to narrow down the filter list, type "trigger" (UPPER/lower case does not matter) in the Search Text Box


Both pallets shown docked


This will list all the Track Objects containing the text "trigger" in their names or descriptions.
Left Click on the item name Track Trigger (or another Track Trigger object) in the list - you may have to scroll down the list to find the asset.


If you are not sure about an asset then Double Left Click on the name to bring up its image and description.

When you select any asset in the Assets Palette list it will automatically select the Placement Tool so the next Left Click in your Trainz World will add that asset to your Trainz World

Place the Track Trigger on the track.

Steps: To add a Track Trigger:-
If, for some reason, the Placement Tool has not been selected then Left Click on the Placement Tool or press the  E  key
Left Click on the track at the position where you want to place the Track 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:-
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Free Move Tool (or press  S ) OR
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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:-
Steps:
select the Track Trigger then Left Click on its Context Menu Icon (or press the  T  key)
from the popup menu select the  Rotate Trackside  option
Note: the direction that a "Standard" Track Trigger faces has no effect on its operation. There are some Track Triggers that do have a specific direction of operation
 
Avoid placing a Track Trigger on a junction. You could accidentally place the Track Trigger on the wrong junction branch which means that it will have no effect if the targetted train is directed to the other branch


Change Its Name (S20)

The name of the Track Trigger IS important. It is needed to identify the Track Trigger in Session Rules.

Steps: To change the name of a Track Trigger:-
using either the Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Free Move Tool or the Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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


Enter a useful descriptive name for each Track Trigger - the name will be needed for session rules and driver commands. Many creators base the name on the location (e.g. "Maintown Approach North")


Set its Effect Radius (S20)

The Effect Radius sets the size of green "effect wings" attached to both ends of the Track Trigger. This sets how close a consist has to approach to trigger its "event". The smaller the radius the closer it must approach. In the image shown below, the approaching vehicle will activate the Track Trigger when it is 20m away from it.
Steps: To adjust the Effect Radius of a Track Trigger:-
Left Click and Drag on the Green Dot next to the Track Trigger.
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Drag it Left or Right (at 90° to the direction of the track) to change its Effect Radius.
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 The speed at which you drag it will set the speed at which the radius value will change - faster movements will give larger value changes.
For the best results when adjusting the Effect Radius of any track object, move your camera POV (point of view) to directly above the object


Other Track Objects that have an Effect Radius include:-
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127  Track Direction Markers
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127  Track Markers
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127  Priority Markers
Once you have set the Effect Radius of a Track Trigger it can be quickly duplicated (cloned) in Surveyor 2.0 with those settings and moved to a new location. You can easily edit the name and properties of the clone at the new location. See  How to Use S20 Tools - Cloning Objects for the details


Move it Along the Track (S20)

A Track Trigger can be moved along the track or to other tracks.

Steps: To move the Track Trigger:-
Left Click and Drag Forward or Backward on the Yellow Dot, its Attachment Point, next to the Track Trigger or on the object itself (see Notes: below), to move it along the track or to another track


Notes:

Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 If you drag the object itself and not its Attachment Point then it will stay at its original height as it is moved along the track. If the track is on a grade then the object will rise above or fall below the track as it is moved. To return the object to its correct height on the track see the next section Move it Vertically (S20) below.
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Dragging it by the attachment point will force it to stay at the height of the track as it is moved.


Move it Vertically (S20)

Track Trigger 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 the Track Trigger.
Steps: To move a Track Trigger vertically choose option OR :-
Using the Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Fine Adjustment Tool (press the  D  key) Left Click and Drag Forward or Backward on the  Blue  Vertical Axis Line (labelled as in the image) to move it up or down OR
In the  Info Palette  enter a value in the  Height  setting and press the  Enter  key. NOTE: the height is measured from the absolute 0m level and not from the current height of the object or the track.


If you need to return the Track Trigger to its original height 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 it Horizontally (S20)

Track Triggers can be physically placed left or right of the track.
This feature allow a Track Trigger to be placed so that it will not be hidden in Surveyor if a consist is parked on the trigger. A change in position left or right will have no effect on its operation.
Steps: To move a Track Trigger horizontally:-
Track Objects can be moved along the track using the methods shown in the section  Move it Along the Track (S20) above.
The two methods described below only work if the Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Fine Adjustment Tool - the  D  key - is selected.
Left Click and Drag Forward or Backward on the  Red  Horizontal Axis Line attached to the Track Trigger to move it left or right of the track
Left Click and Drag Forward or Backward on the  Green  Horizontal Axis Line attached to the Track Trigger to move it forward or back in a straight line that will ignore any curves in the track


Assign it 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.
Info palette

Layer control
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:
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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:-


Creating a Track Trigger Event

  Skip Up Top Next Up Next Down Bottom
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:
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
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127

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

Select the Track 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

Skip Down   Top Next Up Next Down Bottom

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

Skip Down Skip Up        
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
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127
(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:-


 Test the Trigger Event:
Exit the Session Editor
Add a consist to your layout a short distance from the Track Trigger (but further away than its Effect 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

  Skip Up Top Next Up   Bottom
There are other Session Rules that can be used in place of the Trigger Check Rule and Track Trigger. A few possibilities are listed below:-
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Trackside Check Rule - very similar to the Trigger Check Rule but provides some different options
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Navigation Points (see the How to Guides below) are more complex but provide more advanced controls and options
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Multiple Resource Check Rule - monitors and acts on changes in multiple industry or multiple wagon resource (commodity) levels
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Resource Verify Rule - monitors and acts on changes in a single industry or wagon resource (commodity) level
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 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:-
Error creating thumbnail: /bin/bash: line 1: /usr/bin/convert: No such file or directory Error code: 127 Wait For Trigger - forces an AI controlled train to wait until a specified Track Trigger has been activated by another train
  Top Next Up    


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.