Difference between revisions of "API:PartModule"
From Kerbal Space Program Wiki
m |
Singularity (talk | contribs) (Added documentation for the StartState enum which is in this namespace) |
||
| Line 98: | Line 98: | ||
|desc=Returns the part information. | |desc=Returns the part information. | ||
}} | }} | ||
| + | }} | ||
| + | |||
| + | |||
| + | {{Enum | ||
| + | |name=StartState | ||
| + | |summary=An enum that determines what game state a part starts in. | ||
| + | |||
| + | ''' The values for this enum are probably incomplete. ''' | ||
}} | }} | ||
[[Category:Community API Documentation]] | [[Category:Community API Documentation]] | ||
| + | PartModule.StartState.Docked | ||
| + | PartModule.StartState.Editor | ||
| + | PartModule.StartState.Flying | ||
| + | PartModule.StartState.Landed | ||
| + | PartModule.StartState.None | ||
| + | PartModule.StartState.Orbital | ||
| + | PartModule.StartState.PreLaunch | ||
| + | PartModule.StartState.Splashed | ||
| + | PartModule.StartState.SubOrbital | ||
Revision as of 21:49, 27 April 2013
Contents
PartModule Class
| Inherits | Implements |
|---|---|
|
The PartModule class allows you to override its functions to intuitively control your parts.
The properties of this class have not been added.
Example
Called during the main menu loading stage.
using System; using UnityEngine; public class RandomPart : PartModule { public override void OnAwake() { Debug.Log("Hello World"); } }
Fields
The following is a list of fields in PartModule.
| Signature | Description |
|---|---|
| ProtoPartModuleSnapshot snapshot | Unknown |
| string moduleName | The modules name |
| bool isEnabled | The part state. |
Methods
The following are methods included in PartModule.
| Signature | Description |
|---|---|
| void OnStart(PartModule.StartState state) | Called during the part startup. |
| void OnUpdate() | Called when OnUpdate is called on the part. |
| void OnAwake() | Called when the part is loaded, this can be more than once. |
| void OnFixedUpdate() | Per-PhysX frame update, Called only when the part is active! |
| void OnActive() | Called when the part is active. |
| void OnInactive() | Get the part information. |
| void OnLoad(ConfigNode node) | Called when the object is loaded from a save. |
| void OnSave(ConfigNode node) | Called when the object is saved. |
| string GetInfo() | Returns the part information. |
|-
| StartState
| Enum template: values parameter missing
PartModule.StartState.Docked
PartModule.StartState.Editor
PartModule.StartState.Flying
PartModule.StartState.Landed
PartModule.StartState.None
PartModule.StartState.Orbital
PartModule.StartState.PreLaunch
PartModule.StartState.Splashed
PartModule.StartState.SubOrbital
