Difference between revisions of "API:PartModule"

Revision as of 12:25, 13 February 2015

The PartModule consits of two types:

Inherits	Implements
MonoBehaviour

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

The properties of this class have not been added.

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 fields in PartModule.

Signature	Description
`ProtoPartModuleSnapshot snapshot`	Unknown
`string moduleName`	The modules name
`bool isEnabled`	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, 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 displayed in the part list mouse-over information box.

@@ Line 100: / Line 100: @@
 |name=GetInfo
 |returntype=string
-|desc=Returns the part information.
+|desc=Returns the part information displayed in the part list mouse-over information box.
 }}
 }}
 [[Category:Community API Documentation]]