Factorio Prototype DocsVersion 2.0.15

FluidProductPrototype :: struct

A fluid product definition.

Properties

type :: "fluid"
name :: FluidID

The name of a FluidPrototype.

The name of a FluidPrototype.

amount optional :: FluidAmount

Can not be < 0.

Can not be < 0.

amount_min optional :: FluidAmount

Only loaded, and mandatory if amount is not defined. [...]

Only loaded, and mandatory if amount is not defined. [...]

amount_max optional :: FluidAmount

Only loaded, and mandatory if amount is not defined. [...]

Only loaded, and mandatory if amount is not defined. [...]

probability optional :: double

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

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

ignored_by_stats optional :: FluidAmount

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. [...]

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. [...]

ignored_by_productivity optional :: FluidAmount

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

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

temperature optional :: float

The temperature of the fluid product.

The temperature of the fluid product.

fluidbox_index optional :: uint32

Used to specify which CraftingMachinePrototype::fluid_boxes this product should use. [...]

Used to specify which CraftingMachinePrototype::fluid_boxes this product should use. [...]

show_details_in_recipe_tooltip optional :: bool

When hovering over a recipe in the crafting menu the recipe tooltip will be shown. [...]

When hovering over a recipe in the crafting menu the recipe tooltip will be shown. [...]

Properties

type :: "fluid"

name :: FluidID

The name of a FluidPrototype.

amount :: FluidAmount optional

Can not be < 0.

amount_min :: FluidAmount optional

Only loaded, and mandatory if amount is not defined.

Can not be < 0.

amount_max :: FluidAmount optional

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 :: double optional

Default: 1

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 :: FluidAmount optional

Default: 0

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 :: FluidAmount optional

Default: 0

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 :: float optional

The temperature of the fluid product.

fluidbox_index :: uint32 optional

Default: 0

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 :: bool optional

Default: true

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.


Type used in

Prototypes

Types

Defines