Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
AxisGroupsModule Class Reference
Inheritance diagram for AxisGroupsModule:
VesselModule

Public Member Functions

void AddAxis (KSPAxisGroup axisGroup, BaseAxisField axisField)
 add the axis field to the list specified by axisGroup More...
 
void BuildAxisGroups ()
 Rebuild the AxisGroup map More...
 
override Activation GetActivation ()
 
void IncrementAxisGroup (KSPAxisGroup axisGroup, float axisRate)
 Increment the values of all axis fields in the group. More...
 
override void OnLoadVessel ()
 
void SetAxisGroup (KSPAxisGroup axisGroup, float axisValue)
 
override bool ShouldBeActive ()
 
void UpdateAxisGroup (KSPAxisGroup axisGroup, float axisValue)
 Update the values of all axis fields in the group according to their modes. More...
 
- Public Member Functions inherited from VesselModule
virtual int GetOrder ()
 
void Load (ConfigNode node)
 
virtual void OnGoOffRails ()
 
virtual void OnGoOnRails ()
 
virtual void OnUnloadVessel ()
 
void Save (ConfigNode node)
 

Public Attributes

Dictionary< int,
BaseAxisFieldList
AxisGroups
 Mapping from AxisGroup to list of fields bound to that group. More...
 

Protected Member Functions

override void OnAwake ()
 
- Protected Member Functions inherited from VesselModule
void Awake ()
 
virtual void OnLoad (ConfigNode node)
 
virtual void OnSave (ConfigNode node)
 
virtual void OnStart ()
 
void Start ()
 

Additional Inherited Members

- Public Types inherited from VesselModule
enum  Activation {
  Activation.FlightScene = 1, Activation.NonFlightScenes = 2, Activation.LoadedVessels = 4, Activation.UnloadedVessels = 8,
  Activation.Never = 0, Activation.AllScenes = 3, Activation.LoadedOrUnloaded = 12, Activation.Always = 255
}
 
- Protected Attributes inherited from VesselModule
BaseFieldList fields
 
Vessel vessel
 
- Properties inherited from VesselModule
BaseFieldList Fields [get]
 
Vessel Vessel [get, set]
 

Member Function Documentation

void AxisGroupsModule.AddAxis ( KSPAxisGroup  axisGroup,
BaseAxisField  axisField 
)
inline

add the axis field to the list specified by axisGroup

void AxisGroupsModule.BuildAxisGroups ( )
inline

Rebuild the AxisGroup map

The map is built from all KSPAxisField tagged float fields in all part modules on all parts of the vessel.

override Activation AxisGroupsModule.GetActivation ( )
inlinevirtual

Reimplemented from VesselModule.

void AxisGroupsModule.IncrementAxisGroup ( KSPAxisGroup  axisGroup,
float  axisRate 
)
inline

Increment the values of all axis fields in the group.

The field values will be incremented by their respective speeds scaled by axisRate. Negative axisRate means the field values will be decremented.

override void AxisGroupsModule.OnAwake ( )
inlineprotectedvirtual

Reimplemented from VesselModule.

override void AxisGroupsModule.OnLoadVessel ( )
inlinevirtual

Reimplemented from VesselModule.

void AxisGroupsModule.SetAxisGroup ( KSPAxisGroup  axisGroup,
float  axisValue 
)
inline
override bool AxisGroupsModule.ShouldBeActive ( )
inlinevirtual

Reimplemented from VesselModule.

void AxisGroupsModule.UpdateAxisGroup ( KSPAxisGroup  axisGroup,
float  axisValue 
)
inline

Update the values of all axis fields in the group according to their modes.

Member Data Documentation

Dictionary<int, BaseAxisFieldList> AxisGroupsModule.AxisGroups

Mapping from AxisGroup to list of fields bound to that group.


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