FluidFX

← Back to Asset Types

Documentation for the FluidFX asset type.

Location

Item/Block/FluidFX

Use in Your Files

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

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

Schema

Tree

Fog string

Enum:"Color""ColorLight""EnvironmentTint"

Default:"Color"

FogColor unknown

Any of

string

string

null

FogDistance arraynull

Array items: number

FogDepthStart number

Default:40

FogDepthFalloff number

Default:10

ColorsSaturation number

Default:1

ColorsFilter arraynull

Array items: number

DistortionAmplitude number

Default:8

DistortionFrequency number

Default:4

Particle unknown

Any of

FluidParticle

null

MovementSettings unknown

Any of

FluidFXMovementSettings

null

All of

base

Raw JSON

Copy

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "FluidFX.json",
  "title": "FluidFX",
  "description": "FluidFX asset type",
  "type": "object",
  "allOf": [
    {
      "$ref": "base.schema.json"
    }
  ],
  "properties": {
    "Fog": {
      "type": "string",
      "title": "FluidFog",
      "enum": [
        "Color",
        "ColorLight",
        "EnvironmentTint"
      ],
      "default": "Color"
    },
    "FogColor": {
      "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"
        }
      ]
    },
    "FogDistance": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "number"
      },
      "minItems": 2,
      "maxItems": 2
    },
    "FogDepthStart": {
      "type": "number",
      "default": 40
    },
    "FogDepthFalloff": {
      "type": "number",
      "default": 10
    },
    "ColorsSaturation": {
      "type": "number",
      "default": 1
    },
    "ColorsFilter": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "number"
      },
      "minItems": 3,
      "maxItems": 3
    },
    "DistortionAmplitude": {
      "type": "number",
      "default": 8
    },
    "DistortionFrequency": {
      "type": "number",
      "default": 4
    },
    "Particle": {
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/FluidParticle"
        },
        {
          "type": "null"
        }
      ]
    },
    "MovementSettings": {
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/FluidFXMovementSettings"
        },
        {
          "type": "null"
        }
      ]
    }
  }
}