Control¶
- public 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.getControl()
.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 getSource()¶
The source of the vessels control, for example by a kerbal or a probe core.
- Game Scenes:
Flight
- ControlState getState()¶
The control state of the vessel.
- Game Scenes:
Flight
- boolean getSAS()¶
- void setSAS(boolean value)¶
The state of SAS.
- Game Scenes:
Flight
Note
Equivalent to
AutoPilot.getSAS()
- void setSASMode(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.getSASMode()
- void setSpeedMode(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
- boolean getRCS()¶
- void setRCS(boolean value)¶
The state of RCS.
- Game Scenes:
Flight
- boolean getReactionWheels()¶
- void setReactionWheels(boolean value)¶
Returns whether all reactive wheels on the vessel are active, and sets the active state of all reaction wheels. See
ReactionWheel.getActive()
.- Game Scenes:
Flight
- boolean getGear()¶
- void setGear(boolean value)¶
The state of the landing gear/legs.
- Game Scenes:
Flight
- boolean getLegs()¶
- void setLegs(boolean 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.getDeployed()
.- Game Scenes:
Flight
- boolean getWheels()¶
- void setWheels(boolean 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.getDeployed()
.- Game Scenes:
Flight
- boolean getLights()¶
- void setLights(boolean value)¶
The state of the lights.
- Game Scenes:
Flight
- boolean getBrakes()¶
- void setBrakes(boolean value)¶
The state of the wheel brakes.
- Game Scenes:
Flight
- boolean getAntennas()¶
- void setAntennas(boolean value)¶
Returns whether all antennas on the vessel are deployed, and sets the deployment state of all antennas. See
Antenna.getDeployed()
.- Game Scenes:
Flight
- boolean getCargoBays()¶
- void setCargoBays(boolean value)¶
Returns whether any of the cargo bays on the vessel are open, and sets the open state of all cargo bays. See
CargoBay.getOpen()
.- Game Scenes:
Flight
- boolean getIntakes()¶
- void setIntakes(boolean value)¶
Returns whether all of the air intakes on the vessel are open, and sets the open state of all air intakes. See
Intake.getOpen()
.- Game Scenes:
Flight
- boolean getParachutes()¶
- void setParachutes(boolean value)¶
Returns whether all parachutes on the vessel are deployed, and sets the deployment state of all parachutes. Cannot be set to
false
. SeeParachute.getDeployed()
.- Game Scenes:
Flight
- boolean getRadiators()¶
- void setRadiators(boolean value)¶
Returns whether all radiators on the vessel are deployed, and sets the deployment state of all radiators. See
Radiator.getDeployed()
.- Game Scenes:
Flight
- boolean getResourceHarvesters()¶
- void setResourceHarvesters(boolean value)¶
Returns whether all of the resource harvesters on the vessel are deployed, and sets the deployment state of all resource harvesters. See
ResourceHarvester.getDeployed()
.- Game Scenes:
Flight
- boolean getResourceHarvestersActive()¶
- void setResourceHarvestersActive(boolean value)¶
Returns whether any of the resource harvesters on the vessel are active, and sets the active state of all resource harvesters. See
ResourceHarvester.getActive()
.- Game Scenes:
Flight
- boolean getSolarPanels()¶
- void setSolarPanels(boolean value)¶
Returns whether all solar panels on the vessel are deployed, and sets the deployment state of all solar panels. See
SolarPanel.getDeployed()
.- Game Scenes:
Flight
- boolean getAbort()¶
- void setAbort(boolean value)¶
The state of the abort action group.
- Game Scenes:
Flight
- float getThrottle()¶
- void setThrottle(float value)¶
The state of the throttle. A value between 0 and 1.
- Game Scenes:
Flight
- ControlInputMode getInputMode()¶
- void setInputMode(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 getPitch()¶
- void setPitch(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 getYaw()¶
- void setYaw(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 getRoll()¶
- void setRoll(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 getForward()¶
- void setForward(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 getUp()¶
- void setUp(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 getRight()¶
- void setRight(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 getWheelThrottle()¶
- void setWheelThrottle(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 getWheelSteering()¶
- void setWheelSteering(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 getCustomAxis01()¶
- void setCustomAxis01(float value)¶
The state of CustomAxis01. A value between -1 and 1.
- Game Scenes:
Flight
- float getCustomAxis02()¶
- void setCustomAxis02(float value)¶
The state of CustomAxis02. A value between -1 and 1.
- Game Scenes:
Flight
- float getCustomAxis03()¶
- void setCustomAxis03(float value)¶
The state of CustomAxis03. A value between -1 and 1.
- Game Scenes:
Flight
- float getCustomAxis04()¶
- void setCustomAxis04(float value)¶
The state of CustomAxis04. A value between -1 and 1.
- Game Scenes:
Flight
- int getCurrentStage()¶
The current stage of the vessel. Corresponds to the stage number in the in-game UI.
- Game Scenes:
Flight
- java.util.List<Vessel> activateNextStage()¶
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
getActiveVessel()
no longer refer to the active vessel. Throws an exception if staging is locked.
- boolean getStageLock()¶
- void setStageLock(boolean value)¶
Whether staging is locked on the vessel.
- Game Scenes:
Flight
Note
This is equivalent to locking the staging using Alt+L
- boolean getActionGroup(int group)¶
Returns
true
if the given action group is enabled.- Parameters:
group (
int
) – A number between 0 and 9 inclusive, or between 0 and 250 inclusive when the Extended Action Groups mod is installed.
- Game Scenes:
Flight
- void setActionGroup(int group, boolean state)¶
Sets the state of the given action group.
- Parameters:
group (
int
) –A number between 0 and 9 inclusive, or between 0 and 250 inclusive when the Extended Action Groups mod is installed.
state (
boolean
) –
- Game Scenes:
Flight
- void toggleActionGroup(int group)¶
Toggles the state of the given action group.
- Parameters:
group (
int
) –A number between 0 and 9 inclusive, or between 0 and 250 inclusive when the Extended Action Groups mod is installed.
- Game Scenes:
Flight
- Node addNode(double ut, float prograde, float normal, float radial)¶
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 (
double
) – Universal time of the maneuver node.prograde (
float
) – Delta-v in the prograde direction.normal (
float
) – Delta-v in the normal direction.radial (
float
) – Delta-v in the radial direction.
- Game Scenes:
Flight
- java.util.List<Node> getNodes()¶
Returns a list of all existing maneuver nodes, ordered by time from first to last.
- Game Scenes:
Flight
- void removeNodes()¶
Remove all maneuver nodes.
- Game Scenes:
Flight
- public enum ControlState¶
The control state of a vessel. See
Control.getState()
.- public ControlState FULL¶
Full controllable.
- public ControlState PARTIAL¶
Partially controllable.
- public ControlState NONE¶
Not controllable.
- public enum ControlSource¶
The control source of a vessel. See
Control.getSource()
.- public ControlSource KERBAL¶
Vessel is controlled by a Kerbal.
- public ControlSource PROBE¶
Vessel is controlled by a probe core.
- public ControlSource NONE¶
Vessel is not controlled.
- public enum SASMode¶
The behavior of the SAS auto-pilot. See
AutoPilot.getSASMode()
.
- public enum SpeedMode¶
The mode of the speed reported in the navball. See
Control.getSpeedMode()
.
- public enum ControlInputMode¶
-
- public ControlInputMode ADDITIVE¶
Control inputs are added to the vessels current control inputs.
- public ControlInputMode OVERRIDE¶
Control inputs (when they are non-zero) override the vessels current control inputs.