Home

FluidProductPrototype

A fluid product definition.

Type

struct

Properties

type

name

The name of a FluidPrototype.

amount

Can not be < 0.

amount_min

Only loaded, and mandatory if amount is not defined.

Can not be < 0.

amount_max

Only loaded, and mandatory if amount is not defined.

If set to a number that is less than amount_min, the game will use amount_min instead.

probability

Value between 0 and 1, 0 for 0% chance and 1 for 100% chance.

The effect of probability is no product, or a linear distribution on [min, max]. For a recipe with probability p, amount_min min, and amount_max max, the Expected Value of this product can be expressed as p * (0.5 * (max + min)). This is what will be shown in a recipe tooltip. The effect of ignored_by_productivity on the product is not shown.

When amount_min and amount_max are not provided, amount applies as min and max. The Expected Value simplifies to p * amount, providing 0 product, or amount product, on recipe completion.

ignored_by_stats

Amount that should not be included in the fluid production statistics, typically with a matching ingredient having the same amount set as ignored_by_stats.

If ignored_by_stats is larger than the amount crafted (for instance due to probability) it will instead show as consumed.

Products with ignored_by_stats defined will not be set as recipe through the circuit network when using the product's fluid-signal.

ignored_by_productivity

Amount that should be deducted from any productivity induced bonus crafts.

This value can safely be set larger than the maximum expected craft amount, any excess is ignored.

This value is ignored when allow_productivity is false.

temperature

The temperature of the fluid product.

fluidbox_index

Used to specify which CraftingMachinePrototype::fluid_boxes this product should use. It will use this one fluidbox. The index is 1-based and separate for input and output fluidboxes.

show_details_in_recipe_tooltip

When hovering over a recipe in the crafting menu the recipe tooltip will be shown. An additional item tooltip will be shown for every product, as a separate tooltip, if the item tooltip has a description and/or properties to show and if show_details_in_recipe_tooltip is true.