Parts¶

The following classes allow interaction with a vessels individual parts.

Parts ¶

public class Parts¶

Instances of this class are used to interact with the parts of a vessel. An instance can be obtained by calling Vessel.getParts().

java.util.List<Part> getAll()¶: A list of all of the vessels parts.

Part getRoot()¶: The vessels root part.

Note

See the discussion on Trees of Parts.

Part getControlling()¶

void setControlling(Part value)¶: The part from which the vessel is controlled.

java.util.List<Part> withName(String name)¶

A list of parts whose Part.getName() is name.

Parameters:

name (String) –

java.util.List<Part> withTitle(String title)¶

A list of all parts whose Part.getTitle() is title.

Parameters:

title (String) –

java.util.List<Part> withTag(String tag)¶

A list of all parts whose Part.getTag() is tag.

Parameters:

tag (String) –

java.util.List<Part> withModule(String moduleName)¶

A list of all parts that contain a Module whose Module.getName() is moduleName.

Parameters:

moduleName (String) –

java.util.List<Part> inStage(int stage)¶

A list of all parts that are activated in the given stage.

Parameters:

stage (int) –

Note

See the discussion on Staging.

java.util.List<Part> inDecoupleStage(int stage)¶

A list of all parts that are decoupled in the given stage.

Parameters:

stage (int) –

Note

See the discussion on Staging.

java.util.List<Module> modulesWithName(String moduleName)¶

A list of modules (combined across all parts in the vessel) whose Module.getName() is moduleName.

Parameters:

moduleName (String) –

java.util.List<Antenna> getAntennas()¶: A list of all antennas in the vessel.

Note

If RemoteTech is installed, this will always return an empty list. To interact with RemoteTech antennas, use the RemoteTech service APIs.

java.util.List<CargoBay> getCargoBays()¶: A list of all cargo bays in the vessel.

java.util.List<ControlSurface> getControlSurfaces()¶: A list of all control surfaces in the vessel.

java.util.List<Decoupler> getDecouplers()¶: A list of all decouplers in the vessel.

java.util.List<DockingPort> getDockingPorts()¶: A list of all docking ports in the vessel.

java.util.List<Engine> getEngines()¶: A list of all engines in the vessel.

Note

This includes any part that generates thrust. This covers many different types of engine, including liquid fuel rockets, solid rocket boosters, jet engines and RCS thrusters.

java.util.List<Experiment> getExperiments()¶: A list of all science experiments in the vessel.

java.util.List<Fairing> getFairings()¶: A list of all fairings in the vessel.

java.util.List<Intake> getIntakes()¶: A list of all intakes in the vessel.

java.util.List<Leg> getLegs()¶: A list of all landing legs attached to the vessel.

java.util.List<LaunchClamp> getLaunchClamps()¶: A list of all launch clamps attached to the vessel.

java.util.List<Light> getLights()¶: A list of all lights in the vessel.

java.util.List<Parachute> getParachutes()¶: A list of all parachutes in the vessel.

java.util.List<Radiator> getRadiators()¶: A list of all radiators in the vessel.

java.util.List<ResourceDrain> getResourceDrains()¶: A list of all resource drains in the vessel.

java.util.List<RCS> getRCS()¶: A list of all RCS blocks/thrusters in the vessel.

java.util.List<ReactionWheel> getReactionWheels()¶: A list of all reaction wheels in the vessel.

java.util.List<ResourceConverter> getResourceConverters()¶: A list of all resource converters in the vessel.

java.util.List<ResourceHarvester> getResourceHarvesters()¶: A list of all resource harvesters in the vessel.

java.util.List<RoboticHinge> getRoboticHinges()¶: A list of all robotic hinges in the vessel.

java.util.List<RoboticPiston> getRoboticPistons()¶: A list of all robotic pistons in the vessel.

java.util.List<RoboticRotation> getRoboticRotations()¶: A list of all robotic rotations in the vessel.

java.util.List<RoboticRotor> getRoboticRotors()¶: A list of all robotic rotors in the vessel.

java.util.List<Sensor> getSensors()¶: A list of all sensors in the vessel.

java.util.List<SolarPanel> getSolarPanels()¶: A list of all solar panels in the vessel.

java.util.List<Wheel> getWheels()¶: A list of all wheels in the vessel.

Part ¶

public class Part¶

Represents an individual part. Vessels are made up of multiple parts. Instances of this class can be obtained by several methods in Parts.

String getName()¶: Internal name of the part, as used in part cfg files. For example “Mark1-2Pod”.

String getTitle()¶: Title of the part, as shown when the part is right clicked in-game. For example “Mk1-2 Command Pod”.

String getTag()¶

void setTag(String value)¶: The name tag for the part. Can be set to a custom string using the in-game user interface.

Note

This string is shared with kOS if it is installed.

String getFlagURL()¶

void setFlagURL(String value)¶: The asset URL for the part’s flag.

boolean getHighlighted()¶

void setHighlighted(boolean value)¶: Whether the part is highlighted.

org.javatuples.Triplet<Double, Double, Double> getHighlightColor()¶

void setHighlightColor(org.javatuples.Triplet<Double, Double, Double> value)¶: The color used to highlight the part, as an RGB triple.

double getCost()¶: The cost of the part, in units of funds.

Vessel getVessel()¶: The vessel that contains this part.

Part getParent()¶: The parts parent. Returns null if the part does not have a parent. This, in combination with Part.getChildren(), can be used to traverse the vessels parts tree.

Note

See the discussion on Trees of Parts.

java.util.List<Part> getChildren()¶: The parts children. Returns an empty list if the part has no children. This, in combination with Part.getParent(), can be used to traverse the vessels parts tree.

Note

See the discussion on Trees of Parts.

boolean getAxiallyAttached()¶: Whether the part is axially attached to its parent, i.e. on the top or bottom of its parent. If the part has no parent, returns false.

Note

See the discussion on Attachment Modes.

boolean getRadiallyAttached()¶: Whether the part is radially attached to its parent, i.e. on the side of its parent. If the part has no parent, returns false.

Note

See the discussion on Attachment Modes.

int getStage()¶: The stage in which this part will be activated. Returns -1 if the part is not activated by staging.

Note

See the discussion on Staging.

int getDecoupleStage()¶: The stage in which this part will be decoupled. Returns -1 if the part is never decoupled from the vessel.

Note

See the discussion on Staging.

boolean getMassless()¶: Whether the part is massless.

double getMass()¶: The current mass of the part, including resources it contains, in kilograms. Returns zero if the part is massless.

double getDryMass()¶: The mass of the part, not including any resources it contains, in kilograms. Returns zero if the part is massless.

boolean getShielded()¶: Whether the part is shielded from the exterior of the vessel, for example by a fairing.

float getDynamicPressure()¶: The dynamic pressure acting on the part, in Pascals.

double getImpactTolerance()¶: The impact tolerance of the part, in meters per second.

double getTemperature()¶: Temperature of the part, in Kelvin.

double getSkinTemperature()¶: Temperature of the skin of the part, in Kelvin.

double getMaxTemperature()¶: Maximum temperature that the part can survive, in Kelvin.

double getMaxSkinTemperature()¶: Maximum temperature that the skin of the part can survive, in Kelvin.

float getThermalMass()¶: A measure of how much energy it takes to increase the internal temperature of the part, in Joules per Kelvin.

float getThermalSkinMass()¶: A measure of how much energy it takes to increase the skin temperature of the part, in Joules per Kelvin.

float getThermalResourceMass()¶: A measure of how much energy it takes to increase the temperature of the resources contained in the part, in Joules per Kelvin.

float getThermalConductionFlux()¶: The rate at which heat energy is conducting into or out of the part via contact with other parts. Measured in energy per unit time, or power, in Watts. A positive value means the part is gaining heat energy, and negative means it is losing heat energy.

float getThermalConvectionFlux()¶: The rate at which heat energy is convecting into or out of the part from the surrounding atmosphere. Measured in energy per unit time, or power, in Watts. A positive value means the part is gaining heat energy, and negative means it is losing heat energy.

float getThermalRadiationFlux()¶: The rate at which heat energy is radiating into or out of the part from the surrounding environment. Measured in energy per unit time, or power, in Watts. A positive value means the part is gaining heat energy, and negative means it is losing heat energy.

float getThermalInternalFlux()¶: The rate at which heat energy is begin generated by the part. For example, some engines generate heat by combusting fuel. Measured in energy per unit time, or power, in Watts. A positive value means the part is gaining heat energy, and negative means it is losing heat energy.

float getThermalSkinToInternalFlux()¶: The rate at which heat energy is transferring between the part’s skin and its internals. Measured in energy per unit time, or power, in Watts. A positive value means the part’s internals are gaining heat energy, and negative means its skin is gaining heat energy.

int getAvailableSeats()¶: How many open seats the part has.

Resources getResources()¶: A Resources object for the part.

boolean getCrossfeed()¶: Whether this part is crossfeed capable.

boolean getIsFuelLine()¶: Whether this part is a fuel line.

java.util.List<Part> getFuelLinesFrom()¶: The parts that are connected to this part via fuel lines, where the direction of the fuel line is into this part.

Note

See the discussion on Fuel Lines.

java.util.List<Part> getFuelLinesTo()¶: The parts that are connected to this part via fuel lines, where the direction of the fuel line is out of this part.

Note

See the discussion on Fuel Lines.

java.util.List<Module> getModules()¶: The modules for this part.

Antenna getAntenna()¶: An Antenna if the part is an antenna, otherwise null.

Note

If RemoteTech is installed, this will always return null. To interact with RemoteTech antennas, use the RemoteTech service APIs.

CargoBay getCargoBay()¶: A CargoBay if the part is a cargo bay, otherwise null.

ControlSurface getControlSurface()¶: A ControlSurface if the part is an aerodynamic control surface, otherwise null.

Decoupler getDecoupler()¶: A Decoupler if the part is a decoupler, otherwise null.

DockingPort getDockingPort()¶: A DockingPort if the part is a docking port, otherwise null.

Engine getEngine()¶: An Engine if the part is an engine, otherwise null.

Experiment getExperiment()¶: An Experiment if the part contains a single science experiment, otherwise null.

Note

Throws an exception if the part contains more than one experiment. In that case, use Part.getExperiments() to get the list of experiments in the part.

java.util.List<Experiment> getExperiments()¶: A list of Experiment objects that the part contains.

Fairing getFairing()¶: A Fairing if the part is a fairing, otherwise null.

Intake getIntake()¶: An Intake if the part is an intake, otherwise null.

Note

This includes any part that generates thrust. This covers many different types of engine, including liquid fuel rockets, solid rocket boosters and jet engines. For RCS thrusters see RCS.

Leg getLeg()¶: A Leg if the part is a landing leg, otherwise null.

LaunchClamp getLaunchClamp()¶: A LaunchClamp if the part is a launch clamp, otherwise null.

Light getLight()¶: A Light if the part is a light, otherwise null.

Parachute getParachute()¶: A Parachute if the part is a parachute, otherwise null.

Radiator getRadiator()¶: A Radiator if the part is a radiator, otherwise null.

ResourceDrain getResourceDrain()¶: A ResourceDrain if the part is a resource drain, otherwise null.

RCS getRCS()¶: A RCS if the part is an RCS block/thruster, otherwise null.

ReactionWheel getReactionWheel()¶: A ReactionWheel if the part is a reaction wheel, otherwise null.

ResourceConverter getResourceConverter()¶: A ResourceConverter if the part is a resource converter, otherwise null.

ResourceHarvester getResourceHarvester()¶: A ResourceHarvester if the part is a resource harvester, otherwise null.

RoboticController getRoboticController()¶: A RoboticController if the part is a robotic controller, otherwise null.

RoboticHinge getRoboticHinge()¶: A RoboticHinge if the part is a robotic hinge, otherwise null.

RoboticPiston getRoboticPiston()¶: A RoboticPiston if the part is a robotic piston, otherwise null.

RoboticRotation getRoboticRotation()¶: A RoboticRotation if the part is a robotic rotation servo, otherwise null.

RoboticRotor getRoboticRotor()¶: A RoboticRotor if the part is a robotic rotor, otherwise null.

Sensor getSensor()¶: A Sensor if the part is a sensor, otherwise null.

SolarPanel getSolarPanel()¶: A SolarPanel if the part is a solar panel, otherwise null.

Wheel getWheel()¶: A Wheel if the part is a wheel, otherwise null.

org.javatuples.Triplet<Double, Double, Double> position(ReferenceFrame referenceFrame)¶

The position of the part in the given reference frame.

Parameters:

referenceFrame (ReferenceFrame) – The reference frame that the returned position vector is in.

Returns:

The position as a vector.

Note

This is a fixed position in the part, defined by the parts model. It s not necessarily the same as the parts center of mass. Use Part.centerOfMass(ReferenceFrame) to get the parts center of mass.

org.javatuples.Triplet<Double, Double, Double> centerOfMass(ReferenceFrame referenceFrame)¶

The position of the parts center of mass in the given reference frame. If the part is physicsless, this is equivalent to Part.position(ReferenceFrame).

Parameters:

referenceFrame (ReferenceFrame) – The reference frame that the returned position vector is in.

Returns:

The position as a vector.

org.javatuples.Pair<org.javatuples.Triplet<Double, Double, Double>, org.javatuples.Triplet<Double, Double, Double>> boundingBox(ReferenceFrame referenceFrame)¶

The axis-aligned bounding box of the part in the given reference frame.

Parameters:

referenceFrame (ReferenceFrame) – The reference frame that the returned position vectors are in.

Returns:

The positions of the minimum and maximum vertices of the box, as position vectors.

Note

This is computed from the collision mesh of the part. If the part is not collidable, the box has zero volume and is centered on the Part.position(ReferenceFrame) of the part.

org.javatuples.Triplet<Double, Double, Double> direction(ReferenceFrame referenceFrame)¶

The direction the part points in, in the given reference frame.

Parameters:

referenceFrame (ReferenceFrame) – The reference frame that the returned direction is in.

Returns:

The direction as a unit vector.

org.javatuples.Triplet<Double, Double, Double> velocity(ReferenceFrame referenceFrame)¶

The linear velocity of the part in the given reference frame.

Parameters:

referenceFrame (ReferenceFrame) – The reference frame that the returned velocity vector is in.

Returns:

The velocity as a vector. The vector points in the direction of travel, and its magnitude is the speed of the body in meters per second.

org.javatuples.Quartet<Double, Double, Double, Double> rotation(ReferenceFrame referenceFrame)¶

The rotation of the part, in the given reference frame.

Parameters:

referenceFrame (ReferenceFrame) – The reference frame that the returned rotation is in.

Returns:

The rotation as a quaternion of the form \((x, y, z, w)\).

org.javatuples.Triplet<Double, Double, Double> getMomentOfInertia()¶: The moment of inertia of the part in \(kg.m^2\) around its center of mass in the parts reference frame (ReferenceFrame).

java.util.List<Double> getInertiaTensor()¶: The inertia tensor of the part in the parts reference frame (ReferenceFrame). Returns the 3x3 matrix as a list of elements, in row-major order.

ReferenceFrame getReferenceFrame()¶

The reference frame that is fixed relative to this part, and centered on a fixed position within the part, defined by the parts model.

The origin is at the position of the part, as returned by Part.position(ReferenceFrame).
The axes rotate with the part.
The x, y and z axis directions depend on the design of the part.

Note

For docking port parts, this reference frame is not necessarily equivalent to the reference frame for the docking port, returned by DockingPort.getReferenceFrame().

../../../_images/part.png — Mk1 Command Pod reference frame origin and axes¶

ReferenceFrame getCenterOfMassReferenceFrame()¶

The reference frame that is fixed relative to this part, and centered on its center of mass.

The origin is at the center of mass of the part, as returned by Part.centerOfMass(ReferenceFrame).
The axes rotate with the part.
The x, y and z axis directions depend on the design of the part.

Note

For docking port parts, this reference frame is not necessarily equivalent to the reference frame for the docking port, returned by DockingPort.getReferenceFrame().

Force addForce(org.javatuples.Triplet<Double, Double, Double> force, org.javatuples.Triplet<Double, Double, Double> position, ReferenceFrame referenceFrame)¶

Exert a constant force on the part, acting at the given position.

Parameters:

force (org.javatuples.Triplet) – A vector pointing in the direction that the force acts, with its magnitude equal to the strength of the force in Newtons.
position (org.javatuples.Triplet) – The position at which the force acts, as a vector.
referenceFrame (ReferenceFrame) – The reference frame that the force and position are in.

Returns:

An object that can be used to remove or modify the force.

void instantaneousForce(org.javatuples.Triplet<Double, Double, Double> force, org.javatuples.Triplet<Double, Double, Double> position, ReferenceFrame referenceFrame)¶

Exert an instantaneous force on the part, acting at the given position.

Parameters:

force (org.javatuples.Triplet) – A vector pointing in the direction that the force acts, with its magnitude equal to the strength of the force in Newtons.
position (org.javatuples.Triplet) – The position at which the force acts, as a vector.
referenceFrame (ReferenceFrame) – The reference frame that the force and position are in.

Note

The force is applied instantaneously in a single physics update.

void setGlow(boolean value)¶: Whether the part is glowing.

AutoStrutMode getAutoStrutMode()¶: Auto-strut mode.

public enum AutoStrutMode¶

The state of an auto-strut. Part.getAutoStrutMode()

public AutoStrutMode OFF¶: Off

public AutoStrutMode ROOT¶: Root

public AutoStrutMode HEAVIEST¶: Heaviest

public AutoStrutMode GRANDPARENT¶: Grandparent

public AutoStrutMode FORCE_ROOT¶: ForceRoot

public AutoStrutMode FORCE_HEAVIEST¶: ForceHeaviest

public AutoStrutMode FORCE_GRANDPARENT¶: ForceGrandparent

public class Force¶

Obtained by calling Part.addForce(org.javatuples.Triplet<Double,Double,Double>, org.javatuples.Triplet<Double,Double,Double>, ReferenceFrame).

Part getPart()¶: The part that this force is applied to.

org.javatuples.Triplet<Double, Double, Double> getForceVector()¶

void setForceVector(org.javatuples.Triplet<Double, Double, Double> value)¶

The force vector, in Newtons.

Returns:: A vector pointing in the direction that the force acts, with its magnitude equal to the strength of the force in Newtons.

org.javatuples.Triplet<Double, Double, Double> getPosition()¶

void setPosition(org.javatuples.Triplet<Double, Double, Double> value)¶

The position at which the force acts, in reference frame ReferenceFrame.

Returns:: The position as a vector.

ReferenceFrame getReferenceFrame()¶

void setReferenceFrame(ReferenceFrame value)¶: The reference frame of the force vector and position.

void remove()¶: Remove the force.

Module ¶

public class Module¶

This can be used to interact with a specific part module. This includes part modules in stock KSP, and those added by mods.

In KSP, each part has zero or more PartModules associated with it. Each one contains some of the functionality of the part. For example, an engine has a “ModuleEngines” part module that contains all the functionality of an engine.

String getName()¶: Name of the PartModule. For example, “ModuleEngines”.

Part getPart()¶: The part that contains this module.

java.util.Map<String, String> getFields()¶: The modules field names and their associated values, as a dictionary. These are the values visible in the right-click menu of the part.

Note

Throws an exception if there is more than one field with the same name. In that case, use Module.getFieldsById() to get the fields by identifier.

java.util.Map<String, String> getFieldsById()¶: The modules field identifiers and their associated values, as a dictionary. These are the values visible in the right-click menu of the part.

boolean hasField(String name)¶

Returns true if the module has a field with the given name.

Parameters:

name (String) – Name of the field.

boolean hasFieldWithId(String id)¶

Returns true if the module has a field with the given identifier.

Parameters:

id (String) – Identifier of the field.

String getField(String name)¶

Returns the value of a field with the given name.

Parameters:

name (String) – Name of the field.

String getFieldById(String id)¶

Returns the value of a field with the given identifier.

Parameters:

id (String) – Identifier of the field.

void setFieldInt(String name, int value)¶

Set the value of a field to the given integer number.

Parameters:

name (String) – Name of the field.
value (int) – Value to set.

void setFieldIntById(String id, int value)¶

Set the value of a field to the given integer number.

Parameters:

id (String) – Identifier of the field.
value (int) – Value to set.

void setFieldFloat(String name, float value)¶

Set the value of a field to the given floating point number.

Parameters:

name (String) – Name of the field.
value (float) – Value to set.

void setFieldFloatById(String id, float value)¶

Set the value of a field to the given floating point number.

Parameters:

id (String) – Identifier of the field.
value (float) – Value to set.

void setFieldString(String name, String value)¶

Set the value of a field to the given string.

Parameters:

name (String) – Name of the field.
value (String) – Value to set.

void setFieldStringById(String id, String value)¶

Set the value of a field to the given string.

Parameters:

id (String) – Identifier of the field.
value (String) – Value to set.

void setFieldBool(String name, boolean value)¶

Set the value of a field to true or false.

Parameters:

name (String) – Name of the field.
value (boolean) – Value to set.

void setFieldBoolById(String id, boolean value)¶

Set the value of a field to true or false.

Parameters:

id (String) – Identifier of the field.
value (boolean) – Value to set.

void resetField(String name)¶

Set the value of a field to its original value.

Parameters:

name (String) – Name of the field.

void resetFieldById(String id)¶

Set the value of a field to its original value.

Parameters:

id (String) – Identifier of the field.

java.util.List<String> getEvents()¶: A list of the names of all of the modules events. Events are the clickable buttons visible in the right-click menu of the part.

java.util.List<String> getEventsById()¶: A list of the identifiers of all of the modules events. Events are the clickable buttons visible in the right-click menu of the part.

boolean hasEvent(String name)¶

true if the module has an event with the given name.

Parameters:

name (String) –

boolean hasEventWithId(String id)¶

true if the module has an event with the given identifier.

Parameters:

id (String) –

void triggerEvent(String name)¶

Trigger the named event. Equivalent to clicking the button in the right-click menu of the part.

Parameters:

name (String) –

void triggerEventById(String id)¶

Trigger the event with the given identifier. Equivalent to clicking the button in the right-click menu of the part.

Parameters:

id (String) –

java.util.List<String> getActions()¶: A list of all the names of the modules actions. These are the parts actions that can be assigned to action groups in the in-game editor.

java.util.List<String> getActionsById()¶: A list of all the identifiers of the modules actions. These are the parts actions that can be assigned to action groups in the in-game editor.

boolean hasAction(String name)¶

true if the part has an action with the given name.

Parameters:

name (String) –

boolean hasActionWithId(String id)¶

true if the part has an action with the given identifier.

Parameters:

id (String) –

void setAction(String name, boolean value)¶

Set the value of an action with the given name.

Parameters:

name (String) –
value (boolean) –

void setActionById(String id, boolean value)¶

Set the value of an action with the given identifier.

Parameters:

id (String) –
value (boolean) –

Specific Types of Part ¶

The following classes provide functionality for specific types of part.

Antenna ¶

Note

If RemoteTech is installed, use the RemoteTech service APIs to interact with antennas. This class is only for stock KSP antennas.

public class Antenna¶

An antenna. Obtained by calling Part.getAntenna().

Part getPart()¶: The part object for this antenna.

AntennaState getState()¶: The current state of the antenna.

boolean getDeployable()¶: Whether the antenna is deployable.

boolean getDeployed()¶

void setDeployed(boolean value)¶: Whether the antenna is deployed.

Note

Fixed antennas are always deployed. Returns an error if you try to deploy a fixed antenna.

boolean getCanTransmit()¶: Whether data can be transmitted by this antenna.

void transmit()¶: Transmit data.

void cancel()¶: Cancel current transmission of data.

boolean getAllowPartial()¶

void setAllowPartial(boolean value)¶: Whether partial data transmission is permitted.

double getPower()¶: The power of the antenna.

boolean getCombinable()¶: Whether the antenna can be combined with other antennae on the vessel to boost the power.

double getCombinableExponent()¶: Exponent used to calculate the combined power of multiple antennae on a vessel.

float getPacketInterval()¶: Interval between sending packets in seconds.

float getPacketSize()¶: Amount of data sent per packet in Mits.

double getPacketResourceCost()¶: Units of electric charge consumed per packet sent.

public enum AntennaState¶

The state of an antenna. See Antenna.getState().

public AntennaState DEPLOYED¶: Antenna is fully deployed.

public AntennaState RETRACTED¶: Antenna is fully retracted.

public AntennaState DEPLOYING¶: Antenna is being deployed.

public AntennaState RETRACTING¶: Antenna is being retracted.

public AntennaState BROKEN¶: Antenna is broken.

Cargo Bay ¶

public class CargoBay¶

A cargo bay. Obtained by calling Part.getCargoBay().

Part getPart()¶: The part object for this cargo bay.

CargoBayState getState()¶: The state of the cargo bay.

boolean getOpen()¶

void setOpen(boolean value)¶: Whether the cargo bay is open.

public enum CargoBayState¶

The state of a cargo bay. See CargoBay.getState().

public CargoBayState OPEN¶: Cargo bay is fully open.

public CargoBayState CLOSED¶: Cargo bay closed and locked.

public CargoBayState OPENING¶: Cargo bay is opening.

public CargoBayState CLOSING¶: Cargo bay is closing.

Control Surface ¶

public class ControlSurface¶

An aerodynamic control surface. Obtained by calling Part.getControlSurface().

Part getPart()¶: The part object for this control surface.

boolean getPitchEnabled()¶

void setPitchEnabled(boolean value)¶: Whether the control surface has pitch control enabled.

boolean getYawEnabled()¶

void setYawEnabled(boolean value)¶: Whether the control surface has yaw control enabled.

boolean getRollEnabled()¶

void setRollEnabled(boolean value)¶: Whether the control surface has roll control enabled.

float getAuthorityLimiter()¶

void setAuthorityLimiter(float value)¶: The authority limiter for the control surface, which controls how far the control surface will move.

boolean getInverted()¶

void setInverted(boolean value)¶: Whether the control surface movement is inverted.

boolean getDeployed()¶

void setDeployed(boolean value)¶: Whether the control surface has been fully deployed.

float getSurfaceArea()¶: Surface area of the control surface in \(m^2\).

org.javatuples.Pair<org.javatuples.Triplet<Double, Double, Double>, org.javatuples.Triplet<Double, Double, Double>> getAvailableTorque()¶: The available torque, in Newton meters, that can be produced by this control surface, in the positive and negative pitch, roll and yaw axes of the vessel. These axes correspond to the coordinate axes of the Vessel.getReferenceFrame().

Decoupler ¶

public class Decoupler¶

A decoupler. Obtained by calling Part.getDecoupler()

Part getPart()¶: The part object for this decoupler.

Vessel decouple()¶: Fires the decoupler. Returns the new vessel created when the decoupler fires. Throws an exception if the decoupler has already fired.

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.

boolean getDecoupled()¶: Whether the decoupler has fired.

boolean getStaged()¶: Whether the decoupler is enabled in the staging sequence.

float getImpulse()¶: The impulse that the decoupler imparts when it is fired, in Newton seconds.

Docking Port ¶

public class DockingPort¶

A docking port. Obtained by calling Part.getDockingPort()

Part getPart()¶: The part object for this docking port.

DockingPortState getState()¶: The current state of the docking port.

Part getDockedPart()¶: The part that this docking port is docked to. Returns null if this docking port is not docked to anything.

Vessel undock()¶: Undocks the docking port and returns the new Vessel that is created. This method can be called for either docking port in a docked pair. Throws an exception if the docking port is not docked to anything.

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.

float getReengageDistance()¶: The distance a docking port must move away when it undocks before it becomes ready to dock with another port, in meters.

boolean getHasShield()¶: Whether the docking port has a shield.

boolean getShielded()¶

void setShielded(boolean value)¶

The state of the docking ports shield, if it has one.

Returns true if the docking port has a shield, and the shield is closed. Otherwise returns false. When set to true, the shield is closed, and when set to false the shield is opened. If the docking port does not have a shield, setting this attribute has no effect.

boolean getCanRotate()¶: Whether the docking port can be commanded to rotate while docked.

float getMaximumRotation()¶: Maximum rotation angle in degrees.

float getMinimumRotation()¶: Minimum rotation angle in degrees.

float getRotationTarget()¶

void setRotationTarget(float value)¶: Rotation target angle in degrees.

boolean getRotationLocked()¶

void setRotationLocked(boolean value)¶: Lock rotation. When locked, allows auto-strut to work across the joint.

org.javatuples.Triplet<Double, Double, Double> position(ReferenceFrame referenceFrame)¶

The position of the docking port, in the given reference frame.

Parameters:

referenceFrame (ReferenceFrame) – The reference frame that the returned position vector is in.

Returns:

The position as a vector.

org.javatuples.Triplet<Double, Double, Double> direction(ReferenceFrame referenceFrame)¶

The direction that docking port points in, in the given reference frame.

Parameters:

referenceFrame (ReferenceFrame) – The reference frame that the returned direction is in.

Returns:

The direction as a unit vector.

org.javatuples.Quartet<Double, Double, Double, Double> rotation(ReferenceFrame referenceFrame)¶

The rotation of the docking port, in the given reference frame.

Parameters:

referenceFrame (ReferenceFrame) – The reference frame that the returned rotation is in.

Returns:

The rotation as a quaternion of the form \((x, y, z, w)\).

ReferenceFrame getReferenceFrame()¶

The reference frame that is fixed relative to this docking port, and oriented with the port.

The origin is at the position of the docking port.
The axes rotate with the docking port.
The x-axis points out to the right side of the docking port.
The y-axis points in the direction the docking port is facing.
The z-axis points out of the bottom off the docking port.

Note

This reference frame is not necessarily equivalent to the reference frame for the part, returned by Part.getReferenceFrame().

../../../_images/docking-port.png — Docking port reference frame origin and axes¶

../../../_images/docking-port-inline.png — Inline docking port reference frame origin and axes¶

public enum DockingPortState¶

The state of a docking port. See DockingPort.getState().

public DockingPortState READY¶: The docking port is ready to dock to another docking port.

public DockingPortState DOCKED¶: The docking port is docked to another docking port, or docked to another part (from the VAB/SPH).

public DockingPortState DOCKING¶: The docking port is very close to another docking port, but has not docked. It is using magnetic force to acquire a solid dock.

public DockingPortState UNDOCKING¶: The docking port has just been undocked from another docking port, and is disabled until it moves away by a sufficient distance (DockingPort.getReengageDistance()).

public DockingPortState SHIELDED¶: The docking port has a shield, and the shield is closed.

public DockingPortState MOVING¶: The docking ports shield is currently opening/closing.

Engine ¶

public class Engine¶

An engine, including ones of various types. For example liquid fuelled gimballed engines, solid rocket boosters and jet engines. Obtained by calling Part.getEngine().

Note

For RCS thrusters Part.getRCS().

Part getPart()¶: The part object for this engine.

boolean getActive()¶

void setActive(boolean value)¶: Whether the engine is active. Setting this attribute may have no effect, depending on Engine.getCanShutdown() and Engine.getCanRestart().

float getThrust()¶: The current amount of thrust being produced by the engine, in Newtons.

float getAvailableThrust()¶: The amount of thrust, in Newtons, that would be produced by the engine when activated and with its throttle set to 100%. Returns zero if the engine does not have any fuel. Takes the engine’s current Engine.getThrustLimit() and atmospheric conditions into account.

float availableThrustAt(double pressure)¶

The amount of thrust, in Newtons, that would be produced by the engine when activated and with its throttle set to 100%. Returns zero if the engine does not have any fuel. Takes the given pressure into account.

Parameters:

pressure (double) – Atmospheric pressure in atmospheres

float getMaxThrust()¶: The amount of thrust, in Newtons, that would be produced by the engine when activated and fueled, with its throttle and throttle limiter set to 100%.

float maxThrustAt(double pressure)¶

The amount of thrust, in Newtons, that would be produced by the engine when activated and fueled, with its throttle and throttle limiter set to 100%. Takes the given pressure into account.

Parameters:

pressure (double) – Atmospheric pressure in atmospheres

float getMaxVacuumThrust()¶: The maximum amount of thrust that can be produced by the engine in a vacuum, in Newtons. This is the amount of thrust produced by the engine when activated, Engine.getThrustLimit() is set to 100%, the main vessel’s throttle is set to 100% and the engine is in a vacuum.

float getThrustLimit()¶

void setThrustLimit(float value)¶: The thrust limiter of the engine. A value between 0 and 1. Setting this attribute may have no effect, for example the thrust limit for a solid rocket booster cannot be changed in flight.

java.util.List<Thruster> getThrusters()¶: The components of the engine that generate thrust.

Note

For example, this corresponds to the rocket nozzel on a solid rocket booster, or the individual nozzels on a RAPIER engine. The overall thrust produced by the engine, as reported by Engine.getAvailableThrust(), Engine.getMaxThrust() and others, is the sum of the thrust generated by each thruster.

float getSpecificImpulse()¶: The current specific impulse of the engine, in seconds. Returns zero if the engine is not active.

float specificImpulseAt(double pressure)¶

The specific impulse of the engine under the given pressure, in seconds. Returns zero if the engine is not active.

Parameters:

pressure (double) – Atmospheric pressure in atmospheres

float getVacuumSpecificImpulse()¶: The vacuum specific impulse of the engine, in seconds.

float getKerbinSeaLevelSpecificImpulse()¶: The specific impulse of the engine at sea level on Kerbin, in seconds.

java.util.List<String> getPropellantNames()¶: The names of the propellants that the engine consumes.

java.util.Map<String, Float> getPropellantRatios()¶: The ratio of resources that the engine consumes. A dictionary mapping resource names to the ratio at which they are consumed by the engine.

Note

For example, if the ratios are 0.6 for LiquidFuel and 0.4 for Oxidizer, then for every 0.6 units of LiquidFuel that the engine burns, it will burn 0.4 units of Oxidizer.

java.util.List<Propellant> getPropellants()¶: The propellants that the engine consumes.

boolean getHasFuel()¶: Whether the engine has any fuel available.

float getThrottle()¶

void setThrottle(float value)¶

The current throttle setting for the engine. A value between 0 and 1. This is not necessarily the same as the vessel’s main throttle setting, as some engines take time to adjust their throttle (such as jet engines), or independent throttle may be enabled.

When the engine’s independent throttle is enabled (see Engine.getIndependentThrottle()), can be used to set the throttle percentage.

boolean getThrottleLocked()¶: Whether the Control.getThrottle() affects the engine. For example, this is true for liquid fueled rockets, and false for solid rocket boosters.

boolean getIndependentThrottle()¶

void setIndependentThrottle(boolean value)¶: Whether the independent throttle is enabled for the engine.

boolean getCanRestart()¶: Whether the engine can be restarted once shutdown. If the engine cannot be shutdown, returns false. For example, this is true for liquid fueled rockets and false for solid rocket boosters.

boolean getCanShutdown()¶: Whether the engine can be shutdown once activated. For example, this is true for liquid fueled rockets and false for solid rocket boosters.

boolean getHasModes()¶: Whether the engine has multiple modes of operation.

String getMode()¶

void setMode(String value)¶: The name of the current engine mode.

java.util.Map<String, Engine> getModes()¶: The available modes for the engine. A dictionary mapping mode names to Engine objects.

void toggleMode()¶: Toggle the current engine mode.

boolean getAutoModeSwitch()¶

void setAutoModeSwitch(boolean value)¶: Whether the engine will automatically switch modes.

boolean getGimballed()¶: Whether the engine is gimballed.

float getGimbalRange()¶: The range over which the gimbal can move, in degrees. Returns 0 if the engine is not gimballed.

boolean getGimbalLocked()¶

void setGimbalLocked(boolean value)¶: Whether the engines gimbal is locked in place. Setting this attribute has no effect if the engine is not gimballed.

float getGimbalLimit()¶

void setGimbalLimit(float value)¶: The gimbal limiter of the engine. A value between 0 and 1. Returns 0 if the gimbal is locked.

org.javatuples.Pair<org.javatuples.Triplet<Double, Double, Double>, org.javatuples.Triplet<Double, Double, Double>> getAvailableTorque()¶: The available torque, in Newton meters, that can be produced by this engine, in the positive and negative pitch, roll and yaw axes of the vessel. These axes correspond to the coordinate axes of the Vessel.getReferenceFrame(). Returns zero if the engine is inactive, or not gimballed.

public class Propellant¶

A propellant for an engine. Obtains by calling Engine.getPropellants().

String getName()¶: The name of the propellant.

double getCurrentAmount()¶: The current amount of propellant.

double getCurrentRequirement()¶: The required amount of propellant.

double getTotalResourceAvailable()¶: The total amount of the underlying resource currently reachable given resource flow rules.

double getTotalResourceCapacity()¶: The total vehicle capacity for the underlying propellant resource, restricted by resource flow rules.

boolean getIgnoreForIsp()¶: If this propellant should be ignored when calculating required mass flow given specific impulse.

boolean getIgnoreForThrustCurve()¶: If this propellant should be ignored for thrust curve calculations.

boolean getDrawStackGauge()¶: If this propellant has a stack gauge or not.

boolean getIsDeprived()¶: If this propellant is deprived.

float getRatio()¶: The propellant ratio.

Experiment ¶

public class Experiment¶

Obtained by calling Part.getExperiment().

Part getPart()¶: The part object for this experiment.

String getName()¶: Internal name of the experiment, as used in part cfg files.

String getTitle()¶: Title of the experiment, as shown on the in-game UI.

void run()¶: Run the experiment.

void transmit()¶: Transmit all experimental data contained by this part.

void dump()¶: Dump the experimental data contained by the experiment.

void reset()¶: Reset the experiment.

boolean getDeployed()¶: Whether the experiment has been deployed.

boolean getRerunnable()¶: Whether the experiment can be re-run.

boolean getInoperable()¶: Whether the experiment is inoperable.

boolean getHasData()¶: Whether the experiment contains data.

java.util.List<ScienceData> getData()¶: The data contained in this experiment.

String getBiome()¶: The name of the biome the experiment is currently in.

boolean getAvailable()¶: Determines if the experiment is available given the current conditions.

ScienceSubject getScienceSubject()¶: Containing information on the corresponding specific science result for the current conditions. Returns null if the experiment is unavailable.

public class ScienceData¶

Obtained by calling Experiment.getData().

float getDataAmount()¶: Data amount.

float getScienceValue()¶: Science value.

float getTransmitValue()¶: Transmit value.

public class ScienceSubject¶

Obtained by calling Experiment.getScienceSubject().

String getTitle()¶: Title of science subject, displayed in science archives

boolean getIsComplete()¶: Whether the experiment has been completed.

float getScience()¶: Amount of science already earned from this subject, not updated until after transmission/recovery.

float getScienceCap()¶: Total science allowable for this subject.

float getDataScale()¶: Multiply science value by this to determine data amount in mits.

float getSubjectValue()¶: Multiplier for specific Celestial Body/Experiment Situation combination.

float getScientificValue()¶: Diminishing value multiplier for decreasing the science value returned from repeated experiments.

Fairing ¶

public class Fairing¶

A fairing. Obtained by calling Part.getFairing(). Supports both stock fairings, and those from the ProceduralFairings mod.

Part getPart()¶: The part object for this fairing.

void jettison()¶: Jettison the fairing. Has no effect if it has already been jettisoned.

boolean getJettisoned()¶: Whether the fairing has been jettisoned.

Intake ¶

public class Intake¶

An air intake. Obtained by calling Part.getIntake().

Part getPart()¶: The part object for this intake.

boolean getOpen()¶

void setOpen(boolean value)¶: Whether the intake is open.

float getSpeed()¶: Speed of the flow into the intake, in \(m/s\).

float getFlow()¶: The rate of flow into the intake, in units of resource per second.

float getArea()¶: The area of the intake’s opening, in square meters.

Leg ¶

public class Leg¶

A landing leg. Obtained by calling Part.getLeg().

Part getPart()¶: The part object for this landing leg.

LegState getState()¶: The current state of the landing leg.

boolean getDeployable()¶: Whether the leg is deployable.

boolean getDeployed()¶

void setDeployed(boolean value)¶: Whether the landing leg is deployed.

Note

Fixed landing legs are always deployed. Returns an error if you try to deploy fixed landing gear.

boolean getIsGrounded()¶: Returns whether the leg is touching the ground.

public enum LegState¶

The state of a landing leg. See Leg.getState().

public LegState DEPLOYED¶: Landing leg is fully deployed.

public LegState RETRACTED¶: Landing leg is fully retracted.

public LegState DEPLOYING¶: Landing leg is being deployed.

public LegState RETRACTING¶: Landing leg is being retracted.

public LegState BROKEN¶: Landing leg is broken.

Launch Clamp ¶

public class LaunchClamp¶

A launch clamp. Obtained by calling Part.getLaunchClamp().

Part getPart()¶: The part object for this launch clamp.

void release()¶: Releases the docking clamp. Has no effect if the clamp has already been released.

Light ¶

public class Light¶

A light. Obtained by calling Part.getLight().

Part getPart()¶: The part object for this light.

boolean getActive()¶

void setActive(boolean value)¶: Whether the light is switched on.

org.javatuples.Triplet<Float, Float, Float> getColor()¶

void setColor(org.javatuples.Triplet<Float, Float, Float> value)¶: The color of the light, as an RGB triple.

boolean getBlink()¶

void setBlink(boolean value)¶: Whether blinking is enabled.

float getBlinkRate()¶

void setBlinkRate(float value)¶: The blink rate of the light.

float getPowerUsage()¶: The current power usage, in units of charge per second.

Parachute ¶

public class Parachute¶

A parachute. Obtained by calling Part.getParachute().

Part getPart()¶: The part object for this parachute.

void deploy()¶: Deploys the parachute. This has no effect if the parachute has already been deployed.

boolean getDeployed()¶: Whether the parachute has been deployed.

void arm()¶: Deploys the parachute. This has no effect if the parachute has already been armed or deployed.

boolean getArmed()¶: Whether the parachute has been armed or deployed.

void cut()¶: Cuts the parachute.

ParachuteState getState()¶: The current state of the parachute.

float getDeployAltitude()¶

void setDeployAltitude(float value)¶: The altitude at which the parachute will full deploy, in meters. Only applicable to stock parachutes.

float getDeployMinPressure()¶

void setDeployMinPressure(float value)¶: The minimum pressure at which the parachute will semi-deploy, in atmospheres. Only applicable to stock parachutes.

public enum ParachuteState¶

The state of a parachute. See Parachute.getState().

public ParachuteState STOWED¶: The parachute is safely tucked away inside its housing.

public ParachuteState ARMED¶: The parachute is armed for deployment.

public ParachuteState SEMI_DEPLOYED¶: The parachute has been deployed and is providing some drag, but is not fully deployed yet. (Stock parachutes only)

public ParachuteState DEPLOYED¶: The parachute is fully deployed.

public ParachuteState CUT¶: The parachute has been cut.

Radiator ¶

public class Radiator¶

A radiator. Obtained by calling Part.getRadiator().

Part getPart()¶: The part object for this radiator.

boolean getDeployable()¶: Whether the radiator is deployable.

boolean getDeployed()¶

void setDeployed(boolean value)¶: For a deployable radiator, true if the radiator is extended. If the radiator is not deployable, this is always true.

RadiatorState getState()¶: The current state of the radiator.

Note

A fixed radiator is always RadiatorState.EXTENDED.

public enum RadiatorState¶

The state of a radiator. Radiator.getState()

public RadiatorState EXTENDED¶: Radiator is fully extended.

public RadiatorState RETRACTED¶: Radiator is fully retracted.

public RadiatorState EXTENDING¶: Radiator is being extended.

public RadiatorState RETRACTING¶: Radiator is being retracted.

public RadiatorState BROKEN¶: Radiator is broken.

Resource Converter ¶

public class ResourceConverter¶

A resource converter. Obtained by calling Part.getResourceConverter().

Part getPart()¶: The part object for this converter.

int getCount()¶: The number of converters in the part.

String name(int index)¶

The name of the specified converter.

Parameters:

index (int) – Index of the converter.

boolean active(int index)¶

True if the specified converter is active.

Parameters:

index (int) – Index of the converter.

void start(int index)¶

Start the specified converter.

Parameters:

index (int) – Index of the converter.

void stop(int index)¶

Stop the specified converter.

Parameters:

index (int) – Index of the converter.

ResourceConverterState state(int index)¶

The state of the specified converter.

Parameters:

index (int) – Index of the converter.

String statusInfo(int index)¶

Status information for the specified converter. This is the full status message shown in the in-game UI.

Parameters:

index (int) – Index of the converter.

java.util.List<String> inputs(int index)¶

List of the names of resources consumed by the specified converter.

Parameters:

index (int) – Index of the converter.

java.util.List<String> outputs(int index)¶

List of the names of resources produced by the specified converter.

Parameters:

index (int) – Index of the converter.

float getOptimumCoreTemperature()¶: The core temperature at which the converter will operate with peak efficiency, in Kelvin.

float getCoreTemperature()¶: The core temperature of the converter, in Kelvin.

float getThermalEfficiency()¶: The thermal efficiency of the converter, as a percentage of its maximum.

public enum ResourceConverterState¶

The state of a resource converter. See ResourceConverter.state(int).

public ResourceConverterState RUNNING¶: Converter is running.

public ResourceConverterState IDLE¶: Converter is idle.

public ResourceConverterState MISSING_RESOURCE¶: Converter is missing a required resource.

public ResourceConverterState STORAGE_FULL¶: No available storage for output resource.

public ResourceConverterState CAPACITY¶: At preset resource capacity.

public ResourceConverterState UNKNOWN¶: Unknown state. Possible with modified resource converters. In this case, check ResourceConverter.statusInfo(int) for more information.

Resource Harvester ¶

public class ResourceHarvester¶

A resource harvester (drill). Obtained by calling Part.getResourceHarvester().

Part getPart()¶: The part object for this harvester.

ResourceHarvesterState getState()¶: The state of the harvester.

boolean getDeployed()¶

void setDeployed(boolean value)¶: Whether the harvester is deployed.

boolean getActive()¶

void setActive(boolean value)¶: Whether the harvester is actively drilling.

float getExtractionRate()¶: The rate at which the drill is extracting ore, in units per second.

float getThermalEfficiency()¶: The thermal efficiency of the drill, as a percentage of its maximum.

float getCoreTemperature()¶: The core temperature of the drill, in Kelvin.

float getOptimumCoreTemperature()¶: The core temperature at which the drill will operate with peak efficiency, in Kelvin.

public enum ResourceHarvesterState¶

The state of a resource harvester. See ResourceHarvester.getState().

public ResourceHarvesterState DEPLOYING¶: The drill is deploying.

public ResourceHarvesterState DEPLOYED¶: The drill is deployed and ready.

public ResourceHarvesterState RETRACTING¶: The drill is retracting.

public ResourceHarvesterState RETRACTED¶: The drill is retracted.

public ResourceHarvesterState ACTIVE¶: The drill is running.

Reaction Wheel ¶

public class ReactionWheel¶

A reaction wheel. Obtained by calling Part.getReactionWheel().

Part getPart()¶: The part object for this reaction wheel.

boolean getActive()¶

void setActive(boolean value)¶: Whether the reaction wheel is active.

boolean getBroken()¶: Whether the reaction wheel is broken.

org.javatuples.Pair<org.javatuples.Triplet<Double, Double, Double>, org.javatuples.Triplet<Double, Double, Double>> getAvailableTorque()¶: The available torque, in Newton meters, that can be produced by this reaction wheel, in the positive and negative pitch, roll and yaw axes of the vessel. These axes correspond to the coordinate axes of the Vessel.getReferenceFrame(). Returns zero if the reaction wheel is inactive or broken.

org.javatuples.Pair<org.javatuples.Triplet<Double, Double, Double>, org.javatuples.Triplet<Double, Double, Double>> getMaxTorque()¶: The maximum torque, in Newton meters, that can be produced by this reaction wheel, when it is active, in the positive and negative pitch, roll and yaw axes of the vessel. These axes correspond to the coordinate axes of the Vessel.getReferenceFrame().

Resource Drain ¶

public class ResourceDrain¶

A resource drain. Obtained by calling Part.getResourceDrain().

Part getPart()¶: The part object for this resource drain.

java.util.List<Resource> getAvailableResources()¶: List of available resources.

void setResource(Resource resource, boolean enabled)¶

Whether the given resource should be drained.

Parameters:

resource (Resource) –
enabled (boolean) –

boolean checkResource(Resource resource)¶

Whether the provided resource is enabled for draining.

Parameters:

resource (Resource) –

DrainMode getDrainMode()¶

void setDrainMode(DrainMode value)¶: The drain mode.

float getMinRate()¶: Minimum possible drain rate

float getMaxRate()¶: Maximum possible drain rate.

float getRate()¶

void setRate(float value)¶: Current drain rate.

void start()¶: Activates resource draining for all enabled parts.

void stop()¶: Turns off resource draining.

public enum DrainMode¶

Resource drain mode. See ResourceDrain.getDrainMode().

public DrainMode PART¶: Drains from the parent part.

public DrainMode VESSEL¶: Drains from all available parts.

Robotic Controller ¶

public class RoboticController¶

A robotic controller. Obtained by calling Part.getRoboticController().

Part getPart()¶: The part object for this controller.

boolean hasPart(Part part)¶

Whether the controller has a part.

Parameters:

part (Part) –

java.util.List<java.util.List<String>> axes()¶: The axes for the controller.

boolean addAxis(Module module, String fieldName)¶

Add an axis to the controller.

Parameters:

module (Module) –
fieldName (String) –

Returns:

Returns true if the axis is added successfully.

boolean addKeyFrame(Module module, String fieldName, float time, float value)¶

Add key frame value for controller axis.

Parameters:

module (Module) –
fieldName (String) –
time (float) –
value (float) –

Returns:

Returns true if the key frame is added successfully.

boolean clearAxis(Module module, String fieldName)¶

Clear axis.

Parameters:

module (Module) –
fieldName (String) –

Returns:

Returns true if the axis is cleared successfully.

Robotic Hinge ¶

public class RoboticHinge¶

A robotic hinge. Obtained by calling Part.getRoboticHinge().

Part getPart()¶: The part object for this robotic hinge.

float getTargetAngle()¶

void setTargetAngle(float value)¶: Target angle.

float getCurrentAngle()¶: Current angle.

float getRate()¶

void setRate(float value)¶: Target movement rate in degrees per second.

float getDamping()¶

void setDamping(float value)¶: Damping percentage.

boolean getLocked()¶

void setLocked(boolean value)¶: Lock movement.

boolean getMotorEngaged()¶

void setMotorEngaged(boolean value)¶: Whether the motor is engaged.

void moveHome()¶: Move hinge to it’s built position.

Robotic Piston ¶

public class RoboticPiston¶

A robotic piston part. Obtained by calling Part.getRoboticPiston().

Part getPart()¶: The part object for this robotic piston.

float getTargetExtension()¶

void setTargetExtension(float value)¶: Target extension of the piston.

float getCurrentExtension()¶: Current extension of the piston.

float getRate()¶

void setRate(float value)¶: Target movement rate in degrees per second.

float getDamping()¶

void setDamping(float value)¶: Damping percentage.

boolean getLocked()¶

void setLocked(boolean value)¶: Lock movement.

boolean getMotorEngaged()¶

void setMotorEngaged(boolean value)¶: Whether the motor is engaged.

void moveHome()¶: Move piston to it’s built position.

Robotic Rotation ¶

public class RoboticRotation¶

A robotic rotation servo. Obtained by calling Part.getRoboticRotation().

Part getPart()¶: The part object for this robotic rotation servo.

float getTargetAngle()¶

void setTargetAngle(float value)¶: Target angle.

float getCurrentAngle()¶: Current angle.

float getRate()¶

void setRate(float value)¶: Target movement rate in degrees per second.

float getDamping()¶

void setDamping(float value)¶: Damping percentage.

boolean getLocked()¶

void setLocked(boolean value)¶: Lock Movement

boolean getMotorEngaged()¶

void setMotorEngaged(boolean value)¶: Whether the motor is engaged.

void moveHome()¶: Move rotation servo to it’s built position.

Robotic Rotor ¶

public class RoboticRotor¶

A robotic rotor. Obtained by calling Part.getRoboticRotor().

Part getPart()¶: The part object for this robotic rotor.

float getTargetRPM()¶

void setTargetRPM(float value)¶: Target RPM.

float getCurrentRPM()¶: Current RPM.

boolean getInverted()¶

void setInverted(boolean value)¶: Whether the rotor direction is inverted.

float getTorqueLimit()¶

void setTorqueLimit(float value)¶: Torque limit percentage.

boolean getLocked()¶

void setLocked(boolean value)¶: Lock movement.

boolean getMotorEngaged()¶

void setMotorEngaged(boolean value)¶: Whether the motor is engaged.

RCS ¶

public class RCS¶

An RCS block or thruster. Obtained by calling Part.getRCS().

Part getPart()¶: The part object for this RCS.

boolean getActive()¶: Whether the RCS thrusters are active. An RCS thruster is inactive if the RCS action group is disabled (Control.getRCS()), the RCS thruster itself is not enabled (RCS.getEnabled()) or it is covered by a fairing (Part.getShielded()).

boolean getEnabled()¶

void setEnabled(boolean value)¶: Whether the RCS thrusters are enabled.

boolean getPitchEnabled()¶

void setPitchEnabled(boolean value)¶: Whether the RCS thruster will fire when pitch control input is given.

boolean getYawEnabled()¶

void setYawEnabled(boolean value)¶: Whether the RCS thruster will fire when yaw control input is given.

boolean getRollEnabled()¶

void setRollEnabled(boolean value)¶: Whether the RCS thruster will fire when roll control input is given.

boolean getForwardEnabled()¶

void setForwardEnabled(boolean value)¶: Whether the RCS thruster will fire when pitch control input is given.

boolean getUpEnabled()¶

void setUpEnabled(boolean value)¶: Whether the RCS thruster will fire when yaw control input is given.

boolean getRightEnabled()¶

void setRightEnabled(boolean value)¶: Whether the RCS thruster will fire when roll control input is given.

org.javatuples.Pair<org.javatuples.Triplet<Double, Double, Double>, org.javatuples.Triplet<Double, Double, Double>> getAvailableTorque()¶: The available torque, in Newton meters, that can be produced by this RCS, in the positive and negative pitch, roll and yaw axes of the vessel. These axes correspond to the coordinate axes of the Vessel.getReferenceFrame(). Returns zero if RCS is disable.

org.javatuples.Pair<org.javatuples.Triplet<Double, Double, Double>, org.javatuples.Triplet<Double, Double, Double>> getAvailableForce()¶: The available force, in Newtons, that can be produced by this RCS, in the positive and negative x, y and z axes of the vessel. These axes correspond to the coordinate axes of the Vessel.getReferenceFrame(). Returns zero if RCS is disabled.

float getAvailableThrust()¶: The amount of thrust, in Newtons, that would be produced by the thruster when activated. Returns zero if the thruster does not have any fuel. Takes the thrusters current RCS.getThrustLimit() and atmospheric conditions into account.

float getMaxThrust()¶: The maximum amount of thrust that can be produced by the RCS thrusters when active, in Newtons. Takes the thrusters current RCS.getThrustLimit() and atmospheric conditions into account.

float getMaxVacuumThrust()¶: The maximum amount of thrust that can be produced by the RCS thrusters when active in a vacuum, in Newtons.

float getThrustLimit()¶

void setThrustLimit(float value)¶: The thrust limiter of the thruster. A value between 0 and 1.

java.util.List<Thruster> getThrusters()¶: A list of thrusters, one of each nozzel in the RCS part.

float getSpecificImpulse()¶: The current specific impulse of the RCS, in seconds. Returns zero if the RCS is not active.

float getVacuumSpecificImpulse()¶: The vacuum specific impulse of the RCS, in seconds.

float getKerbinSeaLevelSpecificImpulse()¶: The specific impulse of the RCS at sea level on Kerbin, in seconds.

java.util.List<String> getPropellants()¶: The names of resources that the RCS consumes.

java.util.Map<String, Float> getPropellantRatios()¶: The ratios of resources that the RCS consumes. A dictionary mapping resource names to the ratios at which they are consumed by the RCS.

boolean getHasFuel()¶: Whether the RCS has fuel available.

Sensor ¶

public class Sensor¶

A sensor, such as a thermometer. Obtained by calling Part.getSensor().

Part getPart()¶: The part object for this sensor.

boolean getActive()¶

void setActive(boolean value)¶: Whether the sensor is active.

String getValue()¶: The current value of the sensor.

Solar Panel ¶

public class SolarPanel¶

A solar panel. Obtained by calling Part.getSolarPanel().

Part getPart()¶: The part object for this solar panel.

boolean getDeployable()¶: Whether the solar panel is deployable.

boolean getDeployed()¶

void setDeployed(boolean value)¶: Whether the solar panel is extended.

SolarPanelState getState()¶: The current state of the solar panel.

float getEnergyFlow()¶: The current amount of energy being generated by the solar panel, in units of charge per second.

float getSunExposure()¶: The current amount of sunlight that is incident on the solar panel, as a percentage. A value between 0 and 1.

public enum SolarPanelState¶

The state of a solar panel. See SolarPanel.getState().

public SolarPanelState EXTENDED¶: Solar panel is fully extended.

public SolarPanelState RETRACTED¶: Solar panel is fully retracted.

public SolarPanelState EXTENDING¶: Solar panel is being extended.

public SolarPanelState RETRACTING¶: Solar panel is being retracted.

public SolarPanelState BROKEN¶: Solar panel is broken.

Thruster ¶

public class Thruster¶

The component of an Engine or RCS part that generates thrust. Can obtained by calling Engine.getThrusters() or RCS.getThrusters().

Note

Engines can consist of multiple thrusters. For example, the S3 KS-25x4 “Mammoth” has four rocket nozzels, and so consists of four thrusters.

Part getPart()¶: The Part that contains this thruster.

org.javatuples.Triplet<Double, Double, Double> thrustPosition(ReferenceFrame referenceFrame)¶

The position at which the thruster generates thrust, in the given reference frame. For gimballed engines, this takes into account the current rotation of the gimbal.

Parameters:

referenceFrame (ReferenceFrame) – The reference frame that the returned position vector is in.

Returns:

The position as a vector.

org.javatuples.Triplet<Double, Double, Double> thrustDirection(ReferenceFrame referenceFrame)¶

The direction of the force generated by the thruster, in the given reference frame. This is opposite to the direction in which the thruster expels propellant. For gimballed engines, this takes into account the current rotation of the gimbal.

Parameters:

referenceFrame (ReferenceFrame) – The reference frame that the returned direction is in.

Returns:

The direction as a unit vector.

ReferenceFrame getThrustReferenceFrame()¶

A reference frame that is fixed relative to the thruster and orientated with its thrust direction (Thruster.thrustDirection(ReferenceFrame)). For gimballed engines, this takes into account the current rotation of the gimbal.

The origin is at the position of thrust for this thruster (Thruster.thrustPosition(ReferenceFrame)).
The axes rotate with the thrust direction. This is the direction in which the thruster expels propellant, including any gimballing.
The y-axis points along the thrust direction.
The x-axis and z-axis are perpendicular to the thrust direction.

boolean getGimballed()¶: Whether the thruster is gimballed.

org.javatuples.Triplet<Double, Double, Double> gimbalPosition(ReferenceFrame referenceFrame)¶

Position around which the gimbal pivots.

Parameters:

referenceFrame (ReferenceFrame) – The reference frame that the returned position vector is in.

Returns:

The position as a vector.

org.javatuples.Triplet<Double, Double, Double> getGimbalAngle()¶: The current gimbal angle in the pitch, roll and yaw axes, in degrees.

org.javatuples.Triplet<Double, Double, Double> initialThrustPosition(ReferenceFrame referenceFrame)¶

The position at which the thruster generates thrust, when the engine is in its initial position (no gimballing), in the given reference frame.

Parameters:

referenceFrame (ReferenceFrame) – The reference frame that the returned position vector is in.

Returns:

The position as a vector.

Note

This position can move when the gimbal rotates. This is because the thrust position and gimbal position are not necessarily the same.

org.javatuples.Triplet<Double, Double, Double> initialThrustDirection(ReferenceFrame referenceFrame)¶

The direction of the force generated by the thruster, when the engine is in its initial position (no gimballing), in the given reference frame. This is opposite to the direction in which the thruster expels propellant.

Parameters:

referenceFrame (ReferenceFrame) – The reference frame that the returned direction is in.

Returns:

The direction as a unit vector.

Wheel ¶

public class Wheel¶

A wheel. Includes landing gear and rover wheels. Obtained by calling Part.getWheel(). Can be used to control the motors, steering and deployment of wheels, among other things.

Part getPart()¶: The part object for this wheel.

WheelState getState()¶: The current state of the wheel.

float getRadius()¶: Radius of the wheel, in meters.

boolean getGrounded()¶: Whether the wheel is touching the ground.

boolean getHasBrakes()¶: Whether the wheel has brakes.

float getBrakes()¶

void setBrakes(float value)¶: The braking force, as a percentage of maximum, when the brakes are applied.

boolean getAutoFrictionControl()¶

void setAutoFrictionControl(boolean value)¶: Whether automatic friction control is enabled.

float getManualFrictionControl()¶

void setManualFrictionControl(float value)¶: Manual friction control value. Only has an effect if automatic friction control is disabled. A value between 0 and 5 inclusive.

boolean getDeployable()¶: Whether the wheel is deployable.

boolean getDeployed()¶

void setDeployed(boolean value)¶: Whether the wheel is deployed.

boolean getPowered()¶: Whether the wheel is powered by a motor.

boolean getMotorEnabled()¶

void setMotorEnabled(boolean value)¶: Whether the motor is enabled.

boolean getMotorInverted()¶

void setMotorInverted(boolean value)¶: Whether the direction of the motor is inverted.

MotorState getMotorState()¶: Whether the direction of the motor is inverted.

float getMotorOutput()¶: The output of the motor. This is the torque currently being generated, in Newton meters.

boolean getTractionControlEnabled()¶

void setTractionControlEnabled(boolean value)¶: Whether automatic traction control is enabled. A wheel only has traction control if it is powered.

float getTractionControl()¶

void setTractionControl(float value)¶: Setting for the traction control. Only takes effect if the wheel has automatic traction control enabled. A value between 0 and 5 inclusive.

float getDriveLimiter()¶

void setDriveLimiter(float value)¶: Manual setting for the motor limiter. Only takes effect if the wheel has automatic traction control disabled. A value between 0 and 100 inclusive.

boolean getSteerable()¶: Whether the wheel has steering.

boolean getSteeringEnabled()¶

void setSteeringEnabled(boolean value)¶: Whether the wheel steering is enabled.

boolean getSteeringInverted()¶

void setSteeringInverted(boolean value)¶: Whether the wheel steering is inverted.

float getSteeringAngleLimit()¶

void setSteeringAngleLimit(float value)¶: The steering angle limit.

float getSteeringResponseTime()¶

void setSteeringResponseTime(float value)¶: Steering response time.

boolean getHasSuspension()¶: Whether the wheel has suspension.

float getSuspensionSpringStrength()¶: Suspension spring strength, as set in the editor.

float getSuspensionDamperStrength()¶: Suspension damper strength, as set in the editor.

boolean getBroken()¶: Whether the wheel is broken.

boolean getRepairable()¶: Whether the wheel is repairable.

float getStress()¶: Current stress on the wheel.

float getStressTolerance()¶: Stress tolerance of the wheel.

float getStressPercentage()¶: Current stress on the wheel as a percentage of its stress tolerance.

float getDeflection()¶: Current deflection of the wheel.

float getSlip()¶: Current slip of the wheel.

public enum WheelState¶

The state of a wheel. See Wheel.getState().

public WheelState DEPLOYED¶: Wheel is fully deployed.

public WheelState RETRACTED¶: Wheel is fully retracted.

public WheelState DEPLOYING¶: Wheel is being deployed.

public WheelState RETRACTING¶: Wheel is being retracted.

public WheelState BROKEN¶: Wheel is broken.

public enum MotorState¶

The state of the motor on a powered wheel. See Wheel.getMotorState().

public MotorState IDLE¶: The motor is idle.

public MotorState RUNNING¶: The motor is running.

public MotorState DISABLED¶: The motor is disabled.

public MotorState INOPERABLE¶: The motor is inoperable.

public MotorState NOT_ENOUGH_RESOURCES¶: The motor does not have enough resources to run.

Trees of Parts ¶

Vessels in KSP are comprised of a number of parts, connected to one another in a tree structure. An example vessel is shown in Figure 1, and the corresponding tree of parts in Figure 2. The craft file for this example can also be downloaded here.

../../../_images/parts.png — **Figure 1** – Example parts making up a vessel.¶

../../../_images/parts-tree.png — **Figure 2** – Tree of parts for the vessel in Figure 1. Arrows point from the parent part to the child part.¶

Traversing the Tree ¶

The tree of parts can be traversed using the attributes Parts.getRoot(), Part.getParent() and Part.getChildren().

The root of the tree is the same as the vessels root part (part number 1 in the example above) and can be obtained by calling Parts.getRoot(). A parts children can be obtained by calling Part.getChildren(). If the part does not have any children, Part.getChildren() returns an empty list. A parts parent can be obtained by calling Part.getParent(). If the part does not have a parent (as is the case for the root part), Part.getParent() returns null.

The following Java example uses these attributes to perform a depth-first traversal over all of the parts in a vessel:

import krpc.client.Connection;
import krpc.client.RPCException;
import krpc.client.services.SpaceCenter;
import krpc.client.services.SpaceCenter.Part;
import krpc.client.services.SpaceCenter.Vessel;

import org.javatuples.Pair;

import java.io.IOException;
import java.util.ArrayDeque;
import java.util.Deque;

public class TreeTraversal {
    public static void main(String[] args) throws IOException, RPCException {
        Connection connection = Connection.newInstance();
        Vessel vessel = SpaceCenter.newInstance(connection).getActiveVessel();
        Part root = vessel.getParts().getRoot();
        Deque<Pair<Part, Integer>> stack = new ArrayDeque<Pair<Part, Integer>>();
        stack.push(new Pair<Part, Integer>(root, 0));
        while (stack.size() > 0) {
            Pair<Part, Integer> item = stack.pop();
            Part part = item.getValue0();
            int depth = item.getValue1();
            String prefix = "";
            for (int i = 0; i < depth; i++) {
                prefix += " ";
            }
            System.out.println(prefix + part.getTitle());
            for (Part child : part.getChildren()) {
                stack.push(new Pair<Part, Integer>(child, depth + 1));
            }
        }
        connection.close();
    }
}

When this code is execute using the craft file for the example vessel pictured above, the following is printed out:

Command Pod Mk1
 TR-18A Stack Decoupler
  FL-T400 Fuel Tank
   LV-909 Liquid Fuel Engine
    TR-18A Stack Decoupler
     FL-T800 Fuel Tank
      LV-909 Liquid Fuel Engine
      TT-70 Radial Decoupler
       FL-T400 Fuel Tank
        TT18-A Launch Stability Enhancer
        FTX-2 External Fuel Duct
        LV-909 Liquid Fuel Engine
        Aerodynamic Nose Cone
      TT-70 Radial Decoupler
       FL-T400 Fuel Tank
        TT18-A Launch Stability Enhancer
        FTX-2 External Fuel Duct
        LV-909 Liquid Fuel Engine
        Aerodynamic Nose Cone
   LT-1 Landing Struts
   LT-1 Landing Struts
 Mk16 Parachute

Attachment Modes ¶

Parts can be attached to other parts either radially (on the side of the parent part) or axially (on the end of the parent part, to form a stack).

For example, in the vessel pictured above, the parachute (part 2) is axially connected to its parent (the command pod – part 1), and the landing leg (part 5) is radially connected to its parent (the fuel tank – part 4).

The root part of a vessel (for example the command pod – part 1) does not have a parent part, so does not have an attachment mode. However, the part is consider to be axially attached to nothing.

The following Java example does a depth-first traversal as before, but also prints out the attachment mode used by the part:

import krpc.client.Connection;
import krpc.client.RPCException;
import krpc.client.services.SpaceCenter;
import krpc.client.services.SpaceCenter.Part;
import krpc.client.services.SpaceCenter.Vessel;

import org.javatuples.Pair;

import java.io.IOException;
import java.util.ArrayDeque;
import java.util.Deque;

public class AttachmentModes {
    public static void main(String[] args) throws IOException, RPCException {
        Connection connection = Connection.newInstance();
        Vessel vessel = SpaceCenter.newInstance(connection).getActiveVessel();
        Part root = vessel.getParts().getRoot();
        Deque<Pair<Part, Integer>> stack = new ArrayDeque<Pair<Part, Integer>>();
        stack.push(new Pair<Part, Integer>(root, 0));
        while (stack.size() > 0) {
            Pair<Part, Integer> item = stack.pop();
            Part part = item.getValue0();
            int depth = item.getValue1();
            String prefix = "";
            for (int i = 0; i < depth; i++) {
                prefix += " ";
            }
            String attachMode = part.getAxiallyAttached() ? "axial" : "radial";
            System.out.println(prefix + part.getTitle() + " - " + attachMode);
            for (Part child : part.getChildren()) {
                stack.push(new Pair<Part, Integer>(child, depth + 1));
            }
        }
        connection.close();
    }
}

When this code is execute using the craft file for the example vessel pictured above, the following is printed out:

Command Pod Mk1 - axial
 TR-18A Stack Decoupler - axial
  FL-T400 Fuel Tank - axial
   LV-909 Liquid Fuel Engine - axial
    TR-18A Stack Decoupler - axial
     FL-T800 Fuel Tank - axial
      LV-909 Liquid Fuel Engine - axial
      TT-70 Radial Decoupler - radial
       FL-T400 Fuel Tank - radial
        TT18-A Launch Stability Enhancer - radial
        FTX-2 External Fuel Duct - radial
        LV-909 Liquid Fuel Engine - axial
        Aerodynamic Nose Cone - axial
      TT-70 Radial Decoupler - radial
       FL-T400 Fuel Tank - radial
        TT18-A Launch Stability Enhancer - radial
        FTX-2 External Fuel Duct - radial
        LV-909 Liquid Fuel Engine - axial
        Aerodynamic Nose Cone - axial
   LT-1 Landing Struts - radial
   LT-1 Landing Struts - radial
 Mk16 Parachute - axial

Fuel Lines ¶

Fuel lines are considered parts, and are included in the parts tree (for example, as pictured in Figure 4). However, the parts tree does not contain information about which parts fuel lines connect to. The parent part of a fuel line is the part from which it will take fuel (as shown in Figure 4) however the part that it will send fuel to is not represented in the parts tree.

Figure 5 shows the fuel lines from the example vessel pictured earlier. Fuel line part 15 (in red) takes fuel from a fuel tank (part 11 – in green) and feeds it into another fuel tank (part 9 – in blue). The fuel line is therefore a child of part 11, but its connection to part 9 is not represented in the tree.

The attributes Part.getFuelLinesFrom() and Part.getFuelLinesTo() can be used to discover these connections. In the example in Figure 5, when Part.getFuelLinesTo() is called on fuel tank part 11, it will return a list of parts containing just fuel tank part 9 (the blue part). When Part.getFuelLinesFrom() is called on fuel tank part 9, it will return a list containing fuel tank parts 11 and 17 (the parts colored green).

Staging ¶

Each part has two staging numbers associated with it: the stage in which the part is activated and the stage in which the part is decoupled. These values can be obtained using Part.getStage() and Part.getDecoupleStage() respectively. For parts that are not activated by staging, Part.getStage() returns -1. For parts that are never decoupled, Part.getDecoupleStage() returns a value of -1.

Figure 6 shows an example staging sequence for a vessel. Figure 7 shows the stages in which each part of the vessel will be activated. Figure 8 shows the stages in which each part of the vessel will be decoupled.

../../../_images/parts-staging-activate.png — **Figure 7** – The stage in which each part is *activated*.¶

../../../_images/parts-staging-decouple.png — **Figure 8** – The stage in which each part is *decoupled*.¶