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](/mediaWiki/images/5/5f/LinkWiki.PNG) |
For examples of how to use this rule in Sessions see the Trainz Wiki Page at:-
|
|
Workflow Diagram
![Workflow diagram](/mediaWiki/images/b/ba/MessagePopupWorkflow.png) |
![DotPoint.JPG](/mediaWiki/images/8/81/DotPoint.JPG) |
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 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](/mediaWiki/images/0/06/Ablue.png) |
with a Custom Message - the quickest and easiest method, OR |
![Bblue.png](/mediaWiki/images/5/5f/Bblue.png) |
with a HTML (Web) Page - the most complicated method but it often gives the best results, OR |
![Cblue.png](/mediaWiki/images/7/79/Cblue.png) |
with a String Table Message |
|
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.
![MessagePopup2a.JPG](/mediaWiki/images/d/d6/MessagePopup2a.JPG) |
The custom message popup created by the example shown above |
![PencilTips.PNG](/mediaWiki/images/0/0e/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](/mediaWiki/images/thumb/8/81/DotPoint.JPG/10px-DotPoint.JPG) |
Category select Texture- Not Environmental |
![DotPoint.JPG](/mediaWiki/images/thumb/8/81/DotPoint.JPG/10px-DotPoint.JPG) |
Name type icon |
![DotPoint.JPG](/mediaWiki/images/thumb/8/81/DotPoint.JPG/10px-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](/mediaWiki/images/5/5f/LinkWiki.PNG) |
For information on how to create your own Message Popup Icons, see the Trainz Wiki Page at:-
|
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.
|
![Gears.PNG](/mediaWiki/images/4/4b/Gears.PNG) |
Settings: Shown in the example above:-
A pre-defined HTML page (advanced) |
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 |
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 |
Autoplay Wav - the sound will be played when the page is displayed |
|
|
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](/mediaWiki/images/3/3a/MessagePopup4.JPG) |
![NotePad.PNG](/mediaWiki/images/0/04/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](/mediaWiki/images/5/5f/LinkWiki.PNG) |
For more information, see the Trainz Wiki Page at:-
|
![RulesWiki.PNG](/mediaWiki/images/d/d1/RulesWiki.PNG) |
There are other HTML message window rules that are alternatives to the Message Popup rule. A few possibilities are:- |
Related Links
Trainz Wiki
![TrainzWiki.png](/mediaWiki/images/7/71/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.