LuaRecipe

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

Attributes

name

• Read: string
• Write: unknown
• Optional: false

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

• Read: LocalisedString
• Write: unknown
• Optional: false

Localised name of the recipe.

localised_description

• Read: LocalisedString
• Write: unknown
• Optional: false

prototype

• Read: LuaRecipePrototype
• Write: unknown
• Optional: false

The prototype for this recipe.

enabled

• Read: boolean
• Write: boolean
• Optional: false

Can the recipe be used?

category

• Read: string
• Write: unknown
• Optional: false

Category of the recipe.

additional_categories

• Read: Array<string>
• Write: unknown
• Optional: false

Additional categories of this recipe.

ingredients

• Read: Array<Ingredient>
• Write: unknown
• Optional: false

The ingredients to this recipe.

products

• Read: Array<Product>
• Write: unknown
• Optional: false

The results/products of this recipe.

hidden

• Read: boolean
• Write: unknown
• Optional: false

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

hidden_from_flow_stats

• Read: boolean
• Write: boolean
• Optional: false

Is the recipe hidden from flow statistics?

energy

• Read: double
• Write: unknown
• Optional: false

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

• Read: string
• Write: unknown
• Optional: false

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

group

• Read: LuaGroup
• Write: unknown
• Optional: false

Group of this recipe.

subgroup

• Read: LuaGroup
• Write: unknown
• Optional: false

Subgroup of this recipe.

force

• Read: LuaForce
• Write: unknown
• Optional: false

The force that owns this recipe.

productivity_bonus

• Read: float
• Write: float
• Optional: false

The productivity bonus for this recipe.

valid

• Read: boolean
• Write: unknown
• Optional: false

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

• Read: string
• Write: unknown
• Optional: false

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.

Methods

reload

LuaRecipe.reload()

Call As

recipe.reload()

Call Convention

• takes_table: false
• table_optional: false

Reload the recipe from the prototype.

has_category

LuaRecipe.has_category(category: RecipeCategoryID) -> boolean

Call As

recipe.has_category(category)

Call Convention

• takes_table: false
• table_optional: false

Checks if recipe has given category

Parameters

• category: RecipeCategoryID

Returns

• boolean — true if recipe has this category.