Keen:New Component Modding Guide - Revision history

CptTwinkie at 20:22, 18 July 2022

2022-07-18T20:22:05Z

← Older revision		Revision as of 20:22, 18 July 2022
Line 13:		Line 13:
	===MyEntityFXComponent===		===MyEntityFXComponent===
	The Entity FX component provides light, particle and sound effects to a block. See Data/CubeBlocks/Props/TorchStand.sbc for an example.		The Entity FX component provides light, particle and sound effects to a block. See Data/CubeBlocks/Props/TorchStand.sbc for an example.
	<~~source~~ lang="xml">		<syntaxhighlight lang="xml" line>
	<Definition xsi:type="MyObjectBuilder_EntityFXComponentDefinition">		<Definition xsi:type="MyObjectBuilder_EntityFXComponentDefinition">
	<Id Type="MyObjectBuilder_EntityFXComponent" Subtype="TorchStand" />		<Id Type="MyObjectBuilder_EntityFXComponent" Subtype="TorchStand" />
Line 22:		Line 22:
	</Effects>		</Effects>
	</Definition>		</Definition>
	</~~source~~>		</syntaxhighlight>
	The Effects contains a list of effects, as well as which events toggles them on and off and which dummy they respond to. Finally, they refer to the effect as defined in Data/FX/Effects.sbc.		The Effects contains a list of effects, as well as which events toggles them on and off and which dummy they respond to. Finally, they refer to the effect as defined in Data/FX/Effects.sbc.

Line 28:		Line 28:
	===MotionEventsComponent===		===MotionEventsComponent===
	The MotionEventsComponent is a simple component that can fire events on the entity depending on how fast it is moving. Look at Data/CubeBlocks/Miscellaneous/Projectiles.sbc for an example.		The MotionEventsComponent is a simple component that can fire events on the entity depending on how fast it is moving. Look at Data/CubeBlocks/Miscellaneous/Projectiles.sbc for an example.
	<~~source~~ lang="xml">		<syntaxhighlight lang="xml" line>
	<Definition xsi:type="MyObjectBuilder_MotionEventsComponentDefinition">		<Definition xsi:type="MyObjectBuilder_MotionEventsComponentDefinition">
	<Id Type="MyObjectBuilder_MotionEventsComponent" Subtype="CatapultProjectile"/>		<Id Type="MyObjectBuilder_MotionEventsComponent" Subtype="CatapultProjectile"/>
Line 34:		Line 34:
	<VelocityEvent Speed="20" Threshold="Above" Name="MovingFast"/>		<VelocityEvent Speed="20" Threshold="Above" Name="MovingFast"/>
	</Definition>		</Definition>
	</~~source~~>		</syntaxhighlight>
	Each velocity event checks if the speed goes from either above to below a speed, or from below to above a speed, and then fires the event in Name on the object.		Each velocity event checks if the speed goes from either above to below a speed, or from below to above a speed, and then fires the event in Name on the object.

Line 40:		Line 40:
	===MyCraftingComponentBlock===		===MyCraftingComponentBlock===
	The CraftingComponentBlock component adds crafting functionality to a block that relies on the presence of fuel. This is used for the bonfire and the furnace. See Data/CubeBlocks/Production/Bonfire.sbc for an example.		The CraftingComponentBlock component adds crafting functionality to a block that relies on the presence of fuel. This is used for the bonfire and the furnace. See Data/CubeBlocks/Production/Bonfire.sbc for an example.
	<~~source~~ lang="xml">		<syntaxhighlight lang="xml" line>
	<Definition xsi:type="MyObjectBuilder_CraftingComponentQueuedDefinition">		<Definition xsi:type="MyObjectBuilder_CraftingComponentQueuedDefinition">
	<Id Type="CraftingComponentQueued" Subtype="BonFire"/>		<Id Type="CraftingComponentQueued" Subtype="BonFire"/>
Line 55:		Line 55:
	<PowerRequired>All</PowerRequired>		<PowerRequired>All</PowerRequired>
	</Definition>		</Definition>
	</~~source~~>		</syntaxhighlight>
	;CarftingCategories: lists the categories of crafting recipes that can be crafted.		;CarftingCategories: lists the categories of crafting recipes that can be crafted.

Line 71:		Line 71:
	===StockpileComponent===		===StockpileComponent===
	The StockpileComponent component adds the ability to display the inventory items in the world on to the entity per subpart points. This component requires the CubeBlockSubpartComponent to be present. Look at Data/CubeBlocks/Storage/WoodenShelf.sbc for an example.		The StockpileComponent component adds the ability to display the inventory items in the world on to the entity per subpart points. This component requires the CubeBlockSubpartComponent to be present. Look at Data/CubeBlocks/Storage/WoodenShelf.sbc for an example.
	<~~source~~ lang="xml">		<syntaxhighlight lang="xml" line>
	<Definition xsi:type="MyObjectBuilder_StockpileComponentDefinition">		<Definition xsi:type="MyObjectBuilder_StockpileComponentDefinition">
	<Id Type="MyObjectBuilder_StockpileComponent" Subtype="WoodenShelf" />		<Id Type="MyObjectBuilder_StockpileComponent" Subtype="WoodenShelf" />
Line 77:		Line 77:
	<MaxNumberOfSubparts>3</MaxNumberOfSubparts>		<MaxNumberOfSubparts>3</MaxNumberOfSubparts>
	</Definition>		</Definition>
	</~~source~~>		</syntaxhighlight>
	The SubpartNameFormat specifies the numerated subpart names that are used for the system, and MaxNumberOfSubparts specifies the limit of visible subparts to try and assign contents to.		The SubpartNameFormat specifies the numerated subpart names that are used for the system, and MaxNumberOfSubparts specifies the limit of visible subparts to try and assign contents to.

Line 83:		Line 83:
	===CrankComponent===		===CrankComponent===
	The CrankComponent simply specifies the sound and angular speed and torque properties of a handcrank object. Look at Data/CubeBlocks/Mechanical/TurnWheel.sbc for an example.		The CrankComponent simply specifies the sound and angular speed and torque properties of a handcrank object. Look at Data/CubeBlocks/Mechanical/TurnWheel.sbc for an example.
	<~~source~~ lang="xml">		<syntaxhighlight lang="xml" line>
	<Definition xsi:type="MyObjectBuilder_CrankComponentDefinition">		<Definition xsi:type="MyObjectBuilder_CrankComponentDefinition">
	<Id Type="CrankComponent" Subtype="TurnCrossSmall" />		<Id Type="CrankComponent" Subtype="TurnCrossSmall" />
Line 90:		Line 90:
	<ActionSound>GearWheel</ActionSound>		<ActionSound>GearWheel</ActionSound>
	</Definition>		</Definition>
	</~~source~~>		</syntaxhighlight>
	AngularImpulse specifies the physical strength of the rotation, AngularVelocityLimit limits the rotation speed and ActionSound specifies the sound played while rotating.		AngularImpulse specifies the physical strength of the rotation, AngularVelocityLimit limits the rotation speed and ActionSound specifies the sound played while rotating.

Line 96:		Line 96:
	===LockableRopeComponent===		===LockableRopeComponent===
	The LockableRopeComponent specifies the lockable rope drum properties for when you want to make an object that behaves exactly like the lockable rope drum. Look at Data/CubeBlocks/Mechanical/RopeDrum.sbc for an example.		The LockableRopeComponent specifies the lockable rope drum properties for when you want to make an object that behaves exactly like the lockable rope drum. Look at Data/CubeBlocks/Mechanical/RopeDrum.sbc for an example.
	<~~source~~ lang="xml">		<syntaxhighlight lang="xml" line>
	<Definition xsi:type="MyObjectBuilder_LockableRopeComponentDefinition">		<Definition xsi:type="MyObjectBuilder_LockableRopeComponentDefinition">
	<Id Type="MyObjectBuilder_LockableRopeComponent" Subtype="LockableDrumSmall" />		<Id Type="MyObjectBuilder_LockableRopeComponent" Subtype="LockableDrumSmall" />
Line 103:		Line 103:
	<DefaultMaxRopeLength>40</DefaultMaxRopeLength>		<DefaultMaxRopeLength>40</DefaultMaxRopeLength>
	</Definition>		</Definition>
	</~~source~~>		</syntaxhighlight>
	MinRopeLength and MaxRopeLength specify how long a rope can be, and DefaultMaxRopeLength specifies the default rope length when the drum is fully unwinded.		MinRopeLength and MaxRopeLength specify how long a rope can be, and DefaultMaxRopeLength specifies the default rope length when the drum is fully unwinded.

Line 109:		Line 109:
	===TorsionSpringComponent===		===TorsionSpringComponent===
	The TorsionSpringComponent component specifies torsion spring properties. Look at Data/CubeBlocks/Mechanical/TorsionSpring.sbc for an example.		The TorsionSpringComponent component specifies torsion spring properties. Look at Data/CubeBlocks/Mechanical/TorsionSpring.sbc for an example.
	<~~source~~ lang="xml">		<syntaxhighlight lang="xml" line>
	<Definition xsi:type="MyObjectBuilder_TorsionSpringComponentDefinition">		<Definition xsi:type="MyObjectBuilder_TorsionSpringComponentDefinition">
	<Id Type="MyObjectBuilder_TorsionSpringComponent" Subtype="RopePowerSmallCogWheel1"/>		<Id Type="MyObjectBuilder_TorsionSpringComponent" Subtype="RopePowerSmallCogWheel1"/>
Line 116:		Line 116:
	<MaxFrictionTorque>30</MaxFrictionTorque>		<MaxFrictionTorque>30</MaxFrictionTorque>
	</Definition>		</Definition>
	</~~source~~>		</syntaxhighlight>
	MaxAngularImpulse specifies the maximum strength the block can provide, the MaxAngle is the maximum angle it rotates and MaxFrictionTorque is the maximum torque friction.		MaxAngularImpulse specifies the maximum strength the block can provide, the MaxAngle is the maximum angle it rotates and MaxFrictionTorque is the maximum torque friction.

CptTwinkie at 12:51, 7 July 2018

2018-07-07T12:51:35Z

← 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=We introduce a multitude of new entity components, as well as an upgrade to the subpart animation system to be more generic and easy to use.}}		{{SEO\|image_url=http://www.medievalengineerswiki.com/images/b/b7/KeenLogoBig.png\|description=We introduce a multitude of new entity components, as well as an upgrade to the subpart animation system to be more generic and easy to use.}}
	{{Keen:OCH}}		{{Keen:OCH}}

CptTwinkie at 12:31, 7 July 2018

2018-07-07T12:31:19Z

← Older revision		Revision as of 12:31, 7 July 2018
Line 1:		Line 1:
	{{SEO\|image_url=http://www.medievalengineerswiki.com/images/e/e6/~~KEEN_COMPASS_ONLY~~.png\|description=We introduce a multitude of new entity components, as well as an upgrade to the subpart animation system to be more generic and easy to use.}}		{{SEO\|image_url=http://www.medievalengineerswiki.com/images/e/eb/KeenLogo.png\|description=We introduce a multitude of new entity components, as well as an upgrade to the subpart animation system to be more generic and easy to use.}}
	{{Keen:OCH}}		{{Keen:OCH}}

CptTwinkie at 10:53, 29 June 2018

2018-06-29T10:53:31Z

← Older revision		Revision as of 10:53, 29 June 2018
Line 1:		Line 1:
	{{SEO\|image_url=http://www.medievalengineerswiki.com/images/e/e6/KEEN_COMPASS_ONLY.png\|description=We introduce a multitude of new entity components, as well as an upgrade to the subpart animation system to be more generic and easy to use.}}		{{SEO\|image_url=http://www.medievalengineerswiki.com/images/e/e6/KEEN_COMPASS_ONLY.png\|description=We introduce a multitude of new entity components, as well as an upgrade to the subpart animation system to be more generic and easy to use.}}
	{{:~~Official Content/~~OCH}}		{{Keen:OCH}}

CptTwinkie: CptTwinkie moved page Official Content/New Component Modding Guide to Keen:New Component Modding Guide

2018-06-29T10:22:21Z

CptTwinkie moved page Official Content/New Component Modding Guide to Keen:New Component Modding Guide

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

CptTwinkie at 10:19, 29 June 2018

2018-06-29T10:19:49Z

← Older revision		Revision as of 10:19, 29 June 2018
Line 67:		Line 67:


	For more information about crafting blocks see the [[~~Official_Content/~~Crafting\|crafting guide]].		For more information about crafting blocks see the [[Keen:Crafting\|crafting guide]].

	===StockpileComponent===		===StockpileComponent===

CptTwinkie at 21:42, 1 June 2018

2018-06-01T21:42:28Z

← Older revision		Revision as of 21:42, 1 June 2018
Line 1:		Line 1:
			{{SEO\|image_url=http://www.medievalengineerswiki.com/images/e/e6/KEEN_COMPASS_ONLY.png\|description=We introduce a multitude of new entity components, as well as an upgrade to the subpart animation system to be more generic and easy to use.}}
	{{:Official Content/OCH}}		{{:Official Content/OCH}}

CptTwinkie at 14:58, 30 May 2018

2018-05-30T14:58:59Z

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


	Hello engineers,		Hello engineers,

CptTwinkie: /* MyCraftingComponentBlock */

2018-04-13T10:24:36Z

MyCraftingComponentBlock

← Older revision		Revision as of 10:24, 13 April 2018
Line 37:		Line 37:
	The CraftingComponentBlock component adds crafting functionality to a block that relies on the presence of fuel. This is used for the bonfire and the furnace. See Data/CubeBlocks/Production/Bonfire.sbc for an example.		The CraftingComponentBlock component adds crafting functionality to a block that relies on the presence of fuel. This is used for the bonfire and the furnace. See Data/CubeBlocks/Production/Bonfire.sbc for an example.
	<source lang="xml">		<source lang="xml">
	<Definition xsi:type="~~MyObjectBuilder_CraftingComponentDefinition~~">		<Definition xsi:type="MyObjectBuilder_CraftingComponentQueuedDefinition">
	<Id Type="~~CraftingComponent~~" Subtype="BonFire"/>		<Id Type="CraftingComponentQueued" Subtype="BonFire"/>
	<CraftingCategories>		<CraftingCategories>
			<Category>Campfire</Category>
	<Category>Meals</Category>		<Category>Meals</Category>
	</CraftingCategories>		</CraftingCategories>
	<CraftingInventory>~~BonfireInventory~~</CraftingInventory>		<InputInventory>BonfireInventory</InputInventory>
			<OutputInventory>BonfireInventory</OutputInventory>
			<CraftingInventory>ProcessingInventory</CraftingInventory>
	<ProductionQueueSize>4</ProductionQueueSize>		<ProductionQueueSize>4</ProductionQueueSize>
	<CraftingSpeedMultiplier>1</CraftingSpeedMultiplier>		<CraftingSpeedMultiplier>1</CraftingSpeedMultiplier>
	<ConstrainInventory>true</ConstrainInventory>		<ConstrainInventory>true</ConstrainInventory>
			<PowerRequired>All</PowerRequired>
	</Definition>		</Definition>
	</source>		</source>
	CarftingCategories lists the categories of crafting recipes that can be crafted. CraftingInventory references an inventory component of the bonfire that is used for crafting. (Any block can have multiple inventories, this sets which one is used for crafting). ProductionQueueSize sets how long can crafting queue get. CraftingSpeedMultiplier can modify speed that recipes are being built with. This way you can make faster crafting stations. ConstrainInventory set to true will only allow items in its inventory, that are used for crafting by that block, or produced by this block.		;CarftingCategories: lists the categories of crafting recipes that can be crafted.

			;CraftingInventory: references an inventory component of the bonfire that is used for crafting. (Any block can have multiple inventories, this sets which one is used for crafting).

			;ProductionQueueSize: sets how long can crafting queue get.

			;CraftingSpeedMultiplier: can modify speed that recipes are being built with. This way you can make faster crafting stations.

			;ConstrainInventory: set to true will only allow items in its inventory, that are used for crafting by that block, or produced by this block.


	For more information about crafting blocks see the [[Official_Content/Crafting\|crafting guide]].		For more information about crafting blocks see the [[Official_Content/Crafting\|crafting guide]].


	===StockpileComponent===		===StockpileComponent===

CptTwinkie at 10:17, 13 April 2018

2018-04-13T10:17:27Z

← Older revision		Revision as of 10:17, 13 April 2018
Line 20:		Line 20:
	</source>		</source>
	The Effects contains a list of effects, as well as which events toggles them on and off and which dummy they respond to. Finally, they refer to the effect as defined in Data/FX/Effects.sbc.		The Effects contains a list of effects, as well as which events toggles them on and off and which dummy they respond to. Finally, they refer to the effect as defined in Data/FX/Effects.sbc.


	===MotionEventsComponent===		===MotionEventsComponent===
Line 31:		Line 32:
	</source>		</source>
	Each velocity event checks if the speed goes from either above to below a speed, or from below to above a speed, and then fires the event in Name on the object.		Each velocity event checks if the speed goes from either above to below a speed, or from below to above a speed, and then fires the event in Name on the object.


	===MyCraftingComponentBlock===		===MyCraftingComponentBlock===
	The CraftingComponentBlock component adds crafting functionality to a block that relies on the presence of fuel. This is used for the bonfire and the furnace. See Data/CubeBlocks/Production/Bonfire.sbc for an example.		The CraftingComponentBlock component adds crafting functionality to a block that relies on the presence of fuel. This is used for the bonfire and the furnace. See Data/CubeBlocks/Production/Bonfire.sbc for an example.
Line 46:		Line 49:
	</source>		</source>
	CarftingCategories lists the categories of crafting recipes that can be crafted. CraftingInventory references an inventory component of the bonfire that is used for crafting. (Any block can have multiple inventories, this sets which one is used for crafting). ProductionQueueSize sets how long can crafting queue get. CraftingSpeedMultiplier can modify speed that recipes are being built with. This way you can make faster crafting stations. ConstrainInventory set to true will only allow items in its inventory, that are used for crafting by that block, or produced by this block.		CarftingCategories lists the categories of crafting recipes that can be crafted. CraftingInventory references an inventory component of the bonfire that is used for crafting. (Any block can have multiple inventories, this sets which one is used for crafting). ProductionQueueSize sets how long can crafting queue get. CraftingSpeedMultiplier can modify speed that recipes are being built with. This way you can make faster crafting stations. ConstrainInventory set to true will only allow items in its inventory, that are used for crafting by that block, or produced by this block.


			For more information about crafting blocks see the [[Official_Content/Crafting\|crafting guide]].


	===StockpileComponent===		===StockpileComponent===
Line 57:		Line 64:
	</source>		</source>
	The SubpartNameFormat specifies the numerated subpart names that are used for the system, and MaxNumberOfSubparts specifies the limit of visible subparts to try and assign contents to.		The SubpartNameFormat specifies the numerated subpart names that are used for the system, and MaxNumberOfSubparts specifies the limit of visible subparts to try and assign contents to.


	===CrankComponent===		===CrankComponent===
Line 69:		Line 77:
	</source>		</source>
	AngularImpulse specifies the physical strength of the rotation, AngularVelocityLimit limits the rotation speed and ActionSound specifies the sound played while rotating.		AngularImpulse specifies the physical strength of the rotation, AngularVelocityLimit limits the rotation speed and ActionSound specifies the sound played while rotating.


	===LockableRopeComponent===		===LockableRopeComponent===
	The LockableRopeComponent specifies the lockable rope drum properties for when you want to make an object that behaves exactly like the lockable rope drum. Look at Data/CubeBlocks/Mechanical/RopeDrum.sbc for an example.		The LockableRopeComponent specifies the lockable rope drum properties for when you want to make an object that behaves exactly like the lockable rope drum. Look at Data/CubeBlocks/Mechanical/RopeDrum.sbc for an example.
Line 80:		Line 90:
	</source>		</source>
	MinRopeLength and MaxRopeLength specify how long a rope can be, and DefaultMaxRopeLength specifies the default rope length when the drum is fully unwinded.		MinRopeLength and MaxRopeLength specify how long a rope can be, and DefaultMaxRopeLength specifies the default rope length when the drum is fully unwinded.


	===TorsionSpringComponent===		===TorsionSpringComponent===
	The TorsionSpringComponent component specifies torsion spring properties. Look at Data/CubeBlocks/Mechanical/TorsionSpring.sbc for an example.		The TorsionSpringComponent component specifies torsion spring properties. Look at Data/CubeBlocks/Mechanical/TorsionSpring.sbc for an example.
Line 91:		Line 103:
	</source>		</source>
	MaxAngularImpulse specifies the maximum strength the block can provide, the MaxAngle is the maximum angle it rotates and MaxFrictionTorque is the maximum torque friction.		MaxAngularImpulse specifies the maximum strength the block can provide, the MaxAngle is the maximum angle it rotates and MaxFrictionTorque is the maximum torque friction.


	==New event system==		==New event system==
	We changed the way the components interact with each other. This system provides a more elegant approach to handling events so that we do not need as many entity components to create specific effects without requiring programming.		We changed the way the components interact with each other. This system provides a more elegant approach to handling events so that we do not need as many entity components to create specific effects without requiring programming.