Difference between revisions of "User:Glyph/sandbox2"

From Kerbal Space Program Wiki
Jump to: navigation, search
(Created page with "{{Enums| {{Enum |name=PartModule.StartState |values=An enum that determines what game state a part starts in. Implemented in PartModule. }} }} {{Fields| {{...")
 
Line 1: Line 1:
{{Enums|
+
<!-- Class tables autogenerated by Glyph's kerbal_wiki_pdoc program for KSP 1.04. Using syntax set up for the wiki by N3X15, format from DOCTOOLS (I'm not clear if DOCTOOLS is the script used to generate N3X15's old version of these tables, or some mediawiki thing). -->
{{Enum
+
{{Class
|name=PartModule.StartState
+
  |inherits={{Type|MonoBehaviour}}
|values=An enum that determines what game state a part starts in. Implemented in [[API:PartModule|PartModule]].
+
  |implements=<ul></ul>
 +
  |name=PartModule
 +
  |summary=
 +
}}
 +
 
 +
{{Properties|
 +
{{Property
 +
  |type=BaseActionList
 +
  |name=Actions
 +
  |desc=?
 +
  |hasget=1
 +
  |hasset=
 +
}}
 +
{{Property
 +
  |type=int
 +
  |name=ClassID
 +
  |desc=?
 +
  |hasget=1
 +
  |hasset=
 +
}}
 +
{{Property
 +
  |type=string
 +
  |name=ClassName
 +
  |desc=?
 +
  |hasget=1
 +
  |hasset=
 +
}}
 +
{{Property
 +
  |type=BaseEventList
 +
  |name=Events
 +
  |desc=?
 +
  |hasget=1
 +
  |hasset=
 +
}}
 +
{{Property
 +
  |type=BaseFieldList
 +
  |name=Fields
 +
  |desc=?
 +
  |hasget=1
 +
  |hasset=
 +
}}
 +
{{Property
 +
  |type=string
 +
  |name=GUIName
 +
  |desc=?
 +
  |hasget=1
 +
  |hasset=
 +
}}
 +
{{Property
 +
  |type=Part
 +
  |name=part
 +
  |desc=?
 +
  |hasget=1
 +
  |hasset=1
 +
}}
 +
{{Property
 +
  |type=Vessel
 +
  |name=vessel
 +
  |desc=?
 +
  |hasget=1
 +
  |hasset=
 
}}
 
}}
 
}}
 
}}
Line 8: Line 68:
 
{{Fields|
 
{{Fields|
 
{{Field
 
{{Field
|name=Docked
+
  |type=bool
|type=PartModule.StartState
+
  |name=isEnabled
|desc=Part started while docked.
+
  |desc=?
 +
}}
 +
{{Field
 +
  |type=string
 +
  |name=moduleName
 +
  |desc=?
 +
}}
 +
{{Field
 +
  |type=ProtoPartModuleSnapshot
 +
  |name=snapshot
 +
  |desc=?
 
}}
 
}}
 
}}
 
}}
  
[[Category:Community API Documentation]]
+
{{Methods|
 +
{{Method
 +
  |returntype=constructor
 +
  |returndesc=
 +
  |name=PartModule
 +
  |args=
 +
  |desc=?
 +
}}
 +
{{Method
 +
  |returntype=virtual string
 +
  |returndesc=
 +
  |name=GetInfo
 +
  |args=
 +
  |desc=?
 +
}}
 +
{{Method
 +
  |returntype=void
 +
  |returndesc=
 +
  |name=Load
 +
  |args={{arg|ConfigNode|node}}
 +
  |desc=?
 +
}}
 +
{{Method
 +
  |returntype=virtual void
 +
  |returndesc=
 +
  |name=OnActive
 +
  |args=
 +
  |desc=?
 +
}}
 +
{{Method
 +
  |returntype=virtual void
 +
  |returndesc=
 +
  |name=OnAwake
 +
  |args=
 +
  |desc=?
 +
}}
 +
{{Method
 +
  |returntype=virtual void
 +
  |returndesc=
 +
  |name=OnFixedUpdate
 +
  |args=
 +
  |desc=?
 +
}}
 +
{{Method
 +
  |returntype=virtual void
 +
  |returndesc=
 +
  |name=OnInactive
 +
  |args=
 +
  |desc=?
 +
}}
 +
{{Method
 +
  |returntype=virtual void
 +
  |returndesc=
 +
  |name=OnInitialize
 +
  |args=
 +
  |desc=?
 +
}}
 +
{{Method
 +
  |returntype=virtual void
 +
  |returndesc=
 +
  |name=OnLoad
 +
  |args={{arg|ConfigNode|node}}
 +
  |desc=?
 +
}}
 +
{{Method
 +
  |returntype=virtual void
 +
  |returndesc=
 +
  |name=OnSave
 +
  |args={{arg|ConfigNode|node}}
 +
  |desc=?
 +
}}
 +
{{Method
 +
  |returntype=virtual void
 +
  |returndesc=
 +
  |name=OnStart
 +
  |args={{arg|StartState|state}}
 +
  |desc=?
 +
}}
 +
{{Method
 +
  |returntype=virtual void
 +
  |returndesc=
 +
  |name=OnUpdate
 +
  |args=
 +
  |desc=?
 +
}}
 +
{{Method
 +
  |returntype=void
 +
  |returndesc=
 +
  |name=Save
 +
  |args={{arg|ConfigNode|node}}
 +
  |desc=?
 +
}}
 +
}}
 +
{{Enums|
 +
{{Enum
 +
  |name=StartState
 +
  |values={ None, Editor, PreLaunch, Landed = 4, Docked = 8, Flying = 16, Splashed = 32, SubOrbital = 64, Orbital = 128 }
 +
}}
 +
}}

Revision as of 19:50, 13 October 2015

PartModule Class

Inherits Implements
MonoBehaviour

    Properties

    The following is a list of properties in Glyph/sandbox2.

    Name Description

    {{{properties}}}

    Fields

    The following is a list of fields in Glyph/sandbox2.

    Signature Description
    bool isEnabled  ?
    string moduleName  ?
    ProtoPartModuleSnapshot snapshot  ?

    Methods

    The following are methods included in Glyph/sandbox2.

    Signature Description
    constructor PartModule()  ?
    virtual string GetInfo()  ?
    void Load(ConfigNode node)  ?
    virtual void OnActive()  ?
    virtual void OnAwake()  ?
    virtual void OnFixedUpdate()  ?
    virtual void OnInactive()  ?
    virtual void OnInitialize()  ?
    virtual void OnLoad(ConfigNode node)  ?
    virtual void OnSave(ConfigNode node)  ?
    virtual void OnStart(StartState state)  ?
    virtual void OnUpdate()  ?
    void Save(ConfigNode node)  ?

    Enumerations

    The following is a list of enumerations in Glyph/sandbox2.

    Name Values

    {{{enums}}}