Control — kRPC v0.7.0 documentation

class SpaceCenter.Control#

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 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: SpaceCenter.Control.forward and 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: 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. SpaceCenter.Control.rcs deploys and stows the jetpack and 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 SpaceCenter.CrewMember.eva() and SpaceCenter.Control.board(), and SpaceCenter.Control.grab_ladder() and SpaceCenter.Control.release_ladder() for the ladders it passes on the way.

source: SpaceCenter.ControlSource#

The source of the vessels control, for example by a kerbal or a probe core.

Attribute:: Read-only, cannot be set
Return type:: SpaceCenter.ControlSource

state: SpaceCenter.ControlState#

The control state of the vessel.

Attribute:: Read-only, cannot be set
Return type:: SpaceCenter.ControlState

sas: boolean#

The state of SAS.

Attribute:: Can be read or written
Return type:: boolean

Note

Equivalent to 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.

sas_mode: SpaceCenter.SASMode#

The current SpaceCenter.Control.sas_mode. These modes are equivalent to the mode buttons to the left of the navball that appear when SAS is enabled.

Attribute:: Can be read or written
Return type:: SpaceCenter.SASMode

Note

Equivalent to SpaceCenter.AutoPilot.sas_mode

speed_mode: SpaceCenter.SpeedMode#

The current SpaceCenter.Control.speed_mode of the navball. This is the mode displayed next to the speed at the top of the navball.

Attribute:: Can be read or written
Return type:: SpaceCenter.SpeedMode

engine_gimbals: boolean#

Returns whether all gimballed engines on the vessel have gimbal enabled, and sets the gimbal enabled state of all gimballed engines. See SpaceCenter.Engine.gimbal_locked.

Attribute:: Can be read or written
Return type:: boolean

thrust_reversers: boolean#

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 SpaceCenter.Engine.thrust_reversed.

Attribute:: Can be read or written
Return type:: boolean

aero_surfaces: boolean#

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 SpaceCenter.ControlSurface.pitch_enabled, SpaceCenter.ControlSurface.yaw_enabled and SpaceCenter.ControlSurface.roll_enabled.

Attribute:: Can be read or written
Return type:: boolean

rcs: boolean#

The state of RCS.

Attribute:: Can be read or written
Return type:: boolean

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.

reaction_wheels: boolean#

Returns whether all reactive wheels on the vessel are active, and sets the active state of all reaction wheels. See SpaceCenter.ReactionWheel.active.

Attribute:: Can be read or written
Return type:: boolean

gear: boolean#

The state of the landing gear/legs.

Attribute:: Can be read or written
Return type:: boolean

legs: boolean#

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 SpaceCenter.Leg.deployed.

Attribute:: Can be read or written
Return type:: boolean

wheels: boolean#

Returns whether all wheels on the vessel are deployed, and sets the deployment state of all wheels. Does not include landing legs. See SpaceCenter.Wheel.deployed.

Attribute:: Can be read or written
Return type:: boolean

lights: boolean#

The state of the lights.

Attribute:: Can be read or written
Return type:: boolean

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.

brakes: boolean#

The state of the wheel brakes.

Attribute:: Can be read or written
Return type:: boolean

antennas: boolean#

Returns whether all antennas on the vessel are deployed, and sets the deployment state of all antennas. See SpaceCenter.Antenna.deployed.

Attribute:: Can be read or written
Return type:: boolean

cargo_bays: boolean#

Returns whether any of the cargo bays on the vessel are open, and sets the open state of all cargo bays. See SpaceCenter.CargoBay.open.

Attribute:: Can be read or written
Return type:: boolean

intakes: boolean#

Returns whether all of the air intakes on the vessel are open, and sets the open state of all air intakes. See SpaceCenter.Intake.open.

Attribute:: Can be read or written
Return type:: boolean

parachutes: boolean#

Returns whether all parachutes on the vessel are deployed, and sets the deployment state of all parachutes. Cannot be set to False. See SpaceCenter.Parachute.deployed.

Attribute:: Can be read or written
Return type:: boolean

radiators: boolean#

Returns whether all radiators on the vessel are deployed, and sets the deployment state of all radiators. See SpaceCenter.Radiator.deployed.

Attribute:: Can be read or written
Return type:: boolean

resource_harvesters: boolean#

Returns whether all of the resource harvesters on the vessel are deployed, and sets the deployment state of all resource harvesters. See SpaceCenter.ResourceHarvester.deployed.

Attribute:: Can be read or written
Return type:: boolean

resource_harvesters_active: boolean#

Returns whether any of the resource harvesters on the vessel are active, and sets the active state of all resource harvesters. See SpaceCenter.ResourceHarvester.active.

Attribute:: Can be read or written
Return type:: boolean

solar_panels: boolean#

Returns whether all solar panels on the vessel are deployed, and sets the deployment state of all solar panels. See SpaceCenter.SolarPanel.deployed.

Attribute:: Can be read or written
Return type:: boolean

abort: boolean#

The state of the abort action group.

Attribute:: Can be read or written
Return type:: boolean

throttle: number#

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.

Attribute:: Can be read or written
Return type:: number

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.

input_mode: SpaceCenter.ControlInputMode#

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.

Attribute:: Can be read or written
Return type:: SpaceCenter.ControlInputMode

pitch: number#

The state of the pitch control. A value between -1 and 1. Equivalent to the w and s keys.

Attribute:: Can be read or written
Return type:: number

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.

yaw: number#

The state of the yaw control. A value between -1 and 1. Equivalent to the a and d keys.

Attribute:: Can be read or written
Return type:: number

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.

roll: number#

The state of the roll control. A value between -1 and 1. Equivalent to the q and e keys.

Attribute:: Can be read or written
Return type:: number

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.

pitch_trim: number#

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.

Attribute:: Can be read or written
Return type:: number

yaw_trim: number#

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.

Attribute:: Can be read or written
Return type:: number

roll_trim: number#

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.

Attribute:: Can be read or written
Return type:: number

precision_mode: boolean#

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.

Attribute:: Can be read or written
Return type:: boolean

Note

Precision mode weakens the RCS thrust that the control inputs produce. A block driven by SpaceCenter.RCS.input_override is exempt.

forward: number#

The state of the forward translational control. A value between -1 and 1. Equivalent to the h and n keys.

Attribute:: Can be read or written
Return type:: number

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.

up: number#

The state of the up translational control. A value between -1 and 1. Equivalent to the i and k keys.

Attribute:: Can be read or written
Return type:: number

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.

right: number#

The state of the right translational control. A value between -1 and 1. Equivalent to the j and l keys.

Attribute:: Can be read or written
Return type:: number

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.

wheel_throttle: number#

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.

Attribute:: Can be read or written
Return type:: number

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.

wheel_steering: number#

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.

Attribute:: Can be read or written
Return type:: number

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.

custom_axis01: number#

The state of CustomAxis01. A value between -1 and 1.

Attribute:: Can be read or written
Return type:: number

custom_axis02: number#

The state of CustomAxis02. A value between -1 and 1.

Attribute:: Can be read or written
Return type:: number

custom_axis03: number#

The state of CustomAxis03. A value between -1 and 1.

Attribute:: Can be read or written
Return type:: number

custom_axis04: number#

The state of CustomAxis04. A value between -1 and 1.

Attribute:: Can be read or written
Return type:: number

current_stage: number#

The current stage of the vessel. Corresponds to the stage number in the in-game UI.

Attribute:: Read-only, cannot be set
Return type:: number

activate_next_stage()#

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.
Return type:: List

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 SpaceCenter.active_vessel no longer refer to the active vessel. Throws an exception if staging is locked.

stage_lock: boolean#

Whether staging is locked on the vessel.

Attribute:: Can be read or written
Return type:: boolean

Note

This is equivalent to locking the staging using Alt+L

get_action_group(group)#

Returns True if the given action group is enabled.

Parameters:: group (number) – A number between 0 and 9 inclusive, or between 0 and 250 inclusive when the Extended Action Groups mod is installed.
Return type:: boolean

set_action_group(group, state)#

Sets the state of the given action group.

Parameters:

group (number) –
A number between 0 and 9 inclusive, or between 0 and 250 inclusive when the Extended Action Groups mod is installed.
state (boolean)

toggle_action_group(group)#

Toggles the state of the given action group.

Parameters:

group (number) –

A number between 0 and 9 inclusive, or between 0 and 250 inclusive when the Extended Action Groups mod is installed.

get_action_group_actions(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 (number) –

A number between 0 and 9 inclusive, or between 0 and 250 inclusive when the Extended Action Groups mod is installed.

Return type:

List

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.

add_node(ut[, prograde = 0.0][, normal = 0.0][, radial = 0.0])#

Creates a maneuver node at the given universal time, and returns a SpaceCenter.Node 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 (number) – Universal time of the maneuver node.
prograde (number) – Delta-v in the prograde direction.
normal (number) – Delta-v in the normal direction.
radial (number) – Delta-v in the radial direction.

Return type:

SpaceCenter.Node

nodes: List#

Returns a list of all existing maneuver nodes, ordered by time from first to last.

Attribute:: Read-only, cannot be set
Return type:: List

remove_nodes()#: Remove all maneuver nodes.

airlock: SpaceCenter.Part#

The part whose hatch the kerbal is standing at, and so the one SpaceCenter.Control.board() would put it in. nil if it is not at a hatch or the vessel is not a kerbal on EVA.

Attribute:: Read-only, cannot be set
Return type:: SpaceCenter.Part or Types.none

board()#: 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.

Note

A kerbal can only board through a hatch it is already at, which 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.

ladder: SpaceCenter.Part#

The ladder the kerbal is holding on to, or nil if it is not holding one or the vessel is not a kerbal on EVA.

Attribute:: Read-only, cannot be set
Return type:: SpaceCenter.Part or Types.none

grab_ladder()#: 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. SpaceCenter.Control.ladder reports the one it ends up holding. Does nothing if the kerbal is already holding a ladder.

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.

release_ladder()#: 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.

Note

Throws an exception if the vessel is not a kerbal on EVA.

class SpaceCenter.ActionGroupAction#

An action, belonging to a part module, that is assigned to an action group. Obtained by calling SpaceCenter.Control.get_action_group_actions().

part: SpaceCenter.Part#

The part that the action acts on.

Return type:: SpaceCenter.Part

module: SpaceCenter.Module#

The part module that the action belongs to. Returns nil 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.

Return type:: SpaceCenter.Module or Types.none

name: string#

The human-readable name of the action, as shown in the action group editor.

Return type:: string

id: string#

The non-localized identifier for the action.

Return type:: string

class SpaceCenter.ControlState#

The control state of a vessel. See SpaceCenter.Control.state.

full#: Full controllable.

partial#: Partially controllable.

none#: Not controllable.

class SpaceCenter.ControlSource#

The control source of a vessel. See SpaceCenter.Control.source.

kerbal#: Vessel is controlled by a Kerbal.

probe#: Vessel is controlled by a probe core.

none#: Vessel is not controlled.

class SpaceCenter.SASMode#

The behavior of the SAS auto-pilot. See SpaceCenter.AutoPilot.sas_mode.

stability_assist#: Stability assist mode. Dampen out any rotation.

maneuver#: Point in the burn direction of the next maneuver node.

prograde#: Point in the prograde direction.

retrograde#: Point in the retrograde direction.

normal#: Point in the orbit normal direction.

anti_normal#: Point in the orbit anti-normal direction.

radial#: Point in the orbit radial direction.

anti_radial#: Point in the orbit anti-radial direction.

target#: Point in the direction of the current target.

anti_target#: Point away from the current target.

class SpaceCenter.SpeedMode#

The mode of the speed reported in the navball. See SpaceCenter.Control.speed_mode.

orbit#: Speed is relative to the vessel’s orbit.

surface#: Speed is relative to the surface of the body being orbited.

target#: Speed is relative to the current target.

class SpaceCenter.ControlInputMode#

See SpaceCenter.Control.input_mode.

additive#: Control inputs are added to the vessels current control inputs.

override#: Control inputs (when they are non-zero) override the vessels current control inputs.