How to Use Message Popup Rule

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
(→‎Using a Custom Message)
(→‎Using a String-Table Message)
Line 98: Line 98:
 
<td>[[file:MessagePopup4.JPG]]</td>
 
<td>[[file:MessagePopup4.JPG]]</td>
 
<td>
 
<td>
 +
<table cellpadding="4" bgcolor=#cccccc>
 +
<tr valign="top">
 +
<td>[[file:Gears.PNG]]</td>
 +
<td><font size="3">'''Settings:'''</font><br>
 +
'''In This Example:'''
 +
*Gameplay will not be paused while the message is displayed.
 +
*Any previously opened message window will be closed before this message is displayed.
 +
*'''Message location:''' - the '''Top left''' of the screen will be used.
 +
*The text message in the '''config.txt''' file of the HTML asset named '''General Purpose Session HTML''' will be displayed. This message will be stored:-
 +
**in a '''string-table'' container,
 +
**using a '''String Table Token''' named '''html_warning_late'''
 +
*An optional sound file named '''"all-aboard.wav"''' has been added and is found in the HTML asset named '''General Purpose Session HTML'''
 +
*'''Autoplay Wav''' is ticked so the sound will be played when the page is displayed</td>
 +
</tr>
 +
</table>
 +
<br>
 
<table cellpadding="4" bgcolor=#ffffb0>
 
<table cellpadding="4" bgcolor=#ffffb0>
 
<tr valign="top">
 
<tr valign="top">
Line 106: Line 122:
 
</tr>
 
</tr>
 
</table>
 
</table>
−
<br>
+
</td>
 +
</tr>
 +
</table>
 +
<br clear=all>
 
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 115: Line 134:
 
<br><br>
 
<br><br>
 
See the Trainz Wiki Page '''[[How to Create a HTML Asset]]''' for more information.
 
See the Trainz Wiki Page '''[[How to Create a HTML Asset]]''' for more information.
−
</td>
 
−
</tr>
 
−
</table>
 
 
----
 
----
 
----
 
----

Revision as of 15:45, 9 July 2018

Contents


DotPoint.JPG The Message Popup Rule is a T:ANE Session Rule that creates onscreen messages for users in Driver Mode.

The screenshots below illustrate how to use the Message Popup Rule.

Using a HTML Page

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

MessagePopup1.JPG
Gears.PNG Settings:

In This Example:

  • Pause game while message is displayed - if checked this will halt the gameplay 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 - checked is usually a good idea unless you want multiple message windows open.
  • Message location: - the 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.
  • The web page to be displayed is named "right_away.html" and the sound file to be played is named "all-aboard.wav". Both are found in the HTML asset named General Purpose Session HTML
  • Autoplay Wav is ticked so the sound will be played when the page is displayed.


NotePad.PNG Notes:
  • Knowledge of HTML, as used by TANE, is 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.


See the Trainz Wiki Page How to Create a HTML Asset for more information.


Using a Custom Message

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

MessagePopup3.JPG
Gears.PNG Settings:

In This Example:

  • Gameplay will not be paused while the message is displayed.
  • Any previously opened message window will be closed before this message is displayed.
  • Message location: - the Top left of the screen will be used.
  • A Custom Message, as entered into the text box, and a selected Icon will be displayed.
  • No optional sound has been added.


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

See the Trainz Wiki Page How to Create a HTML Asset for more information.
MessagePopup2a.JPG The custom message popup created by the example shown above


Using a String-Table Message

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

MessagePopup4.JPG
Gears.PNG Settings:

In This Example:

  • Gameplay will not be paused while the message is displayed.
  • Any previously opened message window will be closed before this message is displayed.
  • Message location: - the Top left of the screen will be used.
  • The text message in the config.txt file of the HTML asset named General Purpose Session HTML will be displayed. This message will be stored:-
    • in a 'string-table container,
    • using a String Table Token named html_warning_late
  • An optional sound file named "all-aboard.wav" has been added and is found in the HTML asset named General Purpose Session HTML
  • Autoplay Wav is ticked so 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 on the left.

See the Trainz Wiki Page How to Create a HTML Asset for more information.


Trainz Wiki


Route Creation Tutorials:


Session Creation Tutorials:

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