Fluid

← Back to Asset Types

Documentation for the Fluid asset type.

Location

Item/Block/Fluids

Use in Your Files

Add this to your JSON files for IDE autocompletion and validation:

"$schema": "https://hytaledb.ginco.gg/schemas/Fluid.schema.json" Copy

Schema

Tree

MaxFluidLevel integer

Default:8

Min: 0Max: 15

Textures arraynull

Array items: BlockTypeTextures

Effect arraynull

Array items: string

Opacity string

Enum:"Solid""Semitransparent""Cutout""Transparent"

Default:"Solid"

RequiresAlphaBlending boolean

Default:true

FluidFXId stringnull

Default:"Empty"

Ticker unknown

Any of

DefaultFluidTicker

FiniteFluidTicker

null

Light unknown

Any of

ColorLight

null

DamageToEntities integer

Default:0

BlockParticleSetId stringnull

The block particle set defined here defines which particles should be spawned when an entity interacts with this block (like when stepping on it for example

ParticleColor unknown

Any of

string

string

null

BlockSoundSetId stringnull

Sets the BlockSoundSet that will be used for this block for various events e.g. placement, breaking

Default:"EMPTY"

Interactions objectnull

Primary unknown

Any of

stringReference to RootInteraction

RootInteraction

Secondary unknown

Any of

stringReference to RootInteraction

RootInteraction

Ability1 unknown

Any of

stringReference to RootInteraction

RootInteraction

Ability2 unknown

Any of

stringReference to RootInteraction

RootInteraction

Ability3 unknown

Any of

stringReference to RootInteraction

RootInteraction

Use unknown

Any of

stringReference to RootInteraction

RootInteraction

Pick unknown

Any of

stringReference to RootInteraction

RootInteraction

Pickup unknown

Any of

stringReference to RootInteraction

RootInteraction

CollisionEnter unknown

Any of

stringReference to RootInteraction

RootInteraction

CollisionLeave unknown

Any of

stringReference to RootInteraction

RootInteraction

Collision unknown

Any of

stringReference to RootInteraction

RootInteraction

EntityStatEffect unknown

Any of

stringReference to RootInteraction

RootInteraction

SwapTo unknown

Any of

stringReference to RootInteraction

RootInteraction

SwapFrom unknown

Any of

stringReference to RootInteraction

RootInteraction

Death unknown

Any of

stringReference to RootInteraction

RootInteraction

Wielding unknown

Any of

stringReference to RootInteraction

RootInteraction

ProjectileSpawn unknown

Any of

stringReference to RootInteraction

RootInteraction

ProjectileHit unknown

Any of

stringReference to RootInteraction

RootInteraction

ProjectileMiss unknown

Any of

stringReference to RootInteraction

RootInteraction

ProjectileBounce unknown

Any of

stringReference to RootInteraction

RootInteraction

Held unknown

Any of

stringReference to RootInteraction

RootInteraction

HeldOffhand unknown

Any of

stringReference to RootInteraction

RootInteraction

Equipped unknown

Any of

stringReference to RootInteraction

RootInteraction

Dodge unknown

Any of

stringReference to RootInteraction

RootInteraction

GameModeSwap unknown

Any of

stringReference to RootInteraction

RootInteraction

Additional properties

Any of

stringReference to RootInteraction

RootInteraction

All of

base

Raw JSON

Copy

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "Fluid.json",
  "title": "Fluid",
  "description": "Fluid asset type",
  "type": "object",
  "allOf": [
    {
      "$ref": "base.schema.json"
    }
  ],
  "properties": {
    "MaxFluidLevel": {
      "type": "integer",
      "minimum": 0,
      "maximum": 15,
      "default": 8
    },
    "Textures": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "common.schema.json#/$defs/BlockTypeTextures"
      }
    },
    "Effect": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string",
        "title": "ShaderType",
        "enum": [
          "None",
          "Wind",
          "WindAttached",
          "WindRandom",
          "WindFractal",
          "Ice",
          "Water",
          "Lava",
          "Slime",
          "Ripple"
        ]
      }
    },
    "Opacity": {
      "type": "string",
      "title": "Opacity",
      "enum": [
        "Solid",
        "Semitransparent",
        "Cutout",
        "Transparent"
      ],
      "default": "Solid"
    },
    "RequiresAlphaBlending": {
      "type": "boolean",
      "default": true
    },
    "FluidFXId": {
      "type": [
        "string",
        "null"
      ],
      "default": "Empty"
    },
    "Ticker": {
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/DefaultFluidTicker"
        },
        {
          "$ref": "common.schema.json#/$defs/FiniteFluidTicker"
        },
        {
          "type": "null"
        }
      ]
    },
    "Light": {
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/ColorLight"
        },
        {
          "type": "null"
        }
      ]
    },
    "DamageToEntities": {
      "type": "integer",
      "default": 0
    },
    "BlockParticleSetId": {
      "type": [
        "string",
        "null"
      ],
      "description": "The block particle set defined here defines which particles should be spawned when an entity interacts with this block (like when stepping on it for example"
    },
    "ParticleColor": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^\\s*#([0-9a-fA-F]{3}){1,2}\\s*$"
        },
        {
          "type": "string",
          "pattern": "^\\s*rgb\\((\\s*[0-9]{1,3}\\s*,){2}\\s*[0-9]{1,3}\\s*\\)\\s*$"
        },
        {
          "type": "null"
        }
      ]
    },
    "BlockSoundSetId": {
      "type": [
        "string",
        "null"
      ],
      "description": "Sets the BlockSoundSet that will be used for this block for various events e.g. placement, breaking",
      "markdownDescription": "Sets the **BlockSoundSet** that will be used for this block for various events e.g. placement, breaking",
      "default": "EMPTY"
    },
    "Interactions": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "Primary": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "Secondary": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "Ability1": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "Ability2": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "Ability3": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "Use": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "Pick": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "Pickup": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "CollisionEnter": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "CollisionLeave": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "Collision": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "EntityStatEffect": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "SwapTo": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "SwapFrom": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "Death": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "Wielding": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "ProjectileSpawn": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "ProjectileHit": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "ProjectileMiss": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "ProjectileBounce": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "Held": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "HeldOffhand": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "Equipped": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "Dodge": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "GameModeSwap": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        }
      },
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string",
            "title": "Reference to RootInteraction"
          },
          {
            "$ref": "RootInteraction.json#"
          }
        ]
      },
      "propertyNames": {
        "enum": [
          "Primary",
          "Secondary",
          "Ability1",
          "Ability2",
          "Ability3",
          "Use",
          "Pick",
          "Pickup",
          "CollisionEnter",
          "CollisionLeave",
          "Collision",
          "EntityStatEffect",
          "SwapTo",
          "SwapFrom",
          "Death",
          "Wielding",
          "ProjectileSpawn",
          "ProjectileHit",
          "ProjectileMiss",
          "ProjectileBounce",
          "Held",
          "HeldOffhand",
          "Equipped",
          "Dodge",
          "GameModeSwap"
        ]
      }
    }
  }
}