.. default-domain:: py .. highlight:: py .. currentmodule:: SpaceCenter .. _python-api-editor: Editor ====== .. class:: Editor Provides access to the vehicle assembly building and space plane hangar. Obtained by calling :attr:`editor`. .. attribute:: facility The editor that is currently open. :Attribute: Read-only, cannot be set :rtype: :class:`EditorFacility` :Game Scenes: Editor Vab, Editor Sph .. attribute:: vessel The vessel that is being constructed. :Attribute: Read-only, cannot be set :rtype: :class:`EditorVessel` :Game Scenes: Editor Vab, Editor Sph .. note:: An editor that has not had a vessel loaded into it holds an empty vessel, with no parts, rather than nothing at all. .. method:: load_vessel(craft_directory, name) Load a vessel from a craft file into the editor, replacing the vessel that is currently being constructed. :param str craft_directory: Name of the directory in the current saves "Ships" directory, that contains the craft file. For example ``"VAB"`` or ``"SPH"``. :param str name: Name of the vessel to load. This is the name of the ".craft" file in the save directory, without the ".craft" file extension. :Game Scenes: Editor Vab, Editor Sph .. note:: The vessel is loaded into whichever editor is open, regardless of which directory it came from. Its delta-v figures are recalculated in the background afterwards; see :attr:`EditorVessel.delta_v_ready`. .. method:: launch_vessel(launch_site, [crew = None], [recover = True], [flag_url = '']) Launch the vessel that is being constructed, from the given launch site. :param str launch_site: Name of the launch site. For example ``"LaunchPad"`` or ``"Runway"``. :param list or None crew: The Kerbals to place in the vessel, by name. Controls how the vessel is crewed, as described in the remarks. :param bool recover: If true and there is a vessel on the launch site, recover it before launching. :param str flag_url: If not ``None``, the asset URL of the mission flag to use for the launch. :Game Scenes: Editor Vab, Editor Sph .. note:: The vessel being constructed is not a craft file, so it is written to the editor's auto-saved craft file and that is launched, as the game's own launch button does. The vessel's own craft file, if it was loaded from one, is left alone. The *crew* parameter works as it does for :meth:`launch_vessel`, and takes precedence over the crew assigned in the editor. Throws an exception if any of the games pre-flight checks fail. .. attribute:: delta_v_body The body whose gravity and atmosphere the vessel's delta-v, thrust, TWR and specific impulse figures assume. :Attribute: Can be read or written :rtype: :class:`CelestialBody` :Game Scenes: Editor Vab, Editor Sph .. note:: This and :attr:`Editor.delta_v_altitude` are what :attr:`EditorVessel.delta_v`, :attr:`Stage.delta_v` and the other current-situation figures are computed for. The body sets the gravity the thrust-to-weight ratios are against, and, with the altitude, the atmospheric pressure and density the specific impulses and thrusts are against. This is global game state rather than editor state: the same setting backs the game's delta-v readout in flight, and it persists across scene changes. Setting it asks the game to re-run the simulation and returns straight away; the figures are out of date until :attr:`EditorVessel.delta_v_ready` is true again. .. attribute:: delta_v_altitude The altitude above :attr:`Editor.delta_v_body`, in meters, that the vessel's delta-v, thrust, TWR and specific impulse figures assume. The atmospheric pressure and density at this altitude are what the figures are computed for, so raising it from zero to above the body's atmosphere moves them from the vessel's sea-level figures to its vacuum ones. Setting it asks the game to re-run the simulation and returns straight away; the figures are out of date until :attr:`EditorVessel.delta_v_ready` is true again. :Attribute: Can be read or written :rtype: float :Game Scenes: Editor Vab, Editor Sph .. attribute:: delta_v_situation Which situation the game's own delta-v readout shows figures for. :Attribute: Can be read or written :rtype: :class:`DeltaVSituation` :Game Scenes: Editor Vab, Editor Sph .. note:: This selects which column the game's own delta-v app displays, and nothing else. It does not affect anything kRPC reports: the current-situation figures follow :attr:`Editor.delta_v_body` and :attr:`Editor.delta_v_altitude` whatever this is set to, and the sea-level and vacuum figures are reported directly as :attr:`EditorVessel.sea_level_delta_v` and :attr:`EditorVessel.vacuum_delta_v`. It is here for completeness with the app. .. class:: DeltaVSituation The situation the game's own delta-v readout shows figures for. See :attr:`Editor.delta_v_situation`. .. data:: sea_level At sea level on the selected body. .. data:: altitude At the selected altitude on the selected body. .. data:: vacuum In vacuum. .. class:: EditorVessel The vessel that is being constructed in the editor. Obtained by calling :attr:`Editor.vessel`. .. attribute:: name The name of the vessel. :Attribute: Can be read or written :rtype: str :Game Scenes: Editor Vab, Editor Sph .. attribute:: description The description of the vessel. :Attribute: Can be read or written :rtype: str :Game Scenes: Editor Vab, Editor Sph .. attribute:: facility The editor the vessel is in. :Attribute: Read-only, cannot be set :rtype: :class:`EditorFacility` :Game Scenes: Editor Vab, Editor Sph .. note:: This is the editor the vessel is currently loaded into, not the one it was designed in. A vessel moved from the vehicle assembly building to the space plane hangar reports the space plane hangar. .. attribute:: mass The total mass of the vessel, including resources and crew, in kg. :Attribute: Read-only, cannot be set :rtype: float :Game Scenes: Editor Vab, Editor Sph .. attribute:: dry_mass The total mass of the vessel, excluding resources, in kg. :Attribute: Read-only, cannot be set :rtype: float :Game Scenes: Editor Vab, Editor Sph .. attribute:: moment_of_inertia The moment of inertia of the vessel around its center of mass in :math:`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 (:attr:`EditorVessel.reference_frame`). :Attribute: Read-only, cannot be set :rtype: tuple(float, float, float) :Game Scenes: Editor Vab, Editor Sph .. attribute:: inertia_tensor The inertia tensor of the vessel around its center of mass, in the vessels reference frame (:attr:`EditorVessel.reference_frame`). Returns the 3x3 matrix as a list of elements, in row-major order. :Attribute: Read-only, cannot be set :rtype: list(float) :Game Scenes: Editor Vab, Editor Sph .. attribute:: reference_frame 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. :Attribute: Read-only, cannot be set :rtype: :class:`ReferenceFrame` :Game Scenes: Editor Vab, Editor Sph .. note:: The axes are those of the root part. This is the frame :attr:`Vessel.reference_frame` gives at launch, with the root part as the control point. .. attribute:: surface_reference_frame The reference frame that is fixed relative to the vessel, and orientated with the vertical of the editor. * The origin is at the center of mass of the vessel. * The axes are fixed in the editor. * The x-axis points upwards. * The y-axis and z-axis are horizontal. :Attribute: Read-only, cannot be set :rtype: :class:`ReferenceFrame` :Game Scenes: Editor Vab, Editor Sph .. note:: This is the vessel as it stands in the editor, and as it stands at launch. The editor has no north or east, so the horizontal axes are fixed in the editor. .. method:: flight([reference_frame = None]) Returns a :class:`SimulatedFlight` object that can be used to simulate the vessel in flight, in the specified reference frame. :param ReferenceFrame or None reference_frame: Reference frame. Defaults to the simulated surface reference frame (:attr:`SimulatedFlight.surface_reference_frame`), and follows it when it is set. :rtype: :class:`SimulatedFlight` :Game Scenes: Editor Vab, Editor Sph .. note:: Each call returns a new object, which is kept until the game leaves the editor. .. method:: position(reference_frame) The position of the center of mass of the vessel, in the given reference frame. :param ReferenceFrame reference_frame: The reference frame that the returned position vector is in. :returns: The position as a vector. :rtype: tuple(float, float, float) :Game Scenes: Editor Vab, Editor Sph .. method:: bounding_box(reference_frame) The axis-aligned bounding box of the vessel in the given reference frame. :param ReferenceFrame reference_frame: The reference frame that the returned position vectors are in. :returns: The positions of the minimum and maximum vertices of the box. :rtype: :class:`BoundingBox` :Game Scenes: Editor Vab, Editor Sph .. method:: rotation(reference_frame) The rotation of the vessel, in the given reference frame. :param ReferenceFrame reference_frame: The reference frame that the returned rotation is in. :returns: The rotation as a quaternion of the form :math:`(x, y, z, w)`. :rtype: tuple(float, float, float, float) :Game Scenes: Editor Vab, Editor Sph .. method:: direction(reference_frame) The direction in which the vessel is pointing, in the given reference frame. :param ReferenceFrame reference_frame: The reference frame that the returned direction is in. :returns: The direction as a unit vector. :rtype: tuple(float, float, float) :Game Scenes: Editor Vab, Editor Sph .. attribute:: cost The total cost of the vessel, including resources, in funds. :Attribute: Read-only, cannot be set :rtype: float :Game Scenes: Editor Vab, Editor Sph .. attribute:: crew_capacity The total number of crew that the vessel can hold. :Attribute: Read-only, cannot be set :rtype: int :Game Scenes: Editor Vab, Editor Sph .. attribute:: parts A :class:`Parts` object, that can be used to interact with the parts that make up the vessel. :Attribute: Read-only, cannot be set :rtype: :class:`Parts` :Game Scenes: Editor Vab, Editor Sph .. note:: Only the parts of :class:`Part` that describe the design are available in the editor. Those that need a vessel in flight or running physics, such as the thermal members, are restricted to the flight scene. :meth:`Part.position`, :meth:`Part.center_of_mass`, :meth:`Part.direction`, :meth:`Part.rotation`, :meth:`Part.bounding_box`, the part's reference frames, :attr:`Part.moment_of_inertia` and :attr:`Part.inertia_tensor` are available. .. attribute:: resources A :attr:`EditorVessel.resources` object for the resources the vessel can hold. :Attribute: Read-only, cannot be set :rtype: :class:`Resources` :Game Scenes: Editor Vab, Editor Sph .. note:: This is a view of what the vessel can hold as designed. The flow-state members work, as they are part of the design, but nothing here reports how a resource would be drawn on in flight. .. attribute:: stages Activation (burn) stages for the vessel, in ascending stage order. This does not include the -1 stage (parts with no staging icon), as it carries no delta-v; use :meth:`EditorVessel.stage_at` with -1 to get those parts. :Attribute: Read-only, cannot be set :rtype: list(:class:`Stage`) :Game Scenes: Editor Vab, Editor Sph .. method:: stage_at(stage) The activation stage with the given number. Pass -1 to get the parts that are never activated (those with no staging icon). :param int stage: Get activation stage at this index. :rtype: :class:`Stage` :Game Scenes: Editor Vab, Editor Sph .. attribute:: decouple_stages Decouple stages for the 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. :Attribute: Read-only, cannot be set :rtype: list(:class:`Stage`) :Game Scenes: Editor Vab, Editor Sph .. method:: decouple_stage_at(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. :param int stage: Get decouple stage at this index. :rtype: :class:`Stage` :Game Scenes: Editor Vab, Editor Sph .. attribute:: delta_v_ready Whether the stock delta-v figures for the vessel have been calculated. :Attribute: Read-only, cannot be set :rtype: bool :Game Scenes: Editor Vab, Editor Sph .. note:: The game recalculates them in the background whenever the vessel changes, and whenever :attr:`Editor.delta_v_body` or :attr:`Editor.delta_v_altitude` is set, and they are out of date until it has finished. Reading :attr:`EditorVessel.delta_v`, or any delta-v member of a :class:`Stage`, before then raises an error rather than returning a stale figure. Poll this after changing anything the figures depend on. .. attribute:: delta_v Total delta-v for the vessel in the situation the game's delta-v readout assumes, in m/s. See :attr:`Editor.delta_v_body`. :Attribute: Read-only, cannot be set :rtype: float :Game Scenes: Editor Vab, Editor Sph .. attribute:: vacuum_delta_v Total vacuum delta-v for the vessel, in m/s. :Attribute: Read-only, cannot be set :rtype: float :Game Scenes: Editor Vab, Editor Sph .. attribute:: sea_level_delta_v Total sea-level delta-v for the vessel, in m/s. :Attribute: Read-only, cannot be set :rtype: float :Game Scenes: Editor Vab, Editor Sph .. attribute:: burn_time Total burn time for the vessel, in seconds. :Attribute: Read-only, cannot be set :rtype: float :Game Scenes: Editor Vab, Editor Sph .. class:: SimulatedFlight Used to simulate the vessel in the editor in flight. The counterpart of :class:`Flight`. All of the information returned by this class is given in the reference frame passed to :meth:`EditorVessel.flight`, or in :attr:`SimulatedFlight.surface_reference_frame` if none was passed. Obtained by calling :meth:`EditorVessel.flight`. .. note:: The simulated attitude is set by :attr:`SimulatedFlight.surface_reference_frame`, and belongs to this object. The vessel is read from the editor on each call, so the object follows every edit. .. attribute:: surface_reference_frame The reference frame of the surface the vessel is simulated over. Its x-axis points upwards, and gravity acts along the negative x-axis. Defaults to :attr:`EditorVessel.surface_reference_frame`. :Attribute: Can be read or written :rtype: :class:`ReferenceFrame` :Game Scenes: Editor Vab, Editor Sph .. note:: Only the rotation of the frame is used. A frame created relative to :attr:`EditorVessel.reference_frame` follows the vessel as it is edited. .. attribute:: center_of_mass The position of the center of mass of the vessel, in the reference frame :class:`ReferenceFrame` :Attribute: Read-only, cannot be set :returns: The position as a vector. :rtype: tuple(float, float, float) :Game Scenes: Editor Vab, Editor Sph .. attribute:: rotation The rotation of the vessel, in the reference frame :class:`ReferenceFrame` :Attribute: Read-only, cannot be set :returns: The rotation as a quaternion of the form :math:`(x, y, z, w)`. :rtype: tuple(float, float, float, float) :Game Scenes: Editor Vab, Editor Sph .. attribute:: direction The direction that the vessel is pointing in, in the reference frame :class:`ReferenceFrame`. :Attribute: Read-only, cannot be set :returns: The direction as a unit vector. :rtype: tuple(float, float, float) :Game Scenes: Editor Vab, Editor Sph .. attribute:: pitch The pitch of the vessel relative to the horizon, in degrees. A value between -90° and +90°. :Attribute: Read-only, cannot be set :rtype: float :Game Scenes: Editor Vab, Editor Sph .. note:: An absolute Euler angle, ill-conditioned when the vessel points near vertical (a pitch near -90° or +90°). For an always-defined attitude use :attr:`SimulatedFlight.rotation` or :attr:`SimulatedFlight.direction`. .. attribute:: roll The roll of the vessel relative to the horizon, in degrees. A value between -180° and +180°. :Attribute: Read-only, cannot be set :rtype: float :Game Scenes: Editor Vab, Editor Sph .. note:: An absolute Euler angle, ill-conditioned when the vessel points near vertical (a pitch near -90° or +90°). For an always-defined attitude use :attr:`SimulatedFlight.rotation`. .. attribute:: displacement The volume of water the vessel displaces when fully submerged, in :math:`m^3`. :Attribute: Read-only, cannot be set :rtype: float :Game Scenes: Editor Vab, Editor Sph .. attribute:: fully_submerged_center_of_buoyancy The point the buoyant force acts through with the vessel fully submerged, in reference frame :class:`ReferenceFrame`. Returns ``None`` if no part of the vessel displaces any water. :Attribute: Read-only, cannot be set :returns: The position as a vector. :rtype: tuple(float, float, float) or None :Game Scenes: Editor Vab, Editor Sph .. note:: A hull at rest carries this on the same vertical line as :attr:`SimulatedFlight.center_of_mass`. .. method:: buoyant_force_at(density, gravity) The buoyant force on the vessel when fully submerged in a fluid of the given density, in Newtons. :param float density: The density of the fluid, in :math:`kg/m^3`. :param float gravity: The acceleration due to gravity, in :math:`m/s^2`. :rtype: float :Game Scenes: Editor Vab, Editor Sph .. method:: buoyant_torque_at(density, gravity) The torque the buoyant force exerts about the vessel's center of mass when fully submerged in a fluid of the given density, in reference frame :class:`ReferenceFrame`. Gravity acts along the negative x-axis of :attr:`SimulatedFlight.surface_reference_frame`. :param float density: The density of the fluid, in :math:`kg/m^3`. :param float gravity: The acceleration due to gravity, in :math:`m/s^2`. :returns: A vector pointing along the axis of the torque, with its magnitude equal to the strength of the torque in newton-meters. :rtype: tuple(float, float, float) :Game Scenes: Editor Vab, Editor Sph