How to Use Message Popup Rule (Applications)

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
m
m (fixed HTML tag errors)
Line 30: Line 30:
 
</tr>
 
</tr>
 
</table>
 
</table>
−
<table> <!-- BEGIN Nav Buttons Table -->
+
<table width=1000> <!-- BEGIN Nav Buttons Table -->
 
<tr valign="top">
 
<tr valign="top">
 
<td width=729><span id="stepTimed"></span>&nbsp;</td>
 
<td width=729><span id="stepTimed"></span>&nbsp;</td>
Line 84: Line 84:
 
</tr>
 
</tr>
 
</table>
 
</table>
 +
<table width=1000>
 +
<tr valign="top">
 +
<td>
 
*'''Line 1: Trigger Check''' The event is triggered when a consist passes over a track trigger but any event could be used, such as a '''Navigation Point''', a '''TimeCheck''', a '''Wait On ...''' or '''Wait For ...''', etc. As long as the following rules are child rules of the trigger event.
 
*'''Line 1: Trigger Check''' The event is triggered when a consist passes over a track trigger but any event could be used, such as a '''Navigation Point''', a '''TimeCheck''', a '''Wait On ...''' or '''Wait For ...''', etc. As long as the following rules are child rules of the trigger event.
 
**'''Line 2: Simultaneous List''' This forces all the following child rules to be executed at the same time. Events such as the '''Trigger Check''' that execute their child rules in order would not work in this example because everything else would be forced to wait until the '''Message Popup''' has been closed. Using the '''Simultaneous List Rule''' avoids this problem. Events that execute their child rules simultaneously would not need the '''Simultaneous List Rule''' (see next example).
 
**'''Line 2: Simultaneous List''' This forces all the following child rules to be executed at the same time. Events such as the '''Trigger Check''' that execute their child rules in order would not work in this example because everything else would be forced to wait until the '''Message Popup''' has been closed. Using the '''Simultaneous List Rule''' avoids this problem. Events that execute their child rules simultaneously would not need the '''Simultaneous List Rule''' (see next example).
Line 89: Line 92:
 
***'''Line 4: Wait''' This forces a wait for a set time period, in this case 20 seconds but any time interval can be set. At the end of that period the '''Wait Rule''' will execute its own set of child rules.
 
***'''Line 4: Wait''' This forces a wait for a set time period, in this case 20 seconds but any time interval can be set. At the end of that period the '''Wait Rule''' will execute its own set of child rules.
 
****'''Line 5: Close Message Popup''' The message window is closed.
 
****'''Line 5: Close Message Popup''' The message window is closed.
−
<table width="100%">
+
</td>
−
<table> <!-- BEGIN Nav Buttons Table -->
+
</tr>
 +
</table>
 +
 
 +
<table width=1000> <!-- BEGIN Nav Buttons Table -->
 
<tr valign="top">
 
<tr valign="top">
 
<td width=729><span id="stepNavPoint"></span>&nbsp;</td>
 
<td width=729><span id="stepNavPoint"></span>&nbsp;</td>
Line 152: Line 158:
 
</tr>
 
</tr>
 
</table>
 
</table>
 +
<table width=1000>
 +
<tr valign="top">
 +
<td>
 
*'''Line 1: Wait on Navigation Point''' The event is triggered when a consist reaches a preset navigation point. This rule executes all its child rules simultaneously so no '''Simultaneous List Rule''' is required in this example.
 
*'''Line 1: Wait on Navigation Point''' The event is triggered when a consist reaches a preset navigation point. This rule executes all its child rules simultaneously so no '''Simultaneous List Rule''' is required in this example.
 
**'''Line 2: Message Popup''' This places the message window on the screen and waits for it to be closed either manually (by the user) or by another rule.
 
**'''Line 2: Message Popup''' This places the message window on the screen and waits for it to be closed either manually (by the user) or by another rule.
Line 158: Line 167:
  
 
In this example, the '''Close Message Popups Rule''' could be replaced by lines 2, 3, 4 and 5 from the '''Timed Message''' example shown above to produce a new message when the train stops moving and that message would be closed after a set time interval.<br>
 
In this example, the '''Close Message Popups Rule''' could be replaced by lines 2, 3, 4 and 5 from the '''Timed Message''' example shown above to produce a new message when the train stops moving and that message would be closed after a set time interval.<br>
 +
</td>
 +
</tr>
 +
</table>
  
 
<table cellpadding=4 bgcolor="Aquamarine">
 
<table cellpadding=4 bgcolor="Aquamarine">
Line 168: Line 180:
 
</tr>
 
</tr>
 
</table>
 
</table>
−
<table> <!-- BEGIN Nav Buttons Table -->
+
<table width=1000> <!-- BEGIN Nav Buttons Table -->
 
<tr valign="top">
 
<tr valign="top">
 
<td width=729><span id="bottom"></span>&nbsp;</td>
 
<td width=729><span id="bottom"></span>&nbsp;</td>

Revision as of 22:21, 10 February 2023

The information in this Wiki Page applies to TANE, TRS19, Trainz Plus and TRS22. It gives practical examples of how to use the Message Popup Rule in Sessions to create messages that appear after an event and automatically close after another event.

Contents
LinkWiki.PNG

For information of how to configure the Message Popup Rule in Trainz, see the Trainz Wiki Page at:-


DotPoint.JPG The WikiLink.PNG Message Popup Rule is a Trainz Session Rule that creates onscreen messages for users in Driver Mode.
DotPoint.JPG The WikiLink.PNG Close Message Popup Rule is a Trainz Session Rule that closes onscreen messages for users in Driver Mode.
  Top   Next Down Bottom

Application 1: Timed Message

Magnifier.png The Scenario:

A Message Popup is activated by a track trigger event and is automatically closed by a timed event.

RulesWiki.PNG Rules Used:


Screenshot.PNG Session Editor Screenshot:
Message Popup.jpg


Explanation.PNG Description:
  • Line 1: Trigger Check The event is triggered when a consist passes over a track trigger but any event could be used, such as a Navigation Point, a TimeCheck, a Wait On ... or Wait For ..., etc. As long as the following rules are child rules of the trigger event.
    • Line 2: Simultaneous List This forces all the following child rules to be executed at the same time. Events such as the Trigger Check that execute their child rules in order would not work in this example because everything else would be forced to wait until the Message Popup has been closed. Using the Simultaneous List Rule avoids this problem. Events that execute their child rules simultaneously would not need the Simultaneous List Rule (see next example).
      • Line 3: Message Popup This places the message window on the screen and waits for it to be closed either manually (by the user) or by another rule.
      • Line 4: Wait This forces a wait for a set time period, in this case 20 seconds but any time interval can be set. At the end of that period the Wait Rule will execute its own set of child rules.
        • Line 5: Close Message Popup The message window is closed.
  Top Next Up Next Down Bottom

Application 2: Navigation Point and Train Stopped Event Message

Magnifier.png The Scenario:

A Message Popup is activated by a navigation event and is automatically closed by a train stopped event.

Conditions.PNG Preconditions:


RulesWiki.PNG Rules Used:


Screenshot.PNG Session Editor Screenshot:
Message Popup2.JPG


Explanation.PNG Description:
  • Line 1: Wait on Navigation Point The event is triggered when a consist reaches a preset navigation point. This rule executes all its child rules simultaneously so no Simultaneous List Rule is required in this example.
    • Line 2: Message Popup This places the message window on the screen and waits for it to be closed either manually (by the user) or by another rule.
    • Line 3: Wait on Train Stop/Start When the consist comes to a stop then it will execute its own set of child rules.
      • Line 4: Close Message Popup The message window is closed.

In this example, the Close Message Popups Rule could be replaced by lines 2, 3, 4 and 5 from the Timed Message example shown above to produce a new message when the train stops moving and that message would be closed after a set time interval.
LinkWiki.PNG

Information of setting and using Navigation Points can be found on the Trainz Wiki Page at:-
  Top Next Up    

Trainz Wiki

TrainzWiki.png

More Tutorials and Guides to Using Trainz

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

Retrieved from "https://online.ts2009.com/mediaWiki/index.php?title=How_to_Use_Message_Popup_Rule_(Applications)&oldid=35927"
Personal tools