How to Use Message Popup Rule

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
m
 
(160 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
*The '''[[Session_Rule_List_with_Parameters#Message_Popup_Rule|Message Popup Rule]]''' is a '''T:ANE Session Rule''' that creates onscreen messages for users in '''Driver Mode'''.
+
The information in this Wiki Page applies to '''TANE''', '''TRS19''', '''Trainz Plus''' and '''TRS22'''. This page describes how to configure the '''Message Popup Rule'''.
  
−
The screenshots shown below give examples of the Message Popup Rule.
+
<table width=1000>
 +
<tr valign="top">
 +
<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>
 +
<table cellpadding=2 bgcolor="Aquamarine">
 +
<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>
 +
</tr>
 +
</table>
 +
<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 -->
  
−
==='''HTML Page Example'''===
+
='''Add a Message Popup Rule'''=
  
−
The settings shown in this example will direct TANE to load the message from a HTML file.
+
<table width=1000 bgcolor="lightcyan" cellpadding=2>
 +
<tr valign="top">
 +
<td width=10>[[image:BlueDot10x10.png|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>
 +
</tr>
 +
</table>
 +
<br>
 +
<table width=1000>
 +
<tr valign="top">
 +
<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>
 +
</tr>
 +
</table>
 +
<br>
 +
<table bgcolor=#000000 cellpadding=2>
 +
<tr valign="top">
 +
<td>
 +
<table bgcolor=#ffffff cellpadding=2>
 +
<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 valign="top">
 +
<td width=25>[[image:Ablue.png|link=]]</td>
 +
<td>with a '''Custom Message''' - the quickest and easiest method, <span style="font-weight: 700; font-size: 15px;">OR</span></td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:Bblue.png|link=]]</td>
 +
<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>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[image:Cblue.png|link=]]</td>
 +
<td>with a '''String Table Message'''</td>
 +
</tr>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table> <!-- BEGIN Nav Buttons Table -->
 +
<tr valign="top">
 +
<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>
 +
</table> <!-- END Nav Buttons Table -->
  
 +
='''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.
 +
 +
<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">
 +
<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>
 +
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>[[file:MessagePopup1.JPG]]</td>
+
<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:-<br>
 +
[[image:PortalOptionButtonFilled.PNG|link=]] '''Custom text'''
 +
<table>
 +
<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=]] '''Custom Message''' - the message entered into the text box will be displayed</td>
 +
</tr>
 +
<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>
 +
</table>
 +
</td>
 +
</tr>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table>
 +
<tr>
 +
<td>[[image:MessagePopup2a.JPG|link=]]</td>
 +
<td>The custom message popup created by the example shown above</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table bgcolor=#000000>
 +
<tr valign="top">
 +
<td>
 +
<table bgcolor=#ffffe0>
 +
<tr valign="top">
 +
<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:-
 +
<table>
 +
<tr valign="top">
 +
<td width=10>[[image:DotPoint.JPG|10px|link=]]</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>
 +
</table>
 +
<br>
 +
<table cellpadding=2 bgcolor="Aquamarine">
 +
<tr valign="top">
 +
<td>[[image:LinkWiki.PNG|link=]]</td>
 +
<td>
 +
For information on how to create your own '''Message Popup Icons''', see the '''Trainz Wiki Page''' at:-<br>
 +
* '''[[How to Create a Message Popup Icon]]'''</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
−
'''Notes:'''
 
−
*Some knowledge of HTML tags will be required, particularly the very limited set of HTML that applies to Trainz.
 
−
*Graphics and a limited set of HTML effects are possible.
 
−
*The HTML file or "web page" (with filename extension ".html") must be in a Trainz asset of type HTML.
 
−
*If a sound file is to be played when the message is displayed, for example the "whistle" sound shown in the example above, 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.
 
  
−
==='''Custom Message Example'''===
+
<table> <!-- BEGIN Nav Buttons Table -->
 +
<tr valign="top">
 +
<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>
 +
</table> <!-- END Nav Buttons Table -->
  
−
The settings shown in this example will direct TANE to load the message from text entered in the Custom Message box.
+
='''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 width=1000>
 +
<tr>
 +
<td valign="top">[[image:MessagePopup1.JPG|link=]]</td>
 +
<td valign="top">
 +
<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>[[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>
 +
<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>
 
<table>
 +
<tr valign="top">
 +
<td>[[image:PortalOptionButtonFilled.PNG|link=]] '''A pre-defined HTML page (advanced)'''</td>
 +
</tr>
 +
<tr valign="top">
 +
<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>
 +
</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=]] '''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>
−
<td>[[file:MessagePopup2.JPG]]</td>
+
<td colspan="2">
 +
----</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
−
'''Notes:'''
 
−
*No knowledge of HTML is required.
 
−
*You are limited to about 6 lines of text.
 
−
*Test only, no graphics apart from the icon.
 
−
*You can select and display an optional icon with the message.
 
  
−
<table>
+
<table> <!-- BEGIN Nav Buttons Table -->
 +
<tr valign="top">
 +
<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>
 +
</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>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table width=1000 cellpadding=2 bgcolor=#eeeeee>
 
<tr>
 
<tr>
−
<td>[[file:MessagePopup2a.JPG]]</td>
+
<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>
 
<tr>
 
<tr>
−
<td>The custom message popup created by the example shown above</td>
+
<td colspan="2">
 +
----</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 +
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.
 +
<br>
 +
<table> <!-- BEGIN Nav Buttons Table -->
 +
<tr valign="top">
 +
<td width=729><span id="stepAlt"></span>&nbsp;</td>
 +
<td width=46>[[image:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>[[image:NextUp.png|link=#stepString|alt=Next Up|Top]]</td>
 +
<td width=75>&#160;</td>
 +
<td width=75>[[image:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 +
</tr>
 +
</table> <!-- END Nav Buttons Table -->
  
−
'''Additional Links:'''
+
='''Alternatives to the Message Popup Rule'''=
−
    '''[[Message Popup Rule Applications|Message Popup Applications]]'''
+
<table width=1000 cellpadding=2 bgcolor=#ffffff>
 +
<tr valign="top">
 +
<td width=60>[[image:RulesWiki.PNG|link=]]</td>
 +
<td>There are other HTML message window rules that are alternatives to the '''Message Popup''' rule. A few possibilities are:-
 +
*'''[[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)]]'''</td>
 +
</tr>
 +
</table>
 +
<br>
 +
<table> <!-- 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=#stepAlt|alt=Next Up|Top]]</td>
 +
<td width=75>&nbsp;</td>
 +
<td width=75>&nbsp;</td>
 +
</tr>
 +
</table> <!-- END Nav Buttons Table -->
 +
----
 +
----
 +
='''Trainz Wiki'''=
 +
<table width=1000>
 +
<tr valign="top">
 +
<td>
 +
<table width=500 cellpadding=2 bgcolor=#ffffff>
 +
<tr valign="top">
 +
<td width=80>[[image:TrainzWiki.png|link=]]</td>
 +
<td>
 +
<span style="font-size: 17px;">'''More Tutorials and Guides to Using Trainz'''</span><br>
 +
*'''<span class="plainlinks">[http://online.ts2009.com/mediaWiki/index.php/HowTo How to Guides]</span>'''
 +
*'''[[Driver Commands List]]'''
 +
*'''[[Session Rule List with Parameters|Session Rules List (Alphabetical) with Parameters]]'''
 +
*'''[[Session Rules By Categories With Properties|Session Rules List (Categories) With Parameters]]'''
 +
</td>
 +
</tr>
 +
</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]]

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://online.ts2009.com/mediaWiki/index.php?title=How_to_Use_Message_Popup_Rule&oldid=39365"
Personal tools