Keen:Crafting - Revision history

CptTwinkie at 20:09, 18 July 2022

2022-07-18T20:09:11Z

← Older revision		Revision as of 20:09, 18 July 2022
Line 11:		Line 11:

	'''Example:'''		'''Example:'''
	<~~source~~ lang="xml">		<syntaxhighlight lang="xml" line>
	<Definition xsi:type="MyObjectBuilder_CraftingRecipeDefinition">		<Definition xsi:type="MyObjectBuilder_CraftingRecipeDefinition">
	<Id Type="CraftingRecipeDefinition" Subtype="IngotAluminium"/>		<Id Type="CraftingRecipeDefinition" Subtype="IngotAluminium"/>
Line 27:		Line 27:
	<CraftingTime Seconds="12"/>		<CraftingTime Seconds="12"/>
	</Definition>		</Definition>
	</~~source~~>		</syntaxhighlight>
	The first line simply tells the definition manager what type of definition it wants to be. For more information about how that works, refer to [[Keen:Definitions\|Definitions]].		The first line simply tells the definition manager what type of definition it wants to be. For more information about how that works, refer to [[Keen:Definitions\|Definitions]].

Line 50:		Line 50:

	'''Example:'''		'''Example:'''
	<~~source~~ lang="xml">		<syntaxhighlight lang="xml" line>
	<Definition xsi:type="MyObjectBuilder_CraftingCategoryDefinition">		<Definition xsi:type="MyObjectBuilder_CraftingCategoryDefinition">
	<Id Type="CraftingCategoryDefinition" Subtype="TableCraftingMagic" />		<Id Type="CraftingCategoryDefinition" Subtype="TableCraftingMagic" />
Line 57:		Line 57:
	<Icon>Textures\GUI\Icons\Fake.dds</Icon>		<Icon>Textures\GUI\Icons\Fake.dds</Icon>
	</Definition>		</Definition>
	</~~source~~>		</syntaxhighlight>
	The first line simply tells the definition manager what type of definition it wants to be. For more information about how that works, refer to [[Keen:Definitions\|Definitions]].		The first line simply tells the definition manager what type of definition it wants to be. For more information about how that works, refer to [[Keen:Definitions\|Definitions]].

Line 87:		Line 87:
	====Events Available to Scripts====		====Events Available to Scripts====
	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<MyCraftingComponentBase> CraftingStarted;		public event Action<MyCraftingComponentBase> CraftingStarted;
	public event Action<MyCraftingComponentBase> CraftingStopped;		public event Action<MyCraftingComponentBase> CraftingStopped;
Line 94:		Line 94:
	public static event CraftCompletedDelegate OnGlobalCraftCompleted = null;		public static event CraftCompletedDelegate OnGlobalCraftCompleted = null;
	public event CraftCompletedDelegate OnCraftCompleted = null;		public event CraftCompletedDelegate OnCraftCompleted = null;
	</~~source~~>		</syntaxhighlight>
	*'''CraftingStarted:''' fired when the component starts crafting.		*'''CraftingStarted:''' fired when the component starts crafting.

Line 105:		Line 105:
	====Shared Definition Fields====		====Shared Definition Fields====
	Since all crafting components are derived from <code>MyCraftingComponentBase</code>, its definition includes all of the shared fields.		Since all crafting components are derived from <code>MyCraftingComponentBase</code>, its definition includes all of the shared fields.
	<~~source~~ lang="xml">		<syntaxhighlight lang="xml" line>
	...		...
	<CraftingInventory>OvenInputInventory</CraftingInventory>		<CraftingInventory>OvenInputInventory</CraftingInventory>
Line 114:		Line 114:
	<PowerRequired>All</PowerRequired>		<PowerRequired>All</PowerRequired>
	...		...
	</~~source~~>		</syntaxhighlight>
	'''CraftingInventory:''' subtype id of the inventory used to find prerequisites for recipes. If none is specified, or the specified inventory cannot be found, it will try to use the first inventory it can find.		'''CraftingInventory:''' subtype id of the inventory used to find prerequisites for recipes. If none is specified, or the specified inventory cannot be found, it will try to use the first inventory it can find.

Line 141:		Line 141:
	====Events Available to Scripts====		====Events Available to Scripts====
	The queued version of crafting component includes all the events that a regular crafting component does, but it also adds a couple of its own events:		The queued version of crafting component includes all the events that a regular crafting component does, but it also adds a couple of its own events:
	<~~source~~ lang="csharp">		<syntaxhighlight lang="csharp" line>
	public event Action<MyCraftingComponentBase> ProductionQueueChanged;		public event Action<MyCraftingComponentBase> ProductionQueueChanged;

	public delegate void InsufficientResourcesDelegate();		public delegate void InsufficientResourcesDelegate();
	public event InsufficientResourcesDelegate OnInsufficientResources = null;		public event InsufficientResourcesDelegate OnInsufficientResources = null;
	</~~source~~>		</syntaxhighlight>
	*'''ProductionQueueChanged:''' this event is fired when one or more of the following changes happen: a recipe is added (either as a new entry or incrementing the amount on the previous entry), an element in the queue is canceled, or a recipe finished crafting and the next one for the queue was selected.		*'''ProductionQueueChanged:''' this event is fired when one or more of the following changes happen: a recipe is added (either as a new entry or incrementing the amount on the previous entry), an element in the queue is canceled, or a recipe finished crafting and the next one for the queue was selected.

Line 155:		Line 155:

	'''Example:'''		'''Example:'''
	<~~source~~ lang="xml">		<syntaxhighlight lang="xml" line>
	<Definition xsi:type="MyObjectBuilder_CraftingComponentQueuedDefinition">		<Definition xsi:type="MyObjectBuilder_CraftingComponentQueuedDefinition">
	<Id Type="CraftingComponentQueued" Subtype="FurnaceBrick"/>		<Id Type="CraftingComponentQueued" Subtype="FurnaceBrick"/>
Line 167:		Line 167:
	<PowerRequired>All</PowerRequired>		<PowerRequired>All</PowerRequired>
	</Definition>		</Definition>
	</~~source~~>		</syntaxhighlight>
	'''Id:''' queued crafting component uses the <code>CraftingComponentQueued</code> type.		'''Id:''' queued crafting component uses the <code>CraftingComponentQueued</code> type.

Line 187:		Line 187:

	'''Example:'''		'''Example:'''
	<~~source~~ lang="xml">		<syntaxhighlight lang="xml" line>
	<Definition xsi:type="MyObjectBuilder_CraftingComponentAutonomousDefinition">		<Definition xsi:type="MyObjectBuilder_CraftingComponentAutonomousDefinition">
	<Id Type="CraftingComponentAutonomous" Subtype="MillstoneMechanical" />		<Id Type="CraftingComponentAutonomous" Subtype="MillstoneMechanical" />
Line 201:		Line 201:
	</AcceptedToolheads>		</AcceptedToolheads>
	</Definition>		</Definition>
	</~~source~~>		</syntaxhighlight>
	'''Id:''' autonomous crafting component uses the <code>CraftingComponentAutonomous</code> type.		'''Id:''' autonomous crafting component uses the <code>CraftingComponentAutonomous</code> type.

Line 213:		Line 213:

	'''Toolhead Example:'''		'''Toolhead Example:'''
	<~~source~~ lang="xml">		<syntaxhighlight lang="xml" line>
	<Definition xsi:type="MyObjectBuilder_ToolheadItemDefinition">		<Definition xsi:type="MyObjectBuilder_ToolheadItemDefinition">
	<Id Type="ToolheadItem" Subtype="MillstoneCoarse" />		<Id Type="ToolheadItem" Subtype="MillstoneCoarse" />
Line 232:		Line 232:
	<CraftingCategory>MillstoneCoarse</CraftingCategory>		<CraftingCategory>MillstoneCoarse</CraftingCategory>
	</Definition>		</Definition>
	</~~source~~>		</syntaxhighlight>
	'''Id:''' toolhead type is <code>ToolheadItem</code>.		'''Id:''' toolhead type is <code>ToolheadItem</code>.

CptTwinkie at 12:51, 7 July 2018

2018-07-07T12:51:27Z

← 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=Crafting is the process of turning some items into other items. When it comes to the modability of the crafting, you can not only change which items are needed to craft other items, but also the time it takes to craft them, where they are crafted and even how they are crafted.}}		{{SEO\|image_url=http://www.medievalengineerswiki.com/images/b/b7/KeenLogoBig.png\|description=Crafting is the process of turning some items into other items. When it comes to the modability of the crafting, you can not only change which items are needed to craft other items, but also the time it takes to craft them, where they are crafted and even how they are crafted.}}
	{{Keen:OCH}}		{{Keen:OCH}}

CptTwinkie at 12:32, 7 July 2018

2018-07-07T12:32:20Z

← 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=Crafting is the process of turning some items into other items. When it comes to the modability of the crafting, you can not only change which items are needed to craft other items, but also the time it takes to craft them, where they are crafted and even how they are crafted.}}		{{SEO\|image_url=http://www.medievalengineerswiki.com/images/e/eb/KeenLogo.png\|description=Crafting is the process of turning some items into other items. When it comes to the modability of the crafting, you can not only change which items are needed to craft other items, but also the time it takes to craft them, where they are crafted and even how they are crafted.}}
	{{Keen:OCH}}		{{Keen:OCH}}

CptTwinkie at 10:54, 29 June 2018

2018-06-29T10:54:00Z

← 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=Crafting is the process of turning some items into other items. When it comes to the modability of the crafting, you can not only change which items are needed to craft other items, but also the time it takes to craft them, where they are crafted and even how they are crafted.}}		{{SEO\|image_url=http://www.medievalengineerswiki.com/images/e/e6/KEEN_COMPASS_ONLY.png\|description=Crafting is the process of turning some items into other items. When it comes to the modability of the crafting, you can not only change which items are needed to craft other items, but also the time it takes to craft them, where they are crafted and even how they are crafted.}}
	{{:~~Official Content/~~OCH}}		{{Keen:OCH}}

CptTwinkie at 10:25, 29 June 2018

2018-06-29T10:25:17Z

← Older revision		Revision as of 10:25, 29 June 2018
Line 28:		Line 28:
	</Definition>		</Definition>
	</source>		</source>
	The first line simply tells the definition manager what type of definition it wants to be. For more information about how that works, refer to [[~~Official_Content/~~Definitions\|Definitions]].		The first line simply tells the definition manager what type of definition it wants to be. For more information about how that works, refer to [[Keen:Definitions\|Definitions]].

	'''Id:''' definition Id of the crafting recipe. The type for all crafting recipes is currently <code>CraftingRecipeDefinition</code> and subtype is whatever you want it to be, in the example it is <code>IngotSteel</code>. Please note that the subtypes for a given type are shared with the vanilla game and any other mods you may be using, so it might be good to have some unique prefix for your subtype, e.g. <code>MyAwesomeMod_IngotSteel</code>.		'''Id:''' definition Id of the crafting recipe. The type for all crafting recipes is currently <code>CraftingRecipeDefinition</code> and subtype is whatever you want it to be, in the example it is <code>IngotSteel</code>. Please note that the subtypes for a given type are shared with the vanilla game and any other mods you may be using, so it might be good to have some unique prefix for your subtype, e.g. <code>MyAwesomeMod_IngotSteel</code>.
Line 40:		Line 40:
	'''Category:''' subtype id of the category, to which this recipe belongs to. Category defines where the recipe can be crafted. Each crafting station tends to come with its own category, and recipes can be part of more than one category.		'''Category:''' subtype id of the category, to which this recipe belongs to. Category defines where the recipe can be crafted. Each crafting station tends to come with its own category, and recipes can be part of more than one category.

	'''Prerequisites:''' item(s) needed to craft the result(s) of this recipe. You can specify items either by specifying the Amount needed, their Type and Subtype directly, or using a [[~~Official_Content/~~Item_Tags\|Tag]] that is assigned to them.		'''Prerequisites:''' item(s) needed to craft the result(s) of this recipe. You can specify items either by specifying the Amount needed, their Type and Subtype directly, or using a [[Keen:Item_Tags\|Tag]] that is assigned to them.

	'''Results:''' the yield of this crafting recipe. The items are specified using the same syntax as Prerequisites, including the possibility to use [[~~Official_Content/~~Item_Tags\|Tag]]s, where it will return the first item in the tag group.		'''Results:''' the yield of this crafting recipe. The items are specified using the same syntax as Prerequisites, including the possibility to use [[Keen:Item_Tags\|Tag]]s, where it will return the first item in the tag group.

	'''CraftingTime:''' the time it takes to finish crafting this recipe. It uses a special [[~~Official_Content/~~Time_Definition\|time definition]] format.		'''CraftingTime:''' the time it takes to finish crafting this recipe. It uses a special [[Keen:Time_Definition\|time definition]] format.

	==Crafting Category==		==Crafting Category==
Line 58:		Line 58:
	</Definition>		</Definition>
	</source>		</source>
	The first line simply tells the definition manager what type of definition it wants to be. For more information about how that works, refer to [[~~Official_Content/~~Definitions\|Definitions]].		The first line simply tells the definition manager what type of definition it wants to be. For more information about how that works, refer to [[Keen:Definitions\|Definitions]].

	'''Id:''' definition Id of the crafting category. All crafting categories are using the <code>CraftingCategoryDefinition</code> type.		'''Id:''' definition Id of the crafting category. All crafting categories are using the <code>CraftingCategoryDefinition</code> type.
Line 206:		Line 206:
	'''ToolheadInventory:''' inventory where the toolheads are to be looked for. If no inventory with the specified subtype is found, it will try to use the <code>CraftingInventory</code> to find toolheads.		'''ToolheadInventory:''' inventory where the toolheads are to be looked for. If no inventory with the specified subtype is found, it will try to use the <code>CraftingInventory</code> to find toolheads.

	'''AcceptedToolheads:''' toolheads that can be used for crafting in this component. Can be specified by either using the exact Type and Subtype of the toolhead or a [[~~Official_Content/~~Item_Tags\|Tag]]. The toolheads have to be of type <code>ToolheadItem</code> or its child class.		'''AcceptedToolheads:''' toolheads that can be used for crafting in this component. Can be specified by either using the exact Type and Subtype of the toolhead or a [[Keen:Item_Tags\|Tag]]. The toolheads have to be of type <code>ToolheadItem</code> or its child class.

	'''ConstrainInventory:''' this setting has no effect on toolhead inventory, the toolhead inventory will always construct a constraint based on accepted toolheads. Constraints for other inventories are constructed in the same way as for a regular crafting component, except the pool of valid recipes is constructed by checking all crafting recipes assigned to all crafting categories of all toolheads that can be used with this component.		'''ConstrainInventory:''' this setting has no effect on toolhead inventory, the toolhead inventory will always construct a constraint based on accepted toolheads. Constraints for other inventories are constructed in the same way as for a regular crafting component, except the pool of valid recipes is constructed by checking all crafting recipes assigned to all crafting categories of all toolheads that can be used with this component.
Line 240:		Line 240:


	{{TextBox\|NOTICE: If you are not sure what all the other fields in the definition stand for, please refer to the [[~~Official_Content/~~Items\|Items]] Guide.}}		{{TextBox\|NOTICE: If you are not sure what all the other fields in the definition stand for, please refer to the [[Keen:Items\|Items]] Guide.}}


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

CptTwinkie: CptTwinkie moved page Official Content/Crafting to Keen:Crafting

2018-06-29T10:19:30Z

CptTwinkie moved page Official Content/Crafting to Keen:Crafting

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

CptTwinkie at 21:46, 1 June 2018

2018-06-01T21:46:53Z

← Older revision		Revision as of 21:46, 1 June 2018
Line 1:		Line 1:
			{{SEO\|image_url=http://www.medievalengineerswiki.com/images/e/e6/KEEN_COMPASS_ONLY.png\|description=Crafting is the process of turning some items into other items. When it comes to the modability of the crafting, you can not only change which items are needed to craft other items, but also the time it takes to craft them, where they are crafted and even how they are crafted.}}
	{{:Official Content/OCH}}		{{:Official Content/OCH}}

CptTwinkie at 14:57, 30 May 2018

2018-05-30T14:57:57Z

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


	Crafting is the process of turning some items into other items. When it comes to the modability of the crafting, you can not only change which items are needed to craft other items, but also the time it takes to craft them, where they are crafted and even how they are crafted.		Crafting is the process of turning some items into other items. When it comes to the modability of the crafting, you can not only change which items are needed to craft other items, but also the time it takes to craft them, where they are crafted and even how they are crafted.

CptTwinkie at 17:54, 27 December 2017

2017-12-27T17:54:30Z

← Older revision		Revision as of 17:54, 27 December 2017
Line 2:		Line 2:

	{{Version <!-- Do not change the version until the entire page is up-to-date -->		{{Version <!-- Do not change the version until the entire page is up-to-date -->
	\|release=0		\|release=0\|major=6\|minor=1\|suppress=true}}
	\|major=6
	\|minor=1
	}}
	==Crafting Recipe==		==Crafting Recipe==
	Recipes are what defines what items are needed to produce other items, and how much time is needed for an item to be crafted. They also define where the recipe is crafted. So let's take a look at a crafting recipe definition to see what it's made of.		Recipes are what defines what items are needed to produce other items, and how much time is needed for an item to be crafted. They also define where the recipe is crafted. So let's take a look at a crafting recipe definition to see what it's made of.

CptTwinkie at 21:37, 15 December 2017

2017-12-15T21:37:55Z

← Older revision		Revision as of 21:37, 15 December 2017
Line 1:		Line 1:
	Crafting is the process of turning some items into other items. When it comes to the modability of the crafting, you can not only change which items are needed to craft other items, but also the time it takes to craft them, where they are crafted and even how they are crafted.		Crafting is the process of turning some items into other items. When it comes to the modability of the crafting, you can not only change which items are needed to craft other items, but also the time it takes to craft them, where they are crafted and even how they are crafted.

			{{Version <!-- Do not change the version until the entire page is up-to-date -->
			\|release=0
			\|major=6
			\|minor=1
			}}
	==Crafting Recipe==		==Crafting Recipe==
	Recipes are what defines what items are needed to produce other items, and how much time is needed for an item to be crafted. They also define where the recipe is crafted. So let's take a look at a crafting recipe definition to see what it's made of.		Recipes are what defines what items are needed to produce other items, and how much time is needed for an item to be crafted. They also define where the recipe is crafted. So let's take a look at a crafting recipe definition to see what it's made of.