Control

class 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 Vessel::control().

Note

Control inputs (such as pitch, yaw and roll) are zeroed when all clients that have set one or more of these inputs are no longer connected.

ControlSource source()

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

Game Scenes:

Flight

ControlState state()

The control state of the vessel.

Game Scenes:

Flight

bool sas()
void set_sas(bool value)

The state of SAS.

Game Scenes:

Flight

Note

Equivalent to AutoPilot::sas()

SASMode sas_mode()
void set_sas_mode(SASMode value)

The current 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 AutoPilot::sas_mode()

SpeedMode speed_mode()
void set_speed_mode(SpeedMode value)

The current SpeedMode of the navball. This is the mode displayed next to the speed at the top of the navball.

Game Scenes:

Flight

bool rcs()
void set_rcs(bool value)

The state of RCS.

Game Scenes:

Flight

bool reaction_wheels()
void set_reaction_wheels(bool value)

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

Game Scenes:

Flight

bool gear()
void set_gear(bool value)

The state of the landing gear/legs.

Game Scenes:

Flight

bool legs()
void set_legs(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 Leg::deployed().

Game Scenes:

Flight

bool wheels()
void set_wheels(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 Wheel::deployed().

Game Scenes:

Flight

bool lights()
void set_lights(bool value)

The state of the lights.

Game Scenes:

Flight

bool brakes()
void set_brakes(bool value)

The state of the wheel brakes.

Game Scenes:

Flight

bool antennas()
void set_antennas(bool value)

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

Game Scenes:

Flight

bool cargo_bays()
void set_cargo_bays(bool value)

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

Game Scenes:

Flight

bool intakes()
void set_intakes(bool value)

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

Game Scenes:

Flight

bool parachutes()
void set_parachutes(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 Parachute::deployed().

Game Scenes:

Flight

bool radiators()
void set_radiators(bool value)

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

Game Scenes:

Flight

bool resource_harvesters()
void set_resource_harvesters(bool value)

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

Game Scenes:

Flight

bool resource_harvesters_active()
void set_resource_harvesters_active(bool value)

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

Game Scenes:

Flight

bool solar_panels()
void set_solar_panels(bool value)

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

Game Scenes:

Flight

bool abort()
void set_abort(bool value)

The state of the abort action group.

Game Scenes:

Flight

float throttle()
void set_throttle(float value)

The state of the throttle. A value between 0 and 1.

Game Scenes:

Flight

ControlInputMode input_mode()
void set_input_mode(ControlInputMode 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

float pitch()
void set_pitch(float value)

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

Game Scenes:

Flight

float yaw()
void set_yaw(float value)

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

Game Scenes:

Flight

float roll()
void set_roll(float value)

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

Game Scenes:

Flight

float forward()
void set_forward(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

float up()
void set_up(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

float right()
void set_right(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

float wheel_throttle()
void set_wheel_throttle(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

float wheel_steering()
void set_wheel_steering(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

float custom_axis01()
void set_custom_axis01(float value)

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

Game Scenes:

Flight

float custom_axis02()
void set_custom_axis02(float value)

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

Game Scenes:

Flight

float custom_axis03()
void set_custom_axis03(float value)

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

Game Scenes:

Flight

float custom_axis04()
void set_custom_axis04(float value)

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

Game Scenes:

Flight

int32_t current_stage()

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

Game Scenes:

Flight

std::vector<Vessel> 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.

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

bool stage_lock()
void set_stage_lock(bool value)

Whether staging is locked on the vessel.

Game Scenes:

Flight

Note

This is equivalent to locking the staging using Alt+L

bool get_action_group(uint32_t group)

Returns true if the given action group is enabled.

Parameters:
Game Scenes:

Flight

void set_action_group(uint32_t group, bool state)

Sets the state of the given action group.

Parameters:
Game Scenes:

Flight

void toggle_action_group(uint32_t group)

Toggles the state of the given action group.

Parameters:
Game Scenes:

Flight

Node add_node(double ut, float prograde = 0.0, float normal = 0.0, float radial = 0.0)

Creates a maneuver node at the given universal time, and returns a 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 – 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

std::vector<Node> nodes()

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

Game Scenes:

Flight

void remove_nodes()

Remove all maneuver nodes.

Game Scenes:

Flight

enum struct ControlState

The control state of a vessel. See Control::state().

enumerator full

Full controllable.

enumerator partial

Partially controllable.

enumerator none

Not controllable.

enum struct ControlSource

The control source of a vessel. See Control::source().

enumerator kerbal

Vessel is controlled by a Kerbal.

enumerator probe

Vessel is controlled by a probe core.

enumerator none

Vessel is not controlled.

enum struct SASMode

The behavior of the SAS auto-pilot. See AutoPilot::sas_mode().

enumerator stability_assist

Stability assist mode. Dampen out any rotation.

enumerator maneuver

Point in the burn direction of the next maneuver node.

enumerator prograde

Point in the prograde direction.

enumerator retrograde

Point in the retrograde direction.

enumerator normal

Point in the orbit normal direction.

enumerator anti_normal

Point in the orbit anti-normal direction.

enumerator radial

Point in the orbit radial direction.

enumerator anti_radial

Point in the orbit anti-radial direction.

enumerator target

Point in the direction of the current target.

enumerator anti_target

Point away from the current target.

enum struct SpeedMode

The mode of the speed reported in the navball. See Control::speed_mode().

enumerator orbit

Speed is relative to the vessel’s orbit.

enumerator surface

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

enumerator target

Speed is relative to the current target.

enum struct ControlInputMode

See Control::input_mode().

enumerator additive

Control inputs are added to the vessels current control inputs.

enumerator override

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