Types/FluidIngredientPrototype: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Updated styling of prototype doc migration note)
(Removed old prototype docs)
 
Line 2: Line 2:


</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>
</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>
A fluid ingredient definition, for example for a [[Prototype/Recipe]]. Its loading is triggered by the <code>type</code> of a [[Types/IngredientPrototype]] being "fluid".
== Mandatory properties ==
=== name ===
'''Type''': [[Types/string]]
The name of a [[Prototype/Fluid]].
=== amount ===
'''Type''': [[Types/double]]
== Optional properties ==
=== temperature ===
'''Type''': [[Types/double]]
Sets the expected temperature of the fluid ingredient.
=== minimum_temperature ===
'''Type''': [[Types/double]]
If [[#temperature]] is not set, this sets the expected ''minimum'' temperature of the fluid ingredient.
=== maximum_temperature ===
'''Type''': [[Types/double]]
If [[#temperature]] is not set, this sets the expected ''maximum'' temperature of the fluid ingredient.
=== catalyst_amount ===
'''Type''': [[Types/double]]
'''Default''': 0
Amount of this ingredient that should not be included in the fluid consumption statistics. Usually used together with an equal catalyst amount on the "product" of the catalyst in the recipe.
If this FluidIngredientPrototype is used in a recipe, the catalyst amount is calculated automatically based on the [[Prototype/Recipe#ingredients|ingredients]] and [[Prototype/Recipe#results|results]].[https://factorio.com/blog/post/fff-256]
=== fluidbox_index ===
'''Type''': [[Types/uint32]]
'''Default''': 0 (no specific fluidbox)
Used to specify which [[Prototype/CraftingMachine#fluid_boxes|fluidbox]] this ingredient should use on the [[Prototype/CraftingMachine|machine]]. It will only use this one fluidbox.
== Example ==
<syntaxhighlight lang="lua">
{type="fluid", name="water", amount=50}</syntaxhighlight>
== See also ==
* [[Types/IngredientPrototype]]
* [[Types/ItemIngredientPrototype]]

Latest revision as of 14:32, 25 October 2024

The prototype docs have moved to a new website with an improved format. This documentation page can now be found here: https://lua-api.factorio.com/latest/types/FluidIngredientPrototype.html

This wiki page is no longer updated and will be removed at some point in the future, so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback on the forums.