Prototype/Recipe: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(main product only forces localised_name, localised_description is never used from the product and subgroup/icon can still be overwritten by the recipe)
(Removed old prototype docs)
Tag: Replaced
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Prototype parent|PrototypeBase}}
<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]
A recipe. It can be a crafting recipe, a smelting recipe, or a custom type of recipe (see [[Prototype/RecipeCategory]]).


{{Prototype TOC|recipe}}
</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>
 
== General properties ==
Inherits all properties from [[PrototypeBase]].
 
{{Prototype property|category|[[Types/string|string]]|"crafting"|optional=true}}
Optional. Name of a [[Prototype/RecipeCategory]]. The category of the recipe is used to control which machines can craft the recipe. The built-in categories can be found [[Data.raw#recipe-category|here]].
 
The recipe category "crafting" cannot contain recipes with fluid ingredients or products.
 
{{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, or if there is no product, the subgroup is required.
 
{{Prototype property|icons, icon,  icon_size (IconSpecification)|[[Types/IconSpecification|IconSpecification]]|optional=true}}
If given, this determines the recipe's icon. Mandatory for a recipe with more than 1 product and no main_product, or, no 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}}
Optional. Used by crafting machine <code>[[Prototype/CraftingMachine#working_visualisations|working_visualisations]]</code> to tint certain layers with the recipe color. [[Types/WorkingVisualisation#apply_recipe_tint|apply_recipe_tint]] on the working visualisation determines which of the 4 colors is used for that layer (if any).
 
Format:
<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.
 
== Recipe data ==
<!--
Anchor and property for the TOC at the top --><span id="normal">{{#subobject:normal
|Prototype property name=normal
|Prototype property type=[[Prototype/Recipe#Recipe_data|Recipe data]] or [[Types/bool|bool]]
|Prototype property optional=true
|Prototype property pagename={{FULLPAGENAME}}
}}</span><!--
Anchor and property for the TOC at the top --><span id="expensive">{{#subobject:expensive
|Prototype property name=expensive
|Prototype property type=[[Prototype/Recipe#Recipe_data|Recipe data]] or [[Types/bool|bool]]
|Prototype property optional=true
|Prototype property pagename={{FULLPAGENAME}}
}}</span><!--
-->
If the recipe does not have a difficulty, this is located directly in the prototype. Otherwise, if the "'''normal'''" or "'''expensive'''" property exists, the recipe has difficulty. Then, the recipe data has to be specified for each difficulty instead of directly in the prototype. If at least one difficulty has recipe data defined, the other difficulty can be set to <code>false</code>. This will disable the recipe for the difficulty, same as setting it <code>enabled = false</code>. If it is enabled (by technologies etc), it will use the data from the other difficulty. Not setting a difficulty, e.g. <code>normal = nil</code>, is possible and gives that difficulty the exact same properties as the difficulty that is defined. Setting one or both difficulties to <code>true</code> is not valid and will produce an error. See below for examples of difficulty.
 
{{Prototype property|ingredients|[[Types/table|table]] of [[Types/IngredientPrototype|IngredientPrototype]]}}
A table containing ingredient names and counts. Can also contain information about fluid temperature and catalyst amounts. The catalyst amounts are automatically calculated from the recipe, or can be set manually in the [[Types/IngredientPrototype|IngredientPrototype]].<sup>[https://factorio.com/blog/post/fff-256]</sup><br>
Maximum ingredient amount is 65535.<br>
<code>ingredients</code> can be set to an empty table  to create a recipe that needs no ingredients.<br>
Duplicate ingredients, e.g. two entries for the "wood" item, are ''not'' allowed.<br>
In-game, the item ingredients are ordered by [[Prototype/ItemGroup#order_in_recipe|item group order_in_recipe]].
<syntaxhighlight lang="lua">
ingredients = {{"iron-stick", 2}, {"iron-plate", 3}}
</syntaxhighlight>
The same with full format:
<syntaxhighlight lang="lua">
ingredients = {{type = "item", name = "iron-stick", amount = 2}, {type = "item", name = "iron-plate", amount = 3}}
</syntaxhighlight>
For fluids, the full format always has to be used:
<syntaxhighlight lang="lua">
ingredients = {{type="fluid", name="water", amount=50}, {type="fluid", name="crude-oil", amount=100}}
</syntaxhighlight>
 
{{Prototype property|result|[[Types/string|string]]|optional=true}}
Can be replaced with the results parameter. The item created by this recipe. Must be the name of an item, such as "iron-gear-wheel".
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}}
Optional. The number of items created by this recipe.
 
{{Prototype property|results|[[Types/table|table]] of [[Types/ProductPrototype|ProductPrototype]]|optional=true}}
A table containing result names and counts. Can also contain information about fluid temperature and catalyst amounts. The catalyst amounts are automatically calculated from the recipe, or can be set manually in the [[Types/ProductPrototype|ProductPrototype]].<sup>[https://factorio.com/blog/post/fff-256]</sup><br>
<code>results</code> can be set to an empty table to create a recipe that produces nothing.<br>
Duplicate results, e.g. two entries for the "iron-plate" item, are allowed.
 
<syntaxhighlight lang="lua">
results=
    {
      {type="fluid", name="heavy-oil", amount=3},
      {type="fluid", name="light-oil", amount=3},
      {type="fluid", name="petroleum-gas", amount=4}
    },
</syntaxhighlight>
<syntaxhighlight lang="lua">
results =
    {
      {type = "item", name = "iron-nuggets", amount = 9},
      {type = "item", name = "gold-nuggets", amount = 1}
    },
</syntaxhighlight>
<syntaxhighlight lang="lua">
results =
    {
      {type = "fluid", name = "steam", amount = 1, temperature = 165}
    },
</syntaxhighlight>
 
{{Prototype property|energy_required|[[Types/double|double]]|0.5|optional=true}}
Optional. The amount of time it takes to make this recipe. Must be greater than 0.001.
 
This is the number of seconds it takes to craft at crafting speed 1.
 
{{Prototype property|emissions_multiplier|[[Types/double|double]]|1.0|optional=true}}
 
{{Prototype property|requester_paste_multiplier|[[Types/uint32|uint32]]|30|optional=true}}
 
{{Prototype property|overload_multiplier|[[Types/uint32|uint32]]|0|optional=true}}
Used to determine how many extra items are put into an assembling machine before it's considered "full enough". See [[Inserters#Insertion_limits]].
 
If set to 0, it instead uses the following formula: 1.166 / (energy_required / the assembler's crafting_speed), rounded up, and clamped between 2 and 100. The numbers used in this formula can be changed by the [[Prototype/UtilityConstants]] dynamic_recipe_overload_factor, minimum_recipe_overload_multiplier and maximum_recipe_overload_multiplier.
 
{{Prototype property|allow_inserter_overload|[[Types/bool|bool]]|true|optional=true}}
If the recipe is allowed to have the extra inserter overload bonus applied (4 * stack inserter stack size).
 
{{Prototype property|enabled|[[Types/bool|bool]]|true|optional=true}}
Optional. This can be false to disable the recipe at the start of the game, or "true" to leave it enabled.
 
If your recipe is unlocked by a technology, you should set this to "false".
 
{{Prototype property|hidden|[[Types/bool|bool]]|false|optional=true}}
Optional. Hides the recipe from crafting menus.
 
{{Prototype property|hide_from_stats|[[Types/bool|bool]]|false|optional=true}}
Optional. Hides the recipe from flow stats (item/fluid production statistics).
 
{{Prototype property|hide_from_player_crafting|[[Types/bool|bool]]|false|optional=true}}
Optional. Hides the recipe from the player's crafting screen. The recipe will still show up for selection in machines.
 
{{Prototype property|allow_decomposition|[[Types/bool|bool]]|true|optional=true}}
Optional. Whether this recipe is allowed to be broken down for the recipe tooltip "Total raw" calculations.
 
{{Prototype property|allow_as_intermediate|[[Types/bool|bool]]|true|optional=true}}
Optional. Whether the recipe can be used as an intermediate recipe in hand-crafting.
 
{{Prototype property|allow_intermediates|[[Types/bool|bool]]|true|optional=true}}
Optional. Whether the recipe is allowed to use intermediate recipes when hand-crafting.
 
{{Prototype property|always_show_made_in|[[Types/bool|bool]]|false|optional=true}}
Optional. Whether the "Made in: {Machine}" part of the tool-tip should always be present, not only when the recipe can not be hand-crafted.
 
{{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]]"
 
{{Prototype property|always_show_products|[[Types/bool|bool]]|false|optional=true}}
Optional. Whether the products are always shown in the recipe tool-tip.
 
{{Prototype property|unlock_results|[[Types/bool|bool]]|true|optional=true}}
Optional. Whether enabling this recipe unlocks its item products to show in selection lists (item filter, logistic request etc.).
 
{{Prototype property|main_product|[[Types/string|string]]|optional=true}}
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.
 
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.
 
== Examples ==
 
=== "iron-plate" ===
<syntaxhighlight lang="lua">
  {
    type = "recipe",
    name = "iron-plate",
    category = "smelting",
    energy_required = 3.5,
    ingredients = {{"iron-ore", 1}},
    result = "iron-plate"
  }</syntaxhighlight>
 
=== "coal-liquefaction" ===
 
<syntaxhighlight lang="lua">{
  type = "recipe",
  name = "coal-liquefaction",
  category = "oil-processing",
  subgroup = "fluid-recipes",
  order = "a[oil-processing]-c[coal-liquefaction]",
  enabled = false,
  energy_required = 5,
  icon = "__base__/graphics/icons/fluid/coal-liquefaction.png",
  icon_size = 32,
  ingredients =
  {
    {type="item", name="coal", amount=10},
    {type="fluid", name="heavy-oil", amount=25},
    {type="fluid", name="steam", amount=50}
  },
  results=
  {
    {type="fluid", name="heavy-oil", amount=35},
    {type="fluid", name="light-oil", amount=15},
    {type="fluid", name="petroleum-gas", amount=20}
  },
  allow_decomposition = false
}</syntaxhighlight>
 
=== "iron-gear-wheel" — recipe with difficulty ===
<syntaxhighlight lang="lua"> {
    type = "recipe",
    name = "iron-gear-wheel",
    normal =
    {
      ingredients = {{"iron-plate", 2}},
      result = "iron-gear-wheel"
    },
    expensive =
    {
      ingredients = {{"iron-plate", 4}},
      result = "iron-gear-wheel"
    }
  },</syntaxhighlight>
 
==== Modified so that it cannot be crafted in normal mode, unless unlocked via command/research ====
<syntaxhighlight lang="lua">  {
    type = "recipe",
    name = "iron-gear-wheel",
    normal = false,
    expensive =
    {
      ingredients = {{"iron-plate", 4}},
      result = "iron-gear-wheel"
    }
  },</syntaxhighlight>
 
==== Modified so that the expensive recipe is always used, even in normal mode ====
<syntaxhighlight lang="lua">  {
    type = "recipe",
    name = "iron-gear-wheel",
    normal = nil, --this line can be omitted
    expensive =
    {
      ingredients = {{"iron-plate", 4}},
      result = "iron-gear-wheel"
    }
  },</syntaxhighlight>

Latest revision as of 14:33, 25 October 2024

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

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 on the forums.

Retrieved from "https://wiki.factorio.com/index.php?title=Prototype/Recipe&oldid=202973"