Difference between revisions of "API:PartModule"

From Kerbal Space Program Wiki
Jump to: navigation, search
Line 20: Line 20:
 
}
 
}
 
</syntaxhighlight>
 
</syntaxhighlight>
{{Properties|
+
{{Properties|properties=
 
{{Property
 
{{Property
 
   |type=BaseActionList
 
   |type=BaseActionList

Revision as of 22:33, 16 October 2015

PartModule Class

Inherits Implements
MonoBehaviour

    The PartModule class allows you to override its functions to intuitively control your parts.

    Example

    Called during the main menu loading stage.

    using System;
    using UnityEngine;
     
    public class RandomPart : PartModule
    {
    	public override void OnAwake()
    	{
    		Debug.Log("Hello World");
    	}
    }

    Properties

    The following is a list of properties in PartModule.

    Name Description
    BaseActionList Actions { get; }  ?
    int ClassID { get; }  ?
    string ClassName { get; }  ?
    BaseEventList Events { get; }  ?
    BaseFieldList Fields { get; }  ?
    string GUIName { get; }  ?
    Part part { get; set; }  ?
    Vessel vessel { get; }  ?

    Fields

    The following is a list of fields in PartModule.

    Signature Description
    bool isEnabled The part state.
    string moduleName The module's name.
    ProtoPartModuleSnapshot snapshot  ?

    Methods

    The following are methods included in PartModule.

    Signature Description
    constructor PartModule()  ?
    virtual string GetInfo() Returns the part information displayed in the part list mouse-over information box.
    void Load(ConfigNode node)  ?
    virtual void OnActive() Called when the part is active.
    virtual void OnAwake() Called when the part is loaded, this can be more than once.
    virtual void OnFixedUpdate() Per-PhysX frame update, Called only when the part is active!
    virtual void OnInactive() Get the part information.
    virtual void OnInitialize()  ?
    virtual void OnLoad(ConfigNode node) Called when the object is loaded from a save.
    virtual void OnSave(ConfigNode node) Called when the object is saved.
    virtual void OnStart(StartState state) Called during the part startup.
    virtual void OnUpdate() Called when OnUpdate is called on the part.
    void Save(ConfigNode node)  ?

    Enumerations

    The following is a list of enumerations in PartModule.

    Name Values
    StartState None
    Editor
    PreLaunch
    Landed = 4
    Docked = 8
    Flying = 16
    Splashed = 32
    SubOrbital = 64
    Orbital = 128