LuaRecipePrototype

A crafting recipe prototype.

Parent

• LuaPrototypeBase

Attributes

enabled

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

If this recipe prototype is enabled by default (enabled at the beginning of a game).

category

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

Category of the recipe.

additional_categories

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

Additional categories of the 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.

main_product

• Read: Product
• Write: unknown
• Optional: true

The main product of this recipe, if any.

hidden_from_flow_stats

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

Is the recipe hidden from flow statistics (item/fluid production statistics)?

hidden_from_player_crafting

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

Is the recipe hidden from player crafting? The recipe will still show up for selection in machines.

always_show_made_in

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

Should this recipe always show "Made in" in the tooltip?

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.

request_paste_multiplier

• Read: uint32
• Write: unknown
• Optional: false

The multiplier used when this recipe is copied from an assembling machine to a requester chest. For each item in the recipe the item count * this value is set in the requester chest.

overload_multiplier

• Read: uint32
• Write: unknown
• Optional: false

Used to determine how many extra items are put into an assembling machine before it's considered "full enough".

maximum_productivity

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

The maximal productivity bonus that can be achieved with this recipe.

allow_inserter_overload

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

If the recipe is allowed to have the extra inserter overload bonus applied (4 * stack inserter stack size).

allow_as_intermediate

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

If this recipe is enabled for the purpose of intermediate hand-crafting.

allow_intermediates

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

If this recipe is allowed to use intermediate recipes when hand-crafting.

show_amount_in_title

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

If the amount is shown in the recipe tooltip title when the recipe produces more than 1 product.

always_show_products

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

If the products are always shown in the recipe tooltip.

emissions_multiplier

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

The emissions multiplier for this recipe.

allow_decomposition

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

Is this recipe allowed to be broken down for the recipe tooltip "Total raw" calculations?

unlock_results

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

Is this recipe unlocks the result item(s) so they're shown in filter-select GUIs.

hide_from_signal_gui

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

Is this recipe is marked to be hidden from the signal GUI.

hide_from_flow_stats

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

hide_from_player_crafting

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

hide_from_bonus_gui

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

trash

• Read: Array<LuaItemPrototype>
• Write: unknown
• Optional: true

The 'trash' items that this recipe might produce as a result of spoiling.

preserve_products_in_machine_output

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

is_parameter

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

allowed_effects

• Read: Dict<string, boolean>
• Write: unknown
• Optional: true

The allowed module effects for this recipe, if any.

allowed_module_categories

• Read: Dict<string, true>
• Write: unknown
• Optional: true

The allowed module categories for this recipe, if any.

effect_limitation_messages

• Read: Array<LocalisedString>
• Write: unknown
• Optional: true

surface_conditions

• Read: Array<SurfaceCondition>
• Write: unknown
• Optional: true

The surface conditions required to craft this recipe.

alternative_unlock_methods

• Read: Array<LuaTechnologyPrototype>
• Write: unknown
• Optional: true

Additional technologies listed under "Unlocked by" on a recipe's Factoriopedia page.

crafting_machine_tints

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

factoriopedia_alternative

• Read: LuaRecipePrototype
• Write: unknown
• Optional: true

An alternative prototype that will be used to display info about this prototype in Factoriopedia.

result_is_always_fresh

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

reset_freshness_on_craft

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

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

has_category

LuaRecipePrototype.has_category(category: RecipeCategoryID) -> boolean

Call As

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