KSP API
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties
Public Member Functions | Public Attributes | Properties | List of all members
FlightCtrlState Class Reference

A FlightCtrlState is a snapshot of the state of all control inputs to a vessel at a given instant in time. See FlightInputHandler.state and Vessel.OnFlyByWire. More...

Public Member Functions

 FlightCtrlState ()
 
void CopyFrom (FlightCtrlState st)
 Presumably, copies the state of the FlightCtrlState st into this FlightCtrlState object. More...
 

Public Attributes

float fastThrottle
 Unused? More...
 
bool gearDown
 Unused? Landing gear are lowered by sending an Event. More...
 
bool gearUp
 Unused? Landing gear are raised by sending an Event. More...
 
bool headlight
 Presumably, whether the EVA headlight is turned on. More...
 
bool killRot
 Whether SAS is turned on. More...
 
float mainThrottle
 The throttle setting; this must be between 0 and 1. More...
 
float pitch
 The pitch control input; this must be between -1 and 1. More...
 
float pitchTrim
 Presumably, the pitch trim setting, i.e., the pitch input that will be given if no other input is given. More...
 
float roll
 The roll control input; this must be between -1 and 1. More...
 
float rollTrim
 Presumably, the roll trim setting, i.e., the roll input that will be given if no other input is given. More...
 
float X
 The RCS x-axis control input. More...
 
float Y
 The RCS y-axis control input. More...
 
float yaw
 The yaw control input; this must be between -1 and 1. More...
 
float yawTrim
 Presumably, the yaw trim input; i.e., the yaw input that will be given if no other input is given. More...
 
float Z
 The RCS z-axis control input. More...
 

Properties

bool isNeutral [get]
 Presumably, whether this flight control represents "neutral" controls, i.e., no input and zero throttle. More...
 

Detailed Description

A FlightCtrlState is a snapshot of the state of all control inputs to a vessel at a given instant in time. See FlightInputHandler.state and Vessel.OnFlyByWire.

Constructor & Destructor Documentation

FlightCtrlState.FlightCtrlState ( )

Member Function Documentation

void FlightCtrlState.CopyFrom ( FlightCtrlState  st)

Presumably, copies the state of the FlightCtrlState st into this FlightCtrlState object.

Parameters
st

Member Data Documentation

float FlightCtrlState.fastThrottle

Unused?

bool FlightCtrlState.gearDown

Unused? Landing gear are lowered by sending an Event.

bool FlightCtrlState.gearUp

Unused? Landing gear are raised by sending an Event.

bool FlightCtrlState.headlight

Presumably, whether the EVA headlight is turned on.

bool FlightCtrlState.killRot

Whether SAS is turned on.

float FlightCtrlState.mainThrottle

The throttle setting; this must be between 0 and 1.

float FlightCtrlState.pitch

The pitch control input; this must be between -1 and 1.

float FlightCtrlState.pitchTrim

Presumably, the pitch trim setting, i.e., the pitch input that will be given if no other input is given.

float FlightCtrlState.roll

The roll control input; this must be between -1 and 1.

float FlightCtrlState.rollTrim

Presumably, the roll trim setting, i.e., the roll input that will be given if no other input is given.

float FlightCtrlState.X

The RCS x-axis control input.

float FlightCtrlState.Y

The RCS y-axis control input.

float FlightCtrlState.yaw

The yaw control input; this must be between -1 and 1.

float FlightCtrlState.yawTrim

Presumably, the yaw trim input; i.e., the yaw input that will be given if no other input is given.

float FlightCtrlState.Z

The RCS z-axis control input.

Property Documentation

bool FlightCtrlState.isNeutral
get

Presumably, whether this flight control represents "neutral" controls, i.e., no input and zero throttle.


The documentation for this class was generated from the following file: