How to Use Message Popup Rule

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
(→‎Using a HTML Page)
m (→‎Using a HTML Page)
Line 36: Line 36:
 
[[file:PortalOptionButtonFilled.PNG]] '''A pre-defined HTML page (advanced)'''<br>
 
[[file:PortalOptionButtonFilled.PNG]] '''A pre-defined HTML page (advanced)'''<br>
 
'''In This Example:'''<br>
 
'''In This Example:'''<br>
−
:[[file: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.<br>
+
:[[file: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
 
:[[file:CheckBox.PNG]] '''Close previous message popup windows''' - this is usually a good idea unless you want multiple message windows open.
 
:[[file:CheckBox.PNG]] '''Close previous message popup windows''' - this is usually a good idea unless you want multiple message windows open.
−
:'''Message location:''' '''<u>Top left</u>''' of the screen has been chosen as the location for the message window. Other positions are '''Top right''', '''Bottom left''' and '''Bottom right'''.
+
:'''Message location:''' '''<u>Top left</u>''' 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:''' '''<u>General Purpose Session HTML</u>''' one of the HTML assets installed with TANE
 
:'''HTML Asset:''' '''<u>General Purpose Session HTML</u>''' one of the HTML assets installed with TANE
 
:'''HTML Page:''' '''<u>right_away.html</u>''' which is a HTML file inside the '''<u>General Purpose Session HTML</u>''' asset
 
:'''HTML Page:''' '''<u>right_away.html</u>''' which is a HTML file inside the '''<u>General Purpose Session HTML</u>''' asset
 
:'''HTML Wave:''' '''<u>General Purpose Session HTML</u>''' HTML asset contains the sound file to be played
 
:'''HTML Wave:''' '''<u>General Purpose Session HTML</u>''' HTML asset contains the sound file to be played
 
:'''Wav Name:''' '''<u>all-aboard.wav</u>''' is the sound file to be played
 
:'''Wav Name:''' '''<u>all-aboard.wav</u>''' is the sound file to be played
−
:[[file:CheckBox.PNG]] '''Autoplay Wav''' - the sound will be played when the page is displayed.</td>
+
:[[file:CheckBox.PNG]] '''Autoplay Wav''' - the sound will be played when the page is displayed</td>
 
</tr>
 
</tr>
 
<tr>
 
<tr>

Revision as of 21:10, 2 August 2018

This document describes how to configure the Message Popup Rule. For examples of how to use this rule in TANE Sessions see the Trainz Wiki Page WikiLink.PNG Message Popup Rule (Applications)

Contents


DotPoint.JPG The Message Popup Rule is a T:ANE 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, by:

  • using a HTML Page
  • creating a Custom Message
  • using a String Table Message


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

See the Trainz Wiki Page WikiLink.PNG How to Create a HTML Asset for more information.
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 TANE
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 sound file to be played
Wav Name: all-aboard.wav is the 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 TANE, 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.


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:

PortalOptionButtonFilled.PNG Custom text
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 WikiLink.PNG 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:

PortalOptionButtonFilled.PNG A pre-defined string-table entry from a HTML asset (advanced)
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 CheckBox.PNG checked 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.


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


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.

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


Trainz Wiki

TrainzWiki.png

More Tutorials and Guides to Using Trainz
Retrieved from "https://online.ts2009.com/mediaWiki/index.php?title=How_to_Use_Message_Popup_Rule&oldid=15802"
Personal tools