Simutrans-Squirrel-API
Functions
AI only functions

Functions

static void gui::add_message_at (player_x player, string text, coord position)
 
static player_x player_x::self ()
 

Detailed Description

These classes and methods are only available for scripted AI players.

Function Documentation

◆ add_message_at()

static void gui::add_message_at ( player_x  player,
string  text,
coord  position 
)
static

Adds message to the players mailboxes. Will be shown in ticker or as pop-up window depending on players preferences. Message window has small view of world.

Parameters
playersending this message
textText to be shown. Has to be a translated string or a translatable string.
positionPosition of the view on the map. Clicking on the message will center viewport at this position.
Warning
Message only shown on server, but stored in savegame.

◆ self()

static player_x player_x::self ( )
static
Returns
player associated with the AI.
Note
Only available in AI mode.