space_ex v0.4.0 SpaceEx.SpaceCenter.Engine

An engine, including ones of various types.

For example liquid fuelled gimballed engines, solid rocket boosters and jet engines. Obtained by calling SpaceEx.SpaceCenter.Part.engine/2.

For RCS thrusters SpaceEx.SpaceCenter.Part.rcs/2.

Link to this section Summary

Functions

Whether the engine is active

Whether the engine will automatically switch modes

The amount of thrust, in Newtons, that would be produced by the engine when activated and with its throttle set to 100%

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

Whether the engine can be restarted once shutdown

Whether the engine can be shutdown once activated

The gimbal limiter of the engine

Whether the engines gimbal is locked in place

The range over which the gimbal can move, in degrees

Whether the engine is gimballed

Whether the engine has any fuel available

Whether the engine has multiple modes of operation

The specific impulse of the engine at sea level on Kerbin, in seconds

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%

The maximum amount of thrust that can be produced by the engine in a vacuum, in Newtons

The name of the current engine mode

The available modes for the engine

The part object for this engine

The names of the propellants that the engine consumes

The ratio of resources that the engine consumes

The propellants that the engine consumes

Whether the engine is active

Whether the engine will automatically switch modes

The gimbal limiter of the engine

Whether the engines gimbal is locked in place

The name of the current engine mode

The thrust limiter of the engine

The current specific impulse of the engine, in seconds

The current throttle setting for the engine

The current amount of thrust being produced by the engine, in Newtons

The thrust limiter of the engine

The components of the engine that generate thrust

Toggle the current engine mode

The vacuum specific impulse of the engine, in seconds

Link to this section Functions

Link to this function active(conn, this)

Whether the engine is active.

Setting this attribute may have no effect, depending on SpaceEx.SpaceCenter.Engine.can_shutdown/2 and SpaceEx.SpaceCenter.Engine.can_restart/2.

Link to this function auto_mode_switch(conn, this)

Whether the engine will automatically switch modes.

Link to this function available_thrust(conn, this)

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 SpaceEx.SpaceCenter.Engine.thrust_limit/2 and atmospheric conditions into account.

Link to this function available_torque(conn, this)

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 SpaceEx.SpaceCenter.Vessel.reference_frame/2. Returns zero if the engine is inactive, or not gimballed.

Link to this function can_restart(conn, this)

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.

Link to this function can_shutdown(conn, this)

Whether the engine can be shutdown once activated.

For example, this is true for liquid fueled rockets and false for solid rocket boosters.

Link to this function gimbal_limit(conn, this)

The gimbal limiter of the engine.

A value between 0 and 1. Returns 0 if the gimbal is locked.

Link to this function gimbal_locked(conn, this)

Whether the engines gimbal is locked in place.

Setting this attribute has no effect if the engine is not gimballed.

Link to this function gimbal_range(conn, this)

The range over which the gimbal can move, in degrees.

Returns 0 if the engine is not gimballed.

Link to this function gimballed(conn, this)

Whether the engine is gimballed.

Link to this function has_fuel(conn, this)

Whether the engine has any fuel available.

The engine must be activated for this property to update correctly.

Link to this function has_modes(conn, this)

Whether the engine has multiple modes of operation.

Link to this function kerbin_sea_level_specific_impulse(conn, this)

The specific impulse of the engine at sea level on Kerbin, in seconds.

Link to this function max_thrust(conn, this)

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%.

Link to this function max_vacuum_thrust(conn, this)

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, SpaceEx.SpaceCenter.Engine.thrust_limit/2 is set to 100%, the main vessel's throttle is set to 100% and the engine is in a vacuum.

Link to this function mode(conn, this)

The name of the current engine mode.

Link to this function modes(conn, this)

The available modes for the engine.

A dictionary mapping mode names to SpaceEx.SpaceCenter.Engine objects.

Link to this function part(conn, this)

The part object for this engine.

Link to this function propellant_names(conn, this)

The names of the propellants that the engine consumes.

Link to this function propellant_ratios(conn, this)

The ratio of resources that the engine consumes.

A dictionary mapping resource names to the ratio at which they are consumed by the engine.

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.

Link to this function propellants(conn, this)

The propellants that the engine consumes.

Link to this function set_active(conn, this, value)

Whether the engine is active.

Setting this attribute may have no effect, depending on SpaceEx.SpaceCenter.Engine.can_shutdown/2 and SpaceEx.SpaceCenter.Engine.can_restart/2.

Link to this function set_auto_mode_switch(conn, this, value)

Whether the engine will automatically switch modes.

Link to this function set_gimbal_limit(conn, this, value)

The gimbal limiter of the engine.

A value between 0 and 1. Returns 0 if the gimbal is locked.

Link to this function set_gimbal_locked(conn, this, value)

Whether the engines gimbal is locked in place.

Setting this attribute has no effect if the engine is not gimballed.

Link to this function set_mode(conn, this, value)

The name of the current engine mode.

Link to this function set_thrust_limit(conn, this, 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.

Link to this function specific_impulse(conn, this)

The current specific impulse of the engine, in seconds.

Returns zero if the engine is not active.

Link to this function throttle(conn, this)

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).

Link to this function throttle_locked(conn, this)

Whether the SpaceEx.SpaceCenter.Control.throttle/2 affects the engine.

For example, this is true for liquid fueled rockets, and false for solid rocket boosters.

Link to this function thrust(conn, this)

The current amount of thrust being produced by the engine, in Newtons.

Link to this function thrust_limit(conn, this)

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.

Link to this function thrusters(conn, this)

The components of the engine that generate thrust.

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 SpaceEx.SpaceCenter.Engine.available_thrust/2, SpaceEx.SpaceCenter.Engine.max_thrust/2 and others, is the sum of the thrust generated by each thruster.

Link to this function toggle_mode(conn, this)

Toggle the current engine mode.

Link to this function vacuum_specific_impulse(conn, this)

The vacuum specific impulse of the engine, in seconds.