.. default-domain:: lua .. highlight:: lua .. currentmodule:: MechJeb ManeuverPlanner =============== .. class:: ManeuverPlanner .. attribute:: operation_apoapsis: MechJeb.OperationApoapsis :Attribute: Read-only, cannot be set :rtype: :class:`MechJeb.OperationApoapsis` .. attribute:: operation_circularize: MechJeb.OperationCircularize :Attribute: Read-only, cannot be set :rtype: :class:`MechJeb.OperationCircularize` .. attribute:: operation_course_correction: MechJeb.OperationCourseCorrection :Attribute: Read-only, cannot be set :rtype: :class:`MechJeb.OperationCourseCorrection` .. attribute:: operation_ellipticize: MechJeb.OperationEllipticize :Attribute: Read-only, cannot be set :rtype: :class:`MechJeb.OperationEllipticize` .. attribute:: operation_inclination: MechJeb.OperationInclination :Attribute: Read-only, cannot be set :rtype: :class:`MechJeb.OperationInclination` .. attribute:: operation_interplanetary_transfer: MechJeb.OperationInterplanetaryTransfer :Attribute: Read-only, cannot be set :rtype: :class:`MechJeb.OperationInterplanetaryTransfer` .. attribute:: operation_kill_rel_vel: MechJeb.OperationKillRelVel :Attribute: Read-only, cannot be set :rtype: :class:`MechJeb.OperationKillRelVel` .. attribute:: operation_lambert: MechJeb.OperationLambert :Attribute: Read-only, cannot be set :rtype: :class:`MechJeb.OperationLambert` .. attribute:: operation_lan: MechJeb.OperationLan :Attribute: Read-only, cannot be set :rtype: :class:`MechJeb.OperationLan` .. attribute:: operation_longitude: MechJeb.OperationLongitude :Attribute: Read-only, cannot be set :rtype: :class:`MechJeb.OperationLongitude` .. attribute:: operation_moon_return: MechJeb.OperationMoonReturn :Attribute: Read-only, cannot be set :rtype: :class:`MechJeb.OperationMoonReturn` .. attribute:: operation_periapsis: MechJeb.OperationPeriapsis :Attribute: Read-only, cannot be set :rtype: :class:`MechJeb.OperationPeriapsis` .. attribute:: operation_plane: MechJeb.OperationPlane :Attribute: Read-only, cannot be set :rtype: :class:`MechJeb.OperationPlane` .. attribute:: operation_resonant_orbit: MechJeb.OperationResonantOrbit :Attribute: Read-only, cannot be set :rtype: :class:`MechJeb.OperationResonantOrbit` .. attribute:: operation_semi_major: MechJeb.OperationSemiMajor :Attribute: Read-only, cannot be set :rtype: :class:`MechJeb.OperationSemiMajor` .. attribute:: operation_transfer: MechJeb.OperationTransfer :Attribute: Read-only, cannot be set :rtype: :class:`MechJeb.OperationTransfer` .. class:: OperationException This exception is thrown when there is something wrong with the operation (e.g. the target is not set when the operation needs it). TimeSelector ------------ .. class:: TimeSelector .. attribute:: circularize_altitude: number To be used with :attr:`MechJeb.TimeReference.altitude`. :Attribute: Can be read or written :rtype: number .. attribute:: lead_time: number To be used with :attr:`MechJeb.TimeReference.x_from_now`. :Attribute: Can be read or written :rtype: number .. attribute:: time_reference: MechJeb.TimeReference :Attribute: Can be read or written :rtype: :class:`MechJeb.TimeReference` .. class:: TimeReference .. data:: altitude At the selected :attr:`MechJeb.TimeSelector.circularize_altitude`. .. data:: apoapsis At the next apoapsis. .. data:: closest_approach At the closest approach to the target. .. data:: computed At the optimum time. .. data:: eq_ascending At the equatorial ascending node. .. data:: eq_descending At the equatorial descending node. .. data:: eq_highest_ad At the cheapest equatorial AN/DN. .. data:: eq_nearest_ad At the nearest equatorial AN/DN. .. data:: periapsis At the next periapsis. .. data:: rel_ascending At the next ascending node with the target. .. data:: rel_descending At the next descending node with the target. .. data:: rel_highest_ad At the cheapest AN/DN with the target. .. data:: rel_nearest_ad At the nearest AN/DN with the target. .. data:: x_from_now After a fixed :attr:`MechJeb.TimeSelector.lead_time`. Operations ---------- OperationApoapsis ^^^^^^^^^^^^^^^^^ .. class:: OperationApoapsis Create a maneuver to set a new apoapsis .. attribute:: error_message: string A warning may be stored there during MakeNode() call. :Attribute: Read-only, cannot be set :rtype: string .. method:: make_node() Execute the operation and create appropriate maneuver nodes. A warning may be stored in ErrorMessage during this process; so it may be useful to check its value. OperationException is thrown when there is something wrong with the operation. MJServiceException - Internal service error. :returns: The first maneuver node necessary to perform this operation. :rtype: :class:`SpaceCenter.Node` .. note:: This method is deprecated, use MakeNodes instead. .. method:: make_nodes() Execute the operation and create appropriate maneuver nodes. A warning may be stored in ErrorMessage during this process; so it may be useful to check its value. OperationException is thrown when there is something wrong with the operation. MJServiceException - Internal service error. :returns: A list of maneuver nodes necessary to perform this operation :rtype: List .. attribute:: new_apoapsis: number :Attribute: Can be read or written :rtype: number .. attribute:: time_selector: MechJeb.TimeSelector :Attribute: Read-only, cannot be set :rtype: :class:`MechJeb.TimeSelector` OperationCircularize ^^^^^^^^^^^^^^^^^^^^ .. class:: OperationCircularize This mode creates a manevuer to match your apoapsis to periapsis. To match apoapsis to periapsis, set the time to :attr:`MechJeb.TimeReference.periapsis`; to match periapsis to apoapsis, set the time to :attr:`MechJeb.TimeReference.apoapsis`. These are the most efficient, but it can also create node at specific height or after specific time. .. attribute:: error_message: string A warning may be stored there during MakeNode() call. :Attribute: Read-only, cannot be set :rtype: string .. method:: make_node() Execute the operation and create appropriate maneuver nodes. A warning may be stored in ErrorMessage during this process; so it may be useful to check its value. OperationException is thrown when there is something wrong with the operation. MJServiceException - Internal service error. :returns: The first maneuver node necessary to perform this operation. :rtype: :class:`SpaceCenter.Node` .. note:: This method is deprecated, use MakeNodes instead. .. method:: make_nodes() Execute the operation and create appropriate maneuver nodes. A warning may be stored in ErrorMessage during this process; so it may be useful to check its value. OperationException is thrown when there is something wrong with the operation. MJServiceException - Internal service error. :returns: A list of maneuver nodes necessary to perform this operation :rtype: List .. attribute:: time_selector: MechJeb.TimeSelector :Attribute: Read-only, cannot be set :rtype: :class:`MechJeb.TimeSelector` OperationCourseCorrection ^^^^^^^^^^^^^^^^^^^^^^^^^ .. class:: OperationCourseCorrection Create a maneuver to fine-tune closest approach to target .. attribute:: course_correct_final_pe_a: number :Attribute: Can be read or written :rtype: number .. attribute:: error_message: string A warning may be stored there during MakeNode() call. :Attribute: Read-only, cannot be set :rtype: string .. attribute:: intercept_distance: number :Attribute: Can be read or written :rtype: number .. method:: make_node() Execute the operation and create appropriate maneuver nodes. A warning may be stored in ErrorMessage during this process; so it may be useful to check its value. OperationException is thrown when there is something wrong with the operation. MJServiceException - Internal service error. :returns: The first maneuver node necessary to perform this operation. :rtype: :class:`SpaceCenter.Node` .. note:: This method is deprecated, use MakeNodes instead. .. method:: make_nodes() Execute the operation and create appropriate maneuver nodes. A warning may be stored in ErrorMessage during this process; so it may be useful to check its value. OperationException is thrown when there is something wrong with the operation. MJServiceException - Internal service error. :returns: A list of maneuver nodes necessary to perform this operation :rtype: List OperationEllipticize ^^^^^^^^^^^^^^^^^^^^ .. class:: OperationEllipticize Create a maneuver to change both periapsis and apoapsis .. attribute:: error_message: string A warning may be stored there during MakeNode() call. :Attribute: Read-only, cannot be set :rtype: string .. method:: make_node() Execute the operation and create appropriate maneuver nodes. A warning may be stored in ErrorMessage during this process; so it may be useful to check its value. OperationException is thrown when there is something wrong with the operation. MJServiceException - Internal service error. :returns: The first maneuver node necessary to perform this operation. :rtype: :class:`SpaceCenter.Node` .. note:: This method is deprecated, use MakeNodes instead. .. method:: make_nodes() Execute the operation and create appropriate maneuver nodes. A warning may be stored in ErrorMessage during this process; so it may be useful to check its value. OperationException is thrown when there is something wrong with the operation. MJServiceException - Internal service error. :returns: A list of maneuver nodes necessary to perform this operation :rtype: List .. attribute:: new_apoapsis: number :Attribute: Can be read or written :rtype: number .. attribute:: new_periapsis: number :Attribute: Can be read or written :rtype: number .. attribute:: time_selector: MechJeb.TimeSelector :Attribute: Read-only, cannot be set :rtype: :class:`MechJeb.TimeSelector` OperationInclination ^^^^^^^^^^^^^^^^^^^^ .. class:: OperationInclination Create a maneuver to change inclination .. attribute:: error_message: string A warning may be stored there during MakeNode() call. :Attribute: Read-only, cannot be set :rtype: string .. method:: make_node() Execute the operation and create appropriate maneuver nodes. A warning may be stored in ErrorMessage during this process; so it may be useful to check its value. OperationException is thrown when there is something wrong with the operation. MJServiceException - Internal service error. :returns: The first maneuver node necessary to perform this operation. :rtype: :class:`SpaceCenter.Node` .. note:: This method is deprecated, use MakeNodes instead. .. method:: make_nodes() Execute the operation and create appropriate maneuver nodes. A warning may be stored in ErrorMessage during this process; so it may be useful to check its value. OperationException is thrown when there is something wrong with the operation. MJServiceException - Internal service error. :returns: A list of maneuver nodes necessary to perform this operation :rtype: List .. attribute:: new_inclination: number :Attribute: Can be read or written :rtype: number .. attribute:: time_selector: MechJeb.TimeSelector :Attribute: Read-only, cannot be set :rtype: :class:`MechJeb.TimeSelector` OperationInterplanetaryTransfer ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. class:: OperationInterplanetaryTransfer Create a maneuver to transfer to another planet .. attribute:: error_message: string A warning may be stored there during MakeNode() call. :Attribute: Read-only, cannot be set :rtype: string .. method:: make_node() Execute the operation and create appropriate maneuver nodes. A warning may be stored in ErrorMessage during this process; so it may be useful to check its value. OperationException is thrown when there is something wrong with the operation. MJServiceException - Internal service error. :returns: The first maneuver node necessary to perform this operation. :rtype: :class:`SpaceCenter.Node` .. note:: This method is deprecated, use MakeNodes instead. .. method:: make_nodes() Execute the operation and create appropriate maneuver nodes. A warning may be stored in ErrorMessage during this process; so it may be useful to check its value. OperationException is thrown when there is something wrong with the operation. MJServiceException - Internal service error. :returns: A list of maneuver nodes necessary to perform this operation :rtype: List .. attribute:: wait_for_phase_angle: boolean :Attribute: Can be read or written :rtype: boolean OperationKillRelVel ^^^^^^^^^^^^^^^^^^^ .. class:: OperationKillRelVel Match velocities with target .. attribute:: error_message: string A warning may be stored there during MakeNode() call. :Attribute: Read-only, cannot be set :rtype: string .. method:: make_node() Execute the operation and create appropriate maneuver nodes. A warning may be stored in ErrorMessage during this process; so it may be useful to check its value. OperationException is thrown when there is something wrong with the operation. MJServiceException - Internal service error. :returns: The first maneuver node necessary to perform this operation. :rtype: :class:`SpaceCenter.Node` .. note:: This method is deprecated, use MakeNodes instead. .. method:: make_nodes() Execute the operation and create appropriate maneuver nodes. A warning may be stored in ErrorMessage during this process; so it may be useful to check its value. OperationException is thrown when there is something wrong with the operation. MJServiceException - Internal service error. :returns: A list of maneuver nodes necessary to perform this operation :rtype: List .. attribute:: time_selector: MechJeb.TimeSelector :Attribute: Read-only, cannot be set :rtype: :class:`MechJeb.TimeSelector` OperationLambert ^^^^^^^^^^^^^^^^ .. class:: OperationLambert Create a maneuver to set the chosen time .. attribute:: error_message: string A warning may be stored there during MakeNode() call. :Attribute: Read-only, cannot be set :rtype: string .. attribute:: intercept_interval: number :Attribute: Can be read or written :rtype: number .. method:: make_node() Execute the operation and create appropriate maneuver nodes. A warning may be stored in ErrorMessage during this process; so it may be useful to check its value. OperationException is thrown when there is something wrong with the operation. MJServiceException - Internal service error. :returns: The first maneuver node necessary to perform this operation. :rtype: :class:`SpaceCenter.Node` .. note:: This method is deprecated, use MakeNodes instead. .. method:: make_nodes() Execute the operation and create appropriate maneuver nodes. A warning may be stored in ErrorMessage during this process; so it may be useful to check its value. OperationException is thrown when there is something wrong with the operation. MJServiceException - Internal service error. :returns: A list of maneuver nodes necessary to perform this operation :rtype: List .. attribute:: time_selector: MechJeb.TimeSelector :Attribute: Read-only, cannot be set :rtype: :class:`MechJeb.TimeSelector` OperationLan ^^^^^^^^^^^^ .. class:: OperationLan Change longitude of ascending node .. attribute:: error_message: string A warning may be stored there during MakeNode() call. :Attribute: Read-only, cannot be set :rtype: string .. method:: make_node() Execute the operation and create appropriate maneuver nodes. A warning may be stored in ErrorMessage during this process; so it may be useful to check its value. OperationException is thrown when there is something wrong with the operation. MJServiceException - Internal service error. :returns: The first maneuver node necessary to perform this operation. :rtype: :class:`SpaceCenter.Node` .. note:: This method is deprecated, use MakeNodes instead. .. method:: make_nodes() Execute the operation and create appropriate maneuver nodes. A warning may be stored in ErrorMessage during this process; so it may be useful to check its value. OperationException is thrown when there is something wrong with the operation. MJServiceException - Internal service error. :returns: A list of maneuver nodes necessary to perform this operation :rtype: List .. attribute:: new_lan: number :Attribute: Can be read or written :rtype: number .. attribute:: time_selector: MechJeb.TimeSelector :Attribute: Read-only, cannot be set :rtype: :class:`MechJeb.TimeSelector` OperationLongitude ^^^^^^^^^^^^^^^^^^ .. class:: OperationLongitude Change surface longitude of apsis .. attribute:: error_message: string A warning may be stored there during MakeNode() call. :Attribute: Read-only, cannot be set :rtype: string .. method:: make_node() Execute the operation and create appropriate maneuver nodes. A warning may be stored in ErrorMessage during this process; so it may be useful to check its value. OperationException is thrown when there is something wrong with the operation. MJServiceException - Internal service error. :returns: The first maneuver node necessary to perform this operation. :rtype: :class:`SpaceCenter.Node` .. note:: This method is deprecated, use MakeNodes instead. .. method:: make_nodes() Execute the operation and create appropriate maneuver nodes. A warning may be stored in ErrorMessage during this process; so it may be useful to check its value. OperationException is thrown when there is something wrong with the operation. MJServiceException - Internal service error. :returns: A list of maneuver nodes necessary to perform this operation :rtype: List .. attribute:: new_surface_longitude: number :Attribute: Can be read or written :rtype: number .. attribute:: time_selector: MechJeb.TimeSelector :Attribute: Read-only, cannot be set :rtype: :class:`MechJeb.TimeSelector` OperationMoonReturn ^^^^^^^^^^^^^^^^^^^ .. class:: OperationMoonReturn Create a maneuver to return from a moon approximately at the specified altitude .. attribute:: error_message: string A warning may be stored there during MakeNode() call. :Attribute: Read-only, cannot be set :rtype: string .. method:: make_node() Execute the operation and create appropriate maneuver nodes. A warning may be stored in ErrorMessage during this process; so it may be useful to check its value. OperationException is thrown when there is something wrong with the operation. MJServiceException - Internal service error. :returns: The first maneuver node necessary to perform this operation. :rtype: :class:`SpaceCenter.Node` .. note:: This method is deprecated, use MakeNodes instead. .. method:: make_nodes() Execute the operation and create appropriate maneuver nodes. A warning may be stored in ErrorMessage during this process; so it may be useful to check its value. OperationException is thrown when there is something wrong with the operation. MJServiceException - Internal service error. :returns: A list of maneuver nodes necessary to perform this operation :rtype: List .. attribute:: moon_return_altitude: number Approximate return altitude from a moon (from an orbiting body to the parent body). :Attribute: Can be read or written :rtype: number OperationPeriapsis ^^^^^^^^^^^^^^^^^^ .. class:: OperationPeriapsis Create a maneuver to set a new periapsis .. attribute:: error_message: string A warning may be stored there during MakeNode() call. :Attribute: Read-only, cannot be set :rtype: string .. method:: make_node() Execute the operation and create appropriate maneuver nodes. A warning may be stored in ErrorMessage during this process; so it may be useful to check its value. OperationException is thrown when there is something wrong with the operation. MJServiceException - Internal service error. :returns: The first maneuver node necessary to perform this operation. :rtype: :class:`SpaceCenter.Node` .. note:: This method is deprecated, use MakeNodes instead. .. method:: make_nodes() Execute the operation and create appropriate maneuver nodes. A warning may be stored in ErrorMessage during this process; so it may be useful to check its value. OperationException is thrown when there is something wrong with the operation. MJServiceException - Internal service error. :returns: A list of maneuver nodes necessary to perform this operation :rtype: List .. attribute:: new_periapsis: number :Attribute: Can be read or written :rtype: number .. attribute:: time_selector: MechJeb.TimeSelector :Attribute: Read-only, cannot be set :rtype: :class:`MechJeb.TimeSelector` OperationPlane ^^^^^^^^^^^^^^ .. class:: OperationPlane Create a maneuver to match planes with target .. attribute:: error_message: string A warning may be stored there during MakeNode() call. :Attribute: Read-only, cannot be set :rtype: string .. method:: make_node() Execute the operation and create appropriate maneuver nodes. A warning may be stored in ErrorMessage during this process; so it may be useful to check its value. OperationException is thrown when there is something wrong with the operation. MJServiceException - Internal service error. :returns: The first maneuver node necessary to perform this operation. :rtype: :class:`SpaceCenter.Node` .. note:: This method is deprecated, use MakeNodes instead. .. method:: make_nodes() Execute the operation and create appropriate maneuver nodes. A warning may be stored in ErrorMessage during this process; so it may be useful to check its value. OperationException is thrown when there is something wrong with the operation. MJServiceException - Internal service error. :returns: A list of maneuver nodes necessary to perform this operation :rtype: List .. attribute:: time_selector: MechJeb.TimeSelector :Attribute: Read-only, cannot be set :rtype: :class:`MechJeb.TimeSelector` OperationResonantOrbit ^^^^^^^^^^^^^^^^^^^^^^ .. class:: OperationResonantOrbit Resonant orbit is useful for placing satellites to a constellation. This mode should be used starting from a orbit in the desired orbital plane. Important parameter to this mode is the desired orbital ratio, which is the ratio between period of your current orbit and the new orbit. To deploy satellites, set the denominator to number of satellites you want to have in the constellation. Setting the nominator to one less than denominator is the most efficient, but not necessary the fastest. To successfully deploy all satellites, make sure the numbers are incommensurable. .. attribute:: error_message: string A warning may be stored there during MakeNode() call. :Attribute: Read-only, cannot be set :rtype: string .. method:: make_node() Execute the operation and create appropriate maneuver nodes. A warning may be stored in ErrorMessage during this process; so it may be useful to check its value. OperationException is thrown when there is something wrong with the operation. MJServiceException - Internal service error. :returns: The first maneuver node necessary to perform this operation. :rtype: :class:`SpaceCenter.Node` .. note:: This method is deprecated, use MakeNodes instead. .. method:: make_nodes() Execute the operation and create appropriate maneuver nodes. A warning may be stored in ErrorMessage during this process; so it may be useful to check its value. OperationException is thrown when there is something wrong with the operation. MJServiceException - Internal service error. :returns: A list of maneuver nodes necessary to perform this operation :rtype: List .. attribute:: resonance_denominator: number :Attribute: Can be read or written :rtype: number .. attribute:: resonance_numerator: number :Attribute: Can be read or written :rtype: number .. attribute:: time_selector: MechJeb.TimeSelector :Attribute: Read-only, cannot be set :rtype: :class:`MechJeb.TimeSelector` OperationSemiMajor ^^^^^^^^^^^^^^^^^^ .. class:: OperationSemiMajor Create a maneuver to set a new semi-major axis .. attribute:: error_message: string A warning may be stored there during MakeNode() call. :Attribute: Read-only, cannot be set :rtype: string .. method:: make_node() Execute the operation and create appropriate maneuver nodes. A warning may be stored in ErrorMessage during this process; so it may be useful to check its value. OperationException is thrown when there is something wrong with the operation. MJServiceException - Internal service error. :returns: The first maneuver node necessary to perform this operation. :rtype: :class:`SpaceCenter.Node` .. note:: This method is deprecated, use MakeNodes instead. .. method:: make_nodes() Execute the operation and create appropriate maneuver nodes. A warning may be stored in ErrorMessage during this process; so it may be useful to check its value. OperationException is thrown when there is something wrong with the operation. MJServiceException - Internal service error. :returns: A list of maneuver nodes necessary to perform this operation :rtype: List .. attribute:: new_semi_major_axis: number :Attribute: Can be read or written :rtype: number .. attribute:: time_selector: MechJeb.TimeSelector :Attribute: Read-only, cannot be set :rtype: :class:`MechJeb.TimeSelector` OperationTransfer ^^^^^^^^^^^^^^^^^ .. class:: OperationTransfer Bi-impulsive (Hohmann) transfer to target. This option is used to plan transfer to target in single sphere of influence. It is suitable for rendezvous with other vessels or moons. Contrary to the name, the transfer is often uni-impulsive. You can select when you want the manevuer to happen or select optimum time. .. attribute:: error_message: string A warning may be stored there during MakeNode() call. :Attribute: Read-only, cannot be set :rtype: string .. method:: make_node() Execute the operation and create appropriate maneuver nodes. A warning may be stored in ErrorMessage during this process; so it may be useful to check its value. OperationException is thrown when there is something wrong with the operation. MJServiceException - Internal service error. :returns: The first maneuver node necessary to perform this operation. :rtype: :class:`SpaceCenter.Node` .. note:: This method is deprecated, use MakeNodes instead. .. method:: make_nodes() Execute the operation and create appropriate maneuver nodes. A warning may be stored in ErrorMessage during this process; so it may be useful to check its value. OperationException is thrown when there is something wrong with the operation. MJServiceException - Internal service error. :returns: A list of maneuver nodes necessary to perform this operation :rtype: List .. attribute:: intercept_only: boolean Intercept only, no capture burn (impact/flyby) :Attribute: Can be read or written :rtype: boolean .. attribute:: period_offset: number Fractional target period offset :Attribute: Can be read or written :rtype: number .. attribute:: simple_transfer: boolean Simple coplanar Hohmann transfer. Set it to true if you are used to the old version of transfer maneuver. :Attribute: Can be read or written :rtype: boolean .. note:: If set to true, TimeSelector property is ignored. .. attribute:: time_selector: MechJeb.TimeSelector :Attribute: Read-only, cannot be set :rtype: :class:`MechJeb.TimeSelector`