FluidProductPrototype - Prototype Docs

FluidProductPrototype :: struct changed

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. [...]
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. [...]
fluidbox_multipliernew optional	:: uint8	Used to set crafting machine fluidbox volumes. [...]
Used to set crafting machine fluidbox volumes. [...]
optional_fluidbox_indexesnew optional	:: array[uint32]	Additional fluid boxes that will be also used by this fluid product. [...]
Additional fluid boxes that will be also used by this fluid product. [...]

Inherited from ProductPrototypeBase

independent_probabilitynew optional	:: double	Value between 0 and 1. [...]
Value between 0 and 1. [...]
shared_probabilitynew optional	:: SharedProbabilityDefinition	A range of values where lower end is at at least at value of 0 and upper end is at most at value of 1. [...]
A range of values where lower end is at at least at value of 0 and upper end is at most at value of 1. [...]
show_details_in_recipe_tooltipnew optional	:: boolean	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. [...]

name	:: FluidID	The name of a FluidPrototype.
The name of a FluidPrototype.
type	:: `"fluid"`
amount optional	:: FluidAmount	Can not be `< 0`.
Can not be `< 0`.
amount_max optional	:: FluidAmount	Only loaded, and mandatory if `amount` is not defined. [...]
Only loaded, and mandatory if `amount` is not defined. [...]
amount_min optional	:: FluidAmount	Only loaded, and mandatory if `amount` is not defined. [...]
Only loaded, and mandatory if `amount` is not defined. [...]
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. [...]
fluidbox_multipliernew optional	:: uint8	Used to set crafting machine fluidbox volumes. [...]
Used to set crafting machine fluidbox volumes. [...]
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. [...]
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. [...]
optional_fluidbox_indexesnew optional	:: array[uint32]	Additional fluid boxes that will be also used by this fluid product. [...]
Additional fluid boxes that will be also used by this fluid product. [...]
temperature optional	:: float	The temperature of the fluid product.
The temperature of the fluid product.

Inherited from ProductPrototypeBase

independent_probabilitynew optional	:: double	Value between 0 and 1. [...]
Value between 0 and 1. [...]
shared_probabilitynew optional	:: SharedProbabilityDefinition	A range of values where lower end is at at least at value of 0 and upper end is at most at value of 1. [...]
A range of values where lower end is at at least at value of 0 and upper end is at most at value of 1. [...]
show_details_in_recipe_tooltipnew optional	:: boolean	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.

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: Value of ignored_by_stats

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.

fluidbox_multiplier :: uint8 optional new

Default: 3

Used to set crafting machine fluidbox volumes. Must be at least 1.

optional_fluidbox_indexes :: array[uint32] optional new

Additional fluid boxes that will be also used by this fluid product. If a machine does not have a fluid box with that index, then this index will be silently skipped without making recipe uncraftable.

Only loaded if fluidbox_index is defined.

Type used in

ProductPrototype

Factorio Prototype Docs Version 2.1.8

FluidProductPrototype - Prototype Docs

FluidProductPrototype :: struct changed

Properties

Properties

type :: `"fluid"`

name :: FluidID

amount :: FluidAmount optional

amount_min :: FluidAmount optional

amount_max :: FluidAmount optional

ignored_by_stats :: FluidAmount optional

ignored_by_productivity :: FluidAmount optional

temperature :: float optional

fluidbox_index :: uint32 optional

fluidbox_multiplier :: uint8 optional new

optional_fluidbox_indexes :: array[uint32] optional new

Prototypes

Types

Defines

Factorio Prototype DocsVersion 2.1.8

FluidProductPrototype - Prototype Docs

FluidProductPrototype :: struct changed

Properties

Properties

type :: "fluid"

name :: FluidID

amount :: FluidAmount optional

amount_min :: FluidAmount optional

amount_max :: FluidAmount optional

ignored_by_stats :: FluidAmount optional

ignored_by_productivity :: FluidAmount optional

temperature :: float optional

fluidbox_index :: uint32 optional

fluidbox_multiplier :: uint8 optional new

optional_fluidbox_indexes :: array[uint32] optional new

Prototypes

Types

Defines

Factorio Prototype Docs Version 2.1.8

type :: `"fluid"`