KRPC¶
Main kRPC service, used by clients to interact with basic server functionality.
- static get_client_id()¶
Returns the identifier for the current client.
- Return type:
string
- static get_client_name()¶
Returns the name of the current client. This is an empty string if the client has no name.
- Return type:
string
- clients: List¶
A list of RPC clients that are currently connected to the server. Each entry in the list is a clients identifier, name and address.
- Attribute:
Read-only, cannot be set
- Return type:
List
- static get_status()¶
Returns some information about the server, such as the version.
- Return type:
krpc.schema.KRPC.Status
- static get_services()¶
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.
- Return type:
krpc.schema.KRPC.Services
- current_game_scene: KRPC.GameScene¶
Get the current game scene.
- Attribute:
Read-only, cannot be set
- Return type:
- paused: boolean¶
Whether the game is paused.
- Attribute:
Can be read or written
- Return type:
boolean
- class KRPC.GameScene¶
The game scene. See
KRPC.current_game_scene
.- space_center¶
The game scene showing the Kerbal Space Center buildings.
- flight¶
The game scene showing a vessel in flight (or on the launchpad/runway).
- tracking_station¶
The tracking station.
- editor_vab¶
The Vehicle Assembly Building.
- editor_sph¶
The Space Plane Hangar.
- class KRPC.InvalidOperationException¶
A method call was made to a method that is invalid given the current state of the object.
- class KRPC.ArgumentException¶
A method was invoked where at least one of the passed arguments does not meet the parameter specification of the method.
- class KRPC.ArgumentNullException¶
A null reference was passed to a method that does not accept it as a valid argument.
- class KRPC.ArgumentOutOfRangeException¶
The value of an argument is outside the allowable range of values as defined by the invoked method.