Keen:Power Providers - Revision history

CptTwinkie at 20:29, 18 July 2022

2022-07-18T20:29:13Z

← Older revision		Revision as of 20:29, 18 July 2022
Line 12:		Line 12:
	The usage is very simple: there are components that implement <code>IMyPowerProvider</code> and other components, which ask for components that implement <code>IMyPowerProvider</code>. This makes it very easy to expand the power system, and very easy to plug in new power providers, just by making them implement this interface:		The usage is very simple: there are components that implement <code>IMyPowerProvider</code> and other components, which ask for components that implement <code>IMyPowerProvider</code>. This makes it very easy to expand the power system, and very easy to plug in new power providers, just by making them implement this interface:

	<~~source~~ lang="csharp">		<syntaxhighlight lang="csharp" line>
	public interface IMyPowerProvider		public interface IMyPowerProvider
	{		{
Line 24:		Line 24:
	void TryStop();		void TryStop();
	}		}
	</~~source~~>		</syntaxhighlight>

	'''IsPowered:''' this should return whether or not the component is currently supplying power.		'''IsPowered:''' this should return whether or not the component is currently supplying power.
Line 46:		Line 46:

	===Definition===		===Definition===
	<~~source~~ lang="xml">		<syntaxhighlight lang="xml" line>
	<Definition xsi:type="MyObjectBuilder_FuelComponentDefinition">		<Definition xsi:type="MyObjectBuilder_FuelComponentDefinition">
	<Id Type="FuelComponent" Subtype="Compost"/>		<Id Type="FuelComponent" Subtype="Compost"/>
Line 65:		Line 65:
	</FuelTimes>		</FuelTimes>
	</Definition>		</Definition>
	</~~source~~>		</syntaxhighlight>

	'''Id:''' mandatory field, the type for this component is FuelComponent.		'''Id:''' mandatory field, the type for this component is FuelComponent.
Line 91:		Line 91:

	The following events can be hooked into by scripts:		The following events can be hooked into by scripts:
	<~~source~~ lang="csharp">		<syntaxhighlight lang="csharp" line>
	public event Action<MyFuelComponent> TurnedOn;		public event Action<MyFuelComponent> TurnedOn;
	public event Action<MyFuelComponent> TurnedOff;		public event Action<MyFuelComponent> TurnedOff;
	public event Action<MyFuelComponent> FuelConsumed;		public event Action<MyFuelComponent> FuelConsumed;
	public event Action<MyFuelComponent> MissingFuel;		public event Action<MyFuelComponent> MissingFuel;
	</~~source~~>		</syntaxhighlight>

	*'''TurnedOn:''' fired when the component is turned on and starts providing power.		*'''TurnedOn:''' fired when the component is turned on and starts providing power.
Line 106:		Line 106:
	'''Properties:'''		'''Properties:'''

	<~~source~~ lang="csharp">		<syntaxhighlight lang="csharp" line>
	public bool Enabled { get; private set; }		public bool Enabled { get; private set; }

Line 116:		Line 116:

	public float MaxFuelTime;		public float MaxFuelTime;
	</~~source~~>		</syntaxhighlight>

	*'''Enabled:''' whether or not this component is turned on (and providing power).		*'''Enabled:''' whether or not this component is turned on (and providing power).
Line 126:		Line 126:

	'''Methods:'''		'''Methods:'''
	<~~source~~ lang="csharp">		<syntaxhighlight lang="csharp" line>
	public void TurnOn();		public void TurnOn();

Line 132:		Line 132:

	public long GetFuelTime(MyDefinitionId id);		public long GetFuelTime(MyDefinitionId id);
	</~~source~~>		</syntaxhighlight>

	*'''TurnOn():''' tries to start the fuel component. Equivalent to calling <code>IMyPowerProvier.TryStart()</code>.		*'''TurnOn():''' tries to start the fuel component. Equivalent to calling <code>IMyPowerProvier.TryStart()</code>.

CptTwinkie at 12:51, 7 July 2018

2018-07-07T12:51:25Z

← Older revision		Revision as of 12:51, 7 July 2018
Line 1:		Line 1:
	{{SEO\|image_url=http://www.medievalengineerswiki.com/images/e/eb/~~KeenLogo~~.png\|description=Some systems in the game need power to operate, and some other systems are capable of providing power. Power types in the game can be divided into two categories - physical power and other types of power.}}		{{SEO\|image_url=http://www.medievalengineerswiki.com/images/b/b7/KeenLogoBig.png\|description=Some systems in the game need power to operate, and some other systems are capable of providing power. Power types in the game can be divided into two categories - physical power and other types of power.}}
	{{Keen:OCH}}		{{Keen:OCH}}

CptTwinkie at 12:32, 7 July 2018

2018-07-07T12:32:36Z

← Older revision		Revision as of 12:32, 7 July 2018
Line 1:		Line 1:
	{{SEO\|image_url=http://www.medievalengineerswiki.com/images/e/e6/~~KEEN_COMPASS_ONLY~~.png\|description=Some systems in the game need power to operate, and some other systems are capable of providing power. Power types in the game can be divided into two categories - physical power and other types of power.}}		{{SEO\|image_url=http://www.medievalengineerswiki.com/images/e/eb/KeenLogo.png\|description=Some systems in the game need power to operate, and some other systems are capable of providing power. Power types in the game can be divided into two categories - physical power and other types of power.}}
	{{Keen:OCH}}		{{Keen:OCH}}

CptTwinkie at 10:54, 29 June 2018

2018-06-29T10:54:06Z

← Older revision		Revision as of 10:54, 29 June 2018
Line 1:		Line 1:
	{{SEO\|image_url=http://www.medievalengineerswiki.com/images/e/e6/KEEN_COMPASS_ONLY.png\|description=Some systems in the game need power to operate, and some other systems are capable of providing power. Power types in the game can be divided into two categories - physical power and other types of power.}}		{{SEO\|image_url=http://www.medievalengineerswiki.com/images/e/e6/KEEN_COMPASS_ONLY.png\|description=Some systems in the game need power to operate, and some other systems are capable of providing power. Power types in the game can be divided into two categories - physical power and other types of power.}}
	{{:~~Official Content/~~OCH}}		{{Keen:OCH}}

CptTwinkie: CptTwinkie moved page Official Content/Power Providers to Keen:Power Providers

2018-06-29T10:38:38Z

CptTwinkie moved page Official Content/Power Providers to Keen:Power Providers

← Older revision		Revision as of 10:38, 29 June 2018
(No difference)

CptTwinkie at 10:28, 29 June 2018

2018-06-29T10:28:21Z

← Older revision		Revision as of 10:28, 29 June 2018
Line 140:		Line 140:

	==MyMechanicalSinkComponent==		==MyMechanicalSinkComponent==
	The mechanical sink is a part of the [[~~Official_Content/~~Mechanical_System#MyMechanicalSinkComponent\|mechanical system]] and can also serve as a power provider for other components. Compared to <code>MyFuelComponent</code>, this one is significantly simpler. All this does is consume power from the mechanical system, and serve as a relay, instead of being an actual generator. This means that even its implementation of the <code>IMyPowerProvider</code> interface is very different:		The mechanical sink is a part of the [[Keen:Mechanical_System#MyMechanicalSinkComponent\|mechanical system]] and can also serve as a power provider for other components. Compared to <code>MyFuelComponent</code>, this one is significantly simpler. All this does is consume power from the mechanical system, and serve as a relay, instead of being an actual generator. This means that even its implementation of the <code>IMyPowerProvider</code> interface is very different:

	'''IsPowered:''' returns true of the mechanical system this is attached to is providing power.		'''IsPowered:''' returns true of the mechanical system this is attached to is providing power.
Line 155:		Line 155:

	===Definition===		===Definition===
	The definition does not contain any settings that are related to being a <code>IMyPowerProvider</code>. To see what the definition looks like, please refer to the [[~~Official_Content/~~Mechanical_System#MyMechanicalSinkComponent\|mechanical system]].		The definition does not contain any settings that are related to being a <code>IMyPowerProvider</code>. To see what the definition looks like, please refer to the [[Keen:Mechanical_System#MyMechanicalSinkComponent\|mechanical system]].


	[[Category:Keen_Modding_Guides]]		[[Category:Keen_Modding_Guides]]

CptTwinkie at 21:35, 1 June 2018

2018-06-01T21:35:05Z

← Older revision		Revision as of 21:35, 1 June 2018
Line 1:		Line 1:
			{{SEO\|image_url=http://www.medievalengineerswiki.com/images/e/e6/KEEN_COMPASS_ONLY.png\|description=Some systems in the game need power to operate, and some other systems are capable of providing power. Power types in the game can be divided into two categories - physical power and other types of power.}}
	{{:Official Content/OCH}}		{{:Official Content/OCH}}

CptTwinkie at 15:00, 30 May 2018

2018-05-30T15:00:35Z

← Older revision		Revision as of 15:00, 30 May 2018
Line 1:		Line 1:
			{{:Official Content/OCH}}


	Some systems in the game need power to operate, and some other systems are capable of providing power. Power types in the game can be divided into two categories - physical power and other types of power. Physical power is the one that is generated in the physical game world and is used to power catapults, trebuchets, siege towers, elevators, trains, carts, and various other contraptions. The non-physical power, on the other hand, does not rely on any physical interaction, but rather purely on logic and animations. This guide will talk you through the non-physical power in general, concrete components that use it, and also how to create your own.		Some systems in the game need power to operate, and some other systems are capable of providing power. Power types in the game can be divided into two categories - physical power and other types of power. Physical power is the one that is generated in the physical game world and is used to power catapults, trebuchets, siege towers, elevators, trains, carts, and various other contraptions. The non-physical power, on the other hand, does not rely on any physical interaction, but rather purely on logic and animations. This guide will talk you through the non-physical power in general, concrete components that use it, and also how to create your own.

CptTwinkie: /* MyMechanicalSinkComponent */

2018-04-12T20:17:34Z

MyMechanicalSinkComponent

← Older revision		Revision as of 20:17, 12 April 2018
Line 151:		Line 151:

	===Definition===		===Definition===
	The definition does not contain any settings that are related to being a <code>IMyPowerProvider</code>. To see what the definition looks like, please refer to the [[Official_Content/Mechanical_System\|mechanical system]].		The definition does not contain any settings that are related to being a <code>IMyPowerProvider</code>. To see what the definition looks like, please refer to the [[Official_Content/Mechanical_System#MyMechanicalSinkComponent\|mechanical system]].


	[[Category:Keen_Modding_Guides]]		[[Category:Keen_Modding_Guides]]

CptTwinkie: /* MyMechanicalSinkComponent */

2018-04-12T20:16:56Z

MyMechanicalSinkComponent

← Older revision		Revision as of 20:16, 12 April 2018
Line 136:		Line 136:

	==MyMechanicalSinkComponent==		==MyMechanicalSinkComponent==
	The mechanical sink is a part of the [[Official_Content/Mechanical_System\|mechanical system]] and can also serve as a power provider for other components. Compared to <code>MyFuelComponent</code>, this one is significantly simpler. All this does is consume power from the mechanical system, and serve as a relay, instead of being an actual generator. This means that even its implementation of the <code>IMyPowerProvider</code> interface is very different:		The mechanical sink is a part of the [[Official_Content/Mechanical_System#MyMechanicalSinkComponent\|mechanical system]] and can also serve as a power provider for other components. Compared to <code>MyFuelComponent</code>, this one is significantly simpler. All this does is consume power from the mechanical system, and serve as a relay, instead of being an actual generator. This means that even its implementation of the <code>IMyPowerProvider</code> interface is very different:

	'''IsPowered:''' returns true of the mechanical system this is attached to is providing power.		'''IsPowered:''' returns true of the mechanical system this is attached to is providing power.