How to Use Track Triggers

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
m (→‎ Adding a Track Trigger )
m (→‎ Adding a Track Trigger )
Line 310: Line 310:
 
</table>
 
</table>
  
−
<table bgcolor=#000000 width=600 cellpadding=2>
+
<table bgcolor=#000000 width=550 cellpadding=2>
 
<tr valign="top">
 
<tr valign="top">
 
<td>
 
<td>
−
<table bgcolor=#ffffe0 width=596 cellpadding=2>
+
<table bgcolor=#ffffe0 width=546 cellpadding=2>
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[image:PencilTips.PNG|link=]] <span style="font-size: 15px; font-weight: 700; color: white; background-color: blue;">&#160;Shortcut&#160;</span><br>
+
<td colspan=2>[[image:PencilTips.PNG|link=]] <span style="font-size: 15px; font-weight: 700; color: white; background-color: blue;">&#160;Shortcut&#160;</span><br>
−
If you already have a '''Track Trigger''' placed in your route then:-
+
If you already have a '''Track Trigger''' placed in your route then:-</td>
−
# select the '''Eyedropper Tool''' in the '''Tools Palette''' (or press the <span style="font-weight: 700; font-size: 17px; color: white; background-color: black;">&#160;R&#160;</span> key)
+
</tr>
−
# '''Left''' click on the existing '''Track Trigger''' in the route
+
<tr valign="top">
−
# then '''Left''' click on the '''Track Trigger''' name in the Filter List
+
<td width=20>[[image:DotPoint1Blue.png|link=]]</td>
−
This will instantly select the '''Track Trigger''' in the Filter List and switch control to the '''Placement Tool'''.<br>
+
<td>move the tool pointer over the existing track trigger object and hold down the <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;Alt&#160;</span> key. The object name will appear in a '''ToolTip''' attached to the pointer</td>
−
 
+
</tr>
−
Jump to '''Step [[image:DotPoint5.JPG|link=]]''' below.</td>
+
<tr valign="top">
 +
<td>[[image:DotPoint2Blue.png|link=]]</td>
 +
<td>while holding down the <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;Alt&#160;</span> key '''Left''' click on the track trigger to identify it in the '''Assets Palette''' and to select the '''Placement Tool'''. Release the key.</td>
 +
</tr>
 +
<tr valign="top">
 +
<td colspan=2>Jump to '''Step [[image:DotPoint5.JPG|link=]]''' below.</td>
 
</tr>
 
</tr>
 
</table>
 
</table>

Revision as of 21:43, 5 February 2023

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

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


  Top   Next Down Bottom

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 WikiLink.PNG Trigger Check Rule (or a similar rule) or a Driver Command that is monitoring the track trigger.

TrackTrigger.JPG

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


  Top Next Up Next Down Bottom

Route or Session?

DotPoint.JPG Track Triggers can be placed in a Route layer or in a Session layer


NotePad.PNG Notes:
DotPoint.JPG 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.
DotPoint.JPG 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.


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


  Top Next Up Next Down Bottom

Adding a Track Trigger

NotePad.PNG 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)
PencilTips.PNG The direction that a Track Trigger is pointing has NO EFFECT on its operation


 In Surveyor Classic (S10) 

TrackTriggerMode.JPG
Steps.PNG Steps:

A Track Trigger is placed on the track by:-

  1. clicking the Track tool,
  2. clicking the Trackmark Mode button,
  3. selecting the Trigger object from the list of installed objects,
  4. clicking the Add Object button,
  5. 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.PNG

Steps		 DotPoint1.JPG Name the Trigger:
TrackTriggerProperties.JPG
  • 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 WikiLink.PNG Using Layers for information on layers)
  • To confirm the changes click on the Tick.PNG icon on the bottom right of the window
  DotPoint2.JPG (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).
TrackTriggerRadius.JPG
  1. Click the Advanced Tab to open its properties
  2. Enter a new radius value in metres
  3. Click the Set Trigger Radius button
  4. Click on the track trigger to assign its new radius


PencilTips.PNG 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 

DotPoint1.JPG In the Asset Palette either:-

Ablue.png Left click the Track Mesh Filter icon

Track mesh

OR
Bblue.png Left click the Content Drop-down Box

Filter List
Then select Track Objects
Track Objects

NotePad.PNG Notes:

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

Windows Menu
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.
PencilTips.PNG  Shortcut 
If you already have a Track Trigger placed in your route then:-
DotPoint1Blue.png 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
DotPoint2Blue.png 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 DotPoint5.JPG below.


DotPoint2.JPG To narrow down the filter list, type "trig" (UPPER/lower case does not matter) in the Search Text Box

Text search
DotPoint3.JPG This will list all the Track Objects containing the text "trig" in the filter list.
Filtered list DotPoint4.JPG 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.

DotPoint5.JPG Place the Track Trigger on the track.

Add trigger


NotePad.PNG Notes:

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

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


PencilTips.PNG If you need to rotate the Track Trigger to face the opposite direction then:-
  1. Left click on its Context Tool (or press the  T  key if the asset has already been selected)
  2. from the popup menu select  Rotate Trackside 
Note: the direction it faces has no effect on its operation.
Steps.PNG Steps:
DotPoint1Blue.png Select the Placement Tool (or press the  E  key) from the Tools Palette
DotPoint2Blue.png 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 

TriggerAdjust S20.png DotPoint3Blue.png Change Its Name
Steps.PNG Steps:
  1. Left click on the Context Tool (DotPoint3Blue.png 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
  2. Left click on the  Edit Properties  option in the popup menu
  3. enter a name for the Track Trigger
  4. click the Tick.PNG to accept the change or the Cross.PNG to reject it


DotPoint4Blue.png 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.PNG Steps:
  1. Left click and hold down the mouse button on the Green Dot next to the Track Trigger (DotPoint4Blue.png in the images above and below)
  2. While holding down the Left mouse button, move the mouse Forward or Backward to increase or reduce the trigger radius


 Move the Track Trigger 

DotPoint5Blue.png Move it Along the Track
Steps.PNG Steps:
  1. Left click and hold down the mouse button on the Yellow Dot next to the Track Trigger (DotPoint5Blue.png in the images above and below)
  2. While holding down the Left mouse button, move the mouse Forward or Backward to drag the Track Trigger along the track


TriggerFineAdjust S20.png DotPoint6Blue.png 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.PNG Steps:
  1. Select the Fine Adjustment Tool (or press the  D  key)
  2. Left click and hold down the mouse button on the Blue Vertical Axis Line above the Track Trigger (DotPoint6Blue.png in the image on the left)
  3. While holding down the Left mouse button, move the mouse Forward or Backward to move the Track Trigger Up or Down
PencilTips.PNG If you need to return the Track Trigger to its original position then:-
  1. Left click on its Context Tool (or press the  T  key if the asset has already been selected)
  2. from the popup menu select  Reattach to Track 


DotPoint7Blue.png 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.PNG Steps:
  1. Select the Fine Adjustment Tool (or press the  D  key)
  2. Left click and hold down the mouse button on the Red Horizontal Axis Line on the Track Trigger (DotPoint7Blue.png in the image above)
  3. While holding down the Left mouse button, move the mouse Forward or Backward to move the Track Trigger Left or Right of the track
NotePad.PNG Notes:

The Green Horizontal Axis Line shown as DotPoint8Blue.png 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 DotPoint5Blue.png 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.

PencilTips.PNG If you need to return the Track Trigger to its original position then:-
  1. Left click on its Context Tool (or press the  T  key if the asset has already been selected)
  2. 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.PNG Steps:
  1. click the small arrow next to the layer name. This will open the layer properties for the selected object
  2. click the Layer drop down box to select a new layer for the object
  3. if required, click the Binding drop down box to select a new binding layer for the object
  4. 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


Stop.PNG 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.

LinkWiki.PNG Information on layers can be found at:-
  Top Next Up Next Down Bottom

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 WikiLink.PNG Session Editor.

LinkWiki.PNG

More information on the Trigger Check Rule can be found on the Trainz Wiki Rules Page at:-


Steps.PNG

Steps		 DotPoint1.JPG Open the Session Editor:

To add the Trigger Check Rule to a session:-

  1. Open the Surveyor Main Menu in TANE (shown below left) or the Surveyor Edit Menu in TRS19 and later Trainz versions (shown below right)
  2. Select the option Edit Session from the drop down menu list
EditSessionMenu.JPG SessionEditMenuSP1.png
  DotPoint2.JPG 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):-

  1. Scroll down the list to select the Trigger Check rule
  2. Click on the Tick.PNG icon
EditSessionWindowX.JPG RuleSelect.JPG

This will add the Trigger Check rule to the session.
  DotPoint3.JPG 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
TriggerCheck.JPG
  DotPoint4.JPG 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
TriggerCheckProperties.JPG
LinkWiki.PNG

More information on the settings and options in this rule can be found on the Trainz Wiki Rules Page at:-
  DotPoint5.JPG Select the Trigger:
The Trigger Selection Window will list all the Track Triggers in your layout.
  1. Select the trigger you have just added
  2. Click on the Tick.PNG icon at the bottom of the selection window
TriggerList.JPG
Once the trigger has been added to the rule, click on the Tick.PNG icon in the Trigger Check properties window to accept the change.


  Top Next Up Next Down Bottom

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

Steps		 DotPoint1.JPG Add A Message Popup Rule:
When you are back in the Session Editor window:-
  1. Make sure that the new Trigger Check Rule is selected (highlighted)
  2. Click the Add button to add another new rule
  3. Scroll down the rule selection window to find and select the Message Popup rule
  4. Click on the Tick.PNG icon
TriggerAddMesPopup.JPG
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.
  DotPoint2.JPG 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.

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

SessionRuleIndented.JPG

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

Steps		 DotPoint1.JPG 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)
  DotPoint2.JPG Configure the Message:
Set the properties as shown:-
  1. Check ON Close previous message popup windows
  2. Select Option Button Custom text
  3. Enter a short text message
MessagePopupText.JPG
LinkWiki.PNG

More information on this rule can be found on the Trainz Wiki Page at:-
  DotPoint3.JPG (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 Tick.PNG icon
IconStop.JPG
  • click on the Tick.PNG icon to exit the Message Popup Rule and return to the Session Editor

The completed Message Popup Rule
MessagePopupStop.JPG

  DotPoint4.JPG 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 WikiLink.PNG How to Use Message Popup Rule (Applications).


  Top Next Up   Bottom

Alternatives to the Trigger Check Rule

RulesWiki.PNG 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 WikiLink.PNG 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.


CommandsWiki.png 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

LinkWiki.PNG


  Top Next Up    

Trainz Wiki

TrainzWiki.png

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.

Retrieved from "https://online.ts2009.com/mediaWiki/index.php?title=How_to_Use_Track_Triggers&oldid=35882"
Personal tools