space_ex v0.1.1 SpaceEx.KRPC

Main kRPC service, used by clients to interact with basic server functionality.

Link to this section Summary

Functions

Create an event from a server side expression

Add a streaming request and return its identifier

Returns the identifier for the current client

Returns the name of the current client

A list of RPC clients that are currently connected to the server

Get the current game scene

Whether the game is paused

Returns information on all services, procedures, classes, properties etc

Returns some information about the server, such as the version

Remove a streaming request

Whether the game is paused

Set the update rate for a stream in Hz

Start a previously added streaming request

Link to this section Functions

Link to this function add_event(conn, expression)

Create an event from a server side expression.

Link to this function add_stream(conn, call, start)

Add a streaming request and return its identifier.

Link to this function get_client_id(conn)

Returns the identifier for the current client.

Link to this function get_client_name(conn)

Returns the name of the current client.

This is an empty string if the client has no name.

Link to this function get_clients(conn)

A list of RPC clients that are currently connected to the server.

Each entry in the list is a clients identifier, name and address.

Link to this function get_current_game_scene(conn)

Get the current game scene.

Link to this function get_paused(conn)

Whether the game is paused.

Link to this function get_services(conn)

Returns information on all services, procedures, classes, properties etc.

provided by the server. Can be used by client libraries to automatically create functionality such as stubs.

Link to this function get_status(conn)

Returns some information about the server, such as the version.

Link to this function remove_stream(conn, id)

Remove a streaming request.

Link to this function set_paused(conn, value)

Whether the game is paused.

Link to this function set_stream_rate(conn, id, rate)

Set the update rate for a stream in Hz.

Link to this function start_stream(conn, id)

Start a previously added streaming request.