Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Properties | List of all members
ModuleWheels.ModuleWheelDamage Class Reference
Inheritance diagram for ModuleWheels.ModuleWheelDamage:
ModuleWheels.ModuleWheelSubmodule IConstruction PartModule

Public Member Functions

virtual bool CanBeDetached ()
 Returns true if not damaged More...
 
virtual bool CanBeOffset ()
 Returns true if not damaged More...
 
virtual bool CanBeRotated ()
 Returns true if not damaged More...
 
void DamageWheel ()
 
void EventRepairExternal ()
 
void FixedUpdate ()
 
void HandleCollision (Collision c)
 Handle what to do if we have a CollisionVelocity Interface module More...
 
void HandleCollisionVelocity (GameObject otherObject, Vector3 velocity, Vector3 normal)
 Handle the velocity of collisions in the wheel damage. Break the wheel if it collides with things above the impactDamageVelocity More...
 
override void OnDestroy ()
 
override string OnGatherInfo ()
 
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 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...
 
override void OnStart (PartModule.StartState state)
 
void SetDamaged (bool damaged)
 
- Public Member Functions inherited from ModuleWheels.ModuleWheelSubmodule
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...
 
void OnWheelInit (KSPWheelController w)
 
- 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 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 OnSave (ConfigNode node)
 Use OnSave to serialize additional module information into the ConfigNode provided 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 OnStoredInInventory (ModuleInventoryPart moduleInventoryPart)
 Called when the part is stored in an inventory. 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)
 

Static Public Member Functions

static void CacheLocalStrings ()
 
- 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...
 

Public Attributes

string brokenStatusWarning = ""
 Display that warns about a broken wheel when not on EVA. More...
 
float currentDeflection
 
float currentDownForce
 
float currentSlip
 
string damagedTransformName = ""
 
float deflectionMagnitude = 1.0f
 
float deflectionSharpness = 1f
 
float explodeMultiplier = 5f
 damage "stress" (energy-ish) inputs from deflection (downforce) and slip (friction) More...
 
string impactDamageColliderName = ""
 Collider to measure collision with objects to determine breakage More...
 
float impactDamageVelocity = 0f
 The immpact force at which the wheel will be Damaged More...
 
float impactTolerance = 40f
 
bool initialized = false
 
bool isDamaged = false
 
bool isRepairable = true
 
float lastDeflection
 
float lastDownForce
 Repair Immunity, prevents wheels from immediately popping after repair by lerping stresses up over time. More...
 
float lastSlip
 
float slipMagnitude = 1.0f
 
float slipSharpness = 2f
 
float stressPercent
 
float stressTolerance = 10f
 
float stressVariability = 0f
 
float totalStress
 
string undamagedTransformName = ""
 
- Public Attributes inherited from ModuleWheels.ModuleWheelSubmodule
int baseModuleIndex = -1
 
- 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< ConfigNode > upgrades
 
List< string > upgradesApplied = new List<string>()
 
bool upgradesApply = true
 
bool upgradesAsk = true
 

Protected Member Functions

override void OnWheelSetup ()
 Called at flight start, after part.Start is complete More...
 
- Protected Member Functions inherited from ModuleWheels.ModuleWheelSubmodule
virtual void OnSubsystemsModified (WheelSubsystems s)
 
void SetWheelBase ()
 
- 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 ()
 

Properties

bool IsImpactDamageEnable [get]
 Checking if any of the damage options are enabled More...
 
- Properties inherited from PartModule
BaseActionList Actions [get]
 
int ClassID [get]
 
string ClassName [get]
 
List< AdjusterPartModuleBase > CurrentModuleAdjusterList [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]
 

Additional Inherited Members

- 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
}
 
- 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 Attributes inherited from ModuleWheels.ModuleWheelSubmodule
bool baseSetup
 
ModuleWheelBase wheelBase
 
- 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 Function Documentation

static void ModuleWheels.ModuleWheelDamage.CacheLocalStrings ( )
inlinestatic
virtual bool ModuleWheels.ModuleWheelDamage.CanBeDetached ( )
inlinevirtual

Returns true if not damaged

Returns

Implements IConstruction.

virtual bool ModuleWheels.ModuleWheelDamage.CanBeOffset ( )
inlinevirtual

Returns true if not damaged

Returns

Implements IConstruction.

virtual bool ModuleWheels.ModuleWheelDamage.CanBeRotated ( )
inlinevirtual

Returns true if not damaged

Returns

Implements IConstruction.

void ModuleWheels.ModuleWheelDamage.DamageWheel ( )
inline
void ModuleWheels.ModuleWheelDamage.EventRepairExternal ( )
inline
void ModuleWheels.ModuleWheelDamage.FixedUpdate ( )
inline

< Repair Immunity

< Wheel hasn't settled, update our values, but don't act on them yet.

< At max stress, give them half a second, at 150% max stress, give them a quarter second.

void ModuleWheels.ModuleWheelDamage.HandleCollision ( Collision  c)
inline

Handle what to do if we have a CollisionVelocity Interface module

Parameters
cThe collision that occured
void ModuleWheels.ModuleWheelDamage.HandleCollisionVelocity ( GameObject  otherObject,
Vector3  velocity,
Vector3  normal 
)
inline

Handle the velocity of collisions in the wheel damage. Break the wheel if it collides with things above the impactDamageVelocity

Parameters
otherObjectThe object collided with
velocityThe relative velocity vectorof teh impact
normalThe surface normal of the other object so we can work out the velocty reltive to the surface normal
override void ModuleWheels.ModuleWheelDamage.OnDestroy ( )
inlinevirtual

Reimplemented from ModuleWheels.ModuleWheelSubmodule.

override string ModuleWheels.ModuleWheelDamage.OnGatherInfo ( )
inlinevirtual

Implements ModuleWheels.ModuleWheelSubmodule.

override void ModuleWheels.ModuleWheelDamage.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 ModuleWheels.ModuleWheelDamage.OnInventoryModeEnable ( )
inlinevirtual

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.

Reimplemented from PartModule.

override void ModuleWheels.ModuleWheelDamage.OnStart ( PartModule.StartState  state)
inline

< negate the flag before calling the method to force it to update

override void ModuleWheels.ModuleWheelDamage.OnWheelSetup ( )
inlineprotectedvirtual

Called at flight start, after part.Start is complete

Implements ModuleWheels.ModuleWheelSubmodule.

void ModuleWheels.ModuleWheelDamage.SetDamaged ( bool  damaged)
inline

< +/- 2%, so wheels don't pop all at once

Member Data Documentation

string ModuleWheels.ModuleWheelDamage.brokenStatusWarning = ""

Display that warns about a broken wheel when not on EVA.

float ModuleWheels.ModuleWheelDamage.currentDeflection
float ModuleWheels.ModuleWheelDamage.currentDownForce
float ModuleWheels.ModuleWheelDamage.currentSlip
string ModuleWheels.ModuleWheelDamage.damagedTransformName = ""
float ModuleWheels.ModuleWheelDamage.deflectionMagnitude = 1.0f
float ModuleWheels.ModuleWheelDamage.deflectionSharpness = 1f
float ModuleWheels.ModuleWheelDamage.explodeMultiplier = 5f

damage "stress" (energy-ish) inputs from deflection (downforce) and slip (friction)

string ModuleWheels.ModuleWheelDamage.impactDamageColliderName = ""

Collider to measure collision with objects to determine breakage

float ModuleWheels.ModuleWheelDamage.impactDamageVelocity = 0f

The immpact force at which the wheel will be Damaged

float ModuleWheels.ModuleWheelDamage.impactTolerance = 40f
bool ModuleWheels.ModuleWheelDamage.initialized = false
bool ModuleWheels.ModuleWheelDamage.isDamaged = false
bool ModuleWheels.ModuleWheelDamage.isRepairable = true
float ModuleWheels.ModuleWheelDamage.lastDeflection
float ModuleWheels.ModuleWheelDamage.lastDownForce

Repair Immunity, prevents wheels from immediately popping after repair by lerping stresses up over time.

float ModuleWheels.ModuleWheelDamage.lastSlip
float ModuleWheels.ModuleWheelDamage.slipMagnitude = 1.0f
float ModuleWheels.ModuleWheelDamage.slipSharpness = 2f
float ModuleWheels.ModuleWheelDamage.stressPercent
float ModuleWheels.ModuleWheelDamage.stressTolerance = 10f
float ModuleWheels.ModuleWheelDamage.stressVariability = 0f
float ModuleWheels.ModuleWheelDamage.totalStress
string ModuleWheels.ModuleWheelDamage.undamagedTransformName = ""

Property Documentation

bool ModuleWheels.ModuleWheelDamage.IsImpactDamageEnable
get

Checking if any of the damage options are enabled

The documentation for this class was generated from the following file:
API Download: HTML | XML
Generated on Tue Nov 1 2022 18:36:40 for Kerbal Space Program by   doxygen 1.8.7