fluid

Create a new fluid definition. Different properties can be provided for the fluid v ia the use of different children blocks:

• Properties is used to indicate the various stats change that drinking this fluid would cause to the player.

• Categories act as tags for the fluid, to easily identify it.

• BlendWhiteList and BlendBlackList are used to provide rules for the blending of this fluid with other fluids.

• Poison is used to define poison properties for the fluid.

Hierarchy

Valid Parent Blocks:

• module

Possible Child Blocks:

• BlendBlackList

• BlendWhiteList

• Categories

• Poison

• Properties

ID Properties

This block should have an ID.

Parameters

ColorReference

Type:

Any

A reference to a color defined in the Colors class. You can find a full list of the colors available in the Colors documentation.

For example, to use the color Azure from the documentation:

fluid yourFluid
{
  ColorReference = Azure,
  ...
}

DisplayName

Type:

Any

The name of the fluid that will be displayed in the game. The value corresponds to the key for the fluid’s name in the Fluids.json translation file. The translation keys for the fluid usually have the prefix Fluid_Name_ but this is technically not required.

For example:

fluid yourFluid
{
  DisplayName = Fluid_Name_YourFluid,
  ...
}

And in the translation file of your mod:

{
  "Fluid_Name_YourFluid": "Your Fluid"
}