.. default-domain:: c
.. highlight:: c
Control
=======
.. type:: krpc_SpaceCenter_Control_t
Used to manipulate the controls of a vessel. This includes adjusting the
throttle, enabling/disabling systems such as SAS and RCS, or altering the
direction in which the vessel is pointing.
Obtained by calling :func:`krpc_SpaceCenter_Vessel_Control`.
.. note::
Control inputs (pitch, yaw, roll, translation, wheel throttle, wheel steering
and the custom axes) are zeroed when all clients that have set one or more of
these inputs are no longer connected. The throttle is an exception: it keeps
its value when clients disconnect.
A kerbal on EVA is a vessel, and is driven by these same controls. The
translation inputs move it: :func:`krpc_SpaceCenter_Control_Forward` and :func:`krpc_SpaceCenter_Control_Right` walk
it about, relative to the direction it is facing, and all three translate its
jetpack once that is deployed. Walking is not throttled by the size of the
input, only started by it. The rotation inputs turn it, at a rate proportional
to the input: :func:`krpc_SpaceCenter_Control_Yaw` steers it as it walks, and all three turn its
jetpack. Turning the jetpack releases the kerbal from the orientation it was
holding; it stops and holds its new orientation once the input returns to zero.
:func:`krpc_SpaceCenter_Control_RCS` deploys and stows the jetpack and :func:`krpc_SpaceCenter_Control_Lights`
switches the helmet lamp. The remaining controls do nothing for a kerbal.
A kerbal is also sent out and brought back in from here: with
:func:`krpc_SpaceCenter_CrewMember_EVA` and :func:`krpc_SpaceCenter_Control_Board`, and
:func:`krpc_SpaceCenter_Control_GrabLadder` and :func:`krpc_SpaceCenter_Control_ReleaseLadder` for the ladders it
passes on the way.
.. function:: krpc_error_t krpc_SpaceCenter_Control_Source(krpc_connection_t connection, krpc_SpaceCenter_ControlSource_t * returnValue, krpc_SpaceCenter_Control_t instance)
The source of the vessels control, for example by a kerbal or a probe core.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_State(krpc_connection_t connection, krpc_SpaceCenter_ControlState_t * returnValue, krpc_SpaceCenter_Control_t instance)
The control state of the vessel.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_SAS(krpc_connection_t connection, bool * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_SAS(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, bool value)
The state of SAS.
:Game Scenes: Flight
.. note::
Equivalent to :func:`krpc_SpaceCenter_AutoPilot_SAS`.
Throws an exception if set to ``true`` while the auto-pilot is engaged, as the
auto-pilot holds SAS off for as long as it is flying the vessel.
.. function:: krpc_error_t krpc_SpaceCenter_Control_SASMode(krpc_connection_t connection, krpc_SpaceCenter_SASMode_t * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_SASMode(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, krpc_SpaceCenter_SASMode_t value)
The current :func:`krpc_SpaceCenter_Control_SASMode`.
These modes are equivalent to the mode buttons to
the left of the navball that appear when SAS is enabled.
:Game Scenes: Flight
.. note::
Equivalent to :func:`krpc_SpaceCenter_AutoPilot_SASMode`
.. function:: krpc_error_t krpc_SpaceCenter_Control_SpeedMode(krpc_connection_t connection, krpc_SpaceCenter_SpeedMode_t * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_SpeedMode(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, krpc_SpaceCenter_SpeedMode_t value)
The current :func:`krpc_SpaceCenter_Control_SpeedMode` of the navball.
This is the mode displayed next to the speed at the top of the navball.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_EngineGimbals(krpc_connection_t connection, bool * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_EngineGimbals(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, bool value)
Returns whether all gimballed engines on the vessel have gimbal enabled,
and sets the gimbal enabled state of all gimballed engines.
See :func:`krpc_SpaceCenter_Engine_GimbalLocked`.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_ThrustReversers(krpc_connection_t connection, bool * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_ThrustReversers(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, bool value)
Returns whether all engines with a thrust reverser on the vessel have
their thrust reverser engaged, and sets the thrust reverser state of all
such engines.
See :func:`krpc_SpaceCenter_Engine_ThrustReversed`.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_AeroSurfaces(krpc_connection_t connection, bool * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_AeroSurfaces(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, bool value)
Returns whether all control surfaces on the vessel have pitch, yaw and roll enabled,
and sets the pitch, yaw and roll enabled state of all control surfaces.
See :func:`krpc_SpaceCenter_ControlSurface_PitchEnabled`,
:func:`krpc_SpaceCenter_ControlSurface_YawEnabled` and
:func:`krpc_SpaceCenter_ControlSurface_RollEnabled`.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_RCS(krpc_connection_t connection, bool * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_RCS(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, bool value)
The state of RCS.
:Game Scenes: Flight
.. note::
For a kerbal on EVA this is whether its jetpack is deployed. Deploying it
requires the kerbal to have one and to be the active vessel; otherwise
setting this does nothing.
.. function:: krpc_error_t krpc_SpaceCenter_Control_ReactionWheels(krpc_connection_t connection, bool * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_ReactionWheels(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, bool value)
Returns whether all reactive wheels on the vessel are active,
and sets the active state of all reaction wheels.
See :func:`krpc_SpaceCenter_ReactionWheel_Active`.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_Gear(krpc_connection_t connection, bool * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_Gear(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, bool value)
The state of the landing gear/legs.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_Legs(krpc_connection_t connection, bool * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_Legs(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, bool value)
Returns whether all landing legs on the vessel are deployed,
and sets the deployment state of all landing legs.
Does not include wheels (for example landing gear).
See :func:`krpc_SpaceCenter_Leg_Deployed`.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_Wheels(krpc_connection_t connection, bool * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_Wheels(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, bool value)
Returns whether all wheels on the vessel are deployed,
and sets the deployment state of all wheels.
Does not include landing legs.
See :func:`krpc_SpaceCenter_Wheel_Deployed`.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_Lights(krpc_connection_t connection, bool * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_Lights(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, bool value)
The state of the lights.
:Game Scenes: Flight
.. note::
For a kerbal on EVA this is its helmet lamp. Switching it requires the
kerbal to be the active vessel; otherwise setting this does nothing.
.. function:: krpc_error_t krpc_SpaceCenter_Control_Brakes(krpc_connection_t connection, bool * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_Brakes(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, bool value)
The state of the wheel brakes.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_Antennas(krpc_connection_t connection, bool * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_Antennas(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, bool value)
Returns whether all antennas on the vessel are deployed,
and sets the deployment state of all antennas.
See :func:`krpc_SpaceCenter_Antenna_Deployed`.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_CargoBays(krpc_connection_t connection, bool * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_CargoBays(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, bool value)
Returns whether any of the cargo bays on the vessel are open,
and sets the open state of all cargo bays.
See :func:`krpc_SpaceCenter_CargoBay_Open`.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_Intakes(krpc_connection_t connection, bool * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_Intakes(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, bool value)
Returns whether all of the air intakes on the vessel are open,
and sets the open state of all air intakes.
See :func:`krpc_SpaceCenter_Intake_Open`.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_Parachutes(krpc_connection_t connection, bool * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_Parachutes(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, bool value)
Returns whether all parachutes on the vessel are deployed,
and sets the deployment state of all parachutes.
Cannot be set to ``false``.
See :func:`krpc_SpaceCenter_Parachute_Deployed`.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_Radiators(krpc_connection_t connection, bool * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_Radiators(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, bool value)
Returns whether all radiators on the vessel are deployed,
and sets the deployment state of all radiators.
See :func:`krpc_SpaceCenter_Radiator_Deployed`.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_ResourceHarvesters(krpc_connection_t connection, bool * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_ResourceHarvesters(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, bool value)
Returns whether all of the resource harvesters on the vessel are deployed,
and sets the deployment state of all resource harvesters.
See :func:`krpc_SpaceCenter_ResourceHarvester_Deployed`.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_ResourceHarvestersActive(krpc_connection_t connection, bool * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_ResourceHarvestersActive(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, bool value)
Returns whether any of the resource harvesters on the vessel are active,
and sets the active state of all resource harvesters.
See :func:`krpc_SpaceCenter_ResourceHarvester_Active`.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_SolarPanels(krpc_connection_t connection, bool * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_SolarPanels(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, bool value)
Returns whether all solar panels on the vessel are deployed,
and sets the deployment state of all solar panels.
See :func:`krpc_SpaceCenter_SolarPanel_Deployed`.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_Abort(krpc_connection_t connection, bool * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_Abort(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, bool value)
The state of the abort action group.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_Throttle(krpc_connection_t connection, float * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_Throttle(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, float value)
The state of the throttle. A value between 0 and 1.
Unlike the other control inputs, the throttle is not zeroed when the
clients that set it disconnect.
:Game Scenes: Flight
.. note::
The getter returns the input currently applied to the vessel, which
combines the input set by kRPC with any keyboard, SAS and trim input.
It refreshes one physics tick after a set, so a read immediately after
a set returns the previously applied value rather than the value just set.
.. function:: krpc_error_t krpc_SpaceCenter_Control_InputMode(krpc_connection_t connection, krpc_SpaceCenter_ControlInputMode_t * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_InputMode(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, krpc_SpaceCenter_ControlInputMode_t value)
Sets the behavior of the pitch, yaw, roll and translation control inputs.
When set to additive, these inputs are added to the vessels current inputs.
This mode is the default.
When set to override, these inputs (if non-zero) override the vessels inputs.
This mode prevents keyboard control, or SAS, from interfering with the controls when
they are set.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_Pitch(krpc_connection_t connection, float * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_Pitch(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, float value)
The state of the pitch control.
A value between -1 and 1.
Equivalent to the w and s keys.
:Game Scenes: Flight
.. note::
The getter returns the input currently applied to the vessel, which
combines the input set by kRPC with any keyboard, SAS and trim input.
It refreshes one physics tick after a set, so a read immediately after
a set returns the previously applied value rather than the value just set.
.. function:: krpc_error_t krpc_SpaceCenter_Control_Yaw(krpc_connection_t connection, float * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_Yaw(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, float value)
The state of the yaw control.
A value between -1 and 1.
Equivalent to the a and d keys.
:Game Scenes: Flight
.. note::
The getter returns the input currently applied to the vessel, which
combines the input set by kRPC with any keyboard, SAS and trim input.
It refreshes one physics tick after a set, so a read immediately after
a set returns the previously applied value rather than the value just set.
.. function:: krpc_error_t krpc_SpaceCenter_Control_Roll(krpc_connection_t connection, float * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_Roll(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, float value)
The state of the roll control.
A value between -1 and 1.
Equivalent to the q and e keys.
:Game Scenes: Flight
.. note::
The getter returns the input currently applied to the vessel, which
combines the input set by kRPC with any keyboard, SAS and trim input.
It refreshes one physics tick after a set, so a read immediately after
a set returns the previously applied value rather than the value just set.
.. function:: krpc_error_t krpc_SpaceCenter_Control_PitchTrim(krpc_connection_t connection, float * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_PitchTrim(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, float value)
The state of the pitch trim.
A value between -1 and 1.
Equivalent to the Alt+W and Alt+S keys.
This is a persistent trim that remains latched until changed or reset,
and can only be accessed for the active vessel.
Unlike the pitch, yaw and roll control inputs, the trim is not cleared
when clients disconnect.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_YawTrim(krpc_connection_t connection, float * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_YawTrim(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, float value)
The state of the yaw trim.
A value between -1 and 1.
Equivalent to the Alt+A and Alt+D keys.
This is a persistent trim that remains latched until changed or reset,
and can only be accessed for the active vessel.
Unlike the pitch, yaw and roll control inputs, the trim is not cleared
when clients disconnect.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_RollTrim(krpc_connection_t connection, float * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_RollTrim(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, float value)
The state of the roll trim.
A value between -1 and 1.
Equivalent to the Alt+Q and Alt+E keys.
This is a persistent trim that remains latched until changed or reset,
and can only be accessed for the active vessel.
Unlike the pitch, yaw and roll control inputs, the trim is not cleared
when clients disconnect.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_PrecisionMode(krpc_connection_t connection, bool * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_PrecisionMode(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, bool value)
Whether precision control mode is enabled.
Equivalent to the Caps Lock key.
This is a game setting rather than a vessel setting,
and can only be accessed for the active vessel.
Unlike the pitch, yaw and roll control inputs, precision mode is not cleared
when clients disconnect.
:Game Scenes: Flight
.. note::
Precision mode weakens the RCS thrust that the control inputs produce. A block
driven by :func:`krpc_SpaceCenter_RCS_InputOverride` is exempt.
.. function:: krpc_error_t krpc_SpaceCenter_Control_Forward(krpc_connection_t connection, float * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_Forward(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, float value)
The state of the forward translational control.
A value between -1 and 1.
Equivalent to the h and n keys.
:Game Scenes: Flight
.. note::
The getter returns the input currently applied to the vessel, which
combines the input set by kRPC with any keyboard, SAS and trim input.
It refreshes one physics tick after a set, so a read immediately after
a set returns the previously applied value rather than the value just set.
.. function:: krpc_error_t krpc_SpaceCenter_Control_Up(krpc_connection_t connection, float * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_Up(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, float value)
The state of the up translational control.
A value between -1 and 1.
Equivalent to the i and k keys.
:Game Scenes: Flight
.. note::
The getter returns the input currently applied to the vessel, which
combines the input set by kRPC with any keyboard, SAS and trim input.
It refreshes one physics tick after a set, so a read immediately after
a set returns the previously applied value rather than the value just set.
.. function:: krpc_error_t krpc_SpaceCenter_Control_Right(krpc_connection_t connection, float * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_Right(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, float value)
The state of the right translational control.
A value between -1 and 1.
Equivalent to the j and l keys.
:Game Scenes: Flight
.. note::
The getter returns the input currently applied to the vessel, which
combines the input set by kRPC with any keyboard, SAS and trim input.
It refreshes one physics tick after a set, so a read immediately after
a set returns the previously applied value rather than the value just set.
.. function:: krpc_error_t krpc_SpaceCenter_Control_WheelThrottle(krpc_connection_t connection, float * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_WheelThrottle(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, float value)
The state of the wheel throttle.
A value between -1 and 1.
A value of 1 rotates the wheels forwards, a value of -1 rotates
the wheels backwards.
:Game Scenes: Flight
.. note::
The getter returns the input currently applied to the vessel, which
combines the input set by kRPC with any keyboard, SAS and trim input.
It refreshes one physics tick after a set, so a read immediately after
a set returns the previously applied value rather than the value just set.
.. function:: krpc_error_t krpc_SpaceCenter_Control_WheelSteering(krpc_connection_t connection, float * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_WheelSteering(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, float value)
The state of the wheel steering.
A value between -1 and 1.
A value of 1 steers to the left, and a value of -1 steers to the right.
:Game Scenes: Flight
.. note::
The getter returns the input currently applied to the vessel, which
combines the input set by kRPC with any keyboard, SAS and trim input.
It refreshes one physics tick after a set, so a read immediately after
a set returns the previously applied value rather than the value just set.
.. function:: krpc_error_t krpc_SpaceCenter_Control_CustomAxis01(krpc_connection_t connection, float * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_CustomAxis01(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, float value)
The state of CustomAxis01.
A value between -1 and 1.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_CustomAxis02(krpc_connection_t connection, float * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_CustomAxis02(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, float value)
The state of CustomAxis02.
A value between -1 and 1.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_CustomAxis03(krpc_connection_t connection, float * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_CustomAxis03(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, float value)
The state of CustomAxis03.
A value between -1 and 1.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_CustomAxis04(krpc_connection_t connection, float * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_CustomAxis04(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, float value)
The state of CustomAxis04.
A value between -1 and 1.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_CurrentStage(krpc_connection_t connection, int32_t * returnValue, krpc_SpaceCenter_Control_t instance)
The current stage of the vessel. Corresponds to the stage number in
the in-game UI.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_ActivateNextStage(krpc_connection_t connection, krpc_list_object_t * returnValue, krpc_SpaceCenter_Control_t instance)
Activates the next stage. Equivalent to pressing the space bar in-game.
:returns: A list of vessel objects that are jettisoned from the active vessel.
:Game Scenes: Flight
.. note::
When called, the active vessel may change. It is therefore possible that,
after calling this function, the object(s) returned by previous call(s) to
:func:`krpc_SpaceCenter_ActiveVessel` no longer refer to the active vessel.
Throws an exception if staging is locked.
.. function:: krpc_error_t krpc_SpaceCenter_Control_StageLock(krpc_connection_t connection, bool * returnValue, krpc_SpaceCenter_Control_t instance)
.. function:: krpc_error_t krpc_SpaceCenter_Control_set_StageLock(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, bool value)
Whether staging is locked on the vessel.
:Game Scenes: Flight
.. note::
This is equivalent to locking the staging using Alt+L
.. function:: krpc_error_t krpc_SpaceCenter_Control_GetActionGroup(krpc_connection_t connection, bool * returnValue, krpc_SpaceCenter_Control_t instance, uint32_t group)
Returns ``true`` if the given action group is enabled.
:Parameters:
* **group** -- A number between 0 and 9 inclusive, or between 0 and 250 inclusive when the `Extended Action Groups mod `_ is installed.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_SetActionGroup(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, uint32_t group, bool state)
Sets the state of the given action group.
:Parameters:
* **group** -- A number between 0 and 9 inclusive, or between 0 and 250 inclusive when the `Extended Action Groups mod `_ is installed.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_ToggleActionGroup(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance, uint32_t group)
Toggles the state of the given action group.
:Parameters:
* **group** -- A number between 0 and 9 inclusive, or between 0 and 250 inclusive when the `Extended Action Groups mod `_ is installed.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_GetActionGroupActions(krpc_connection_t connection, krpc_list_SpaceCenter_ActionGroupAction_t * returnValue, krpc_SpaceCenter_Control_t instance, uint32_t group)
Returns a list of all the part actions that are assigned to the given action group.
Each entry identifies the part, the part module, and the action's name and identifier.
Returns an empty list if no actions are assigned to the group.
:Parameters:
* **group** -- A number between 0 and 9 inclusive, or between 0 and 250 inclusive when the `Extended Action Groups mod `_ is installed.
:Game Scenes: Flight
.. note::
For stock action groups, the assignments are read from each part action directly.
When the Extended Action Groups mod is installed, the assignments are queried from
the mod instead, so that actions assigned to its additional groups are included.
.. function:: krpc_error_t krpc_SpaceCenter_Control_AddNode(krpc_connection_t connection, krpc_SpaceCenter_Node_t * returnValue, krpc_SpaceCenter_Control_t instance, double ut, float prograde, float normal, float radial)
Creates a maneuver node at the given universal time, and returns a
:type:`krpc_SpaceCenter_Node_t` object that can be used to modify it.
Optionally sets the magnitude of the delta-v for the maneuver node
in the prograde, normal and radial directions.
:Parameters:
* **ut** -- Universal time of the maneuver node.
* **prograde** -- Delta-v in the prograde direction.
* **normal** -- Delta-v in the normal direction.
* **radial** -- Delta-v in the radial direction.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_Nodes(krpc_connection_t connection, krpc_list_object_t * returnValue, krpc_SpaceCenter_Control_t instance)
Returns a list of all existing maneuver nodes, ordered by time from first to last.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_RemoveNodes(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance)
Remove all maneuver nodes.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_Airlock(krpc_connection_t connection, krpc_SpaceCenter_Part_t * returnValue, krpc_SpaceCenter_Control_t instance)
The part whose hatch the kerbal is standing at, and so the one
:func:`krpc_SpaceCenter_Control_Board` would put it in. ``nullptr`` if it is not at a hatch or the
vessel is not a kerbal on EVA.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_Board(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance)
Climb into the part whose hatch the kerbal is standing at, ending the EVA. The
kerbal takes a seat in that part and its own vessel ceases to exist. If the
kerbal was the active vessel, the game switches to the vessel it boarded.
:Game Scenes: Flight
.. note::
A kerbal can only board through a hatch it is already at, which
:func:`krpc_SpaceCenter_Control_Airlock` reports; it does not walk to one. Throws an exception if
the vessel is not a kerbal on EVA, if the kerbal is not at a hatch, if boarding
is disabled for the game, if the part has no free seat, or if the kerbal is
carrying science data that the part cannot store, as the game asks what to do
with it in that case.
.. function:: krpc_error_t krpc_SpaceCenter_Control_Ladder(krpc_connection_t connection, krpc_SpaceCenter_Part_t * returnValue, krpc_SpaceCenter_Control_t instance)
The ladder the kerbal is holding on to, or ``nullptr`` if it is not holding one
or the vessel is not a kerbal on EVA.
:Game Scenes: Flight
.. function:: krpc_error_t krpc_SpaceCenter_Control_GrabLadder(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance)
Take hold of the ladder the kerbal is standing at, as pressing the grab key
in-game does. A kerbal can only take hold of a ladder it is already alongside;
it does not walk to one. :func:`krpc_SpaceCenter_Control_Ladder` reports the one it ends up
holding. Does nothing if the kerbal is already holding a ladder.
:Game Scenes: Flight
.. note::
Throws an exception if the vessel is not a kerbal on EVA, if there is no ladder
within reach, or if the kerbal is doing something it cannot grab a ladder from.
.. function:: krpc_error_t krpc_SpaceCenter_Control_ReleaseLadder(krpc_connection_t connection, krpc_SpaceCenter_Control_t instance)
Let go of the ladder the kerbal is holding, as pressing the jump key in-game
does. Does nothing if it is not holding one.
:Game Scenes: Flight
.. note::
Throws an exception if the vessel is not a kerbal on EVA.
.. type:: krpc_SpaceCenter_ActionGroupAction_t
An action, belonging to a part module, that is assigned to an action group.
Obtained by calling :func:`krpc_SpaceCenter_Control_GetActionGroupActions`.
.. member:: krpc_SpaceCenter_Part_t part
The part that the action acts on.
.. member:: krpc_nullable_object_t module
The part module that the action belongs to. Returns ``nullptr`` for a
part-level action that is not associated with a module. This only occurs when
the Extended Action Groups mod is installed, as it can assign actions defined
directly on a part, rather than on one of its modules, to an action group.
.. member:: char * name
The human-readable name of the action, as shown in the action group editor.
.. member:: char * id
The non-localized identifier for the action.
.. type:: krpc_SpaceCenter_ControlState_t
The control state of a vessel.
See :func:`krpc_SpaceCenter_Control_State`.
.. macro:: KRPC_SPACECENTER_CONTROLSTATE_FULL
Full controllable.
.. macro:: KRPC_SPACECENTER_CONTROLSTATE_PARTIAL
Partially controllable.
.. macro:: KRPC_SPACECENTER_CONTROLSTATE_NONE
Not controllable.
.. type:: krpc_SpaceCenter_ControlSource_t
The control source of a vessel.
See :func:`krpc_SpaceCenter_Control_Source`.
.. macro:: KRPC_SPACECENTER_CONTROLSOURCE_KERBAL
Vessel is controlled by a Kerbal.
.. macro:: KRPC_SPACECENTER_CONTROLSOURCE_PROBE
Vessel is controlled by a probe core.
.. macro:: KRPC_SPACECENTER_CONTROLSOURCE_NONE
Vessel is not controlled.
.. type:: krpc_SpaceCenter_SASMode_t
The behavior of the SAS auto-pilot. See :func:`krpc_SpaceCenter_AutoPilot_SASMode`.
.. macro:: KRPC_SPACECENTER_SASMODE_STABILITYASSIST
Stability assist mode. Dampen out any rotation.
.. macro:: KRPC_SPACECENTER_SASMODE_MANEUVER
Point in the burn direction of the next maneuver node.
.. macro:: KRPC_SPACECENTER_SASMODE_PROGRADE
Point in the prograde direction.
.. macro:: KRPC_SPACECENTER_SASMODE_RETROGRADE
Point in the retrograde direction.
.. macro:: KRPC_SPACECENTER_SASMODE_NORMAL
Point in the orbit normal direction.
.. macro:: KRPC_SPACECENTER_SASMODE_ANTINORMAL
Point in the orbit anti-normal direction.
.. macro:: KRPC_SPACECENTER_SASMODE_RADIAL
Point in the orbit radial direction.
.. macro:: KRPC_SPACECENTER_SASMODE_ANTIRADIAL
Point in the orbit anti-radial direction.
.. macro:: KRPC_SPACECENTER_SASMODE_TARGET
Point in the direction of the current target.
.. macro:: KRPC_SPACECENTER_SASMODE_ANTITARGET
Point away from the current target.
.. type:: krpc_SpaceCenter_SpeedMode_t
The mode of the speed reported in the navball.
See :func:`krpc_SpaceCenter_Control_SpeedMode`.
.. macro:: KRPC_SPACECENTER_SPEEDMODE_ORBIT
Speed is relative to the vessel's orbit.
.. macro:: KRPC_SPACECENTER_SPEEDMODE_SURFACE
Speed is relative to the surface of the body being orbited.
.. macro:: KRPC_SPACECENTER_SPEEDMODE_TARGET
Speed is relative to the current target.
.. type:: krpc_SpaceCenter_ControlInputMode_t
See :func:`krpc_SpaceCenter_Control_InputMode`.
.. macro:: KRPC_SPACECENTER_CONTROLINPUTMODE_ADDITIVE
Control inputs are added to the vessels current control inputs.
.. macro:: KRPC_SPACECENTER_CONTROLINPUTMODE_OVERRIDE
Control inputs (when they are non-zero) override the vessels current control inputs.