How to Use Message Popup Rule

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
m
Line 11: Line 11:
 
</table>
 
</table>
 
<br>
 
<br>
−
 
+
<table>
 +
<tr valign="top">
 +
<td>
 
__TOC__
 
__TOC__
−
<br>
+
</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>
 +
</tr>
 +
</table>
  
 
<table cellpadding=4 bgcolor=#c1e7e7>
 
<table cellpadding=4 bgcolor=#c1e7e7>
Line 26: Line 32:
 
<td>[[file:DotPoint.JPG|link=]]</td>
 
<td>[[file:DotPoint.JPG|link=]]</td>
 
<td>The rule provides you with three different ways of creating an onscreen message:-
 
<td>The rule provides you with three different ways of creating an onscreen message:-
−
*a simple (custom) '''text message with an optional graphic'''
+
#a simple (custom) '''text message with an optional graphic'''
−
*a full '''HTML (web) page'''
+
#a '''HTML asset''' with a full '''HTML (web) page'''
−
*a '''string table''' entry in a '''config.txt''' file</td>
+
#a '''string table''' entry in the '''config.txt''' file of a '''HTML asset'''
 +
Option '''1''' is the easiest but the more limited choice of the three.</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.
 
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.
−
:[[file:DotPoint1Blue.png|link=]]&nbsp;with a '''HTML (Web) Page'''
+
:[[file:DotPoint1Blue.png|link=]]&nbsp;with a '''Custom Message'''
−
:[[file:DotPoint2Blue.png|link=]]&nbsp;with a '''Custom Message'''
+
:[[file:DotPoint2Blue.png|link=]]&nbsp;with a '''HTML (Web) Page'''
 
:[[file:DotPoint3Blue.png|link=]]&nbsp;with a '''String Table Message'''
 
:[[file:DotPoint3Blue.png|link=]]&nbsp;with a '''String Table Message'''
  
 
<table> <!-- BEGIN Nav Buttons Table -->
 
<table> <!-- BEGIN Nav Buttons Table -->
 
<tr valign="top">
 
<tr valign="top">
−
<td width=729><span id="stepHTML"></span>&nbsp;</td>
+
<td width=729><span id="stepCustom"></span>&nbsp;</td>
 
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
 
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
 
<td width=75>[[file:NextUp.png|link=#top|alt=Next Up|Top]]</td>
 
<td width=75>[[file:NextUp.png|link=#top|alt=Next Up|Top]]</td>
−
<td width=75>[[file:NextDown.png|link=#stepCustom|alt=Next Down|Next Down]]</td>
+
<td width=75>[[file:NextDown.png|link=#stepHTML|alt=Next Down|Next Down]]</td>
−
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
+
−
</tr>
+
−
</table> <!-- END Nav Buttons Table -->
+
−
 
+
−
='''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">
+
−
<td>[[file: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>
+
−
<td valign="top">
+
−
<table cellpadding=4 bgcolor=#eeeeee>
+
−
<tr>
+
−
<td colspan="2">
+
−
----</td>
+
−
</tr>
+
−
<tr valign="top">
+
−
<td>[[file:Gears.PNG|link=]]</td>
+
−
<td><span style="font-size: 17px;">'''Settings:'''</span><br>
+
−
[[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>
+
−
<td colspan="2">
+
−
----</td>
+
−
</tr>
+
−
</table>
+
−
<table bgcolor=#000000 cellpadding=2>
+
−
<tr valign="top">
+
−
<td>
+
−
<table cellpadding=4 bgcolor=#ffffb0>
+
−
<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>
+
−
</table>
+
−
</td>
+
−
</tr>
+
−
</table>
+
−
 
+
−
<table> <!-- BEGIN Nav Buttons Table -->
+
−
<tr valign="top">
+
−
<td width=729><span id="stepCustom"></span>&nbsp;</td>
+
−
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
+
−
<td width=75>[[file:NextUp.png|link=#stepHTML|alt=Next Up|Top]]</td>
+
−
<td width=75>[[file:NextDown.png|link=#stepString|alt=Next Down|Next Down]]</td>
+
 
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 
</tr>
 
</tr>
Line 212: Line 148:
 
<table> <!-- BEGIN Nav Buttons Table -->
 
<table> <!-- BEGIN Nav Buttons Table -->
 
<tr valign="top">
 
<tr valign="top">
−
<td width=729><span id="stepString"></span>&nbsp;</td>
+
<td width=729><span id="stepHTML"></span>&nbsp;</td>
 
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
 
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
 
<td width=75>[[file:NextUp.png|link=#stepCustom|alt=Next Up|Top]]</td>
 
<td width=75>[[file:NextUp.png|link=#stepCustom|alt=Next Up|Top]]</td>
 +
<td width=75>[[file:NextDown.png|link=#stepString|alt=Next Down|Next Down]]</td>
 +
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 +
</tr>
 +
</table> <!-- END Nav Buttons Table -->
 +
 +
='''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">
 +
<td>[[file: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>
 +
<td valign="top">
 +
<table cellpadding=4 bgcolor=#eeeeee>
 +
<tr>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
<tr valign="top">
 +
<td>[[file:Gears.PNG|link=]]</td>
 +
<td><span style="font-size: 17px;">'''Settings:'''</span><br>
 +
[[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>
 +
<td colspan="2">
 +
----</td>
 +
</tr>
 +
</table>
 +
<table bgcolor=#000000 cellpadding=2>
 +
<tr valign="top">
 +
<td>
 +
<table cellpadding=4 bgcolor=#ffffb0>
 +
<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>
 +
</table>
 +
</td>
 +
</tr>
 +
</table>
 +
 +
<table> <!-- BEGIN Nav Buttons Table -->
 +
<tr valign="top">
 +
<td width=729><span id="stepString"></span>&nbsp;</td>
 +
<td width=46>[[file:BackToTop.png|link=#top|alt=Top|Top]]</td>
 +
<td width=75>[[file:NextUp.png|link=#stepHTML|alt=Next Up|Top]]</td>
 
<td width=75>[[file:NextDown.png|link=#bottom|alt=Next Down|Next Down]]</td>
 
<td width=75>[[file:NextDown.png|link=#bottom|alt=Next Down|Next Down]]</td>
 
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>
 
<td width=75>[[file:BackToBottom.png|link=#bottom|alt=Bottom|Bottom]]</td>

Revision as of 13:59, 11 December 2022

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

LinkWiki.PNG

For examples of how to use this rule in Sessions see the Trainz Wiki Page at:-


Contents

  Workflow Diagram 
Workflow diagram
In Summary:
DotPoint.JPG The Message Popup Rule is a Trainz Session Rule that creates onscreen messages for users in Driver Mode.
DotPoint.JPG The rule provides you with three different ways of creating an onscreen message:-
  1. a simple (custom) text message with an optional graphic
  2. a HTML asset with a full HTML (web) page
  3. a string table entry in the config.txt file of a HTML asset
Option 1 is the easiest but the more limited choice of the three.


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.

DotPoint1Blue.png with a Custom Message
DotPoint2Blue.png with a HTML (Web) Page
DotPoint3Blue.png with a String Table Message
  Top Next Up Next Down Bottom

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
Gears.PNG Settings:

PortalOptionButtonFilled.PNG Custom text
In This Example:

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
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
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
NotePad.PNG Notes:
  • No knowledge of HTML is required for this option.
  • You can select and display an optional icon with the message.
  • 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.
  • 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:-
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:-
  • Category select Texture- Not Environmental
  • Name type icon
  • On Download Station select True

Not all those shown will be suitable. Double click 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

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

LinkWiki.PNG

For more information, see the Trainz Wiki Page at:-
Gears.PNG Settings:

PortalOptionButtonFilled.PNG A pre-defined HTML page (advanced)
In This Example:

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.
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
HTML Asset: General Purpose Session HTML one of the HTML assets installed with Trainz
HTML Page: right_away.html which is a HTML file inside the General Purpose Session HTML asset
HTML Wave: General Purpose Session HTML HTML asset contains the optional sound file to be played
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
NotePad.PNG Notes:
  • 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.
  Top Next Up Next Down Bottom

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
Gears.PNG Settings:

PortalOptionButtonFilled.PNG A pre-defined string-table entry from a HTML asset (advanced)
In This Example:

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
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
HTML Asset: General Purpose Session HTML one of the HTML assets installed with Trainz
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
HTML Wave: General Purpose Session HTML HTML asset contains the optional sound file to be played
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
NotePad.PNG Notes:
  • 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.


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.

LinkWiki.PNG

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

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:-


Related Links

LinkWiki.PNG
  Top Next Up    

Trainz Wiki

TrainzWiki.png

More Tutorials and Guides to Using Trainz

This page was created by Trainz user pware in 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=34859"
Personal tools