OpenTTD GameScript API: GSAdmin Class Reference

OpenTTD GameScript API 13.0

Static Public Member Functions
GSAdmin Class Reference

Class that handles communication with the AdminPort. More...

Inheritance diagram for GSAdmin:

## Static Public Member Functions
static bool | Send (void *table)
| Send information to the AdminPort. More...

## Detailed Description

Class that handles communication with the AdminPort.

## Member Function Documentation

## ◆ Send()

static bool GSAdmin::Send | ( | void * | table | ) |
| static

Send information to the AdminPort.

The information can be anything as long as it isn't a class or instance thereof.

Parameters

  table | The information to send, in a table. For example: { param = "param" }.

Returns
  True if and only if the data was successfully converted to JSON and send to the AdminPort.

Note
  If the resulting JSON of your table is larger than 1450 bytes, nothing will be sent (and false will be returned).