How to Use Message Popup Rule

From TrainzOnline
Revision as of 17:09, 16 June 2018 by Pware (Talk | contribs)

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

The screenshots shown below give examples of the Message Popup Rule.

Contents

Example 1: HTML Page

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

MessagePopup1.JPG

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 then it would be a good idea to place them in different screen corners.
  • HTML Wave are optional sound files.


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.

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

Notes:

  • No knowledge of HTML is required.
  • You are limited to about 6 lines of text.
  • Text only, no graphics apart from the icon.
  • You can select and display an optional icon with the message.
MessagePopup2a.JPG The custom message popup created by the example shown above

Example 3: 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 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 details.

Trainz Wiki

Route Creation Tutorials:

Session Creation Tutorials:

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