Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Public Attributes | List of all members
KSPAxisField Class Reference

Indicate that the field will be manipulated by an AxisGroup. More...

Inheritance diagram for KSPAxisField:
KSPField FieldAttribute

Public Member Functions

 KSPAxisField ()
 
- Public Member Functions inherited from KSPField
 KSPField ()
 
- Public Member Functions inherited from FieldAttribute
 FieldAttribute ()
 

Public Attributes

KSPAxisGroup axisGroup
 The axis group to which this field is bound. More...
 
KSPAxisMode axisMode
 The default mode used for updating the field. More...
 
bool ignoreClampWhenIncremental
 When true the incremental adjustmens will ignore the min/max clamps and leave it to the instance object to handle values outside the min/max More...
 
bool ignoreIncrementByZero
 When true if the increment value is zero the field will not be sent a setValue More...
 
float incrementalSpeed
 The speed at which the field will change for incremental bindings. More...
 
float incrementalSpeedMultiplier
 Multiplier for the incremental speed. More...
 
float maxValue
 The maximum value for the field. More...
 
float minValue
 The minimum value for the field. More...
 
- Public Attributes inherited from KSPField
bool advancedTweakable
 Does this require advanced tweakables? More...
 
string category
 string category id More...
 
string groupDisplayName
 This field's group display name More...
 
string groupName
 
bool groupStartCollapsed
 True if the group will start collapsed. More...
 
bool guiActive
 Is this field active on gui More...
 
bool guiActiveEditor
 Is this field active in the editor More...
 
bool guiActiveUnfocused
 Is this field active while focused on another vessel? More...
 
string guiFormat
 The gui format string for this field (D4, F2, N0, etc). Blank if none More...
 
bool isPersistant
 Is this field persistant? More...
 
float unfocusedRange
 Minimum distance for the field to show up in the GUI. More...
 

Additional Inherited Members

- Properties inherited from KSPField
string guiUnits [get, set]
 
- Properties inherited from FieldAttribute
string guiName [get, set]
 The field's gui name More...
 

Detailed Description

Indicate that the field will be manipulated by an AxisGroup.

This is valid only for float fields.

Constructor & Destructor Documentation

KSPAxisField.KSPAxisField ( )
inline

Member Data Documentation

KSPAxisGroup KSPAxisField.axisGroup

The axis group to which this field is bound.

KSPAxisMode KSPAxisField.axisMode

The default mode used for updating the field.

bool KSPAxisField.ignoreClampWhenIncremental

When true the incremental adjustmens will ignore the min/max clamps and leave it to the instance object to handle values outside the min/max

bool KSPAxisField.ignoreIncrementByZero

When true if the increment value is zero the field will not be sent a setValue

float KSPAxisField.incrementalSpeed

The speed at which the field will change for incremental bindings.

float KSPAxisField.incrementalSpeedMultiplier

Multiplier for the incremental speed.

float KSPAxisField.maxValue

The maximum value for the field.

float KSPAxisField.minValue

The minimum value for the field.


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