SpaceCenter¶

Service SpaceCenter

Provides functionality to interact with Kerbal Space Program. This includes controlling the active vessel, managing its resources, planning maneuver nodes and auto-piloting.

krpc_error_t krpc_SpaceCenter_Science(krpc_connection_t connection, float *result)¶

The current amount of science.

krpc_error_t krpc_SpaceCenter_Funds(krpc_connection_t connection, double *result)¶

The current amount of funds.

krpc_error_t krpc_SpaceCenter_Reputation(krpc_connection_t connection, float *result)¶

The current amount of reputation.

krpc_error_t krpc_SpaceCenter_ActiveVessel(krpc_connection_t connection, krpc_SpaceCenter_Vessel_t *result)¶

void krpc_SpaceCenter_set_ActiveVessel(krpc_SpaceCenter_Vessel_t value)¶

The currently active vessel.

Game Scenes:

Flight

krpc_error_t krpc_SpaceCenter_Vessels(krpc_connection_t connection, krpc_list_object_t *result)¶

A list of all the vessels in the game.

krpc_error_t krpc_SpaceCenter_LaunchSites(krpc_connection_t connection, krpc_list_object_t *result)¶

A list of available launch sites.

krpc_error_t krpc_SpaceCenter_Bodies(krpc_connection_t connection, krpc_dictionary_string_object_t *result)¶

A dictionary of all celestial bodies (planets, moons, etc.) in the game, keyed by the name of the body.

krpc_error_t krpc_SpaceCenter_TargetBody(krpc_connection_t connection, krpc_SpaceCenter_CelestialBody_t *result)¶

void krpc_SpaceCenter_set_TargetBody(krpc_SpaceCenter_CelestialBody_t value)¶

The currently targeted celestial body.

Game Scenes:

Flight

krpc_error_t krpc_SpaceCenter_TargetVessel(krpc_connection_t connection, krpc_SpaceCenter_Vessel_t *result)¶

void krpc_SpaceCenter_set_TargetVessel(krpc_SpaceCenter_Vessel_t value)¶

The currently targeted vessel.

Game Scenes:

Flight

krpc_error_t krpc_SpaceCenter_TargetDockingPort(krpc_connection_t connection, krpc_SpaceCenter_DockingPort_t *result)¶

void krpc_SpaceCenter_set_TargetDockingPort(krpc_SpaceCenter_DockingPort_t value)¶

The currently targeted docking port.

Game Scenes:

Flight

krpc_error_t krpc_SpaceCenter_ClearTarget(krpc_connection_t connection)¶

Clears the current target.

Game Scenes:

Flight

krpc_error_t krpc_SpaceCenter_LaunchableVessels(krpc_connection_t connection, krpc_list_string_t *result, const char *craftDirectory)¶

Returns a list of vessels from the given craftDirectory that can be launched.

Parameters:

craftDirectory – Name of the directory in the current saves “Ships” directory. For example "VAB" or "SPH".

krpc_error_t krpc_SpaceCenter_LaunchVessel(krpc_connection_t connection, const char *craftDirectory, const char *name, const char *launchSite, bool recover, const krpc_list_string_t *crew, const char *flagUrl)¶

Launch a vessel.

Parameters:

craftDirectory – Name of the directory in the current saves “Ships” directory, that contains the craft file. For example "VAB" or "SPH".

name – Name of the vessel to launch. This is the name of the “.craft” file in the save directory, without the “.craft” file extension.

launchSite – Name of the launch site. For example "LaunchPad" or "Runway".

recover – If true and there is a vessel on the launch site, recover it before launching.

crew – If not nullptr, a list of names of Kerbals to place in the craft. Otherwise the crew will use default assignments.

flagUrl – If not nullptr, the asset URL of the mission flag to use for the launch.

Note

Throws an exception if any of the games pre-flight checks fail.

krpc_error_t krpc_SpaceCenter_LaunchVesselFromVAB(krpc_connection_t connection, const char *name, bool recover)¶

Launch a new vessel from the VAB onto the launchpad.

Parameters:

name – Name of the vessel to launch.

recover – If true and there is a vessel on the launch pad, recover it before launching.

Note

This is equivalent to calling krpc_SpaceCenter_LaunchVessel() with the craft directory set to “VAB” and the launch site set to “LaunchPad”. Throws an exception if any of the games pre-flight checks fail.

krpc_error_t krpc_SpaceCenter_LaunchVesselFromSPH(krpc_connection_t connection, const char *name, bool recover)¶

Launch a new vessel from the SPH onto the runway.

Parameters:

name – Name of the vessel to launch.

recover – If true and there is a vessel on the runway, recover it before launching.

Note

This is equivalent to calling krpc_SpaceCenter_LaunchVessel() with the craft directory set to “SPH” and the launch site set to “Runway”. Throws an exception if any of the games pre-flight checks fail.

krpc_error_t krpc_SpaceCenter_Save(krpc_connection_t connection, const char *name)¶

Save the game with a given name. This will create a save file called name.sfs in the folder of the current save game.

Parameters:

name – Name of the save.

krpc_error_t krpc_SpaceCenter_Load(krpc_connection_t connection, const char *name)¶

Load the game with the given name. This will create a load a save file called name.sfs from the folder of the current save game.

Parameters:

name – Name of the save.

krpc_error_t krpc_SpaceCenter_Quicksave(krpc_connection_t connection)¶

Save a quicksave.

Note

This is the same as calling krpc_SpaceCenter_Save() with the name “quicksave”.

krpc_error_t krpc_SpaceCenter_Quickload(krpc_connection_t connection)¶

Load a quicksave.

Note

This is the same as calling krpc_SpaceCenter_Load() with the name “quicksave”.

krpc_error_t krpc_SpaceCenter_CanRevertToLaunch(krpc_connection_t connection, bool *result)¶

Whether the current flight can be reverted to launch.

krpc_error_t krpc_SpaceCenter_RevertToLaunch(krpc_connection_t connection)¶

Revert the current flight to launch.

krpc_error_t krpc_SpaceCenter_TransferCrew(krpc_connection_t connection, krpc_SpaceCenter_CrewMember_t crewMember, krpc_SpaceCenter_Part_t targetPart)¶

Transfers a crew member to a different part.

Parameters:

crewMember – The crew member to transfer.

targetPart – The part to move them to.

Game Scenes:

Flight

krpc_error_t krpc_SpaceCenter_UIVisible(krpc_connection_t connection, bool *result)¶

void krpc_SpaceCenter_set_UIVisible(bool value)¶

Whether the UI is visible.

Game Scenes:

Flight

krpc_error_t krpc_SpaceCenter_Navball(krpc_connection_t connection, bool *result)¶

void krpc_SpaceCenter_set_Navball(bool value)¶

Whether the navball is visible.

Game Scenes:

Flight

krpc_error_t krpc_SpaceCenter_UT(krpc_connection_t connection, double *result)¶

The current universal time in seconds.

krpc_error_t krpc_SpaceCenter_G(krpc_connection_t connection, double *result)¶

The value of the gravitational constant G in \(N(m/kg)^2\).

krpc_error_t krpc_SpaceCenter_WarpRate(krpc_connection_t connection, float *result)¶

The current warp rate. This is the rate at which time is passing for either on-rails or physical time warp. For example, a value of 10 means time is passing 10x faster than normal. Returns 1 if time warp is not active.

Game Scenes:

Flight

krpc_error_t krpc_SpaceCenter_WarpFactor(krpc_connection_t connection, float *result)¶

The current warp factor. This is the index of the rate at which time is passing for either regular “on-rails” or physical time warp. Returns 0 if time warp is not active. When in on-rails time warp, this is equal to krpc_SpaceCenter_RailsWarpFactor(), and in physics time warp, this is equal to krpc_SpaceCenter_PhysicsWarpFactor().

Game Scenes:

Flight

krpc_error_t krpc_SpaceCenter_RailsWarpFactor(krpc_connection_t connection, int32_t *result)¶

void krpc_SpaceCenter_set_RailsWarpFactor(int32_t value)¶

The time warp rate, using regular “on-rails” time warp. A value between 0 and 7 inclusive. 0 means no time warp. Returns 0 if physical time warp is active.

If requested time warp factor cannot be set, it will be set to the next lowest possible value. For example, if the vessel is too close to a planet. See the KSP wiki for details.

Game Scenes:

Flight

krpc_error_t krpc_SpaceCenter_PhysicsWarpFactor(krpc_connection_t connection, int32_t *result)¶

void krpc_SpaceCenter_set_PhysicsWarpFactor(int32_t value)¶

The physical time warp rate. A value between 0 and 3 inclusive. 0 means no time warp. Returns 0 if regular “on-rails” time warp is active.

Game Scenes:

Flight

krpc_error_t krpc_SpaceCenter_CanRailsWarpAt(krpc_connection_t connection, bool *result, int32_t factor)¶

Returns true if regular “on-rails” time warp can be used, at the specified warp factor. The maximum time warp rate is limited by various things, including how close the active vessel is to a planet. See the KSP wiki for details.

Parameters:

factor – The warp factor to check.

Game Scenes:

Flight

krpc_error_t krpc_SpaceCenter_MaximumRailsWarpFactor(krpc_connection_t connection, int32_t *result)¶

The current maximum regular “on-rails” warp factor that can be set. A value between 0 and 7 inclusive. See the KSP wiki for details.

Game Scenes:

Flight

krpc_error_t krpc_SpaceCenter_WarpTo(krpc_connection_t connection, double ut, float maxRailsRate, float maxPhysicsRate)¶

Uses time acceleration to warp forward to a time in the future, specified by universal time ut. This call blocks until the desired time is reached. Uses regular “on-rails” or physical time warp as appropriate. For example, physical time warp is used when the active vessel is traveling through an atmosphere. When using regular “on-rails” time warp, the warp rate is limited by maxRailsRate, and when using physical time warp, the warp rate is limited by maxPhysicsRate.

Parameters:

ut – The universal time to warp to, in seconds.

maxRailsRate – The maximum warp rate in regular “on-rails” time warp.

maxPhysicsRate – The maximum warp rate in physical time warp.

Returns:

When the time warp is complete.

Game Scenes:

Flight

krpc_error_t krpc_SpaceCenter_TransformPosition(krpc_connection_t connection, krpc_tuple_double_double_double_t *result, const krpc_tuple_double_double_double_t *position, krpc_SpaceCenter_ReferenceFrame_t from, krpc_SpaceCenter_ReferenceFrame_t to)¶

Converts a position from one reference frame to another.

Parameters:

position – Position, as a vector, in reference frame from.

from – The reference frame that the position is in.

to – The reference frame to covert the position to.

Returns:

The corresponding position, as a vector, in reference frame to.

krpc_error_t krpc_SpaceCenter_TransformDirection(krpc_connection_t connection, krpc_tuple_double_double_double_t *result, const krpc_tuple_double_double_double_t *direction, krpc_SpaceCenter_ReferenceFrame_t from, krpc_SpaceCenter_ReferenceFrame_t to)¶

Converts a direction from one reference frame to another.

Parameters:

direction – Direction, as a vector, in reference frame from.

from – The reference frame that the direction is in.

to – The reference frame to covert the direction to.

Returns:

The corresponding direction, as a vector, in reference frame to.

krpc_error_t krpc_SpaceCenter_TransformRotation(krpc_connection_t connection, krpc_tuple_double_double_double_double_t *result, const krpc_tuple_double_double_double_double_t *rotation, krpc_SpaceCenter_ReferenceFrame_t from, krpc_SpaceCenter_ReferenceFrame_t to)¶

Converts a rotation from one reference frame to another.

Parameters:

rotation – Rotation, as a quaternion of the form \((x, y, z, w)\), in reference frame from.

from – The reference frame that the rotation is in.

to – The reference frame to covert the rotation to.

Returns:

The corresponding rotation, as a quaternion of the form \((x, y, z, w)\), in reference frame to.

krpc_error_t krpc_SpaceCenter_TransformVelocity(krpc_connection_t connection, krpc_tuple_double_double_double_t *result, const krpc_tuple_double_double_double_t *position, const krpc_tuple_double_double_double_t *velocity, krpc_SpaceCenter_ReferenceFrame_t from, krpc_SpaceCenter_ReferenceFrame_t to)¶

Converts a velocity (acting at the specified position) from one reference frame to another. The position is required to take the relative angular velocity of the reference frames into account.

Parameters:

position – Position, as a vector, in reference frame from.

velocity – Velocity, as a vector that points in the direction of travel and whose magnitude is the speed in meters per second, in reference frame from.

from – The reference frame that the position and velocity are in.

to – The reference frame to covert the velocity to.

Returns:

The corresponding velocity, as a vector, in reference frame to.

krpc_error_t krpc_SpaceCenter_RaycastDistance(krpc_connection_t connection, double *result, const krpc_tuple_double_double_double_t *position, const krpc_tuple_double_double_double_t *direction, krpc_SpaceCenter_ReferenceFrame_t referenceFrame)¶

Cast a ray from a given position in a given direction, and return the distance to the hit point. If no hit occurs, returns infinity.

Parameters:

position – Position, as a vector, of the origin of the ray.

direction – Direction of the ray, as a unit vector.

referenceFrame – The reference frame that the position and direction are in.

Returns:

The distance to the hit, in meters, or infinity if there was no hit.

krpc_error_t krpc_SpaceCenter_RaycastPart(krpc_connection_t connection, krpc_SpaceCenter_Part_t *result, const krpc_tuple_double_double_double_t *position, const krpc_tuple_double_double_double_t *direction, krpc_SpaceCenter_ReferenceFrame_t referenceFrame)¶

Cast a ray from a given position in a given direction, and return the part that it hits. If no hit occurs, returns nullptr.

Parameters:

position – Position, as a vector, of the origin of the ray.

direction – Direction of the ray, as a unit vector.

referenceFrame – The reference frame that the position and direction are in.

Returns:

The part that was hit or nullptr if there was no hit.

Game Scenes:

Flight

krpc_error_t krpc_SpaceCenter_FARAvailable(krpc_connection_t connection, bool *result)¶

Whether Ferram Aerospace Research is installed.

krpc_error_t krpc_SpaceCenter_CreateKerbal(krpc_connection_t connection, const char *name, const char *job, bool male)¶

Creates a Kerbal.

Parameters:

krpc_error_t krpc_SpaceCenter_GetKerbal(krpc_connection_t connection, krpc_SpaceCenter_CrewMember_t *result, const char *name)¶

Find a Kerbal by name.

Parameters:

krpc_error_t krpc_SpaceCenter_LoadSpaceCenter(krpc_connection_t connection)¶

Switch to the space center view.

krpc_error_t krpc_SpaceCenter_MapFilter(krpc_connection_t connection, krpc_SpaceCenter_MapFilterType_t *result)¶

void krpc_SpaceCenter_set_MapFilter(krpc_SpaceCenter_MapFilterType_t value)¶

The visible objects in map mode.

krpc_error_t krpc_SpaceCenter_Screenshot(krpc_connection_t connection, const char *filePath, int32_t scale)¶

Saves a screenshot.

Parameters:

filePath – The path of the file to save.

scale – Resolution scaling factor

Game Scenes:

Flight

krpc_error_t krpc_SpaceCenter_GameMode(krpc_connection_t connection, krpc_SpaceCenter_GameMode_t *result)¶

The current mode the game is in.

krpc_error_t krpc_SpaceCenter_WarpMode(krpc_connection_t connection, krpc_SpaceCenter_WarpMode_t *result)¶

The current time warp mode. Returns KRPC_SPACECENTER_WARPMODE_NONE if time warp is not active, KRPC_SPACECENTER_WARPMODE_RAILS if regular “on-rails” time warp is active, or KRPC_SPACECENTER_WARPMODE_PHYSICS if physical time warp is active.

Game Scenes:

Flight

krpc_error_t krpc_SpaceCenter_Camera(krpc_connection_t connection, krpc_SpaceCenter_Camera_t *result)¶

An object that can be used to control the camera.

Game Scenes:

Flight

krpc_error_t krpc_SpaceCenter_WaypointManager(krpc_connection_t connection, krpc_SpaceCenter_WaypointManager_t *result)¶

The waypoint manager.

Game Scenes:

Flight

krpc_error_t krpc_SpaceCenter_ContractManager(krpc_connection_t connection, krpc_SpaceCenter_ContractManager_t *result)¶

The contract manager.

krpc_error_t krpc_SpaceCenter_AlarmManager(krpc_connection_t connection, krpc_SpaceCenter_AlarmManager_t *result)¶

The alarm manager.

type krpc_SpaceCenter_GameMode_t¶

The game mode. Returned by krpc_SpaceCenter_GameMode_t

KRPC_SPACECENTER_GAMEMODE_SANDBOX¶: Sandbox mode.

KRPC_SPACECENTER_GAMEMODE_CAREER¶: Career mode.

KRPC_SPACECENTER_GAMEMODE_SCIENCE¶: Science career mode.

KRPC_SPACECENTER_GAMEMODE_SCIENCESANDBOX¶: Science sandbox mode.

KRPC_SPACECENTER_GAMEMODE_MISSION¶: Mission mode.

KRPC_SPACECENTER_GAMEMODE_MISSIONBUILDER¶: Mission builder mode.

KRPC_SPACECENTER_GAMEMODE_SCENARIO¶: Scenario mode.

KRPC_SPACECENTER_GAMEMODE_SCENARIONONRESUMABLE¶: Scenario mode that cannot be resumed.

type krpc_SpaceCenter_WarpMode_t¶

The time warp mode. Returned by krpc_SpaceCenter_WarpMode_t

KRPC_SPACECENTER_WARPMODE_RAILS¶: Time warp is active, and in regular “on-rails” mode.

KRPC_SPACECENTER_WARPMODE_PHYSICS¶: Time warp is active, and in physical time warp mode.

KRPC_SPACECENTER_WARPMODE_NONE¶: Time warp is not active.

type krpc_SpaceCenter_MapFilterType_t¶

The set of things that are visible in map mode. These may be combined with bitwise logic.

KRPC_SPACECENTER_MAPFILTERTYPE_ALL¶: Everything.

KRPC_SPACECENTER_MAPFILTERTYPE_NONE¶: Nothing.

KRPC_SPACECENTER_MAPFILTERTYPE_DEBRIS¶: Debris.

KRPC_SPACECENTER_MAPFILTERTYPE_UNKNOWN¶: Unknown.

KRPC_SPACECENTER_MAPFILTERTYPE_SPACEOBJECTS¶: SpaceObjects.

KRPC_SPACECENTER_MAPFILTERTYPE_PROBES¶: Probes.

KRPC_SPACECENTER_MAPFILTERTYPE_ROVERS¶: Rovers.

KRPC_SPACECENTER_MAPFILTERTYPE_LANDERS¶: Landers.

KRPC_SPACECENTER_MAPFILTERTYPE_SHIPS¶: Ships.

KRPC_SPACECENTER_MAPFILTERTYPE_STATIONS¶: Stations.

KRPC_SPACECENTER_MAPFILTERTYPE_BASES¶: Bases.

KRPC_SPACECENTER_MAPFILTERTYPE_EVAS¶: EVAs.

KRPC_SPACECENTER_MAPFILTERTYPE_FLAGS¶: Flags.

KRPC_SPACECENTER_MAPFILTERTYPE_PLANE¶: Planes.

KRPC_SPACECENTER_MAPFILTERTYPE_RELAY¶: Relays.

KRPC_SPACECENTER_MAPFILTERTYPE_SITE¶: Launch Sites.

KRPC_SPACECENTER_MAPFILTERTYPE_DEPLOYEDSCIENCECONTROLLER¶: Deployed Science Controllers.

type krpc_SpaceCenter_LaunchSite_t¶

A place where craft can be launched from. More of these can be added with mods like Kerbal Konstructs.

krpc_error_t krpc_SpaceCenter_LaunchSite_Name(krpc_connection_t connection, char **result)¶: The name of the launch site.

krpc_error_t krpc_SpaceCenter_LaunchSite_Body(krpc_connection_t connection, krpc_SpaceCenter_CelestialBody_t *result)¶: The celestial body the launch site is on.

krpc_error_t krpc_SpaceCenter_LaunchSite_EditorFacility(krpc_connection_t connection, krpc_SpaceCenter_EditorFacility_t *result)¶: Which editor is normally used for this launch site.

type krpc_SpaceCenter_EditorFacility_t¶

Editor facility. See krpc_SpaceCenter_LaunchSite_EditorFacility().

KRPC_SPACECENTER_EDITORFACILITY_VAB¶: Vehicle Assembly Building.

KRPC_SPACECENTER_EDITORFACILITY_SPH¶: Space Plane Hanger.

KRPC_SPACECENTER_EDITORFACILITY_NONE¶: None.