How to Use Message Popup Rule (Applications)

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
m (added Trainz Plus where needed, replaced references to multiple Trainz versions with "Trainz")
m
 
(12 intermediate revisions by one user not shown)
Line 1: Line 1:
−
The information in this Wiki Page applies to '''TANE''', '''TRS19''' and '''Trainz Plus'''. It gives examples of how to use the '''Message Popup Rule''' in Sessions.
+
<table width=1000> <!-- BEGIN Nav Buttons Table NO SKIPS -->
 +
<tr valign="top">
 +
<td width=629>&#160;</td>
 +
<td width=50>&#160;</td> <!-- Skip Down -->
 +
<td width=50>&#160;</td> <!-- Skip Up -->
 +
<td width=46>&#160;</td>
 +
<td width=75>&#160;</td>
 +
<td width=75>[[image:NextDown.png|link=#stepTimed|alt=Next Down|Next Down]]</td>
 +
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 +
</tr>
 +
</table> <!-- END Nav Buttons Table -->
  
−
<table cellpadding="4" bgcolor="Aquamarine">
+
<table width=1000>
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[file:LinkWiki.PNG|link=]]</td>
+
<td>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.</td>
 +
</tr>
 +
</table>
 +
 
 +
<table width=1000>
 +
<tr valign="top">
 +
<td width=400>
 +
__TOC__
 +
</td>
 +
<td>
 +
<table cellpadding=2 bgcolor="Aquamarine">
 +
<tr valign="top">
 +
<td>[[image:LinkWiki.PNG|link=]]</td>
 
<td>
 
<td>
 
For information of how to configure the '''Message Popup Rule''' in '''Trainz''', see the '''Trainz Wiki Page''' at:-<br>
 
For information of how to configure the '''Message Popup Rule''' in '''Trainz''', see the '''Trainz Wiki Page''' at:-<br>
 
* '''[[How to Use Message Popup Rule]]'''
 
* '''[[How to Use Message Popup Rule]]'''
 +
</td>
 +
</tr>
 +
</table>
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
−
__TOC__
+
<table bgcolor=#000000 cellpadding=2>
−
<br>
+
−
 
+
−
<table cellpadding="4" bgcolor=#c1e7e7>
+
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[file:DotPoint.JPG|link=]]</td>
+
<td>
−
<td>The [[file:WikiLink.PNG|link=]] '''[[Session_Rule_List_with_Parameters#Message_Popup_Rule|Message Popup Rule]]''' is a '''Trainz Session Rule''' that creates onscreen messages for users in '''Driver Mode'''.</td>
+
<table bgcolor=#ffffb0 cellpadding=2>
 +
<tr valign="top">
 +
<td width=25>[[image:NotePad.PNG|link=]]</td>
 +
<td><span style="font-size: 17px;">'''Notes:'''</span><br>
 +
----
 +
</td>
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[file:DotPoint.JPG|link=]]</td>
+
<td>[[image:DotPoint.JPG|10px|link=]]</td>
−
<td>The [[file:WikiLink.PNG|link=]] '''[[Session_Rule_List_with_Parameters#Close_Message_Popup_Rule|Close Message Popup Rule]]''' is a '''Trainz Session Rule''' that closes onscreen messages for users in '''Driver Mode'''.</td>
+
<td>The [[image:WikiLink.PNG|link=]] '''[[Session_Rule_List_with_Parameters#Message_Popup_Rule|Message Popup Rule]]''' is a '''Trainz Session Rule''' that creates onscreen messages for users in '''Driver Mode'''</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>The [[image:WikiLink.PNG|link=]] '''[[Session_Rule_List_with_Parameters#Close_Message_Popup_Rule|Close Message Popup Rule]]''' is a '''Trainz Session Rule''' that closes onscreen messages for users in '''Driver Mode'''</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
<br>
  
−
This page gives practical examples of how these rules can be used in a session to create messages that appear after an event and automatically close after another event.
+
<table width=1000> <!-- BEGIN Nav Buttons Table NO SKIPS -->
−
 
+
<tr valign="top">
 +
<td width=629><span id="stepTimed"></span>
 
='''Application 1: Timed Message'''=
 
='''Application 1: Timed Message'''=
 +
</td>
 +
<td width=50>&#160;</td> <!-- Skip Down -->
 +
<td width=50>&#160;</td> <!-- Skip Up -->
 +
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>&nbsp;</td>
 +
<td width=75>[[image:NextDown.png|link=#stepNavPoint|alt=Next Down|Next Down]]</td>
 +
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 +
</tr>
 +
</table> <!-- END Nav Buttons Table -->
  
−
<table cellpadding="4" bgcolor=#ffffff>
+
<table width=1000 cellpadding=2 bgcolor=#ffffff>
 
<tr valign="top">
 
<tr valign="top">
−
<td width="58">[[file:binoculars.PNG|link=]]</td>
+
<td width=60 rowspan=4>[[image:magnifier.png|link=]]</td>
−
<td width="640"><span style="font-size: 17px;">'''The Scenario:'''</span><br>
+
<td><span style="font-weight: 700; font-size: 17px;">The Scenario:</span></td>
−
----</td>
+
 
</tr>
 
</tr>
−
</table>
 
−
A '''Message Popup''' is activated by a track trigger event and is automatically closed by a timed event.
 
−
<br><br>
 
−
<table cellpadding="4" bgcolor=#ffffff>
 
 
<tr valign="top">
 
<tr valign="top">
−
<td width="58">[[file:RulesWiki.PNG|link=]]</td>
+
<!-- <td>&#160;</td> -->
−
<td width="640"><span style="font-size: 17px;">'''Rules Used:'''</span><br>
+
<td>A '''Message Popup''' is activated by a track trigger event and is automatically closed by a timed event</td>
−
----</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
−
*'''[[Session_Rule_List_with_Parameters#Trigger_Check_Rule|Trigger Check Rule]]''' to trigger the message event.
 
−
*'''[[Session_Rule_List_with_Parameters#Simultaneous_List_Rule|Simultaneous List Rule]]''' to force all child rules to be executed at the same time.
 
−
*'''[[Session_Rule_List_with_Parameters#Message_Popup_Rule|Message Popup Rule]]''' to open a message window on the screen.
 
−
*'''[[Session_Rule_List_with_Parameters#Wait_Rule|Wait Rule]]''' to wait a set time interval.
 
−
*'''[[Session_Rule_List_with_Parameters#Close Message Popup Rule|Close Message Popup Rule]]''' to close the message window.
 
 
<br>
 
<br>
−
<table cellpadding="4" bgcolor=#ffffff>
+
<table width=1000 cellpadding=2 bgcolor=#ffffff>
 
<tr valign="top">
 
<tr valign="top">
−
<td width="58">[[file:screenshot.PNG|link=]]</td>
+
<td width=60 rowspan=2>[[image:RulesWiki.PNG|link=]]</td>
−
<td width="640"><span style="font-size: 17px;">'''Session Editor Screenshot:'''</span><br>
+
<td><span style="font-size: 17px;">'''Rules Used:'''</span></td>
−
----</td>
+
 
</tr>
 
</tr>
−
</table>
+
<tr valign="top">
 +
<!-- <td>&#160;</td> -->
 +
<td>
 
<table>
 
<table>
−
<tr>
+
<tr valign="top">
−
<td>[[file:Message_Popup.jpg|link=]]</td>
+
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>'''[[Session_Rule_List_with_Parameters#Trigger_Check_Rule|Trigger Check Rule]]''' to trigger the message event</td>
 +
</tr>
 +
<tr valign="top">
 +
<td widht=10>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>'''[[Session_Rule_List_with_Parameters#Simultaneous_List_Rule|Simultaneous List Rule]]''' to force all child rules to be executed at the same time</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>'''[[Session_Rule_List_with_Parameters#Message_Popup_Rule|Message Popup Rule]]''' to open a message window on the screen</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>'''[[Session_Rule_List_with_Parameters#Wait_Rule|Wait Rule]]''' to wait a set time interval</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>'''[[Session_Rule_List_with_Parameters#Close Message Popup Rule|Close Message Popup Rule]]''' to close the message window</td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
−
<table cellpadding="4" bgcolor=#ffffff>
+
<table width=1000 cellpadding=2 bgcolor=#ffffff>
 
<tr valign="top">
 
<tr valign="top">
−
<td width="58">[[file:explanation.PNG|link=]]</td>
+
<td width=60 rowspan=2>[[image:screenshot.PNG|link=]]</td>
−
<td width="640"><span style="font-size: 17px;">'''Description:'''</span><br>
+
<td><span style="font-size: 17px;">'''Session Editor Screenshot:'''</span></td>
−
----</td>
+
</tr>
 +
<tr valign="top">
 +
<!-- <td>&#160;</td> -->
 +
<td>[[image:Message_Popup.jpg|link=]]</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
−
*'''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.
 
 
<br>
 
<br>
−
 
+
<table width=1000 cellpadding=2 bgcolor=#ffffff>
−
='''Application 2: Navigation Point and Train Stopped Event Message'''=
+
−
 
+
−
<table cellpadding="4" bgcolor=#ffffff>
+
 
<tr valign="top">
 
<tr valign="top">
−
<td width="58">[[file:binoculars.PNG|link=]]</td>
+
<td width=60 rowspan=2>[[image:explanation.PNG|link=]]</td>
−
<td width="640"><span style="font-size: 17px;">'''The Scenario:'''</span><br>
+
<td><span style="font-size: 17px;">'''Description:'''</span></td>
−
----</td>
+
 
</tr>
 
</tr>
−
</table>
 
−
A '''Message Popup''' is activated by a navigation event and is automatically closed by a train stopped event.
 
−
<br><br>
 
−
<table cellpadding="4" bgcolor=#ffffff>
 
 
<tr valign="top">
 
<tr valign="top">
−
<td width="58">[[file:conditions.PNG|link=]]</td>
+
<!-- <td>&#160;</td> -->
−
<td width="640"><span style="font-size: 17px;">'''Preconditions:'''</span><br>
+
<td>'''Line''' <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;1&#160;</span>''': 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. This executes the following lines:-
−
----</td>
+
:'''Line''' <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;2&#160;</span>''': 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). This executes the following lines:-
 +
::'''Line''' <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;3&#160;</span>''':  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''' <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;4&#160;</span>''': 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. This executes the following line:-
 +
:::'''Line''' <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;5&#160;</span>''':  Close Message Popup''' The message window is closed</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
−
*'''The [[Session_Rule_List_with_Parameters#Navigation_Display_Rule|Navigation Display Rule]]''' is used to create the navigation point set.
 
 
<br>
 
<br>
−
<table cellpadding="4" bgcolor=#ffffff>
+
<table width=1000> <!-- BEGIN Nav Buttons Table NO SKIPS -->
 
<tr valign="top">
 
<tr valign="top">
−
<td width="58">[[file:RulesWiki.PNG|link=]]</td>
+
<td width=629><span id="stepNavPoint"></span>
−
<td width="640"><span style="font-size: 17px;">'''Rules Used:'''</span><br>
+
='''Application 2: Navigation Point/Train Stopped Event'''=
−
----</td>
+
</td>
 +
<td width=50>&#160;</td> <!-- Skip Down -->
 +
<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=#stepTimed|alt=Next Up|Top]]</td>
 +
<td width=75>[[image:NextDown.png|link=#bottom|alt=Next Down|Next Down]]</td>
 +
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 +
</tr>
 +
</table> <!-- END Nav Buttons Table -->
 +
 
 +
<table width=1000 cellpadding=2 bgcolor=#ffffff>
 +
<tr valign="top">
 +
<td width=60 rowspan=4>[[image:magnifier.png|link=]]</td>
 +
<td><span style="font-weight: 700; font-size: 17px;">The Scenario:</span></td>
 +
</tr>
 +
<tr valign="top">
 +
<!-- <td>&#160;</td> -->
 +
<td>A '''Message Popup''' is activated by a navigation event and is automatically closed by a train stopped event</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
−
*'''[[Session_Rule_List_with_Parameters#Wait_on_Navigation_Point_Rule|Wait on Navigation Point Rule]]''' to trigger the message event.
 
−
*'''[[Session_Rule_List_with_Parameters#Message_Popup_Rule|Message Popup Rule]]''' to open a message window on the screen.
 
−
*'''[[Session_Rule_List_with_Parameters#Wait_on_Train_Stop/Start_Rule|Wait on Train Stop/Start Rule]]''' to trigger an event when the consist stops moving.
 
−
*'''[[Session_Rule_List_with_Parameters#Close Message Popup Rule|Close Message Popup Rule]]''' to close the message window.
 
 
<br>
 
<br>
−
<table cellpadding="4" bgcolor=#ffffff>
+
<table width=1000 cellpadding=2 bgcolor=#ffffff>
 +
<tr valign="top">
 +
<td width=60 rowspan=4>[[image:conditions.PNG|link=]]</td>
 +
<td colspan=2><span style="font-size: 17px;">'''Preconditions:'''</span></td>
 +
</tr>
 +
<tr valign="top">
 +
<!-- <td>&#160;</td> -->
 +
<td>
 +
<table>
 
<tr valign="top">
 
<tr valign="top">
−
<td width="58">[[file:screenshot.PNG|link=]]</td>
+
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
−
<td width="640"><span style="font-size: 17px;">'''Session Editor Screenshot:'''</span><br>
+
<td>'''[[Session_Rule_List_with_Parameters#Navigation_Display_Rule|Navigation Display Rule]]''' to create the navigation point set</td>
−
----</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table width=1000 cellpadding=2 bgcolor=#ffffff>
 +
<tr valign="top">
 +
<td width=60 rowspan=2>[[image:RulesWiki.PNG|link=]]</td>
 +
<td><span style="font-size: 17px;">'''Rules Used:'''</span></td>
 +
</tr>
 +
<tr valign="top">
 +
<!-- <td>&#160;</td> -->
 +
<td>
 
<table>
 
<table>
−
<tr>
+
<tr valign="top">
−
<td>[[file:Message_Popup2.JPG|link=]]</td>
+
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>'''[[Session_Rule_List_with_Parameters#Navigation_Display_Rule|Navigation Display Rule]]''' to create the navigation point set (in '''Preconditions''' above)</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>'''[[Session_Rule_List_with_Parameters#Wait_on_Navigation_Point_Rule|Wait on Navigation Point Rule]]''' to trigger the message event</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>'''[[Session_Rule_List_with_Parameters#Message_Popup_Rule|Message Popup Rule]]''' to open a message window on the screen</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>'''[[Session_Rule_List_with_Parameters#Wait_on_Train_Stop/Start_Rule|Wait on Train Stop/Start Rule]]''' to trigger an event when the consist stops moving</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>'''[[Session_Rule_List_with_Parameters#Close Message Popup Rule|Close Message Popup Rule]]''' to close the message window</td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
−
<table cellpadding="4" bgcolor=#ffffff>
+
<table width=1000 cellpadding=2 bgcolor=#ffffff>
 
<tr valign="top">
 
<tr valign="top">
−
<td width="58">[[file:explanation.PNG|link=]]</td>
+
<td width=60 rowspan=2>[[image:screenshot.PNG|link=]]</td>
−
<td width="640"><span style="font-size: 17px;">'''Description:'''</span><br>
+
<td><span style="font-size: 17px;">'''Session Editor Screenshot:'''</span></td>
−
----</td>
+
</tr>
 +
<tr valign="top">
 +
<!-- <td>&#160;</td> -->
 +
<td>[[image:Message_Popup2.JPG|link=]]</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
−
*'''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.
+
<br>
−
**'''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.
+
<table width=1000 cellpadding=2 bgcolor=#ffffff>
−
**'''Line 3: Wait on Train Stop/Start''' When the consist comes to a stop then it will execute its own set of child rules.
+
<tr valign="top">
−
***'''Line 4: Close Message Popup''' The message window is closed.
+
<td width=60 rowspan=3>[[image:explanation.PNG|link=]]</td>
−
 
+
<td><span style="font-size: 17px;">'''Description:'''</span></td>
−
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>
+
</tr>
−
 
+
<tr valign="top">
−
<table cellpadding="4" bgcolor="Aquamarine">
+
<!-- <td>&#160;</td> -->
 +
<td>'''Line''' <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;1&#160;</span>''': 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. This executes the following lines:-
 +
:'''Line''' <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;2&#160;</span>''': 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''' <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;3&#160;</span>''': Wait on Train Stop/Start''' When the consist comes to a stop then it will execute its own set of child rules. This executes the following line:-
 +
::'''Line''' <span style="font-weight: 700; font-size: 15px; color: white; background-color: black;">&#160;4&#160;</span>''': Close Message Popup''' The message window is closed</td>
 +
</tr>
 +
<tr val="top">
 +
<td>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.</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table cellpadding=2 bgcolor="Aquamarine">
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[file:LinkWiki.PNG|link=]]</td>
+
<td>[[image:LinkWiki.PNG|link=]]</td>
 
<td>
 
<td>
 
Information of setting and using '''Navigation Points''' can be found on the '''Trainz Wiki Page''' at:-<br>
 
Information of setting and using '''Navigation Points''' can be found on the '''Trainz Wiki Page''' at:-<br>
Line 146: Line 259:
 
</tr>
 
</tr>
 
</table>
 
</table>
−
 
+
<table width=1000> <!-- BEGIN Nav Buttons Table -->
 +
<tr valign="top">
 +
<td width=729><span id="bottom"></span>&nbsp;</td>
 +
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>[[image:NextUp.png|link=#stepNavPoint|alt=Next Up|Top]]</td>
 +
<td width=75>&nbsp;</td>
 +
<td width=75>&nbsp;</td>
 +
</tr>
 +
</table> <!-- END Nav Buttons Table -->
 
----
 
----
 
----
 
----
−
<br>
 
  
 
='''Trainz Wiki'''=
 
='''Trainz Wiki'''=
−
<table cellpadding="4" bgcolor=#ffffff>
+
<table cellpadding=2 bgcolor=#ffffff>
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[file:TrainzWiki.png|link=]]</td>
+
<td>[[image:TrainzWiki.png|link=]]</td>
 
<td>
 
<td>
 
<span style="font-size: 17px;">'''More Tutorials and Guides to Using Trainz'''</span><br>
 
<span style="font-size: 17px;">'''More Tutorials and Guides to Using Trainz'''</span><br>
Line 164: Line 284:
 
</tr>
 
</tr>
 
</table>
 
</table>
−
 
+
----
 +
This page was created by Trainz user '''<span class="plainlinks">[http://online.ts2009.com/mediaWiki/index.php/User:Pware pware]</span>''' in April 2018 and was last updated as shown below.
 +
----
 
[[Category:How-to guides]][[Category:Rules]]
 
[[Category:How-to guides]][[Category:Rules]]

Latest revision as of 15:05, 4 October 2023

          Next Down Bottom
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:-


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


[edit] Application 1: Timed Message

     Top   Next Down Bottom
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:
DotPoint.JPG Trigger Check Rule to trigger the message event
DotPoint.JPG Simultaneous List Rule to force all child rules to be executed at the same time
DotPoint.JPG Message Popup Rule to open a message window on the screen
DotPoint.JPG Wait Rule to wait a set time interval
DotPoint.JPG Close Message Popup Rule to close the message window


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. This executes the following lines:-
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). This executes the following lines:-
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. This executes the following line:-
Line  5 : Close Message Popup The message window is closed


[edit] Application 2: Navigation Point/Train Stopped Event

     Top Next Up Next Down Bottom
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:
DotPoint.JPG Navigation Display Rule to create the navigation point set


RulesWiki.PNG Rules Used:
DotPoint.JPG Navigation Display Rule to create the navigation point set (in Preconditions above)
DotPoint.JPG Wait on Navigation Point Rule to trigger the message event
DotPoint.JPG Message Popup Rule to open a message window on the screen
DotPoint.JPG Wait on Train Stop/Start Rule to trigger an event when the consist stops moving
DotPoint.JPG Close Message Popup Rule to close the message window


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. This executes the following lines:-
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. This executes the following line:-
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    

[edit] 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=38994"
Personal tools