LuaRecipe - Runtime Docs

Version 1.1.78 / Runtime Docs / Classes / LuaRecipe <>

Class LuaRecipe

A crafting recipe. Recipes belong to forces (see LuaForce) because some recipes are unlocked by research, and researches are per-force.

Members

reload()		Reload the recipe from the prototype.
Reload the recipe from the prototype.
help()	→ string	All methods and properties that this object supports.
All methods and properties that this object supports.
name [R]	:: string	Name of the recipe.
Name of the recipe.
localised_name [R]	:: LocalisedString	Localised name of the recipe.
Localised name of the recipe.
localised_description [R]	:: LocalisedString
prototype [R]	:: LuaRecipePrototype	The prototype for this recipe.
The prototype for this recipe.
enabled [RW]	:: boolean	Can the recipe be used?
Can the recipe be used?
category [R]	:: string	Category of the recipe.
Category of the recipe.
ingredients [R]	:: array[Ingredient]	Ingredients for this recipe.
Ingredients for this recipe.
products [R]	:: array[Product]	The results of this recipe.
The results of this recipe.
hidden [R]	:: boolean	Is the recipe hidden?
Is the recipe hidden?
hidden_from_flow_stats [RW]	:: boolean	Is the recipe hidden from flow statistics?
Is the recipe hidden from flow statistics?
energy [R]	:: double	Energy required to execute this recipe.
Energy required to execute this recipe.
order [R]	:: string	The string used to alphabetically sort these prototypes.
The string used to alphabetically sort these prototypes.
group [R]	:: LuaGroup	Group of this recipe.
Group of this recipe.
subgroup [R]	:: LuaGroup	Subgroup of this recipe.
Subgroup of this recipe.
force [R]	:: LuaForce	The force that owns this recipe.
The force that owns this recipe.
valid [R]	:: boolean	Is this object valid?
Is this object valid?
object_name [R]	:: string	The class name of this object.
The class name of this object.

Methods

reload()

Reload the recipe from the prototype.

help() → string

All methods and properties that this object supports.

Attributes

name :: string Read

Name of the recipe. This can be different than the name of the result items as there could be more recipes to make the same item.

localised_name :: LocalisedString Read

Localised name of the recipe.

localised_description :: LocalisedString Read

prototype :: LuaRecipePrototype Read

The prototype for this recipe.

enabled :: boolean Read/Write

Can the recipe be used?

category :: string Read

Category of the recipe.

ingredients :: array[Ingredient] Read

Ingredients for this recipe.

Examples

What the "steel-chest" recipe would return

{{type="item", name="steel-plate", amount=8}}

What the "advanced-oil-processing" recipe would return

{{type="fluid", name="crude-oil", amount=10}, {type="fluid", name="water", amount=5}}

products :: array[Product] Read

The results of this recipe.

hidden :: boolean Read

Is the recipe hidden? Hidden recipe don't show up in the crafting menu.

hidden_from_flow_stats :: boolean Read/Write

Is the recipe hidden from flow statistics?

energy :: double Read

Energy required to execute this recipe. This directly affects the crafting time: Recipe's energy is exactly its crafting time in seconds, when crafted in an assembling machine with crafting speed exactly equal to one.

order :: string Read

The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.

group :: LuaGroup Read

Group of this recipe.

subgroup :: LuaGroup Read

Subgroup of this recipe.

force :: LuaForce Read

The force that owns this recipe.

valid :: boolean Read

Is this object valid? This Lua object holds a reference to an object within the game engine. It is possible that the game-engine object is removed whilst a mod still holds the corresponding Lua object. If that happens, the object becomes invalid, i.e. this attribute will be false. Mods are advised to check for object validity if any change to the game state might have occurred between the creation of the Lua object and its access.

object_name :: string Read

The class name of this object. Available even when valid is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.

Factorio Runtime Docs