Vessel#

public class Vessel#

These objects are used to interact with vessels in KSP. This includes getting orbital and flight data, manipulating control inputs and managing resources. Created using getActiveVessel() or getVessels().

String getName()#

void setName(String value)#: The name of the vessel.

VesselType getType()#

void setType(VesselType value)#: The type of the vessel.

VesselSituation getSituation()#: The situation the vessel is in.

boolean getLoaded()#: Whether the vessel is loaded, i.e. its parts are instantiated in the scene because it is within loading range of the active vessel. A vessel that is not loaded exists only as orbital data and is always on-rails (see Vessel.getPacked()).

boolean getPacked()#: Whether the vessel is packed (on-rails). A packed vessel has its physics simulation suspended and follows its orbit analytically. A vessel that is not loaded (see Vessel.getLoaded()) is always packed.

float getPhysicsRange()#

void setPhysicsRange(float value)#

The distance from the active vessel, in meters, out to which this vessel keeps running its physics simulation, and so stays controllable, able to burn its engines and respond to its autopilot. Setting this raises the vessel out of the stock physics bubble, so that it keeps flying while the active vessel is far away. Set to zero to restore the game’s default range.

Game Scenes:: Flight

Note

This always reports the vessel’s live range, so reading it when no range has been set gives the game’s default for the vessel’s current Vessel.getSituation(), which is much shorter than the distance at which the vessel unloads. In orbit a vessel is put on rails just 350m away, long before it unloads at 2.5km, and a vessel on rails produces no thrust and ignores control input even though it is still loaded.

There is a 10% margin below the range, so that a vessel hovering at the threshold does not repeatedly drop out of the simulation and rejoin it. The vessel leaves the simulation at the distance set here, and rejoins it at 90% of that distance; in between it keeps whichever state it is already in.

The requested range applies in every situation. The game’s own defaults are not uniform, and a vessel flying in atmosphere stays loaded out to 22.5km, so setting a small range can shorten the range such a vessel would otherwise have had.

A range lasts until it is set back to zero or the game is exited. Unlike most state a client sets, it is not released when that client disconnects, because dropping a distant vessel back to the default range would put it on-rails part way through a maneuver.

Holding a vessel off-rails a long way from the active vessel costs performance, and accumulates positional error that can destroy it. Raise the range on the vessels that need it, by as little as they need.

boolean getRecoverable()#: Whether the vessel is recoverable.

void recover()#: Recover the vessel. The crew return to the astronaut complex, and the funds and science the vessel is worth are awarded.

Note

Recovering the active vessel ends the flight and returns to the space center, as pressing recover in game does. When a non-active vessel is recovered the current scene is unaffected, and the mission completion dialog is not shown, so a script flying several vessels keeps control of the rest of them.

Returns immediately, does not wait for the vessel to be recovered.

void terminate()#: Terminate the vessel. The vessel and its parts are removed from the game, and its crew are lost, as when the vessel is terminated from the tracking station. Nothing is recovered: no funds, no science and no crew.

Note

The crew are reported missing, and return to the astronaut complex once their respawn timer expires, or never if the game is set up so that missing crews do not respawn.

The active vessel cannot be terminated, because the vessel being flown cannot be taken out of the scene it is being flown in. Switch to another vessel first, or use Vessel.recover(), which ends the flight and returns to the space center.

Returns immediately, does not wait for the vessel to be terminated.

double getMET()#: The mission elapsed time in seconds.

String getBiome()#: The name of the biome the vessel is currently in.

Flight flight(ReferenceFrame referenceFrame)#

Returns a Vessel.flight(ReferenceFrame) object that can be used to get flight telemetry for the vessel, in the specified reference frame.

Parameters:

referenceFrame (ReferenceFrame) – Reference frame. Defaults to the vessel’s surface reference frame (Vessel.getSurfaceReferenceFrame()).

Game Scenes:

Flight

Note

When this is called with no arguments, the vessel’s surface reference frame is used. This reference frame moves with the vessel, therefore velocities and speeds returned by the flight object will be zero. See the reference frames tutorial for examples of getting the orbital and surface speeds of a vessel.

Orbit getOrbit()#: The current orbit of the vessel.

Control getControl()#

Returns a Vessel.getControl() object that can be used to manipulate the vessel’s control inputs. For example, its pitch/yaw/roll controls, RCS and thrust.

Game Scenes:: Flight

Comms getComms()#

Returns a Vessel.getComms() object that can be used to interact with CommNet for this vessel.

Game Scenes:: Flight

AutoPilot getAutoPilot()#

An Vessel.getAutoPilot() object, that can be used to perform simple auto-piloting of the vessel.

Game Scenes:: Flight

int getCrewCapacity()#: The number of crew that can occupy the vessel.

int getCrewCount()#: The number of crew that are occupying the vessel.

java.util.List<CrewMember> getCrew()#: The crew in the vessel.

Resources getResources()#

A Vessel.getResources() object, that can used to get information about resources stored in the vessel.

Game Scenes:: Flight

java.util.List<Stage> getStages()#

Activation (burn) stages for this vessel, in ascending stage order. This does not include the -1 stage (parts with no staging icon), as it carries no delta-v; use Vessel.stageAt(int) with -1 to get those parts.

Game Scenes:: Flight

Note

Lists activation stages only (decouple is false). See also Staging.

Stage stageAt(int stage)#

The activation stage with the given number. Pass -1 to get the parts that are never activated (those with no staging icon).

Parameters:

stage (int) – Get activation stage at this index.

Game Scenes:

Flight

java.util.List<Stage> getDecoupleStages()#

Decouple stages for this vessel, in ascending stage order. The -1 stage, containing the parts that are never decoupled and remain on the vessel, is included first when any such parts exist.

Game Scenes:: Flight

Note

Lists decouple stages only. Delta-v is not defined on these stages.

Stage decoupleStageAt(int stage)#

The decouple stage with the given number. Pass -1 to get the parts that are never decoupled and remain on the vessel after all stages have fired.

Parameters:

stage (int) – Get decouple stage at this index.

Game Scenes:

Flight

boolean getDeltaVReady()#

Whether the vessel’s delta-v figures are current.

Game Scenes:: Flight

Note

The game calculates delta-v for the active vessel alone, over the several ticks after the vessel changes. A delta-v member reports the figures from the last calculation, and waits only when the game has calculated none.

void recalculateDeltaV()#

Recalculates the vessel’s delta-v figures, and waits until they are current. Throws an exception if the vessel is not the active vessel.

Game Scenes:: Flight

float getDeltaV()#

Total delta-v for the vessel in the current situation, in m/s.

Game Scenes:: Flight

Note

Requires the stock delta-v display to be ready. Units are meters per second.

float getVacuumDeltaV()#

Total vacuum delta-v for the vessel, in m/s.

Game Scenes:: Flight

float getSeaLevelDeltaV()#

Total sea-level delta-v for the vessel, in m/s.

Game Scenes:: Flight

float getBurnTime()#

Total burn time for the vessel, in seconds.

Game Scenes:: Flight

Parts getParts()#

A Parts object, that can used to interact with the parts that make up this vessel.

Game Scenes:: Flight

float getMass()#

The total mass of the vessel, including resources, in kg.

Game Scenes:: Flight

float getDryMass()#

The total mass of the vessel, excluding resources, in kg.

Game Scenes:: Flight

float getThrust()#

The total thrust currently being produced by the vessel’s engines, in Newtons. This is computed by summing Engine.getThrust() for every engine in the vessel.

Game Scenes:: Flight

float getAvailableThrust()#

Gets the total available thrust that can be produced by the vessel’s active engines, in Newtons. This is computed by summing Engine.getAvailableThrust() for every active engine in the vessel.

Game Scenes:: Flight

float availableThrustAt(double pressure)#

Gets the total available thrust that can be produced by the vessel’s active engines, in Newtons. This is computed by summing Engine.availableThrustAt(double) for every active engine in the vessel. Takes the given pressure into account.

Parameters:

pressure (double) – Atmospheric pressure in atmospheres

Game Scenes:

Flight

float getMaxThrust()#

The total maximum thrust that can be produced by the vessel’s active engines, in Newtons. This is computed by summing Engine.getMaxThrust() for every active engine.

Game Scenes:: Flight

float maxThrustAt(double pressure)#

The total maximum thrust that can be produced by the vessel’s active engines, in Newtons. This is computed by summing Engine.maxThrustAt(double) for every active engine. Takes the given pressure into account.

Parameters:

pressure (double) – Atmospheric pressure in atmospheres

Game Scenes:

Flight

float getMaxVacuumThrust()#

The total maximum thrust that can be produced by the vessel’s active engines when the vessel is in a vacuum, in Newtons. This is computed by summing Engine.getMaxVacuumThrust() for every active engine.

Game Scenes:: Flight

float getAcceleration()#

The acceleration currently produced by the vessel’s engines, in \(m/s^2\). This is Vessel.getThrust() divided by the vessel’s Vessel.getMass().

Game Scenes:: Flight

float getAvailableAcceleration()#

The total available acceleration that can be produced by the vessel’s active engines, in \(m/s^2\). This is Vessel.getAvailableThrust() divided by the vessel’s Vessel.getMass().

Game Scenes:: Flight

float availableAccelerationAt(double pressure)#

The total available acceleration that can be produced by the vessel’s active engines, in \(m/s^2\). This is Vessel.availableThrustAt(double) divided by the vessel’s Vessel.getMass(). Takes the given pressure into account.

Parameters:

pressure (double) – Atmospheric pressure in atmospheres

Game Scenes:

Flight

float getMaxAcceleration()#

The total maximum acceleration that can be produced by the vessel’s active engines, in \(m/s^2\). This is Vessel.getMaxThrust() divided by the vessel’s Vessel.getMass().

Game Scenes:: Flight

float maxAccelerationAt(double pressure)#

The total maximum acceleration that can be produced by the vessel’s active engines, in \(m/s^2\). This is Vessel.maxThrustAt(double) divided by the vessel’s Vessel.getMass(). Takes the given pressure into account.

Parameters:

pressure (double) – Atmospheric pressure in atmospheres

Game Scenes:

Flight

float getMaxVacuumAcceleration()#

The total maximum acceleration that can be produced by the vessel’s active engines when the vessel is in a vacuum, in \(m/s^2\). This is Vessel.getMaxVacuumThrust() divided by the vessel’s Vessel.getMass().

Game Scenes:: Flight

float getSpecificImpulse()#

The combined specific impulse of all active engines, in seconds. This is computed using the formula described here.

Game Scenes:: Flight

float specificImpulseAt(double pressure)#

The combined specific impulse of all active engines, in seconds. This is computed using the formula described here. Takes the given pressure into account.

Parameters:

pressure (double) – Atmospheric pressure in atmospheres

Game Scenes:

Flight

float getVacuumSpecificImpulse()#

The combined vacuum specific impulse of all active engines, in seconds. This is computed using the formula described here.

Game Scenes:: Flight

float getKerbinSeaLevelSpecificImpulse()#

The combined specific impulse of all active engines at sea level on Kerbin, in seconds. This is computed using the formula described here.

Game Scenes:: Flight

org.javatuples.Triplet<Double, Double, Double> getMomentOfInertia()#

The moment of inertia of the vessel around its center of mass in \(kg.m^2\). The inertia values in the returned 3-tuple are around the pitch, roll and yaw directions respectively. This corresponds to the vessels reference frame (Vessel.getReferenceFrame()).

Game Scenes:: Flight

java.util.List<Double> getInertiaTensor()#

The inertia tensor of the vessel around its center of mass, in the vessels reference frame (Vessel.getReferenceFrame()). Returns the 3x3 matrix as a list of elements, in row-major order.

Game Scenes:: Flight

AxisRange getAvailableTorque()#

The maximum torque that the vessel generates. Includes contributions from reaction wheels, RCS, gimballed engines and aerodynamic control surfaces. Returns the torques in \(N.m\) around each of the coordinate axes of the vessels reference frame (Vessel.getReferenceFrame()). These axes are equivalent to the pitch, roll and yaw axes of the vessel.

Game Scenes:: Flight

AxisRange getAvailableReactionWheelTorque()#

The maximum torque that the currently active and powered reaction wheels can generate. Returns the torques in \(N.m\) around each of the coordinate axes of the vessels reference frame (Vessel.getReferenceFrame()). These axes are equivalent to the pitch, roll and yaw axes of the vessel.

Game Scenes:: Flight

AxisRange getAvailableRCSTorque()#

The maximum torque that the currently active RCS thrusters can generate. Returns the torques in \(N.m\) around each of the coordinate axes of the vessels reference frame (Vessel.getReferenceFrame()). These axes are equivalent to the pitch, roll and yaw axes of the vessel.

Game Scenes:: Flight

AxisRange getAvailableRCSForce()#

The maximum force that the currently active RCS thrusters can generate. Returns the forces in \(N\) along each of the coordinate axes of the vessels reference frame (Vessel.getReferenceFrame()). These axes are equivalent to the right, forward and bottom directions of the vessel.

Game Scenes:: Flight

AxisRange getAvailableRCSAcceleration()#

The maximum acceleration that the currently active RCS thrusters can generate. This is Vessel.getAvailableRCSForce() divided by the vessel’s Vessel.getMass(). Returns the accelerations in \(m/s^2\) along each of the coordinate axes of the vessels reference frame (Vessel.getReferenceFrame()). These axes are equivalent to the right, forward and bottom directions of the vessel.

Game Scenes:: Flight

AxisRange getAvailableEngineTorque()#

The maximum torque that the currently active and gimballed engines can generate. Returns the torques in \(N.m\) around each of the coordinate axes of the vessels reference frame (Vessel.getReferenceFrame()). These axes are equivalent to the pitch, roll and yaw axes of the vessel.

Game Scenes:: Flight

AxisRange getAvailableControlSurfaceTorque()#

The maximum torque that the aerodynamic control surfaces can generate. Returns the torques in \(N.m\) around each of the coordinate axes of the vessels reference frame (Vessel.getReferenceFrame()). These axes are equivalent to the pitch, roll and yaw axes of the vessel.

Game Scenes:: Flight

AxisRange getAvailableOtherTorque()#

The maximum torque that parts (excluding reaction wheels, gimballed engines, RCS and control surfaces) can generate. Returns the torques in \(N.m\) around each of the coordinate axes of the vessels reference frame (Vessel.getReferenceFrame()). These axes are equivalent to the pitch, roll and yaw axes of the vessel.

Game Scenes:: Flight

AxisRange getAvailableAngularAcceleration()#

The maximum angular acceleration that the vessel can generate. Includes contributions from reaction wheels, RCS, gimballed engines and aerodynamic control surfaces. This is Vessel.getAvailableTorque() divided by the vessel’s Vessel.getMomentOfInertia(). Returns the angular accelerations in \(rad/s^2\) around each of the coordinate axes of the vessels reference frame (Vessel.getReferenceFrame()). These axes are equivalent to the pitch, roll and yaw axes of the vessel.

Game Scenes:: Flight

AxisRange getAvailableReactionWheelAngularAcceleration()#

The maximum angular acceleration that the currently active and powered reaction wheels can generate. This is Vessel.getAvailableReactionWheelTorque() divided by the vessel’s Vessel.getMomentOfInertia(). Returns the angular accelerations in \(rad/s^2\) around each of the coordinate axes of the vessels reference frame (Vessel.getReferenceFrame()). These axes are equivalent to the pitch, roll and yaw axes of the vessel.

Game Scenes:: Flight

AxisRange getAvailableRCSAngularAcceleration()#

The maximum angular acceleration that the currently active RCS thrusters can generate. This is Vessel.getAvailableRCSTorque() divided by the vessel’s Vessel.getMomentOfInertia(). Returns the angular accelerations in \(rad/s^2\) around each of the coordinate axes of the vessels reference frame (Vessel.getReferenceFrame()). These axes are equivalent to the pitch, roll and yaw axes of the vessel.

Game Scenes:: Flight

AxisRange getAvailableEngineAngularAcceleration()#

The maximum angular acceleration that the currently active and gimballed engines can generate. This is Vessel.getAvailableEngineTorque() divided by the vessel’s Vessel.getMomentOfInertia(). Returns the angular accelerations in \(rad/s^2\) around each of the coordinate axes of the vessels reference frame (Vessel.getReferenceFrame()). These axes are equivalent to the pitch, roll and yaw axes of the vessel.

Game Scenes:: Flight

AxisRange getAvailableControlSurfaceAngularAcceleration()#

The maximum angular acceleration that the aerodynamic control surfaces can generate. This is Vessel.getAvailableControlSurfaceTorque() divided by the vessel’s Vessel.getMomentOfInertia(). Returns the angular accelerations in \(rad/s^2\) around each of the coordinate axes of the vessels reference frame (Vessel.getReferenceFrame()). These axes are equivalent to the pitch, roll and yaw axes of the vessel.

Game Scenes:: Flight

AxisRange getAvailableOtherAngularAcceleration()#

The maximum angular acceleration that parts (excluding reaction wheels, gimballed engines, RCS and control surfaces) can generate. This is Vessel.getAvailableOtherTorque() divided by the vessel’s Vessel.getMomentOfInertia(). Returns the angular accelerations in \(rad/s^2\) around each of the coordinate axes of the vessels reference frame (Vessel.getReferenceFrame()). These axes are equivalent to the pitch, roll and yaw axes of the vessel.

Game Scenes:: Flight

ReferenceFrame getReferenceFrame()#

The reference frame that is fixed relative to the vessel, and orientated with the vessel.

The origin is at the center of mass of the vessel.
The axes rotate with the vessel.
The x-axis points out to the right of the vessel.
The y-axis points in the forward direction of the vessel.
The z-axis points out of the bottom off the vessel.

Game Scenes:: Flight

../../../_images/vessel-aircraft.png — Vessel reference frame origin and axes for the Aeris 3A aircraft#

../../../_images/vessel-rocket.png — Vessel reference frame origin and axes for the Kerbal-X rocket#

ReferenceFrame getOrbitalReferenceFrame()#

The reference frame that is fixed relative to the vessel, and orientated with the vessels orbital prograde/normal/radial directions.

The origin is at the center of mass of the vessel.
The axes rotate with the orbital prograde/normal/radial directions.
The x-axis points in the orbital anti-radial direction.
The y-axis points in the orbital prograde direction.
The z-axis points in the orbital normal direction.

Game Scenes:: Flight

Note

Be careful not to confuse this with ‘orbit’ mode on the navball.

../../../_images/vessel-orbital.png — Vessel orbital reference frame origin and axes#

ReferenceFrame getSurfaceReferenceFrame()#

The reference frame that is fixed relative to the vessel, and orientated with the surface of the body being orbited.

The origin is at the center of mass of the vessel.
The axes rotate with the north and up directions on the surface of the body.
The x-axis points in the zenith direction (upwards, normal to the body being orbited, from the center of the body towards the center of mass of the vessel).
The y-axis points northwards towards the astronomical horizon (north, and tangential to the surface of the body – the direction in which a compass would point when on the surface).
The z-axis points eastwards towards the astronomical horizon (east, and tangential to the surface of the body – east on a compass when on the surface).

Game Scenes:: Flight

Note

Be careful not to confuse this with ‘surface’ mode on the navball.

../../../_images/vessel-surface.png — Vessel surface reference frame origin and axes#

ReferenceFrame getSurfaceVelocityReferenceFrame()#

The reference frame that is fixed relative to the vessel, and orientated with the velocity vector of the vessel relative to the surface of the body being orbited.

The origin is at the center of mass of the vessel.
The axes rotate with the vessel’s velocity vector.
The y-axis points in the direction of the vessel’s velocity vector, relative to the surface of the body being orbited.
The z-axis is in the plane of the astronomical horizon.
The x-axis is orthogonal to the other two axes.

Game Scenes:: Flight

../../../_images/vessel-surface-velocity.png — Vessel surface velocity reference frame origin and axes#

ReferenceFrame getOrbitSpeedReferenceFrame()#

The reference frame that the navball measures speed against in ‘orbit’ mode.

The origin is at the center of mass of the vessel.
The axes are those of Vessel.getOrbitalReferenceFrame(), which are the directions the navball marks in this mode: the x-axis points in the orbital anti-radial direction, the y-axis in the orbital prograde direction and the z-axis in the orbital normal direction.
The frame moves with the body being orbited, but does not rotate with it.

Game Scenes:: Flight

Note

The velocity of the vessel in this frame is the one the navball shows in ‘orbit’ mode: Flight.getSpeed() is the speed it displays, and Flight.getVelocity() points along the y-axis, towards its prograde marker.

ReferenceFrame getSurfaceSpeedReferenceFrame()#

The reference frame that the navball measures speed against in ‘surface’ mode.

The origin is at the center of mass of the vessel.
The axes are the directions the navball marks in this mode, in the same arrangement as Vessel.getOrbitalReferenceFrame(): the y-axis points in the direction the vessel is moving relative to the surface, which is where the prograde marker points; the z-axis is normal to the plane of that motion; and the x-axis is anti-radial, pointing towards the body and perpendicular to the other two.
The frame moves with the surface of the body being orbited, so it rotates with the body.

Game Scenes:: Flight

Note

The velocity of the vessel in this frame is the one the navball shows in ‘surface’ mode: Flight.getSpeed() is the speed it displays, and Flight.getVelocity() points along the y-axis, towards its prograde marker. The velocity gives the frame its orientation, so, as with Vessel.getSurfaceVelocityReferenceFrame(), the frame is singular and raises an error when the vessel is stationary relative to the surface.

ReferenceFrame getTargetSpeedReferenceFrame()#

The reference frame that the navball measures speed against in ‘target’ mode.

The origin is at the center of mass of the vessel.
The axes are the directions the navball marks in this mode, in the same arrangement as Vessel.getOrbitalReferenceFrame(): the y-axis points in the direction the vessel is moving relative to the target, which is where the prograde marker points; the z-axis is normal to the plane of that motion; and the x-axis is anti-radial, pointing towards the body being orbited and perpendicular to the other two.
The frame moves with the vessels target.

Game Scenes:: Flight

Note

The velocity of the vessel in this frame is the one the navball shows in ‘target’ mode: Flight.getSpeed() is the speed it displays, and Flight.getVelocity() points along the y-axis, towards its prograde marker. The target is the one set for the active vessel, via for example getTargetVessel() or getTargetBody(). This is undefined when no target is set. The velocity gives the frame its orientation, so it is also singular, and raises an error, when the vessel matches the velocity of its target.

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

The position of the center of mass of the vessel, in the given reference frame.

Parameters:

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

Returns:

The position as a vector.

Game Scenes:

Flight

BoundingBox boundingBox(ReferenceFrame referenceFrame)#

The axis-aligned bounding box of the vessel 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.

Game Scenes:

Flight

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

The velocity of the center of mass of the vessel, 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.

Game Scenes:

Flight

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

The rotation of the vessel, 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)\).

Game Scenes:

Flight

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

The direction in which the vessel is pointing, in the given reference frame.

Parameters:

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

Returns:

The direction as a unit vector.

Game Scenes:

Flight

org.javatuples.Triplet<Double, Double, Double> angularVelocity(ReferenceFrame referenceFrame)#

The angular velocity of the vessel, in the given reference frame.

Parameters:

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

Returns:

The angular velocity as a vector. The magnitude of the vector is the rotational speed of the vessel, in radians per second. The direction of the vector indicates the axis of rotation, using the right-hand rule.

Game Scenes:

Flight

public class AxisRange#

The largest value of a quantity, such as a torque or a force, in the positive and the negative direction of each of three axes.

public AxisRange(org.javatuples.Triplet<Double, Double, Double> positive, org.javatuples.Triplet<Double, Double, Double> negative)#: Construct a AxisRange from the values of its fields.

org.javatuples.Triplet<Double, Double, Double> getPositive()#: The value in the positive direction of each axis.

org.javatuples.Triplet<Double, Double, Double> getNegative()#: The value in the negative direction of each axis, which is zero or less.

public class BoundingBox#

An axis-aligned bounding box, as the positions of its minimum and maximum vertices.

public BoundingBox(org.javatuples.Triplet<Double, Double, Double> min, org.javatuples.Triplet<Double, Double, Double> max)#: Construct a BoundingBox from the values of its fields.

org.javatuples.Triplet<Double, Double, Double> getMin()#: The position of the minimum vertex of the box.

org.javatuples.Triplet<Double, Double, Double> getMax()#: The position of the maximum vertex of the box.

public enum VesselType#

The type of a vessel. See Vessel.getType().

public VesselType BASE#: Base.

public VesselType DEBRIS#: Debris.

public VesselType LANDER#: Lander.

public VesselType PLANE#: Plane.

public VesselType PROBE#: Probe.

public VesselType RELAY#: Relay.

public VesselType ROVER#: Rover.

public VesselType SHIP#: Ship.

public VesselType STATION#: Station.

public VesselType SPACE_OBJECT#: SpaceObject.

public VesselType UNKNOWN#: Unknown.

public VesselType EVA#: EVA.

public VesselType FLAG#: Flag.

public VesselType DEPLOYED_SCIENCE_CONTROLLER#: DeployedScienceController.

public VesselType DEPLOYED_SCIENCE_PART#: DeploedSciencePart.

public VesselType DROPPED_PART#: DroppedPart.

public VesselType DEPLOYED_GROUND_PART#: DeployedGroundPart.

public enum VesselSituation#

The situation a vessel is in. See Vessel.getSituation().

public VesselSituation DOCKED#: Vessel is docked to another.

public VesselSituation ESCAPING#: Escaping.

public VesselSituation FLYING#: Vessel is flying through an atmosphere.

public VesselSituation LANDED#: Vessel is landed on the surface of a body.

public VesselSituation ORBITING#: Vessel is orbiting a body.

public VesselSituation PRE_LAUNCH#: Vessel is awaiting launch.

public VesselSituation SPLASHED#: Vessel has splashed down in an ocean.

public VesselSituation SUB_ORBITAL#: Vessel is on a sub-orbital trajectory.

public class CrewMember#

Represents crew in a vessel. Can be obtained using Vessel.getCrew().

String getName()#

void setName(String value)#: The crew members name.

CrewMemberType getType()#: The type of crew member.

boolean getOnMission()#: Whether the crew member is on a mission.

float getCourage()#

void setCourage(float value)#: The crew members courage.

float getStupidity()#

void setStupidity(float value)#: The crew members stupidity.

float getExperience()#

void setExperience(float value)#: The crew members experience.

boolean getBadass()#

void setBadass(boolean value)#: Whether the crew member is a badass.

boolean getVeteran()#

void setVeteran(boolean value)#: Whether the crew member is a veteran.

String getTrait()#: The crew member’s job.

CrewMemberGender getGender()#: The crew member’s gender.

RosterStatus getRosterStatus()#: The crew member’s current roster status.

Part getPart()#

The part containing the crew member. Returns null if the crew member is not occupying a part, or the vessel containing the part is not loaded.

Game Scenes:: Flight

Vessel eVA()#

Send the crew member outside on EVA, through the hatch of the part it is in, and return the vessel it becomes. The game switches to that vessel, which can then be walked around and flown using its Vessel.getControl(), and brought back in with Control.board(). The kerbal climbs out onto the ladder by the hatch, if there is one.

Game Scenes:: Flight

Note

Throws an exception if EVA is disabled for the game, if the crew member is not in a loaded vessel, if it is already on EVA, or if every hatch out of the part it is in is obstructed.

SuitType getSuitType()#

void setSuitType(SuitType value)#: The crew member’s suit type.

java.util.List<FlightLogEntry> getCareerLog()#: The entries in the crew member’s career flight log.

public class FlightLogEntry#

An entry in a crew member’s career flight log.

Note

See CrewMember.getCareerLog().

public FlightLogEntry(int flight, String type, String target)#: Construct a FlightLogEntry from the values of its fields.

int getFlight()#: The flight identifier of the entry.

String getType()#: The type of the entry, e.g. Orbit or Land.

String getTarget()#: The name of the body the entry is for.

public enum CrewMemberType#

The type of a crew member. See CrewMember.getType().

public CrewMemberType APPLICANT#: An applicant for crew.

public CrewMemberType CREW#: Rocket crew.

public CrewMemberType TOURIST#: A tourist.

public CrewMemberType UNOWNED#: An unowned crew member.

public enum CrewMemberGender#

A crew member’s gender. See CrewMember.getGender().

public CrewMemberGender MALE#: Male.

public CrewMemberGender FEMALE#: Female.

public enum RosterStatus#

A crew member’s roster status. See CrewMember.getRosterStatus().

public RosterStatus AVAILABLE#: Available.

public RosterStatus ASSIGNED#: Assigned.

public RosterStatus DEAD#: Dead.

public RosterStatus MISSING#: Missing.

public enum SuitType#

A crew member’s suit type. See CrewMember.getSuitType().

public SuitType DEFAULT#: Default.

public SuitType VINTAGE#: Vintage.

public SuitType FUTURE#: Future.

public SuitType SLIM#: Slim.