.. default-domain:: py
.. highlight:: py
.. currentmodule:: SpaceCenter
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 :attr:`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.
.. attribute:: source
The source of the vessels control, for example by a kerbal or a probe core.
:Attribute: Read-only, cannot be set
:rtype: :class:`ControlSource`
:Game Scenes: Flight
.. attribute:: state
The control state of the vessel.
:Attribute: Read-only, cannot be set
:rtype: :class:`ControlState`
:Game Scenes: Flight
.. attribute:: sas
The state of SAS.
:Attribute: Can be read or written
:rtype: bool
:Game Scenes: Flight
.. note::
Equivalent to :attr:`AutoPilot.sas`
.. attribute:: sas_mode
The current :class:`SASMode`.
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
:rtype: :class:`SASMode`
:Game Scenes: Flight
.. note::
Equivalent to :attr:`AutoPilot.sas_mode`
.. attribute:: speed_mode
The current :class:`SpeedMode` of the navball.
This is the mode displayed next to the speed at the top of the navball.
:Attribute: Can be read or written
:rtype: :class:`SpeedMode`
:Game Scenes: Flight
.. attribute:: rcs
The state of RCS.
:Attribute: Can be read or written
:rtype: bool
:Game Scenes: Flight
.. attribute:: reaction_wheels
Returns whether all reactive wheels on the vessel are active,
and sets the active state of all reaction wheels.
See :attr:`ReactionWheel.active`.
:Attribute: Can be read or written
:rtype: bool
:Game Scenes: Flight
.. attribute:: gear
The state of the landing gear/legs.
:Attribute: Can be read or written
:rtype: bool
:Game Scenes: Flight
.. attribute:: legs
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 :attr:`Leg.deployed`.
:Attribute: Can be read or written
:rtype: bool
:Game Scenes: Flight
.. attribute:: wheels
Returns whether all wheels on the vessel are deployed,
and sets the deployment state of all wheels.
Does not include landing legs.
See :attr:`Wheel.deployed`.
:Attribute: Can be read or written
:rtype: bool
:Game Scenes: Flight
.. attribute:: lights
The state of the lights.
:Attribute: Can be read or written
:rtype: bool
:Game Scenes: Flight
.. attribute:: brakes
The state of the wheel brakes.
:Attribute: Can be read or written
:rtype: bool
:Game Scenes: Flight
.. attribute:: antennas
Returns whether all antennas on the vessel are deployed,
and sets the deployment state of all antennas.
See :attr:`Antenna.deployed`.
:Attribute: Can be read or written
:rtype: bool
:Game Scenes: Flight
.. attribute:: cargo_bays
Returns whether any of the cargo bays on the vessel are open,
and sets the open state of all cargo bays.
See :attr:`CargoBay.open`.
:Attribute: Can be read or written
:rtype: bool
:Game Scenes: Flight
.. attribute:: intakes
Returns whether all of the air intakes on the vessel are open,
and sets the open state of all air intakes.
See :attr:`Intake.open`.
:Attribute: Can be read or written
:rtype: bool
:Game Scenes: Flight
.. attribute:: parachutes
Returns whether all parachutes on the vessel are deployed,
and sets the deployment state of all parachutes.
Cannot be set to ``False``.
See :attr:`Parachute.deployed`.
:Attribute: Can be read or written
:rtype: bool
:Game Scenes: Flight
.. attribute:: radiators
Returns whether all radiators on the vessel are deployed,
and sets the deployment state of all radiators.
See :attr:`Radiator.deployed`.
:Attribute: Can be read or written
:rtype: bool
:Game Scenes: Flight
.. attribute:: resource_harvesters
Returns whether all of the resource harvesters on the vessel are deployed,
and sets the deployment state of all resource harvesters.
See :attr:`ResourceHarvester.deployed`.
:Attribute: Can be read or written
:rtype: bool
:Game Scenes: Flight
.. attribute:: resource_harvesters_active
Returns whether any of the resource harvesters on the vessel are active,
and sets the active state of all resource harvesters.
See :attr:`ResourceHarvester.active`.
:Attribute: Can be read or written
:rtype: bool
:Game Scenes: Flight
.. attribute:: solar_panels
Returns whether all solar panels on the vessel are deployed,
and sets the deployment state of all solar panels.
See :attr:`SolarPanel.deployed`.
:Attribute: Can be read or written
:rtype: bool
:Game Scenes: Flight
.. attribute:: abort
The state of the abort action group.
:Attribute: Can be read or written
:rtype: bool
:Game Scenes: Flight
.. attribute:: throttle
The state of the throttle. A value between 0 and 1.
:Attribute: Can be read or written
:rtype: float
:Game Scenes: Flight
.. attribute:: input_mode
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
:rtype: :class:`ControlInputMode`
:Game Scenes: Flight
.. attribute:: pitch
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
:rtype: float
:Game Scenes: Flight
.. attribute:: yaw
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
:rtype: float
:Game Scenes: Flight
.. attribute:: roll
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
:rtype: float
:Game Scenes: Flight
.. attribute:: forward
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
:rtype: float
:Game Scenes: Flight
.. attribute:: up
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
:rtype: float
:Game Scenes: Flight
.. attribute:: right
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
:rtype: float
:Game Scenes: Flight
.. attribute:: wheel_throttle
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
:rtype: float
:Game Scenes: Flight
.. attribute:: wheel_steering
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
:rtype: float
:Game Scenes: Flight
.. attribute:: custom_axis01
The state of CustomAxis01.
A value between -1 and 1.
:Attribute: Can be read or written
:rtype: float
:Game Scenes: Flight
.. attribute:: custom_axis02
The state of CustomAxis02.
A value between -1 and 1.
:Attribute: Can be read or written
:rtype: float
:Game Scenes: Flight
.. attribute:: custom_axis03
The state of CustomAxis03.
A value between -1 and 1.
:Attribute: Can be read or written
:rtype: float
:Game Scenes: Flight
.. attribute:: custom_axis04
The state of CustomAxis04.
A value between -1 and 1.
:Attribute: Can be read or written
:rtype: float
:Game Scenes: Flight
.. attribute:: current_stage
The current stage of the vessel. Corresponds to the stage number in
the in-game UI.
:Attribute: Read-only, cannot be set
:rtype: int
:Game Scenes: Flight
.. method:: 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.
:rtype: list(:class:`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
:attr:`active_vessel` no longer refer to the active vessel.
Throws an exception if staging is locked.
.. attribute:: stage_lock
Whether staging is locked on the vessel.
:Attribute: Can be read or written
:rtype: bool
:Game Scenes: Flight
.. note::
This is equivalent to locking the staging using Alt+L
.. method:: get_action_group(group)
Returns ``True`` if the given action group is enabled.
:param int group: A number between 0 and 9 inclusive, or between 0 and 250 inclusive when the `Extended Action Groups mod `_ is installed.
:rtype: bool
:Game Scenes: Flight
.. method:: set_action_group(group, state)
Sets the state of the given action group.
:param int group: A number between 0 and 9 inclusive, or between 0 and 250 inclusive when the `Extended Action Groups mod `_ is installed.
:param bool state:
:Game Scenes: Flight
.. method:: toggle_action_group(group)
Toggles the state of the given action group.
:param int 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
.. method:: add_node(ut, [prograde = 0.0], [normal = 0.0], [radial = 0.0])
Creates a maneuver node at the given universal time, and returns a
:class:`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.
:param float ut: Universal time of the maneuver node.
:param float prograde: Delta-v in the prograde direction.
:param float normal: Delta-v in the normal direction.
:param float radial: Delta-v in the radial direction.
:rtype: :class:`Node`
:Game Scenes: Flight
.. attribute:: nodes
Returns a list of all existing maneuver nodes, ordered by time from first to last.
:Attribute: Read-only, cannot be set
:rtype: list(:class:`Node`)
:Game Scenes: Flight
.. method:: remove_nodes()
Remove all maneuver nodes.
:Game Scenes: Flight
.. class:: ControlState
The control state of a vessel.
See :attr:`Control.state`.
.. data:: full
Full controllable.
.. data:: partial
Partially controllable.
.. data:: none
Not controllable.
.. class:: ControlSource
The control source of a vessel.
See :attr:`Control.source`.
.. data:: kerbal
Vessel is controlled by a Kerbal.
.. data:: probe
Vessel is controlled by a probe core.
.. data:: none
Vessel is not controlled.
.. class:: SASMode
The behavior of the SAS auto-pilot. See :attr:`AutoPilot.sas_mode`.
.. data:: stability_assist
Stability assist mode. Dampen out any rotation.
.. data:: maneuver
Point in the burn direction of the next maneuver node.
.. data:: prograde
Point in the prograde direction.
.. data:: retrograde
Point in the retrograde direction.
.. data:: normal
Point in the orbit normal direction.
.. data:: anti_normal
Point in the orbit anti-normal direction.
.. data:: radial
Point in the orbit radial direction.
.. data:: anti_radial
Point in the orbit anti-radial direction.
.. data:: target
Point in the direction of the current target.
.. data:: anti_target
Point away from the current target.
.. class:: SpeedMode
The mode of the speed reported in the navball.
See :attr:`Control.speed_mode`.
.. data:: orbit
Speed is relative to the vessel's orbit.
.. data:: surface
Speed is relative to the surface of the body being orbited.
.. data:: target
Speed is relative to the current target.
.. class:: ControlInputMode
See :attr:`Control.input_mode`.
.. data:: additive
Control inputs are added to the vessels current control inputs.
.. data:: override
Control inputs (when they are non-zero) override the vessels current control inputs.