Prototype/Recipe - Revision history

BilkaBot: Removed old prototype docs

2024-10-25T14:33:00Z

Removed old prototype docs

BilkaBot: Updated styling of prototype doc migration note

2023-09-21T10:43:23Z

Updated styling of prototype doc migration note

← Older revision		Revision as of 10:43, 21 September 2023
Line 1:		Line 1:
	'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/prototypes/RecipePrototype.html https://lua-api.factorio.com/latest/prototypes/RecipePrototype.html]		<div class="stub"><p>'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/prototypes/RecipePrototype.html https://lua-api.factorio.com/latest/prototypes/RecipePrototype.html]

	This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].		</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>

BilkaBot: Protected "Prototype/Recipe": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2023-08-16T17:53:03Z

Protected "Prototype/Recipe": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

← Older revision		Revision as of 17:53, 16 August 2023
(No difference)

BilkaBot: Migrated prototype doc to separate website

2023-08-16T17:53:03Z

Migrated prototype doc to separate website

← Older revision		Revision as of 17:53, 16 August 2023
Line 1:		Line 1:
			'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/prototypes/RecipePrototype.html https://lua-api.factorio.com/latest/prototypes/RecipePrototype.html]

			This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].



	{{Prototype parent\|PrototypeBase}}		{{Prototype parent\|PrototypeBase}}
	A recipe. It can be a crafting recipe, a smelting recipe, or a custom type of recipe (see [[Prototype/RecipeCategory]]).		A recipe. It can be a crafting recipe, a smelting recipe, or a custom type of recipe (see [[Prototype/RecipeCategory]]).

Bilka: 1.1.73: crafting_machine_tint default changed

2023-08-14T08:01:05Z

1.1.73: crafting_machine_tint default changed

← Older revision		Revision as of 08:01, 14 August 2023
Line 26:		Line 26:
	<syntaxhighlight lang="lua">crafting_machine_tint = { primary = {r=0,g=0,b=0,a=0}, secondary = {r=0,g=0,b=0,a=0}, tertiary = {r=0,g=0,b=0,a=0}, quaternary = {r=0,g=0,b=0,a=0}}</syntaxhighlight>		<syntaxhighlight lang="lua">crafting_machine_tint = { primary = {r=0,g=0,b=0,a=0}, secondary = {r=0,g=0,b=0,a=0}, tertiary = {r=0,g=0,b=0,a=0}, quaternary = {r=0,g=0,b=0,a=0}}</syntaxhighlight>

	Each key/value pair is optional and defaults to the ~~above value~~.		Each key/value pair is optional and defaults to no tint. If no tint is specified, the crafting machine falls back to [[Prototype/CraftingMachine#default_recipe_tint]].

	== Recipe data ==		== Recipe data ==

Bilka: result_count -> uint16

2023-08-10T17:55:24Z

result_count -> uint16

← Older revision		Revision as of 17:55, 10 August 2023
Line 67:		Line 67:
	Note that <code>results</code> takes priority over <code>result</code>. So if a recipe has both keys set, <code>result</code> will be ignored.<br>		Note that <code>results</code> takes priority over <code>result</code>. So if a recipe has both keys set, <code>result</code> will be ignored.<br>

	{{Prototype property\|result_count\|[[Types/~~uint32~~\|~~uint32~~]]\|1\|optional=true}}		{{Prototype property\|result_count\|[[Types/uint16\|uint16]]\|1\|optional=true}}
	Optional. The number of items created by this recipe.		Optional. The number of items created by this recipe.

Bilka: why main_product = "" is used

2023-07-03T14:36:15Z

why main_product = "" is used

← Older revision		Revision as of 14:36, 3 July 2023
Line 141:		Line 141:

	{{Prototype property\|show_amount_in_title\|[[Types/bool\|bool]]\|true\|optional=true}}		{{Prototype property\|show_amount_in_title\|[[Types/bool\|bool]]\|true\|optional=true}}
	Optional. Whether the recipe name should have the product amount in front of it, e.g. "2 [[transport belt]]"		Optional. Whether the recipe name should have the product amount in front of it, e.g. "2 [[transport belt]]".

	{{Prototype property\|always_show_products\|[[Types/bool\|bool]]\|false\|optional=true}}		{{Prototype property\|always_show_products\|[[Types/bool\|bool]]\|false\|optional=true}}
Line 152:		Line 152:
	Optional.		Optional.

	For recipes with one or more products: Subgroup, localised_name and icon default to the values of the only/main product, but can be overwritten by the recipe.		For recipes with one or more products: Subgroup, localised_name and icon default to the values of the only/main product, but can be overwritten by the recipe. Setting the main_product to an empty string (<code>""</code>) forces the title in the recipe tooltip to use the recipe's name (not that of the product) and shows the products in the tooltip.

	If 1) there are multiple products and this property is nil, 2) this property is set to an empty string (<code>""</code>), or 3) there are no products, the recipe will use the localised_name, icon, and subgroup of the recipe. icon and subgroup become non-optional.		If 1) there are multiple products and this property is nil, 2) this property is set to an empty string (<code>""</code>), or 3) there are no products, the recipe will use the localised_name, icon, and subgroup of the recipe. icon and subgroup become non-optional.

Bilka: actually localised_name works the same as icon and subgroup

2023-07-03T14:29:10Z

actually localised_name works the same as icon and subgroup

← Older revision		Revision as of 14:29, 3 July 2023
Line 152:		Line 152:
	Optional.		Optional.

	For recipes with one or more products: ~~The recipe takes the only/main product's~~ localised_name~~. Subgroup~~ and icon default to the values of the product, but can be overwritten by the recipe.		For recipes with one or more products: Subgroup, localised_name and icon default to the values of the only/main product, but can be overwritten by the recipe.

	If 1) there are multiple products and this property is nil, 2) this property is set to an empty string (<code>""</code>), or 3) there are no products, the recipe will use the localised_name, icon, and subgroup of the recipe. icon and subgroup become non-optional.		If 1) there are multiple products and this property is nil, 2) this property is set to an empty string (<code>""</code>), or 3) there are no products, the recipe will use the localised_name, icon, and subgroup of the recipe. icon and subgroup become non-optional.

Bilka: main product only forces localised_name, localised_description is never used from the product and subgroup/icon can still be overwritten by the recipe

2023-07-03T14:19:55Z

main product only forces localised_name, localised_description is never used from the product and subgroup/icon can still be overwritten by the recipe

← Older revision		Revision as of 14:19, 3 July 2023
Line 152:		Line 152:
	Optional.		Optional.

	For recipes with more ~~than one product~~: The recipe takes ~~that~~ product's localised_name~~, localised_description,~~ icon, ~~and subgroup~~.		For recipes with one or more products: The recipe takes the only/main product's localised_name. Subgroup and icon default to the values of the product, but can be overwritten by the recipe.

	~~For recipes with one product (<code>results</code> with one product or <code>result</code>): The recipe uses the localised_name, localised_description, icon, and subgroup of the product.~~		If 1) there are multiple products and this property is nil, 2) this property is set to an empty string (<code>""</code>), or 3) there are no products, the recipe will use the localised_name, icon, and subgroup of the recipe. icon and subgroup become non-optional.

	If 1) there are multiple products and this property is nil, 2) this property is set to an empty string (<code>""</code>), or 3) there are no products, the recipe will use the localised_name~~, localised_description~~, icon, and subgroup of the recipe. icon and subgroup become non-optional.

	== Examples ==		== Examples ==

Honktown: /* General properties */ reword icon(s)

2023-04-06T09:02:59Z

General properties: reword icon(s)

← Older revision		Revision as of 09:02, 6 April 2023
Line 13:		Line 13:

	{{Prototype property\|subgroup\|[[Types/string\|string]]\|\|optional=true}}		{{Prototype property\|subgroup\|[[Types/string\|string]]\|\|optional=true}}
	Optional. Name of a [[Prototype/ItemSubGroup]]. The subgroup of this recipe. If not specified, defaults to the subgroup of the product if there is only 1, or main_product if multiple products exist. If multiple products exist and no main_product is specified, the subgroup is required.		Optional. Name of a [[Prototype/ItemSubGroup]]. The subgroup of this recipe. If not specified, defaults to the subgroup of the product if there is only 1, or main_product if multiple products exist. If multiple products exist and no main_product is specified, or if there is no product, the subgroup is required.

	{{Prototype property\|icons, icon, icon_size (IconSpecification)\|[[Types/IconSpecification\|IconSpecification]]\|optional=true}}		{{Prototype property\|icons, icon, icon_size (IconSpecification)\|[[Types/IconSpecification\|IconSpecification]]\|optional=true}}
	An icon ~~is mandatory~~ for recipe with more than 1 product and no main_product~~. Otherwise defaults to the icon of main_product/1~~ product.		If given, this determines the recipe's icon. Mandatory for a recipe with more than 1 product and no main_product, or, no product.

	~~If given~~, ~~it overwrites~~ the icon of the ~~main_product/1~~ product.		Otherwise, the icon of main_product or the only product is used.

	{{Prototype property\|crafting_machine_tint\|[[Types/table\|table]] of [[Types/Color\|Color]]\|optional=true}}		{{Prototype property\|crafting_machine_tint\|[[Types/table\|table]] of [[Types/Color\|Color]]\|optional=true}}