Prototype/Recipe: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(→‎Properties: added main_product)
(overhaul to include Prototype)
Line 3: Line 3:


== Properties ==
== Properties ==
=== type ===
Inherits all properties from [[Prototype]].
'''Type''': [[Types/string]]
 
Must be "recipe".
 
=== name ===
'''Type''': [[Types/string]]
 
The unique name of this recipe.


=== ingredients ===
=== ingredients ===

Revision as of 13:05, 23 January 2018

Basics

A recipe. It can be a crafting recipe, a smelting recipe, or a custom type of recipe (see Prototype/RecipeCategory).

Properties

Inherits all properties from Prototype.

ingredients

Type: Types/table

A table containing ingredient names and counts. For example:

ingredients = {{"iron-stick", 2}, {"iron-plate", 3}}

or the same with full format:

ingredients = {{type = "item", name = "iron-stick", amount = 2}, {type = "item", name = "iron-plate", amount = 3}}

Maximal ingredient amount is 65535.

result

Type: Types/string

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".

result_count

Type: Types/unsigned

Optional. The number of items created by this recipe. The default is 1.

results

Type: Types/table

A table containing result names and counts. For example:

results=
    {
      {type="fluid", name="heavy-oil", amount=3},
      {type="fluid", name="light-oil", amount=3},
      {type="fluid", name="petroleum-gas", amount=4}
    },
results = 
    {
      {type = "item", name = "iron-nuggets", amount = 9},
      {type = "item", name = "gold-nuggets", amount = 1}
     },

category

Type: Types/string

Optional. The category of this recipe. The default is "crafting". The built-in categories can be found here. See also Prototype/RecipeCategory.

energy_required

Type: Types/unsigned

Optional. The amount of time it takes to make this recipe. The default is 0.5.

For crafting recipes, this is the number of seconds it takes to craft at crafting speed 1.

enabled

Type: Types/bool

Optional. This can be false to disable the recipe at the start of the game, or "true" to leave it enabled. The default is true.

If your recipe is unlocked by a technology, you should set this to "false".

main_product

Type: Types/string

Optional.

For recipes with more than one product: This defines of which result the icon, subgroup and name is used. If it is not set and the recipe has more than 1 result the recipe will use the recipe-name and recipe-description locale and its own subgroup and icon.

For recipes with 1 result: The recipe uses the icon, subgroup and name of the result by default. If set this property is set to an empty string, the recipe will use the properties of the recipe instead of the result.

Examples

vanilla "iron-plate"

  {
    type = "recipe",
    name = "iron-plate",
    category = "smelting",
    energy_required = 3.5,
    ingredients = {{"iron-ore", 1}},
    result = "iron-plate"
  }

vanilla "coal-liquefaction"

data.raw.recipe["coal-liquefaction"] = {
  type = "recipe",
  name = "coal-liquefaction",

  category = "oil-processing",
  subgroup = "fluid-recipes",
  order = "a[oil-processing]-c[coal-liquefaction]",

  enabled = false,
  energy_required = 5,
  icons = {{icon = "__base__/graphics/icons/fluid/coal-liquefaction.png"}},
  ingredients = {
    {
      amount = 10,
      name = "coal",
      type = "item"
    },
    {
      amount = 25,
      name = "heavy-oil",
      type = "fluid"
    },
    {
      amount = 50,
      name = "steam",
      type = "fluid"
    }
  },

  results = {
    {
      amount = 35,
      name = "heavy-oil",
      type = "fluid"
    },
    {
      amount = 15,
      name = "light-oil",
      type = "fluid"
    },
    {
      amount = 20,
      name = "petroleum-gas",
      type = "fluid"
    }
  },
  allow_decomposition = false
}