Difference between revisions of "API:FlightCtrlState"
From Kerbal Space Program Wiki
Michael Kim (talk | contribs) m |
m (+ action group link.) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{class|name=FlightCtrlState|summary=FlightCtrlState objects are in charge of controlling vessels. User input can be acquired through the FlightCtrlState object of the current vessel. Modifications to the object will overwrite user input, and can lead to autopiloting. Below are some useful members of class FlightCtrlState. Note that this list is far from complete.}}{{FieldsStart}}{{Field|type=float|name=mainThrottle|desc=The current throttle, ranging from 0 to 1.}}{{Field|type=float|name=pitch|desc=-1(pitch down) ~ 1(pitch up)}}{{Field|type=float|name=yaw|desc=-1(yaw left) ~ 1(yaw right)}}{{Field|type=float|name=roll|desc=-1(roll left) ~ 1(roll right)}}{{Field|type=float|name=X|desc=-1(translate right) ~ 1(translate left)}}{{Field|type=float|name=Y|desc=-1(translate down) ~ 1(translate up)}}{{Field|type=float|name=Z|desc=-1(translate forward) ~ 1(translate backward)}}{{Field|type=bool|name=killRot|desc=Responsible for SAS/ASAS toggle before v0.18. It is now obsolete. SAS is now controlled by the SAS action group.}}{{FieldsEnd}}{{MethodsStart}}{{Method|returntype=void|returndesc=|name=CopyFrom|args={{arg|FlightCtrlState|st}}|desc=}}{{MethodsEnd}}[[Category:Community API Documentation]] | + | {{class |
| + | |name=FlightCtrlState | ||
| + | |summary=FlightCtrlState objects are in charge of controlling vessels. User input can be acquired through the FlightCtrlState object of the current vessel. Modifications to the object will overwrite user input, and can lead to autopiloting. Below are some useful members of class FlightCtrlState. Note that this list is far from complete. | ||
| + | }} | ||
| + | {{FieldsStart}} | ||
| + | {{Field | ||
| + | |type=float | ||
| + | |name=mainThrottle | ||
| + | |desc=The current throttle, ranging from 0 to 1. | ||
| + | }} | ||
| + | {{Field | ||
| + | |type=float | ||
| + | |name=pitch | ||
| + | |desc=-1(pitch down) ~ 1(pitch up) | ||
| + | }} | ||
| + | {{Field | ||
| + | |type=float | ||
| + | |name=yaw | ||
| + | |desc=-1(yaw left) ~ 1(yaw right) | ||
| + | }} | ||
| + | {{Field | ||
| + | |type=float | ||
| + | |name=roll | ||
| + | |desc=-1(roll left) ~ 1(roll right) | ||
| + | }} | ||
| + | {{Field | ||
| + | |type=float | ||
| + | |name=X | ||
| + | |desc=-1(translate right) ~ 1(translate left) | ||
| + | }} | ||
| + | {{Field | ||
| + | |type=float | ||
| + | |name=Y | ||
| + | |desc=-1(translate down) ~ 1(translate up) | ||
| + | }} | ||
| + | {{Field | ||
| + | |type=float | ||
| + | |name=Z | ||
| + | |desc=-1(translate forward) ~ 1(translate backward) | ||
| + | }} | ||
| + | {{Field | ||
| + | |type=bool | ||
| + | |name=killRot | ||
| + | |desc=Responsible for SAS/ASAS toggle before v0.18. It is now obsolete. SAS is now controlled by the SAS [[action group]]. | ||
| + | }} | ||
| + | {{FieldsEnd}} | ||
| + | {{MethodsStart}} | ||
| + | {{Method | ||
| + | |returntype=void | ||
| + | |returndesc= | ||
| + | |name=CopyFrom | ||
| + | |args={{arg|FlightCtrlState|st}}|desc=}} | ||
| + | {{MethodsEnd}} | ||
| + | [[Category:Community API Documentation]] | ||
Latest revision as of 10:21, 2 July 2013
FlightCtrlState Class
FlightCtrlState objects are in charge of controlling vessels. User input can be acquired through the FlightCtrlState object of the current vessel. Modifications to the object will overwrite user input, and can lead to autopiloting. Below are some useful members of class FlightCtrlState. Note that this list is far from complete.
Fields
The following is a list of publically-accessible fields in FlightCtrlState. This includes protected items, which can be accessed by subclasses.
| Signature | Description |
|---|---|
| float mainThrottle | The current throttle, ranging from 0 to 1. |
| float pitch | -1(pitch down) ~ 1(pitch up) |
| float yaw | -1(yaw left) ~ 1(yaw right) |
| float roll | -1(roll left) ~ 1(roll right) |
| float X | -1(translate right) ~ 1(translate left) |
| float Y | -1(translate down) ~ 1(translate up) |
| float Z | -1(translate forward) ~ 1(translate backward) |
| bool killRot | Responsible for SAS/ASAS toggle before v0.18. It is now obsolete. SAS is now controlled by the SAS action group. |
Methods
The following are methods included in FlightCtrlState.
| Signature | Description |
|---|---|
| void CopyFrom(FlightCtrlState st) |
