General overview of custom modules - Revision history

KiwiShark: 5 revisions imported

2024-10-09T16:46:05Z

5 revisions imported

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

Spacewarp>Falki: Clarified the distinction between PartBehaviourModule and PartComponentModule

2024-01-26T15:46:21Z

Clarified the distinction between PartBehaviourModule and PartComponentModule

← Older revision		Revision as of 17:46, 26 January 2024
Line 34:		Line 34:

	* base class that's responsible for how a part behaves, what happens when a button is pushed, what is displayed in PAM (in Flight and OAB), what happens on a game tick update		* base class that's responsible for how a part behaves, what happens when a button is pushed, what is displayed in PAM (in Flight and OAB), what happens on a game tick update
			* this class exists only when the vessel is loaded (i.e. player is directly controlling the vessel)
	* use it for immediate frontend logic - player enables the module, engines change their modes, entries in PAM need to be shown/hidden, etc.		* use it for immediate frontend logic - player enables the module, engines change their modes, entries in PAM need to be shown/hidden, etc.

Line 40:		Line 41:
	* base class used mostly for background/backend Module logic, things that aren't directly connected to PAM		* base class used mostly for background/backend Module logic, things that aren't directly connected to PAM
	* example of backend logic: Orbital Survey initiates scans if the conditions are right		* example of backend logic: Orbital Survey initiates scans if the conditions are right
	* use it ~~also~~ for things that continually need to run in background - e.g. life support consumption on game ticks, continuous scanning while the vessel is unloaded, EC collection for solar panels, etc.		* class is instantiated when the part is first placed in the OAB and it continues to exist until the part is destroyed. Update loops are being executed even on unloaded vessels
			* use it for things that continually need to run in background - e.g. life support consumption on game ticks, continuous scanning while the vessel is unloaded, EC collection for solar panels, etc.

	You're free to define your own logic inside these classes, of course, but it's always good to follow established conventions as much as possible.		You're free to define your own logic inside these classes, of course, but it's always good to follow established conventions as much as possible.

Spacewarp>Falki: set sorting

2024-01-11T17:47:49Z

set sorting

← Older revision		Revision as of 19:47, 11 January 2024
Line 72:		Line 72:
	* KLSS: https://github.com/Safarte/KerbalLifeSupportSystem/tree/main/plugin_template/patches		* KLSS: https://github.com/Safarte/KerbalLifeSupportSystem/tree/main/plugin_template/patches
	* Orbital Survey: https://github.com/Falki-git/OrbitalSurvey/tree/master/plugin_template/patches		* Orbital Survey: https://github.com/Falki-git/OrbitalSurvey/tree/master/plugin_template/patches
			{{DEFAULTSORT:1_General_overview_of_custom_modules}}

Spacewarp>Falki: Add page contents

2024-01-11T17:43:16Z

Add page contents

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

			== What are Modules? ==
			Each part in the game has one or more Modules attached to it. Purpose of a Module is to provide a functionality to a part.

			Some examples are:

			* <code>Module_Deployable</code> - adds deploy functionality (landing legs, antennae...)
			* <code>Module_DataTransmitter</code> - adds connection and data transmittance functionality (capsules, antennae...)
			* <code>Module_Color</code> - adds ability to color a part (base color, accent color)
			* <code>Module_Engine</code> - adds engine functionality (thrust, throttle, ISP, propellant requests...)

			All stock Module definitions can be found inside the game's <code>Assembly-CSharp.dll</code> under namespaces: <code>KSP.Modules</code> (ModuleData and PartBehaviourModule) and <code>KSP.Sim.impl</code> (PartComponentModule)

			== What are Custom Modules? ==
			Custom Modules are Modules that we modders can create and attach to a part to give it some custom functionality.

			Some examples are:

			* <code>Module_LifeSupportConsumer</code> - mod: KerbalLifeSupportSystem - provides life support consumption (oxygen, water, food) to parts with crew capacity
			* <code>Module_OrbitalSurvey</code> - mod: Orbital Survey - provides scanning functionality to parts with a Module_DataTransmitter module (antennae)

			== Anatomy of a Module ==
			Modules have 3 basic components, C# classes that inherit from a base class.

			<code>ModuleData</code>

			* base class whose function is to define and maintain data used by the Module
			* data is stored either in save game files ([KSPState] attribute) or in part definition json ([KSPDefinition] attribute) or persists only during runtime
			* some examples of data stored in ModuleData: CurrentDeployState (state of deployment for the part), IsTransmitting (is part currently transmitting or not), thrustPercentage (at what percentage is the thrust currently at for this engine)
			* use it to store data that other components will use or that will be displayed in PAM or OAB/R&D

			<code>PartBehaviourModule</code>

			* base class that's responsible for how a part behaves, what happens when a button is pushed, what is displayed in PAM (in Flight and OAB), what happens on a game tick update
			* use it for immediate frontend logic - player enables the module, engines change their modes, entries in PAM need to be shown/hidden, etc.

			<code>PartComponentModule</code>

			* base class used mostly for background/backend Module logic, things that aren't directly connected to PAM
			* example of backend logic: Orbital Survey initiates scans if the conditions are right
			* use it also for things that continually need to run in background - e.g. life support consumption on game ticks, continuous scanning while the vessel is unloaded, EC collection for solar panels, etc.

			You're free to define your own logic inside these classes, of course, but it's always good to follow established conventions as much as possible.

			== Attaching a Custom Module to a part ==
			To define and add your Custom Module to parts there are 2 things you need to do.

			# In your C# plugin define your classes that derive from <code>ModuleData</code>, <code>PartBehaviourModule</code> and <code>PartComponentModule</code> classes
			# Use the '''Patch Manager''' mod to inject your Custom Module to parts you want.

			== Patch Manager ==
			Think of Patch Manager as a successor to Module Manager from KSP1. You define patches in a text file with a <code>.patch</code> extension that you place somewhere in your plugin folder structure.

			Here's a rudimentary example of a Custom Module being injected to all parts.

			<code>MyCustomModule.patch</code>:
			:parts {
			+Module_MyCustomModule {
			+Data_MyCustomModule {
			}
			}
			}
			With Patch Manager installed this patch will add your <code>MyCustomModule</code> to all parts in the game (don't do this :)).

			You can get Patch Manager either with CKAN or download it from here: https://spacedock.info/mod/3482/Patch%20Manager

			For an in-depth walkthrough of Patch Manager functionalities, syntax, best practices and more sensible examples of Custom Module patches refer to Patch Manager documentation: https://pm.kerbal.wiki/

			Some examples for custom module patches:

			* KLSS: https://github.com/Safarte/KerbalLifeSupportSystem/tree/main/plugin_template/patches
			* Orbital Survey: https://github.com/Falki-git/OrbitalSurvey/tree/master/plugin_template/patches

Spacewarp>Munix at 17:26, 11 January 2024

2024-01-11T17:26:02Z

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

Spacewarp>Falki: What's a module, what's a custom module, what does it consist of

2024-01-11T17:06:52Z

What's a module, what's a custom module, what does it consist of

New page