Simutrans-Squirrel-API
Static Public Member Functions | List of all members
gui Class Reference

Static Public Member Functions

static void open_info_win ()
 
static void open_info_win_at (string tab)
 
static void open_info_win_client (string tab, integer player_nr)
 
static void add_message_at (player_x text, string position, coord)
 
static string add_message (player_x text, string)
 
static void add_message_at (player_x player, string text, coord position)
 

Detailed Description

Table with methods to access gui functions.

Definition at line 5 of file api_gui.cc.

Member Function Documentation

static void gui::open_info_win ( )
static

Opens scenario info window and shows 'info' tab. In network mode, opens window on all clients and server.

Note
Only available in scenario mode.
static void gui::open_info_win_at ( string  tab)
static

Opens scenario info window with specific tab open. In network mode, opens window on all clients and server.

Parameters
tabpossible values are "info", "goal", "rules", "result", "about", "debug"
Note
Only available in scenario mode.
static void gui::open_info_win_client ( string  tab,
integer  player_nr 
)
static

Opens scenario info window for certain clients (and the server), with specific tab open.

Parameters
tabpossible values are "info", "goal", "rules", "result", "about", "debug"
player_nropens scenario info window on all clients that have this player unlocked.
Note
Window is always opened on server. *

The documentation for this class was generated from the following file: