GSAdmin Class Reference

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


Static Public Member Functions

static bool Send (void *table)
 Send information to the AdminPort.


Detailed Description

Class that handles communication with the AdminPort.

Member Function Documentation

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).


Generated on Thu Jun 30 21:53:50 2016 for OpenTTD Game API by  doxygen 1.5.6