Factorio Prototype DocsVersion 1.1.107

FluidProductPrototype :: struct

A fluid product definition.

Properties

type :: "fluid"
name :: FluidID

The name of a FluidPrototype.

The name of a FluidPrototype.

amount optional :: double

Can not be < 0.

Can not be < 0.

amount_min :: MaterialAmountType

Only loaded if amount is not defined. [...]

Only loaded if amount is not defined. [...]

amount_max :: MaterialAmountType

Only loaded if amount is not defined. [...]

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

catalyst_amount optional :: double

Amount that should not be affected by productivity modules (not yielded from bonus production) and should not be included in the fluid production statistics. [...]

Amount that should not be affected by productivity modules (not yielded from bonus production) and should not be included in the fluid production statistics. [...]

temperature optional :: double

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

Can not be < 0.

amount_min :: MaterialAmountType

Only loaded if amount is not defined.

Can not be < 0.

amount_max :: MaterialAmountType

Only loaded 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 catalyst_amount 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.

catalyst_amount :: double optional

Default: 0

Amount that should not be affected by productivity modules (not yielded from bonus production) and should not be included in the fluid production statistics.

If this FluidProductPrototype is used in a recipe, the catalyst_amount is calculated automatically based on the RecipePrototype::ingredients and RecipePrototype::results. See here.

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