component FluidContainer#

Adds a fluid container to an item

Hierarchy#

Valid Parent Blocks:

Possible Child Blocks:

ID Properties#

This block should not have an ID.

Parameters#

Capacity 🔗

Type: float

The fluid capacity of the container, the minimum value is 0.05.

Default: 1.0

ContainerName 🔗

Type: string

The name of the fluid container, seems to be unused. The name cannot have whitespaces, the game will sanitize it to remove them and show an error in the console about it.

Default: FluidContainer

CustomDrinkSound 🔗

Type: string

Refers to a sound block to trigger when drinking.

Default: DrinkingFromGeneric

FillsWithCleanWater 🔗

Type: boolean

When set to true, the container will fill with clean water instead of tainted water when left outside in the rain.

Default: False

HiddenAmount 🔗

Type: boolean

When true, will hide the fluid quantity from the UI.

Default: False

InitialPercent 🔗

Type: float

No description

InitialPercentMax 🔗

Type: float

The minimum amount of fluid which will appear in this container.

Default: 1.0

InitialPercentMin 🔗

Type: float

The maximum amount of fluid which will appear in this container.

Default: 0.0

InputLocked 🔗

Type: boolean

Unused.

Default: False

Opened 🔗

Type: boolean

Unused.

Default: True

PickRandomFluid 🔗

Type: boolean

When set to true, the container will pick one of the available fluids in the Fluids child block at random when filling. If set to false, it will make every fluids appear.

Default: False

RainFactor 🔗

Type: float

Defines how much rain contributes to filling the container. A high value increases the rate of filling. A value of 0.0 means that rain will not fill the container, which is the default value of the parameter.

If the item is a weapon and RainFactor is set to a value above the default, when the player aims with the weapon it will empty it.

Default: 0.0