Class descriptions for custom modules - Revision history

Dandoesstuff: With the release of Redux, PartComponentModules need to be registered for updates. I made sure to document this here.

2025-11-15T09:30:56Z

With the release of Redux, PartComponentModules need to be registered for updates. I made sure to document this here.

← Older revision		Revision as of 11:30, 15 November 2025
Line 12:		Line 12:
	{ .. }		{ .. }

	=== Set your ~~ParthBehaviourModule~~ type reference ===		=== Set your PartBehaviourModule type reference ===
	public override Type ModuleType => typeof(Module_MyCustomModule);		public override Type ModuleType => typeof(Module_MyCustomModule);

Line 279:		Line 279:
	public override void OnStart(double universalTime)		public override void OnStart(double universalTime)
	{		{

	// set a reference to the Data class		// set a reference to the Data class
	if (!DataModules.TryGetByType<Data_MyCustomModule>(out _dataMyCustomModule))		if (!DataModules.TryGetByType<Data_MyCustomModule>(out _dataMyCustomModule))
Line 285:		Line 286:
	return;		return;
	}		}
			Part.RegisterModuleForUpdates(this) // Register module for updates. Make sure to unregister when the part is being shut down!
	// initialize resource requests		// initialize resource requests
	_dataMyCustomModule.SetupResourceRequest(base.resourceFlowRequestBroker);		_dataMyCustomModule.SetupResourceRequest(base.resourceFlowRequestBroker);
Line 295:		Line 296:
	* once the vessel is in Flight, it will always trigger, in any view, until the part is destroyed/recovered		* once the vessel is in Flight, it will always trigger, in any view, until the part is destroyed/recovered
	* use this for tasks that need to continually run, even when vessel is unloaded. Be careful not to put expensive tasks here.		* use this for tasks that need to continually run, even when vessel is unloaded. Be careful not to put expensive tasks here.
			* NOTE: With the release of Redux you must register the part module for updates. This is to improve performance. Register it on OnStart() and unregister it on OnShutdown(), or when appropriate for your part module.

	public override void OnUpdate(double universalTime, double deltaUniversalTime)		public override void OnUpdate(double universalTime, double deltaUniversalTime)

KiwiShark: 6 revisions imported

2024-10-09T16:46:05Z

6 revisions imported

← Older revision		Revision as of 18:46, 9 October 2024
(No difference)

Spacewarp>Falki: Additional clarification that PartBehaviour is only for loaded vessels

2024-01-26T16:01:41Z

Additional clarification that PartBehaviour is only for loaded vessels

← Older revision		Revision as of 18:01, 26 January 2024
Line 201:		Line 201:
	{ /* do stuff here */}		{ /* do stuff here */}

	=== FixedUpdate loop - Flight ===		=== FixedUpdate loop - Flight/Map ===

	* define stuff that needs to be executed continuously on every FixedUpdate loop. Be careful not to do expensive stuff here		* define stuff that needs to be executed continuously on every FixedUpdate loop. Be careful not to do expensive stuff here
	* this triggers in Flight view only		* this triggers when the vessel is loaded, in Flight/Map view only

	// This triggers in flight		// This triggers in flight
Line 223:		Line 223:

	* similar to FixedUpdate, but this is a regular Update loop independent of game time		* similar to FixedUpdate, but this is a regular Update loop independent of game time
	* this triggers in Flight and in OAB		* this triggers in Flight/Map when the vessel is loaded and in OAB when the part is attached to the assembly

	public override void OnUpdate(float deltaTime)		public override void OnUpdate(float deltaTime)
Line 255:		Line 255:
	=== OnEnable ===		=== OnEnable ===

	* triggers when Flight view is loaded and in OAB when part is added to the assembly		* triggers when Flight view is loaded (only for the loaded vessel) and in OAB when part is added to the assembly

	protected void OnEnable()		protected void OnEnable()

Spacewarp>Falki: Formatting

2024-01-11T18:36:43Z

Formatting

← Older revision		Revision as of 20:36, 11 January 2024
Line 5:		Line 5:
	While you're mostly free to define how your classes would be set up, there are some guidelines that need to be followed, restrictions to be aware of and inner workings to understand.		While you're mostly free to define how your classes would be set up, there are some guidelines that need to be followed, restrictions to be aware of and inner workings to understand.

	== # Data class ==		== Data class ==

	=== ## Defining your class ===		=== Defining your class ===
	[Serializable]		[Serializable]
	public class Data_MyCustomModule : ModuleData		public class Data_MyCustomModule : ModuleData
	{ .. }		{ .. }

	=== ## Set your ParthBehaviourModule type reference ===		=== Set your ParthBehaviourModule type reference ===
	public override Type ModuleType => typeof(Module_MyCustomModule);		public override Type ModuleType => typeof(Module_MyCustomModule);

	=== ## Defining module properties ===		=== Defining module properties ===

	* these are entries shown in the PAM		* these are entries shown in the PAM
Line 43:		Line 43:
	public ModuleProperty<float> SomeEditableProperty = new (1f, false, val => $"{val:N0}°"); // initial value, isReadOnly, ToStringDelegate		public ModuleProperty<float> SomeEditableProperty = new (1f, false, val => $"{val:N0}°"); // initial value, isReadOnly, ToStringDelegate

	=== ## Defining a dropdown list property ===		=== Defining a dropdown list property ===

	* dropdown list properties are string properties for which you define dropdown values in OnPartBehaviourModuleInit()		* dropdown list properties are string properties for which you define dropdown values in OnPartBehaviourModuleInit()
Line 59:		Line 59:
	}		}

	=== ## OnPartBehaviourModuleInit() ===		=== OnPartBehaviourModuleInit() ===

	* runs when this module is initialized when entering Flight/OAB state		* runs when this module is initialized when entering Flight/OAB state
Line 66:		Line 66:
	{ /* use this to initialize some values for your module, if needed */ }		{ /* use this to initialize some values for your module, if needed */ }

	=== ## OAB module description ===		=== OAB module description ===

	* set the description of your module for all parts it’s being attached to		* set the description of your module for all parts it’s being attached to
Line 114:		Line 114:
	}		}

	=== ## Setting up resource consumptions ===		=== Setting up resource consumptions ===

	* Note: trigger this from OnStart() in the Part Component class		* Note: trigger this from OnStart() in the Part Component class
Line 151:		Line 151:


	== # Part Behaviour class ==		== Part Behaviour class ==

	=== ## Defining your class ===		=== Defining your class ===
	[DisallowMultipleComponent]		[DisallowMultipleComponent]
	public class Module_OrbitalSurvey : PartBehaviourModule		public class Module_OrbitalSurvey : PartBehaviourModule
	{ .. }		{ .. }

	=== ## Set your PartComponentModule type reference ===		=== Set your PartComponentModule type reference ===
	public override Type PartComponentModuleType => typeof(PartComponentModule_MyCustomModule);		public override Type PartComponentModuleType => typeof(PartComponentModule_MyCustomModule);

	=== ## Create Data module instance ===		=== Create Data module instance ===
	[SerializeField]		[SerializeField]
	protected Data_MyCustomModule _dataMyCustomModule;		protected Data_MyCustomModule _dataMyCustomModule;
Line 172:		Line 172:
	}		}

	=== ## Initialize the module behaviour ===		=== Initialize the module behaviour ===
	private ModuleAction _myCustomAction;		private ModuleAction _myCustomAction;

Line 201:		Line 201:
	{ /* do stuff here */}		{ /* do stuff here */}

	=== ## FixedUpdate loop - Flight ===		=== FixedUpdate loop - Flight ===

	* define stuff that needs to be executed continuously on every FixedUpdate loop. Be careful not to do expensive stuff here		* define stuff that needs to be executed continuously on every FixedUpdate loop. Be careful not to do expensive stuff here
Line 220:		Line 220:
	}		}

	=== ## Update loop ===		=== Update loop ===

	* similar to FixedUpdate, but this is a regular Update loop independent of game time		* similar to FixedUpdate, but this is a regular Update loop independent of game time
Line 228:		Line 228:
	{ .. }		{ .. }

	=== ## FixedUpdate loop - OAB ===		=== FixedUpdate loop - OAB ===

	* same as OnModuleFixedUpdate but it triggers only in OAB		* same as OnModuleFixedUpdate but it triggers only in OAB
Line 235:		Line 235:
	{ .. }		{ .. }

	=== ## Define behaviour when the behaviour module instance will be destroyed ===		=== Define behaviour when the behaviour module instance will be destroyed ===

	* cases: exiting Flight view, part has been destroyed, exiting the game		* cases: exiting Flight view, part has been destroyed, exiting the game
Line 245:		Line 245:
	}		}

	=== ## Setting visibility for PAM properties ===		=== Setting visibility for PAM properties ===
	private void UpdateFlightPAMVisibility(bool state)		private void UpdateFlightPAMVisibility(bool state)
	{		{
Line 253:		Line 253:
	}		}

	=== ## OnEnable ===		=== OnEnable ===

	* triggers when Flight view is loaded and in OAB when part is added to the assembly		* triggers when Flight view is loaded and in OAB when part is added to the assembly
Line 260:		Line 260:
	{ .. }		{ .. }

	== # Part Component class ==		== Part Component class ==

	=== ## Defining your class ===		=== Defining your class ===
	public class PartComponentModule_MyCustomModule : PartBehaviourModule		public class PartComponentModule_MyCustomModule : PartBehaviourModule
	{ .. }		{ .. }

	=== ## Set your PartBehaviourModule type reference ===		=== Set your PartBehaviourModule type reference ===
	public override Type PartComponentModuleType => typeof(PartComponentModule_MyCustomModule);		public override Type PartComponentModuleType => typeof(PartComponentModule_MyCustomModule);

	=== ## OnStart(double universalTime) ===		=== OnStart(double universalTime) ===

	* for new vessels this will run when the Flight view is loaded		* for new vessels this will run when the Flight view is loaded
Line 290:		Line 290:
	}		}

	=== ## OnUpdate ===		=== OnUpdate ===

	* this starts triggering when the vessel is first placed in Flight. Doesn't trigger in the OAB before that		* this starts triggering when the vessel is first placed in Flight. Doesn't trigger in the OAB before that
Line 302:		Line 302:
	}		}

	=== ## Resource consumption ===		=== Resource consumption ===
	private void ResourceConsumptionUpdate(double deltaTime)		private void ResourceConsumptionUpdate(double deltaTime)
	{		{
Line 352:		Line 352:
	}		}

	=== ## OnShutdown ===		=== OnShutdown ===

	* define behaviour when the Part Component instance will be destroyed		* define behaviour when the Part Component instance will be destroyed

Spacewarp>Falki: Add page contents

2024-01-11T18:34:00Z

Add page contents

Show changes

Spacewarp>Falki: set sorting

2024-01-11T17:47:15Z

set sorting

← Older revision		Revision as of 19:47, 11 January 2024
Line 1:		Line 1:
	[[Category:Custom Modules]]		[[Category:Custom Modules]]

			{{DEFAULTSORT:2_Class_descriptions_for_custom_modules}}

Spacewarp>Falki: Add the page to the category

2024-01-11T17:46:07Z

Add the page to the category

← Older revision	Revision as of 19:46, 11 January 2024
Line 1:	Line 1:
		[[Category:Custom Modules]]

Spacewarp>Falki: HowTo for Data, PartBehaviour and PartComponent classes

2024-01-11T17:45:38Z

HowTo for Data, PartBehaviour and PartComponent classes

New page