space_ex

v0.8.0

space_ex v0.8.0 SpaceEx.KRPC

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

Link to this section Summary

Functions

clients(conn)

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

current_game_scene(conn)

Get the current game scene

get_client_id(conn)

Returns the identifier for the current client

get_client_name(conn)

Returns the name of the current client

get_services(conn)

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

get_status(conn)

Returns some information about the server, such as the version

paused(conn)

Whether the game is paused

set_paused(conn, value)

Whether the game is paused

Link to this section Functions

Link to this function 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.

Returns: [{bytes, str, str}, ...], where bytes is a string of binary bytes and str is a string

Link to this function current_game_scene(conn)

Get the current game scene.

Returns: a Elixir.SpaceEx.KRPC.GameScene value in atom form

Link to this function get_client_id(conn)

Returns the identifier for the current client.

Returns: a string of binary bytes

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.

Returns: a string

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.

Returns: a nested structure describing available services

Link to this function get_status(conn)

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

Returns: a structure with internal server details

Link to this function paused(conn)

Whether the game is paused.

Returns: true or false

Link to this function set_paused(conn, value)

Whether the game is paused.

Returns: :ok