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

Public Types

enum  animationStates { animationStates.LOCKED, animationStates.MOVING, animationStates.CLAMPED, animationStates.FIXED }
 
- Public Types inherited from PartModule
enum  PartUpgradeState { PartUpgradeState.NONE, PartUpgradeState.LOCKED, PartUpgradeState.AVAILABLE }
 
enum  StartState {
  StartState.None = 0, StartState.Editor = 1, StartState.PreLaunch = 2, StartState.Landed = 4,
  StartState.Docked = 8, StartState.Flying = 16, StartState.Splashed = 32, StartState.SubOrbital = 64,
  StartState.Orbital = 128
}
 

Public Member Functions

void AssumeDragCubePosition (string name)
 Used by the DragCubeSystem when it is generating drag cube entries on startup if none are found for this module. When called the module should set it's model position/setup to match the expected position/orientation when 'name' drag cube is active. More...
 
Animation GetAnimation ()
 
string[] GetDragCubeNames ()
 Should return an array of strings that are the drag cube names that this module implements. More...
 
AnimationState GetState ()
 
bool IsMoving ()
 
override void OnAwake ()
 Method fires once the module has been added to the part. Use for first time setup. Module will not have loaded fully by this point More...
 
override void OnInventoryModeDisable ()
 This method will be called when this modules part and itself is first disabled (when it is not attached to a vessel) when created in Inventory/Construction mode. More...
 
override void OnSave (ConfigNode node)
 Use OnSave to serialize additional module information into the ConfigNode provided More...
 
override void OnStart (PartModule.StartState state)
 
override void OnStoredInInventory (ModuleInventoryPart moduleInventoryPart)
 Called when the part is stored in an inventory. More...
 
void SetScalar (float t)
 Call to tell the module to assume the given state. Mind transition may not happen instantly. Check GetScalar for the actual state of the thing. More...
 
void SetUIRead (bool state)
 Call to set whether or not the module will display its own UI. Read and Write define which kinds of information are allowed to be displayed More...
 
void SetUIWrite (bool state)
 Call to set whether or not the module will display its own UI. Read and Write define which kinds of information are allowed to be displayed More...
 
void Toggle ()
 
void ToggleAction (KSPActionParam param)
 
bool UsesProceduralDragCubes ()
 Used by the DragCubeSystem when it is generating drag cube entries on startup if none are found for this module. Should return true if this module is to use procedural drag cubes and false if it is to generate drag cubes for the drag cube names returned in GetDragCubeNames method. More...
 
void VariantToggleAnimationDisabled (bool disabled)
 Allows part variants to disable or enable the animation. More...
 
- Public Member Functions inherited from PartModule
void AddPartModuleAdjuster (AdjusterPartModuleBase newAdjuster)
 Call this to add an adjuster to this part module. More...
 
void AddPartModuleAdjusterList (List< AdjusterPartModuleBase > moduleAdjusters)
 Applies the appropriate module adjusters. Performs checks to make sure that the adjusters are valid too. More...
 
bool AppliedUpgrades ()
 Returns true if upgrades are applied More...
 
void ApplyAdjustersOnStart ()
 Called when a part module is loaded and applies all of the currently loaded adjusters. More...
 
virtual void ApplyUpgradeNode (List< string > appliedUps, ConfigNode node, bool doLoad)
 Applies the upgrades to a confignode. Will either copy the upgrades back to the node or (if doLoad) calls load/onload on it. More...
 
virtual bool ApplyUpgrades (StartState state)
 Will find and apply upgrades. Called during Part's ModulesOnStart, before a module's OnStart. More...
 
void Awake ()
 
delegate bool boolPMApplyUpgrades (PartModule pm, StartState state)
 
delegate bool boolPMBoolDelegate (PartModule pm, bool apply)
 
void ClearPersistentId ()
 Clear the modules persistentId More...
 
void Copy (PartModule fromModule)
 
virtual void DemoteToPhysicslessPart ()
 This method will be called from Part class DemoteToPhysicslessPart when the part is being converted from physical to physicsless part. It is called before the joints and rigidbodies are destroyed. More...
 
virtual bool FindUpgrades (bool fillApplied, ConfigNode node=null)
 Find applicable upgrades to the partmodule (isunlocked and isenabled) and add to the upgradesApplied list. Pass true if you want to add the upgrades to upgradesApplied, false if you just want to know if at least one upgrade is applicable (unlocked rather than enabled) More...
 
virtual Color GetCurrentColor ()
 Returns the current part module color. More...
 
virtual Color GetCurrentColor (string fieldName)
 Returns the current part module color for a field where usespe. More...
 
virtual string GetInfo ()
 Returns formatted string of additional data for use in the VAB and SPH More...
 
virtual string GetModuleDisplayName ()
 Override this to provide a Localized version of the PartModules Name for UI components More...
 
uint GetPersistenActiontId ()
 Get the modules persistentID, and create one if it doesnt already have one More...
 
uint GetPersistentId ()
 Get the modules persistentID, and create one if it doesnt already have one More...
 
virtual string GetStagingDisableText ()
 
virtual string GetStagingEnableText ()
 
virtual string GetUpgradeInfo ()
 Called by Upgrade Stats dialog More...
 
bool HasUpgrades ()
 Returns true if upgrades exist for the partmodule More...
 
virtual bool IsStageable ()
 Should this module be counted when seeing whether to have a stack icon present? Override in a module for custom behavior; otherwise returns true if the module (or something the module inherits from above PartModule itself) overrides OnActive() More...
 
bool IsValidContractObjective (string objectiveType)
 Returns if, for example, an antenna part module qualifies as an antenna for contracts. More...
 
void Load (ConfigNode node)
 
virtual void LoadUpgrades (ConfigNode node)
 Loads module-relevant upgrades from the partmodule confignode More...
 
uint NewPersistentId ()
 Reset the modules persistentId to a new number More...
 
virtual void OnActive ()
 Called when the part is set active (after unpacking etc) More...
 
virtual void OnColorChanged (Color color)
 Meant to be overwritten by part modules implementing color changes. In this case, it doesn't matter which color picker changed specifically. More...
 
virtual void OnColorChanged (Color color, string pickerID="")
 Meant to be overwritten by part modules implementing color changes More...
 
virtual void OnConstructionModeFixedUpdate ()
 This method will be called when in EVA Construction mode and this part and itself is disabled (when it is not attached to a vessel) every FixedUpdate(). More...
 
virtual void OnConstructionModeUpdate ()
 This method will be called when in EVA Construction mode and this part and itself is disabled (when it is not attached to a vessel) every Update(). More...
 
virtual void OnCopy (PartModule fromModule)
 Use OnCopy to copy any additional data from the PartModule provided More...
 
virtual void OnFixedUpdate ()
 Called every physics/fixed frame that the part is active More...
 
virtual void OnIconCreate ()
 Method fires just before components are stripped from the gameobject to make it an icon. (The part is instantiated and then various components like Part, PartModule, EffectBehaviour, Colliders, Particles, etc are stripped and then it's set as the icon prefab. This lets PartModules do stuff to the model right before that happens. More...
 
virtual void OnInactive ()
 Called before the part goes inactive (after packing etc) More...
 
virtual void OnInitialize ()
 Called on all modules after all parts are loaded but before they give the ship to the game More...
 
virtual void OnInventoryModeEnable ()
 This method will be called when this modules part and itself is first enabled (when it is attached to a vessel) when created in Inventory/Construction mode. More...
 
virtual void OnLoad (ConfigNode node)
 Use OnLoad to load any additional data from the ConfigNode provided More...
 
void OnModuleAdjusterAddedWrapper (AdjusterPartModuleBase adjuster)
 Wrapper to check the mission expansion availability before performing processing specific to this part module when an adjuster is added. More...
 
virtual void OnModuleAdjusterRemoved (AdjusterPartModuleBase adjuster)
 Perform processing specific to this part module when an adjuster is removed. By default this does nothing is up to each part module to implement it properly. More...
 
virtual void OnPartCreatedFomInventory (ModuleInventoryPart moduleInventoryPart)
 This method is called when a part is being taken out from a slot while being in EVAConstruction mode. More...
 
virtual void OnStart (StartState state)
 Called when the part starts. The StartState gives an indication of where in flight you are. All values may not be plugged in! More...
 
virtual void OnStartBeforePartAttachJoint (StartState state)
 Called in flight scene in Part.Start just before the Part attachnode joints are created. More...
 
virtual void OnStartFinished (StartState state)
 Called when the part finishes starting. The StartState gives an indication of where in flight you are. All values may not be plugged in! More...
 
virtual void OnUpdate ()
 Called every frame that the part is active More...
 
virtual void OnWasCopied (PartModule copyPartModule, bool asSymCounterpart)
 Called when the PartModule was copied, through Alt+Copy or symmetry More...
 
virtual void OnWillBeCopied (bool asSymCounterpart)
 Called when the PartModule is about to be copied, through Alt+Copy or symmetry More...
 
virtual bool OnWillBeMirrored (ref Quaternion rotation, AttachNode selPartNode, Part partParent)
 This is called in the Editor scene when a symmetry copy of a part is being positioned. Only called on the symmetry parts and only when symmetry mode is set to Mirror. It allows the mirror rotation to be changed and returned before being applied to the symmetry copy part.

Parameters
rotationThe current calculated rotation. Will be updated if method returns true.
selPartNodeThe attachnode.
partParentThe part that will become this part's parent.
Returns
True if the rotation was changed. Otherwise will return false.
More...
 
virtual List< Color > PresetColors ()
 Preset colors received for any part module. By default, returns only black, override to make your own selection. More...
 
virtual string PrintUpgrades ()
 
virtual void PromoteToPhysicalPart ()
 This method will be called from Part class PromoteToPhysicalPart when the part is being converted from physicsless to physical part. More...
 
void RemovePartModuleAdjuster (AdjusterPartModuleBase oldAdjuster)
 Call this to remove an adjuster from this part module. More...
 
void RemovePartModuleAdjusterList (List< AdjusterPartModuleBase > moduleAdjusters)
 Removes the appropriate module adjusters. Performs checks to make sure that the adjusters are valid too. More...
 
void Save (ConfigNode node)
 
virtual void SetStaging (bool newValue)
 Run by the part's staging toggle handler, sets staging on modules on symmetry counterparts. More...
 
void SetStagingState (bool newState)
 Set the staging enabled bool for this module. More...
 
virtual bool StagingEnabled ()
 Gets current staging status (is staging enabled for this module) Override me! More...
 
virtual bool StagingToggleEnabledEditor ()
 
virtual bool StagingToggleEnabledFlight ()
 
void ToggleStaging ()
 
virtual void UpdateStagingToggle ()
 Updates the staging toggle More...
 
delegate void voidPMApplyNodeDelegate (PartModule pm, List< string > appliedUps, ConfigNode node, bool doLoad)
 
delegate void voidPMDelegate (PartModule pm)
 
delegate void voidPMNodeDelegate (PartModule pm, ConfigNode node)
 

Public Attributes

bool actionAvailable = true
 
string actionGUIName = "#autoLOC_6001354"
 
bool allowAnimationWhileShielded = true
 
bool allowDeployLimit = false
 
bool allowManualControl = true
 
bool animationIsDisabled = false
 
string animationName = "default"
 
float animSpeed = 1f
 
bool animSwitch = true
 
float animTime = 0f
 
animationStates aniState = animationStates.LOCKED
 
int CrewCapacity = 0
 Dynamic crew capacity when animation is fully played. More...
 
KSPActionGroup defaultActionGroup = KSPActionGroup.None
 
float deployPercent = 100f
 
bool disableAfterPlaying = false
 
string endEventGUIName = "#autoLOC_6001354"
 
float evaDistance = 5f
 
bool eventAvailableEditor = true
 
bool eventAvailableEVA = true
 
bool eventAvailableFlight = true
 
bool instantAnimInEditor = true
 
bool isOneShot = false
 
int layer = 1
 
string moduleID = "genericAnim"
 
string restrictedNode = ""
 
bool revClampDirection = false
 
bool revClampPercent = false
 
bool revClampSpeed = false
 
bool showStatus = true
 
string startEventGUIName = "#autoLOC_6001354"
 
string status = Localizer.Format("#autoLOC_215362")
 
bool useMultipleDragCubes = true
 Determines whether this module will use multiple drag cubes. Default is true. Set to false for cosmetic-only animations, eg: Lights More...
 
- Public Attributes inherited from PartModule
bool isEnabled = true
 
bool moduleIsEnabled = true
 
string moduleName
 
bool overrideStagingIconIfBlank = true
 
ModuleResourceHandler resHandler = new ModuleResourceHandler()
 
bool showUpgradesInModuleInfo = false
 
ProtoPartModuleSnapshot snapshot
 
string stagingDisableText = ""
 
bool stagingEnabled = true
 
string stagingEnableText = ""
 
bool stagingToggleEnabledEditor = false
 
bool stagingToggleEnabledFlight = false
 
List< ConfigNodeupgrades
 
List< string > upgradesApplied = new List<string>()
 
bool upgradesApply = true
 
bool upgradesAsk = true
 

Protected Attributes

Animation anim
 

Properties

bool AnimationIsDisabledByVariant [get]
 Has the animation been disabled by a part variant? More...
 
bool CanMove [get]
 
float GetScalar [get]
 
bool IsMultipleCubesActive [get]
 
EventData< float, float > OnMoving [get]
 
EventData< float > OnStop [get]
 
float Progress [get]
 
string ScalarModuleID [get]
 
- Properties inherited from PartModule
BaseActionList Actions [get]
 
int ClassID [get]
 
string ClassName [get]
 
List< AdjusterPartModuleBaseCurrentModuleAdjusterList [get]
 List of all the module adjusters that are currently active on this part module. More...
 
BaseEventList Events [get]
 
BaseFieldList Fields [get]
 
string GUIName [get]
 
bool HasAdjusters [get]
 Has this part module been adjusted? More...
 
ReflectedAttributes ModuleAttributes [get, set]
 
Part part [get, set]
 
uint PersistentActionsId [get, set]
 A unique identifier for each vessel including from when it was Shipconstruct More...
 
uint PersistentId [get]
 A unique identifier for each vessel including from when it was Shipconstruct More...
 
Vessel vessel [get]
 
- Properties inherited from IScalarModule
bool CanMove [get]
 A flag stating whether or not the module is able to change state at all. More...
 
float GetScalar [get]
 
EventData< float, float > OnMoving [get]
 
EventData< float > OnStop [get]
 
string ScalarModuleID [get]
 
- Properties inherited from IMultipleDragCube
bool IsMultipleCubesActive [get]
 Used by the DragCubeSystem when it is generating drag cube entries on startup if none are found for this module. Should return true if multiple drag cubes are expected to be generated for the part this module is a part of or false if not. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from PartModule
static ReflectedAttributes GetReflectedAttributes (Type partModuleType)
 
static PartUpgradeState UpgradesAvailable (Part part)
 Returns true if at least one module on the part has at least one upgrade available (isUnlocked) More...
 
static PartUpgradeState UpgradesAvailable (Part part, ConfigNode node)
 Returns true if at least one module on the part has at least one upgrade available (isUnlocked) More...
 
- Static Public Attributes inherited from PartModule
static voidPMApplyNodeDelegate ApplyUpgradeNodeDel
 
static boolPMApplyUpgrades ApplyUpgradesDel
 
static bool ApplyUpgradesEditorAuto = true
 
static boolPMBoolDelegate FindUpgradesDel
 
static voidPMNodeDelegate LoadExpansionNodes
 Hook for loading extra nodes common to all part modules. More...
 
static voidPMNodeDelegate LoadUpgradesDel
 
static voidPMNodeDelegate SaveExpansionNodes
 Hook for saving extra nodes common to all part modules. More...
 
static voidPMDelegate SetupExpansion
 Hook for performing extra setup common to all part modules. More...
 
static string UpgradesAvailableString = "#autoLOC_6002273"
 
static string UpgradesLockedString = "#autoLOC_6002274"
 
- Protected Member Functions inherited from PartModule
ConfigNode GetUpgrade (string name)
 
virtual void LoadUpgradesApplied (List< string > applieds, ConfigNode node)
 Load the applied upgrade names More...
 
virtual void OnModuleAdjusterAdded (AdjusterPartModuleBase adjuster)
 Perform processing specific to this part module when an adjuster is added. By default this does nothing is up to each part module to implement it properly. More...
 
virtual void SaveUpgradesApplied (ConfigNode node)
 Save the applied upgrades. More...
 
IEnumerator UpgradeWaitForScenarioModules ()
 
- Static Protected Attributes inherited from PartModule
static Dictionary< string,
ConfigNode
exclusives = new Dictionary<string, ConfigNode>()
 
static Dictionary< Type,
ReflectedAttributes
reflectedAttributeCache = new Dictionary<Type, ReflectedAttributes>()
 

Member Enumeration Documentation

Enumerator
LOCKED 
MOVING 
CLAMPED 
FIXED 

Member Function Documentation

void ModuleAnimateGeneric.AssumeDragCubePosition ( string  name)
inline

Used by the DragCubeSystem when it is generating drag cube entries on startup if none are found for this module. When called the module should set it's model position/setup to match the expected position/orientation when 'name' drag cube is active.

Parameters
nameThe name of the drag cube to assume the position/setup for.

Implements IMultipleDragCube.

Animation ModuleAnimateGeneric.GetAnimation ( )
inline
string [] ModuleAnimateGeneric.GetDragCubeNames ( )
inline

Should return an array of strings that are the drag cube names that this module implements.

Returns

Implements IMultipleDragCube.

AnimationState ModuleAnimateGeneric.GetState ( )
inline
bool ModuleAnimateGeneric.IsMoving ( )
inline

Implements IScalarModule.

override void ModuleAnimateGeneric.OnAwake ( )
inlinevirtual

Method fires once the module has been added to the part. Use for first time setup. Module will not have loaded fully by this point

Reimplemented from PartModule.

override void ModuleAnimateGeneric.OnInventoryModeDisable ( )
inlinevirtual

This method will be called when this modules part and itself is first disabled (when it is not attached to a vessel) when created in Inventory/Construction mode.

Reimplemented from PartModule.

override void ModuleAnimateGeneric.OnSave ( ConfigNode  node)
inlinevirtual

Use OnSave to serialize additional module information into the ConfigNode provided

Parameters
node

Reimplemented from PartModule.

override void ModuleAnimateGeneric.OnStart ( PartModule.StartState  state)
inline
override void ModuleAnimateGeneric.OnStoredInInventory ( ModuleInventoryPart  moduleInventoryPart)
inlinevirtual

Called when the part is stored in an inventory.

Parameters
moduleInventoryPart

Reimplemented from PartModule.

void ModuleAnimateGeneric.SetScalar ( float  t)
inline

Call to tell the module to assume the given state. Mind transition may not happen instantly. Check GetScalar for the actual state of the thing.

Parameters
s

Implements IScalarModule.

void ModuleAnimateGeneric.SetUIRead ( bool  state)
inline

Call to set whether or not the module will display its own UI. Read and Write define which kinds of information are allowed to be displayed

Implements IScalarModule.

void ModuleAnimateGeneric.SetUIWrite ( bool  state)
inline

Call to set whether or not the module will display its own UI. Read and Write define which kinds of information are allowed to be displayed

Implements IScalarModule.

void ModuleAnimateGeneric.Toggle ( )
inline
void ModuleAnimateGeneric.ToggleAction ( KSPActionParam  param)
inline
bool ModuleAnimateGeneric.UsesProceduralDragCubes ( )
inline

Used by the DragCubeSystem when it is generating drag cube entries on startup if none are found for this module. Should return true if this module is to use procedural drag cubes and false if it is to generate drag cubes for the drag cube names returned in GetDragCubeNames method.

Returns

Implements IMultipleDragCube.

void ModuleAnimateGeneric.VariantToggleAnimationDisabled ( bool  disabled)
inline

Allows part variants to disable or enable the animation.

Member Data Documentation

bool ModuleAnimateGeneric.actionAvailable = true
string ModuleAnimateGeneric.actionGUIName = "#autoLOC_6001354"
bool ModuleAnimateGeneric.allowAnimationWhileShielded = true
bool ModuleAnimateGeneric.allowDeployLimit = false
bool ModuleAnimateGeneric.allowManualControl = true
Animation ModuleAnimateGeneric.anim
protected
bool ModuleAnimateGeneric.animationIsDisabled = false
string ModuleAnimateGeneric.animationName = "default"
float ModuleAnimateGeneric.animSpeed = 1f
bool ModuleAnimateGeneric.animSwitch = true
float ModuleAnimateGeneric.animTime = 0f
animationStates ModuleAnimateGeneric.aniState = animationStates.LOCKED
int ModuleAnimateGeneric.CrewCapacity = 0

Dynamic crew capacity when animation is fully played.

KSPActionGroup ModuleAnimateGeneric.defaultActionGroup = KSPActionGroup.None
float ModuleAnimateGeneric.deployPercent = 100f
bool ModuleAnimateGeneric.disableAfterPlaying = false
string ModuleAnimateGeneric.endEventGUIName = "#autoLOC_6001354"
float ModuleAnimateGeneric.evaDistance = 5f
bool ModuleAnimateGeneric.eventAvailableEditor = true
bool ModuleAnimateGeneric.eventAvailableEVA = true
bool ModuleAnimateGeneric.eventAvailableFlight = true
bool ModuleAnimateGeneric.instantAnimInEditor = true
bool ModuleAnimateGeneric.isOneShot = false
int ModuleAnimateGeneric.layer = 1
string ModuleAnimateGeneric.moduleID = "genericAnim"
string ModuleAnimateGeneric.restrictedNode = ""
bool ModuleAnimateGeneric.revClampDirection = false
bool ModuleAnimateGeneric.revClampPercent = false
bool ModuleAnimateGeneric.revClampSpeed = false
bool ModuleAnimateGeneric.showStatus = true
string ModuleAnimateGeneric.startEventGUIName = "#autoLOC_6001354"
string ModuleAnimateGeneric.status = Localizer.Format("#autoLOC_215362")
bool ModuleAnimateGeneric.useMultipleDragCubes = true

Determines whether this module will use multiple drag cubes. Default is true. Set to false for cosmetic-only animations, eg: Lights

Property Documentation

bool ModuleAnimateGeneric.AnimationIsDisabledByVariant
get

Has the animation been disabled by a part variant?

bool ModuleAnimateGeneric.CanMove
get
float ModuleAnimateGeneric.GetScalar
get
bool ModuleAnimateGeneric.IsMultipleCubesActive
get
EventData<float, float> ModuleAnimateGeneric.OnMoving
get
EventData<float> ModuleAnimateGeneric.OnStop
get
float ModuleAnimateGeneric.Progress
get
string ModuleAnimateGeneric.ScalarModuleID
get

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