How to Use Message Popup Rule

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
m (→‎Using a String-Table Message)
 
(32 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
The information in this Wiki Page applies to '''TANE''', '''TRS19''' and '''Trainz Plus'''. This page describes how to configure the '''Message Popup Rule'''.
+
The information in this Wiki Page applies to '''TANE''', '''TRS19''', '''Trainz Plus''' and '''TRS22'''. This page describes how to configure the '''Message Popup Rule'''.
  
−
<table cellpadding="4" bgcolor="Aquamarine">
+
<table width=1000>
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[file:LinkWiki.PNG|link=]]</td>
+
<td width=300>
 +
__TOC__
 +
</td>
 +
<td align="center"><span style="font-weight: 700; font-size: 17px; color: white; background-color: black;">&#160;Workflow Diagram&#160;</span><br>
 +
[[image:MessagePopupWorkflow.png|link=|alt=Workflow diagram]]</td>
 
<td>
 
<td>
−
For examples of how to use this rule in Sessions see the '''Trainz Wiki Page''' at:-<br>
+
<table cellpadding=2 bgcolor="Aquamarine">
−
* '''[[How to Use Message Popup Rule (Applications)]]'''
+
<tr valign="top">
 +
<td>[[image:LinkWiki.PNG|link=]]</td>
 +
<td>
 +
For more information on creating a '''HTML Asset''' see the '''Trainz Wiki Page''' at:-<br>
 +
* '''[[How to Create a HTML Asset]]'''</td>
 +
</tr>
 +
</table>
 
</td>
 
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
−
<br>
+
<table> <!-- BEGIN Nav Buttons Table -->
 +
<tr valign="top">
 +
<td width=729><span id="stepNewAsset"></span>&nbsp;</td>
 +
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>&#160;</td>
 +
<td width=75>[[image:NextDown.png|link=#stepCustom|alt=Next Down|Next Down]]</td>
 +
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 +
</tr>
 +
</table> <!-- END Nav Buttons Table -->
  
−
__TOC__
+
='''Add a Message Popup Rule'''=
−
<br>
+
  
−
<table cellpadding="4" bgcolor=#c1e7e7>
+
<table width=1000 bgcolor="lightcyan" cellpadding=2>
 
<tr valign="top">
 
<tr valign="top">
−
<td colspan=2><span style="font-size: 17px; font-weight: 700;">In Summary:</span></td>
+
<td width=10>[[image:BlueDot10x10.png|link=]]</td>
−
</tr>
+
−
<tr valign="top">
+
−
<td>[[file:DotPoint.JPG|link=]]</td>
+
 
<td>The '''[[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>
 
<td>The '''[[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>
 +
</table>
 +
<br>
 +
<table width=1000>
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[file:DotPoint.JPG|link=]]</td>
+
<td>The '''Message Popup Rule''' is added to a Session and configured using the [[image:WikiLink.PNG|link=]] '''[[How to Use Session Editor|Session Editor]]''' in Surveyor. The rule will open a browser window on the screen in Driver Mode that will remain on the screen until it is closed by the user or by another rule.</td>
−
<td>The rule provides you with three different ways of creating an onscreen message:-
+
−
*a simple (custom) '''text message with an optional graphic'''
+
−
*a full '''HTML (web) page'''
+
−
*a '''string table''' entry in a '''config.txt''' file</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
−
The '''Message Popup Rule''' is added to a Session and configured using the [[file:WikiLink.PNG|link=]] '''[[How to Use Session Editor|Session Editor]]''' in Surveyor. The rule will open a browser window on the screen in Driver Mode that will remain on the screen until it is closed by the user or by another rule. There are three ways the message window can be created.
+
<table bgcolor=#000000 cellpadding=2>
−
:# using a '''HTML Page'''
+
−
:# creating a '''Custom Message'''
+
−
:# using a '''String Table Message'''
+
−
 
+
−
='''Using a HTML Page'''=
+
−
 
+
−
The settings shown in this example will direct Trainz to load the message from a HTML file in a HTML asset.
+
−
 
+
−
<table>
+
−
<tr>
+
−
<td valign="top">[[file:MessagePopup1.JPG|link=]]<br><br>
+
−
<table cellpadding="4" bgcolor="Aquamarine">
+
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[file:LinkWiki.PNG|link=]]</td>
 
 
<td>
 
<td>
−
For more information, see the '''Trainz Wiki Page''' at:-<br>
+
<table bgcolor=#ffffff cellpadding=2>
−
* '''[[How to Create a HTML Asset]]'''</td>
+
<tr valign="top">
 +
<td colspan=2>There are three ways the message window can be created:-<br>
 +
<span style="font-weight: 700; font-size: 15px;">Options:</span> Choose one of:-</td>
 
</tr>
 
</tr>
−
</table></td>
+
<tr valign="top">
−
<td valign="top">
+
<td width=25>[[image:Ablue.png|link=]]</td>
−
<table cellpadding="4" bgcolor=#eeeeee>
+
<td>with a '''Custom Message''' - the quickest and easiest method, <span style="font-weight: 700; font-size: 15px;">OR</span></td>
−
<tr>
+
−
<td colspan="2">
+
−
----</td>
+
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[file:Gears.PNG|link=]]</td>
+
<td>[[image:Bblue.png|link=]]</td>
−
<td><span style="font-size: 17px;">'''Settings:'''</span><br>
+
<td>with a '''HTML (Web) Page''' - the most complicated method but it often gives the best results, <span style="font-weight: 700; font-size: 15px;">OR</span></td>
−
[[file:PortalOptionButtonFilled.PNG|link=]] '''A pre-defined HTML page (advanced)'''<br>
+
−
'''In This Example:'''<br>
+
−
:[[file:CheckBox.PNG|link=]] '''Pause game while message is displayed''' - this will halt the game play until the window is closed. This may be needed if you have a long introductory HTML information page, otherwise leave unchecked
+
−
:[[file:CheckBox.PNG|link=]] '''Close previous message popup windows''' - this is usually a good idea unless you want multiple message windows open.
+
−
:'''Message location:''' '''<span style="text-decoration: underline;">Top left</span>''' of the screen has been chosen as the location for the message window. Other positions are '''Top right''', '''Bottom left''' and '''Bottom right'''
+
−
:'''HTML Asset:''' '''<span style="text-decoration: underline;">General Purpose Session HTML</span>''' one of the HTML assets installed with '''Trainz'''
+
−
:'''HTML Page:''' '''<span style="text-decoration: underline;">right_away.html</span>''' which is a HTML file inside the '''<span style="text-decoration: underline;">General Purpose Session HTML</span>''' asset
+
−
:'''HTML Wave:''' '''<span style="text-decoration: underline;">General Purpose Session HTML</span>''' HTML asset contains the ''optional'' sound file to be played
+
−
:'''Wav Name:''' '''<span style="text-decoration: underline;">all-aboard.wav</span>''' is the ''optional'' sound file to be played
+
−
:[[file:CheckBox.PNG|link=]] '''Autoplay Wav''' - the sound will be played when the page is displayed</td>
+
 
</tr>
 
</tr>
−
<tr>
+
<tr valign="top">
−
<td colspan="2">
+
<td>[[image:Cblue.png|link=]]</td>
−
----</td>
+
<td>with a '''String Table Message'''</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
−
<table cellpadding="4" bgcolor=#ffffb0>
+
</td>
−
<tr valign="top">
+
−
<td>[[file:NotePad.PNG|link=]]</td>
+
−
<td><span style="font-size: 17px;">'''Notes:'''</span><br>
+
−
*Knowledge of HTML, as used by Trainz, will '''probably''' be required for this option.
+
−
*The HTML page (with filename extension ".html") must be in a Trainz asset of type HTML.
+
−
*Graphics and a limited set of HTML effects are possible.
+
−
*The sound file settings '''HTML Wave''' and '''Wave Name''' are optional.
+
−
*If a sound file is to be played when the message is displayed then it must be of type WAV (with filename extension ".wav") and must be in a Trainz asset of type HTML. It does not have to be in the same HTML asset as the HTML page.</td>
+
−
</tr>
+
−
</table></td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
−
<table width="100%">
+
<table> <!-- BEGIN Nav Buttons Table -->
 
<tr valign="top">
 
<tr valign="top">
−
<td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
+
<td width=729><span id="stepCustom"></span>&nbsp;</td>
 +
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>[[image:NextUp.png|link=#stepNewAsset|alt=Next Up|Top]]</td>
 +
<td width=75>[[image:NextDown.png|link=#stepHTML|alt=Next Down|Next Down]]</td>
 +
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 
</tr>
 
</tr>
−
</table>
+
</table> <!-- END Nav Buttons Table -->
  
 
='''Using a Custom Message'''=
 
='''Using a Custom Message'''=
Line 101: Line 84:
 
The settings shown in this example will direct '''Trainz''' to load the message from text entered in the Custom Message box.
 
The settings shown in this example will direct '''Trainz''' to load the message from text entered in the Custom Message box.
  
 +
<table width=1000>
 +
<tr valign="top">
 +
<td>[[image:MessagePopup3.JPG|link=]]</td>
 +
<td>
 +
<table bgcolor=#000000 cellpadding=2>
 +
<tr valign="top">
 +
<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 valign="top">
 +
<td colspan=2>
 
<table>
 
<table>
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[file:MessagePopup3.JPG|link=]]</td>
+
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>No knowledge of HTML is required for this option</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>You can select and display an optional icon with the message</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>You are no longer limited in the number of lines of text you can add. Although the popup window will only show 7 lines, a vertical scroll bar will appear for longer messages</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>Text only can be entered (box cannot be left blank). Some HTML markup is acceptable, for example <i>italic</i> and <b>bold</b> tags</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table cellpadding=2 bgcolor="Aquamarine">
 +
<tr valign="top">
 +
<td>[[image:LinkWiki.PNG|link=]]</td>
 
<td>
 
<td>
−
<table cellpadding="4" bgcolor=#eeeeee>
+
For more information, see the '''Trainz Wiki Page''' at:-<br>
 +
* '''[[How to Create a HTML Asset]]'''</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table width=1000 cellpadding=2 bgcolor=#eeeeee>
 
<tr>
 
<tr>
 
<td colspan="2">
 
<td colspan="2">
Line 111: Line 143:
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[file:Gears.PNG|link=]]</td>
+
<td>[[image:Gears.PNG|link=]]</td>
−
<td><span style="font-size: 17px;">'''Settings:'''</span><br>
+
<td><span style="font-size: 17px;">'''Settings:'''</span> Shown in the example above:-<br>
−
[[file:PortalOptionButtonFilled.PNG|link=]] '''Custom text'''<br>
+
[[image:PortalOptionButtonFilled.PNG|link=]] '''Custom text'''
−
'''In This Example:'''
+
<table>
−
:[[file:CheckBoxOff.PNG|link=]] '''Pause game while message is displayed''' - game play will not be paused
+
<tr valign="top">
−
:[[file:CheckBox.PNG|link=]] '''Close previous message popup windows''' - this is usually a good idea unless you want multiple message windows open
+
<td>[[image:CheckBoxOff.PNG|link=]] '''Pause game while message is displayed''' - game play will not be paused</td>
−
:'''Message location:''' '''<span style="text-decoration: underline;">Top left</span>''' of the screen has been chosen as the location for the message window. Other positions are '''Top right''', '''Bottom left''' and '''Bottom right'''
+
−
:'''Custom Message''' - the message entered into the text box will be displayed
+
−
:'''Icon''' - the selected ''optional'' icon will be displayed
+
−
:No optional sound has been added</td>
+
 
</tr>
 
</tr>
−
<tr>
+
<tr valign="top">
−
<td colspan="2">
+
<td>[[image:CheckBox.PNG|link=]] '''Close previous message popup windows''' - this is usually a good idea unless you want multiple message windows open</td>
−
----</td>
+
 
</tr>
 
</tr>
−
</table>
 
−
 
−
<table cellpadding="4" bgcolor=#ffffb0>
 
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[file:NotePad.PNG|link=]]</td>
+
<td>[[image:BlackDot10x10.png|link=]] '''Message location:''' '''<span style="text-decoration: underline;">Top left</span>''' of the screen has been chosen as the location for the message window. Other positions are '''Top right''', '''Bottom left''' and '''Bottom right'''</td>
−
<td><span style="font-size: 17px;">'''Notes:'''</span><br>
+
−
*No knowledge of HTML is required for this option.
+
−
*You are limited to about 6 lines of text.
+
−
*Text only can be entered (there '''must''' be text added - it cannot be left blank).
+
−
*You can select and display an optional icon with the message.</td>
+
 
</tr>
 
</tr>
−
</table><br>
 
−
<table cellpadding="4" bgcolor="Aquamarine">
 
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[file:LinkWiki.PNG|link=]]</td>
+
<td>[[image:BlackDot10x10.png|link=]] '''Custom Message''' - the message entered into the text box will be displayed</td>
−
<td>
+
−
For more information, see the '''Trainz Wiki Page''' at:-<br>
+
−
* '''[[How to Create a HTML Asset]]'''</td>
+
 
</tr>
 
</tr>
−
</table></td>
+
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]] '''Icon''' - the selected ''optional'' icon will be displayed</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]] No optional sound has been added</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 +
</td>
 +
</tr>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
</table>
 +
<br>
 
<table>
 
<table>
 
<tr>
 
<tr>
−
<td>[[file:MessagePopup2a.JPG|link=]]</td>
+
<td>[[image:MessagePopup2a.JPG|link=]]</td>
 
<td>The custom message popup created by the example shown above</td>
 
<td>The custom message popup created by the example shown above</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
−
<table cellpadding="4" bgcolor=#ffffb0>
+
<table bgcolor=#000000>
 +
<tr valign="top">
 +
<td>
 +
<table bgcolor=#ffffe0>
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[file:PencilTips.PNG|link=]]</td>
+
<td>[[image:PencilTips.PNG|link=]]</td>
 
<td>To find additional graphic icons that can be added to the '''Message Popup''' window, use '''Content Manager''' and set a '''Custom Filter''' to search for:-
 
<td>To find additional graphic icons that can be added to the '''Message Popup''' window, use '''Content Manager''' and set a '''Custom Filter''' to search for:-
−
*'''Category''' select '''Texture- Not Environmental'''
+
<table>
−
*'''Name''' type '''icon'''
+
<tr valign="top">
−
*'''On Download Station''' select '''True'''
+
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
−
Not all those shown will be suitable. Double click a possible icon to display its details before downloading.</td>
+
<td>'''Category''' select '''Texture- Not Environmental'''</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>'''Name''' type '''icon'''</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>'''On Download Station''' select '''True'''</td>
 +
</tr>
 +
<tr valign="top">
 +
<td colspan=2>Not all those shown will be suitable. <span style="font-weight: 700; font-size: 15px; background-color: lightcyan;">Double Left Click</span> on a possible icon to display its details before downloading</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
−
<table cellpadding="4" bgcolor="Aquamarine">
+
<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>
 
For information on how to create your own '''Message Popup Icons''', see the '''Trainz Wiki Page''' at:-<br>
 
For information on how to create your own '''Message Popup Icons''', see the '''Trainz Wiki Page''' at:-<br>
Line 174: Line 220:
 
</tr>
 
</tr>
 
</table>
 
</table>
−
<br>
+
 
−
<table width="100%">
+
<table> <!-- BEGIN Nav Buttons Table -->
 
<tr valign="top">
 
<tr valign="top">
−
<td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
+
<td width=729><span id="stepHTML"></span>&nbsp;</td>
 +
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>[[image:NextUp.png|link=#stepCustom|alt=Next Up|Top]]</td>
 +
<td width=75>[[image:NextDown.png|link=#stepString|alt=Next Down|Next Down]]</td>
 +
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 
</tr>
 
</tr>
−
</table>
+
</table> <!-- END Nav Buttons Table -->
  
−
='''Using a String-Table Message'''=
+
='''Using a HTML Page'''=
  
−
The settings shown in this example will direct '''Trainz''' to load the message from text stored in the '''config.txt''' string table of a specified HTML asset.
+
The settings shown in this example will direct Trainz to load the message from a HTML file in a HTML asset.
  
−
<table>
+
<table width=1000>
 +
<tr>
 +
<td valign="top">[[image:MessagePopup1.JPG|link=]]</td>
 +
<td valign="top">
 +
<table bgcolor=#000000 cellpadding=2>
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[file:MessagePopup4.JPG|link=]]</td>
 
 
<td>
 
<td>
−
<table cellpadding="4" bgcolor=#eeeeee>
+
<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 valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>Knowledge of HTML, as used by Trainz, will '''probably''' be required for this option</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>The HTML page (with filename extension ".html") must be in a Trainz asset of type HTML</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>Graphics and a limited set of HTML effects are possible</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>The sound file settings '''HTML Wave''' and '''Wave Name''' are optional</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>If a sound file is to be played when the message is displayed then it must be of type WAV (with filename extension ".wav") and must be in a Trainz asset of type HTML. It does not have to be in the same HTML asset as the HTML page</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table cellpadding=2 bgcolor="Aquamarine">
 +
<tr valign="top">
 +
<td>[[image:LinkWiki.PNG|link=]]</td>
 +
<td>
 +
For more information, see the '''Trainz Wiki Page''' at:-<br>
 +
* '''[[How to Create a HTML Asset]]'''</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table width=1000 cellpadding=2 bgcolor=#eeeeee>
 
<tr>
 
<tr>
 
<td colspan="2">
 
<td colspan="2">
Line 195: Line 292:
 
</tr>
 
</tr>
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[file:Gears.PNG|link=]]</td>
+
<td>[[image:Gears.PNG|link=]]</td>
−
<td><span style="font-size: 17px;">'''Settings:'''</span><br>
+
<td><span style="font-size: 17px;">'''Settings:'''</span> Shown in the example above:-
−
[[file:PortalOptionButtonFilled.PNG|link=]] '''A pre-defined string-table entry from a HTML asset (advanced)'''<br>
+
<table>
−
'''In This Example:'''
+
<tr valign="top">
−
:[[file:CheckBoxOff.PNG|link=]] '''Pause game while message is displayed''' - game play will not be paused
+
<td>[[image:PortalOptionButtonFilled.PNG|link=]] '''A pre-defined HTML page (advanced)'''</td>
−
:[[file:CheckBox.PNG|link=]] '''Close previous message popup windows''' - this is usually a good idea unless you want multiple message windows open
+
</tr>
−
:'''Message location:''' '''<span style="text-decoration: underline;">Top left</span>''' of the screen has been chosen as the location for the message window. Other positions are '''Top right''', '''Bottom left''' and '''Bottom right'''
+
<tr valign="top">
−
:'''HTML Asset:''' '''<span style="text-decoration: underline;">General Purpose Session HTML</span>''' one of the HTML assets installed with '''Trainz'''
+
<td>[[image:CheckBox.PNG|link=]] '''Pause game while message is displayed''' - this will halt the game play until the window is closed. This may be needed if you have a long introductory HTML information page, otherwise leave unchecked</td>
−
:'''String Table Token:''' '''<span style="text-decoration: underline;">html_warning_late</span>''' the string table '''token''' in the config.txt file of the '''<span style="text-decoration: underline;">General Purpose Session HTML</span>''' asset contains the message to be displayed
+
</tr>
−
:'''HTML Wave:''' '''<span style="text-decoration: underline;">General Purpose Session HTML</span>''' HTML asset contains the ''optional'' sound file to be played
+
<tr valign="top">
−
:'''Wav Name:''' '''<span style="text-decoration: underline;">all-aboard.wav</span>''' is the ''optional'' sound file to be played
+
<td>[[image:CheckBox.PNG|link=]] '''Close previous message popup windows''' - this is usually a good idea unless you want multiple message windows open</td>
−
:[[file:CheckBox.PNG|link=]] '''Autoplay Wav''' - the sound will be played when the page is displayed</td>
+
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]] '''Message location:''' '''<span style="text-decoration: underline;">Top left</span>''' of the screen has been chosen as the location for the message window. Other positions are '''Top right''', '''Bottom left''' and '''Bottom right'''</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]] '''HTML Asset:''' '''<span style="text-decoration: underline;">General Purpose Session HTML</span>''' one of the HTML assets installed with '''Trainz'''</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]] '''HTML Page:''' '''<span style="text-decoration: underline;">right_away.html</span>''' which is a HTML file inside the '''<span style="text-decoration: underline;">General Purpose Session HTML</span>''' asset</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]] '''HTML Wave:''' '''<span style="text-decoration: underline;">General Purpose Session HTML</span>''' HTML asset contains the ''optional'' sound file to be played</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]] '''Wav Name:''' '''<span style="text-decoration: underline;">all-aboard.wav</span>''' is the ''optional'' sound file to be played</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:CheckBox.PNG|link=]] '''Autoplay Wav''' - the sound will be played when the page is displayed</td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>
Line 214: Line 331:
 
</table>
 
</table>
  
−
<table cellpadding="4" bgcolor=#ffffb0>
+
<table> <!-- BEGIN Nav Buttons Table -->
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[file:NotePad.PNG|link=]]</td>
+
<td width=729><span id="stepString"></span>&nbsp;</td>
 +
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>[[image:NextUp.png|link=#stepHTML|alt=Next Up|Top]]</td>
 +
<td width=75>[[image:NextDown.png|link=#stepAlt|alt=Next Down|Next Down]]</td>
 +
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 +
</tr>
 +
</table> <!-- END Nav Buttons Table -->
 +
 
 +
='''Using a String-Table Message'''=
 +
 
 +
The settings shown in this example will direct '''Trainz''' to load the message from text stored in the '''config.txt''' string table of a specified HTML asset.
 +
 
 +
<table width=1000>
 +
<tr valign="top">
 +
<td>[[image:MessagePopup4.JPG|link=]]</td>
 +
<td>
 +
<table bgcolor=#000000 cellpadding=2>
 +
<tr valign="top">
 +
<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><span style="font-size: 17px;">'''Notes:'''</span><br>
−
*The '''config.txt''' file of the HTML asset must have a '''string-table''' container which holds all the text messages to be displayed.
+
----
−
*The '''string-table token''' is the "tag" which identifies the message text in the '''config.txt''' file.</td>
+
</td>
 +
</tr>
 +
<tr valign="top">
 +
<td width=10>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>The '''config.txt''' file of the HTML asset must have a '''string-table''' container which holds all the text messages to be displayed</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:DotPoint.JPG|10px|link=]]</td>
 +
<td>The '''string-table token''' is the "tag" which identifies the message text in the '''config.txt''' file</td>
 +
</tr>
 +
</table>
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
Line 226: Line 375:
 
</table>
 
</table>
 
<br>
 
<br>
 +
<table width=1000 cellpadding=2 bgcolor=#eeeeee>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:Gears.PNG|link=]]</td>
 +
<td><span style="font-size: 17px;">'''Settings:'''</span> Shown in the example above:-
 +
<table>
 +
<tr valign="top">
 +
<td>[[image:PortalOptionButtonFilled.PNG|link=]] '''A pre-defined string-table entry from a HTML asset (advanced)'''</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:CheckBoxOff.PNG|link=]] '''Pause game while message is displayed''' - game play will not be paused</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:CheckBox.PNG|link=]] '''Close previous message popup windows''' - this is usually a good idea unless you want multiple message windows open</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]] '''Message location:''' '''<span style="text-decoration: underline;">Top left</span>''' of the screen has been chosen as the location for the message window. Other positions are '''Top right''', '''Bottom left''' and '''Bottom right'''</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]] '''HTML Asset:''' '''<span style="text-decoration: underline;">General Purpose Session HTML</span>''' one of the HTML assets installed with '''Trainz'''</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]] '''String Table Token:''' '''<span style="text-decoration: underline;">html_warning_late</span>''' the string table '''token''' in the config.txt file of the '''<span style="text-decoration: underline;">General Purpose Session HTML</span>''' asset contains the message to be displayed</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]] '''HTML Wave:''' '''<span style="text-decoration: underline;">General Purpose Session HTML</span>''' HTML asset contains the ''optional'' sound file to be played</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:BlackDot10x10.png|link=]] '''Wav Name:''' '''<span style="text-decoration: underline;">all-aboard.wav</span>''' is the ''optional'' sound file to be played</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:CheckBox.PNG|link=]] '''Autoplay Wav''' - the sound will be played when the page is displayed</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
</table>
 
For example, the '''config.txt''' file of the asset '''General Purpose Session HTML''' contains the following:-
 
For example, the '''config.txt''' file of the asset '''General Purpose Session HTML''' contains the following:-
 
  '''string-table'''
 
  '''string-table'''
Line 233: Line 426:
 
...which will produce the message "'''You are running late!'''" from the '''Message Popup Rule''' settings shown above.
 
...which will produce the message "'''You are running late!'''" from the '''Message Popup Rule''' settings shown above.
 
<br>
 
<br>
−
<table cellpadding="4" bgcolor="Aquamarine">
+
<table> <!-- BEGIN Nav Buttons Table -->
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[file:LinkWiki.PNG|link=]]</td>
+
<td width=729><span id="stepAlt"></span>&nbsp;</td>
−
<td>
+
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
−
For more information, see the '''Trainz Wiki Page''' at:-<br>
+
<td width=75>[[image:NextUp.png|link=#stepString|alt=Next Up|Top]]</td>
−
* '''[[How to Create a HTML Asset]]'''</td>
+
<td width=75>&#160;</td>
 +
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 
</tr>
 
</tr>
−
</table>
+
</table> <!-- END Nav Buttons Table -->
−
<br>
+
−
<table width="100%">
+
−
<tr valign="top">
+
−
<td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
+
−
</tr>
+
−
</table>
+
  
 
='''Alternatives to the Message Popup Rule'''=
 
='''Alternatives to the Message Popup Rule'''=
−
<table cellpadding="4" bgcolor=#ffffff>
+
<table width=1000 cellpadding=2 bgcolor=#ffffff>
 
<tr valign="top">
 
<tr valign="top">
−
<td width="58">[[file:RulesWiki.PNG|link=]]</td>
+
<td width=60>[[image:RulesWiki.PNG|link=]]</td>
−
<td width="640">
+
<td>There are other HTML message window rules that are alternatives to the '''Message Popup''' rule. A few possibilities are:-
−
There are other HTML message window rules that are alternatives to the '''Message Popup''' rule. A few possibilities are:-</td>
+
−
</tr>
+
−
</table>
+
 
*'''[[Session_Rule_List_with_Parameters#Display_HTML_Pages_Rule|Display HTML Pages Rule]]'''
 
*'''[[Session_Rule_List_with_Parameters#Display_HTML_Pages_Rule|Display HTML Pages Rule]]'''
−
*'''[[Session_Rule_List_with_Parameters#Timed_Limited_Display_HTML_Rule_(SP2_and_later)|Timed Limited Display HTML Rule (SP2 and later)]]'''
+
*'''[[Session_Rule_List_with_Parameters#Timed_Limited_Display_HTML_Rule_(SP2_and_later)|Timed Limited Display HTML Rule (SP2 and later)]]'''</td>
−
<br>
+
−
='''Related Links'''=
+
−
 
+
−
<table cellpadding="4" bgcolor=#ffffff>
+
−
<tr valign="top">
+
−
<td>[[file:LinkWiki.PNG|link=]]</td>
+
−
<td>
+
−
*'''[[How to Create a HTML Asset]]'''
+
−
*'''[[How to Create a Message Popup Icon]]'''
+
−
*'''[[How to Use Session Editor|Using the Session Editor]]'''
+
−
</td>
+
 
</tr>
 
</tr>
 
</table>
 
</table>
 
<br>
 
<br>
−
<table width="100%">
+
<table> <!-- BEGIN Nav Buttons Table -->
 
<tr valign="top">
 
<tr valign="top">
−
<td align="right">[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
+
<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=#stepAlt|alt=Next Up|Top]]</td>
 +
<td width=75>&nbsp;</td>
 +
<td width=75>&nbsp;</td>
 
</tr>
 
</tr>
−
</table>
+
</table> <!-- END Nav Buttons Table -->
 
----
 
----
 
----
 
----
−
 
 
='''Trainz Wiki'''=
 
='''Trainz Wiki'''=
−
<table cellpadding="4" bgcolor=#ffffff>
+
<table width=1000>
 
<tr valign="top">
 
<tr valign="top">
−
<td>[[file:TrainzWiki.png|link=]]</td>
+
<td>
 +
<table width=500 cellpadding=2 bgcolor=#ffffff>
 +
<tr valign="top">
 +
<td width=80>[[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 293: Line 473:
 
</tr>
 
</tr>
 
</table>
 
</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 Message Popup Rule (Applications)]]'''
 +
* '''[[How to Use Session Editor|Session Editor]]'''
 +
* '''[[How to Create a HTML Asset]]'''
 +
* '''[[How to Create a Message Popup Icon]]'''</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</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 07:04, 22 November 2023

The information in this Wiki Page applies to TANE, TRS19, Trainz Plus and TRS22. This page describes how to configure the Message Popup Rule.

Contents

  Workflow Diagram 
Workflow diagram
LinkWiki.PNG

For more information on creating a HTML Asset see the Trainz Wiki Page at:-
  Top   Next Down Bottom

[edit] Add a Message Popup Rule

BlueDot10x10.png The Message Popup Rule is a Trainz Session Rule that creates onscreen messages for users in Driver Mode.


The Message Popup Rule is added to a Session and configured using the WikiLink.PNG Session Editor in Surveyor. The rule will open a browser window on the screen in Driver Mode that will remain on the screen until it is closed by the user or by another rule.


There are three ways the message window can be created:-
Options: Choose one of:-
Ablue.png with a Custom Message - the quickest and easiest method, OR
Bblue.png with a HTML (Web) Page - the most complicated method but it often gives the best results, OR
Cblue.png with a String Table Message


  Top Next Up Next Down Bottom

[edit] Using a Custom Message

The settings shown in this example will direct Trainz to load the message from text entered in the Custom Message box.

MessagePopup3.JPG
NotePad.PNG Notes:
DotPoint.JPG No knowledge of HTML is required for this option
DotPoint.JPG You can select and display an optional icon with the message
DotPoint.JPG You are no longer limited in the number of lines of text you can add. Although the popup window will only show 7 lines, a vertical scroll bar will appear for longer messages
DotPoint.JPG Text only can be entered (box cannot be left blank). Some HTML markup is acceptable, for example italic and bold tags


LinkWiki.PNG

For more information, see the Trainz Wiki Page at:-


Gears.PNG Settings: Shown in the example above:-

PortalOptionButtonFilled.PNG Custom text

CheckBoxOff.PNG Pause game while message is displayed - game play will not be paused
CheckBox.PNG Close previous message popup windows - this is usually a good idea unless you want multiple message windows open
BlackDot10x10.png Message location: Top left of the screen has been chosen as the location for the message window. Other positions are Top right, Bottom left and Bottom right
BlackDot10x10.png Custom Message - the message entered into the text box will be displayed
BlackDot10x10.png Icon - the selected optional icon will be displayed
BlackDot10x10.png No optional sound has been added


MessagePopup2a.JPG The custom message popup created by the example shown above


PencilTips.PNG To find additional graphic icons that can be added to the Message Popup window, use Content Manager and set a Custom Filter to search for:-
DotPoint.JPG Category select Texture- Not Environmental
DotPoint.JPG Name type icon
DotPoint.JPG On Download Station select True
Not all those shown will be suitable. Double Left Click on a possible icon to display its details before downloading


LinkWiki.PNG

For information on how to create your own Message Popup Icons, see the Trainz Wiki Page at:-
  Top Next Up Next Down Bottom

[edit] Using a HTML Page

The settings shown in this example will direct Trainz to load the message from a HTML file in a HTML asset.

MessagePopup1.JPG
NotePad.PNG Notes:
DotPoint.JPG Knowledge of HTML, as used by Trainz, will probably be required for this option
DotPoint.JPG The HTML page (with filename extension ".html") must be in a Trainz asset of type HTML
DotPoint.JPG Graphics and a limited set of HTML effects are possible
DotPoint.JPG The sound file settings HTML Wave and Wave Name are optional
DotPoint.JPG If a sound file is to be played when the message is displayed then it must be of type WAV (with filename extension ".wav") and must be in a Trainz asset of type HTML. It does not have to be in the same HTML asset as the HTML page


LinkWiki.PNG

For more information, see the Trainz Wiki Page at:-


Gears.PNG Settings: Shown in the example above:-
PortalOptionButtonFilled.PNG A pre-defined HTML page (advanced)
CheckBox.PNG Pause game while message is displayed - this will halt the game play until the window is closed. This may be needed if you have a long introductory HTML information page, otherwise leave unchecked
CheckBox.PNG Close previous message popup windows - this is usually a good idea unless you want multiple message windows open
BlackDot10x10.png Message location: Top left of the screen has been chosen as the location for the message window. Other positions are Top right, Bottom left and Bottom right
BlackDot10x10.png HTML Asset: General Purpose Session HTML one of the HTML assets installed with Trainz
BlackDot10x10.png HTML Page: right_away.html which is a HTML file inside the General Purpose Session HTML asset
BlackDot10x10.png HTML Wave: General Purpose Session HTML HTML asset contains the optional sound file to be played
BlackDot10x10.png Wav Name: all-aboard.wav is the optional sound file to be played
CheckBox.PNG Autoplay Wav - the sound will be played when the page is displayed
  Top Next Up Next Down Bottom

[edit] Using a String-Table Message

The settings shown in this example will direct Trainz to load the message from text stored in the config.txt string table of a specified HTML asset.

MessagePopup4.JPG
NotePad.PNG Notes:
DotPoint.JPG The config.txt file of the HTML asset must have a string-table container which holds all the text messages to be displayed
DotPoint.JPG The string-table token is the "tag" which identifies the message text in the config.txt file


Gears.PNG Settings: Shown in the example above:-
PortalOptionButtonFilled.PNG A pre-defined string-table entry from a HTML asset (advanced)
CheckBoxOff.PNG Pause game while message is displayed - game play will not be paused
CheckBox.PNG Close previous message popup windows - this is usually a good idea unless you want multiple message windows open
BlackDot10x10.png Message location: Top left of the screen has been chosen as the location for the message window. Other positions are Top right, Bottom left and Bottom right
BlackDot10x10.png HTML Asset: General Purpose Session HTML one of the HTML assets installed with Trainz
BlackDot10x10.png String Table Token: html_warning_late the string table token in the config.txt file of the General Purpose Session HTML asset contains the message to be displayed
BlackDot10x10.png HTML Wave: General Purpose Session HTML HTML asset contains the optional sound file to be played
BlackDot10x10.png Wav Name: all-aboard.wav is the optional sound file to be played
CheckBox.PNG Autoplay Wav - the sound will be played when the page is displayed

For example, the config.txt file of the asset General Purpose Session HTML contains the following:- 

string-table
    {
        html_warning_late       "You are running late!"
    }

...which will produce the message "You are running late!" from the Message Popup Rule settings shown above.

  Top Next Up   Bottom

[edit] Alternatives to the Message Popup Rule

RulesWiki.PNG There are other HTML message window rules that are alternatives to the Message Popup rule. A few possibilities are:-


  Top Next Up    

[edit] Trainz Wiki

TrainzWiki.png

More Tutorials and Guides to Using Trainz
LinkWiki.PNG

Related Links

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

Retrieved from "https://game.ts2009.com/mediaWiki/index.php?title=How_to_Use_Message_Popup_Rule&oldid=39365"
Personal tools