Difference between revisions of "API:PartModule"

Revision as of 19:25, 24 April 2013

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");
	}
}

The following is a list of publically-accessible fields in PartModule. This includes protected items, which can be accessed by subclasses.

Signature	Description
`ProtoPartModuleSnapshot snapshot`	Unknown
`string moduleName`	The modules name
`bool isEnabled`	Set the part state.

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( during the main menu. )
`void OnFixedUpdate()`	Per-PhysX frame update, Called only when the part is active!
`void OnActive()`	Unknown
`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()`	Get the part information.

@@ Line 35: / Line 35: @@
 |name=isEnabled
 |type=bool
-|desc=is the part enabled?
+|desc=Set the part state.
 }}
 {{FieldsEnd}}