Struct LuaRecipePrototype 

pub struct LuaRecipePrototype;

A crafting recipe prototype.

Implementations

impl LuaRecipePrototype

pub fn custom_tooltip_fields(&self) -> Vec<CustomTooltipField>

Extra description items in the tooltip and Factoriopedia.

pub fn factoriopedia_description(&self) -> &str

Provides additional description used in factoriopedia.

pub fn group(&self) -> LuaGroup

Group of this prototype.

pub fn hidden(&self) -> bool

pub fn hidden_in_factoriopedia(&self) -> bool

pub fn localised_description(&self) -> &str

pub fn localised_name(&self) -> &str

pub fn name(&self) -> &str

Name of this prototype.

pub fn order(&self) -> &str

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

pub fn parameter(&self) -> bool

pub fn subgroup(&self) -> LuaGroup

Subgroup of this prototype.

pub fn type(&self) -> &str

Type of this prototype.

pub fn allow_as_intermediate(&self) -> bool

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

pub fn allow_decomposition(&self) -> bool

Whether this recipe is allowed to be broken down for the recipe tooltip “Total raw” calculations.

pub fn allow_inserter_overload(&self) -> bool

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

pub fn allow_intermediates(&self) -> bool

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

pub fn allowed_effects(&self) -> HashMap<String, bool>

The allowed module effects for this recipe, if any.

pub fn allowed_module_categories(&self) -> HashMap<String, bool>

The allowed module categories for this recipe, if any.

pub fn alternative_unlock_methods(&self) -> Vec<LuaTechnologyPrototype>

Additional technologies listed under “Unlocked by” on a recipe’s Factoriopedia page.

pub fn always_show_made_in(&self) -> bool

Should this recipe always show “Made in” in the tooltip?

pub fn can_set_quality(&self) -> bool

True if a player can set quality of the recipe to craft. False when only normal quality recipes can be crafted.

pub fn categories(&self) -> Vec<&str>

Categories of the recipe.

pub fn crafting_machine_tints(&self) -> Vec<Color>

pub fn effect_limitation_messages(&self) -> Vec<&str>

pub fn emissions_multiplier(&self) -> f64

The emissions multiplier for this recipe.

pub fn enabled(&self) -> bool

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

pub fn energy(&self) -> f64

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.

pub fn factoriopedia_alternative(&self) -> LuaRecipePrototype

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

pub fn hidden_from_flow_stats(&self) -> bool

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

pub fn hidden_from_player_crafting(&self) -> bool

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

pub fn hide_from_bonus_gui(&self) -> bool

pub fn hide_from_flow_stats(&self) -> bool

pub fn hide_from_player_crafting(&self) -> bool

pub fn hide_from_signal_gui(&self) -> bool

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

pub fn ingredients(&self) -> Vec<Ingredient>

The ingredients to this recipe.

pub fn main_product(&self) -> LuaAny

The main product of this recipe, if any.

pub fn maximum_productivity(&self) -> f64

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

pub fn object_name(&self) -> &str

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.

pub fn overload_multiplier(&self) -> u32

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

pub fn preserve_products_in_machine_output(&self) -> bool

pub fn products(&self) -> Vec<LuaAny>

The results/products of this recipe.

pub fn request_paste_multiplier(&self) -> u32

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.

pub fn surface_conditions(&self) -> Vec<SurfaceCondition>

The surface conditions required to craft this recipe.

pub fn trash(&self) -> Vec<LuaItemPrototype>

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

pub fn unlock_results(&self) -> bool

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

pub fn valid(&self) -> bool

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.

pub fn get_ingredient_quality( &self, ingredient_index: u32, recipe_quality: Option<LuaAny>, ) -> LuaQualityPrototype

Ingredient materials required to craft recipe when configured to a specific quality.

pub fn get_product_amount( &self, product_index: u32, productivity: Option<f64>, ) -> f64

Average amount of the product given.

pub fn get_product_quality( &self, product_index: u32, recipe_quality: Option<LuaAny>, ) -> LuaQualityPrototype

Quality of the product given when recipe is configured to a specific quality.

pub fn has_category(&self, category: LuaAny) -> bool

Checks if recipe has given category

Trait Implementations

impl Clone for LuaRecipePrototype

fn clone(&self) -> LuaRecipePrototype

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for LuaRecipePrototype

impl Debug for LuaRecipePrototype

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for LuaRecipePrototype

fn default() -> LuaRecipePrototype

Returns the “default value” for a type.

impl Eq for LuaRecipePrototype

impl From<LuaRecipePrototype> for LuaAny

fn from(_: LuaRecipePrototype) -> Self

Converts to this type from the input type.

impl LuaObject for LuaRecipePrototype

impl PartialEq for LuaRecipePrototype

fn eq(&self, other: &LuaRecipePrototype) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for LuaRecipePrototype