ModelVFX

← Back to Asset Types

Documentation for the ModelVFX asset type.

Location

Entity/ModelVFX

Use in Your Files

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

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

Schema

Tree

SwitchTo string

Enum:"Disappear""PostColor""Distortion""Transparency"

Default:"Disappear"

EffectDirection string

Enum:"None""BottomUp""TopDown""ToCenter""FromCenter"

Default:"None"

AnimationDuration NullableNumberOrSpecial

AnimationRange unknown

Any of

Vector2f

null

LoopOption string

Enum:"PlayOnce""Loop""LoopMirror"

Default:"PlayOnce"

CurveType string

Enum:"Linear""QuartIn""QuartOut""QuartInOut"

Default:"Linear"

HighlightColor unknown

Any of

string

string

null

HighlightThickness NullableNumberOrSpecial

UseBloomOnHighlight boolean

Default:false

UseProgessiveHighlight boolean

Default:false

NoiseScale unknown

Any of

Vector2f

null

NoiseScrollSpeed unknown

Any of

Vector2f

null

PostColor unknown

Any of

string

string

null

PostColorOpacity NullableNumberOrSpecial

All of

base

Raw JSON

Copy

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "ModelVFX.json",
  "title": "ModelVFX",
  "description": "ModelVFX asset type",
  "type": "object",
  "allOf": [
    {
      "$ref": "base.schema.json"
    }
  ],
  "properties": {
    "SwitchTo": {
      "type": "string",
      "title": "SwitchTo",
      "enum": [
        "Disappear",
        "PostColor",
        "Distortion",
        "Transparency"
      ],
      "default": "Disappear"
    },
    "EffectDirection": {
      "type": "string",
      "title": "EffectDirection",
      "enum": [
        "None",
        "BottomUp",
        "TopDown",
        "ToCenter",
        "FromCenter"
      ],
      "default": "None"
    },
    "AnimationDuration": {
      "$ref": "base.schema.json#/$defs/NullableNumberOrSpecial"
    },
    "AnimationRange": {
      "anyOf": [
        {
          "default": {
            "X": 0,
            "Y": 1
          },
          "$ref": "common.schema.json#/$defs/Vector2f"
        },
        {
          "type": "null"
        }
      ]
    },
    "LoopOption": {
      "type": "string",
      "title": "LoopOption",
      "enum": [
        "PlayOnce",
        "Loop",
        "LoopMirror"
      ],
      "default": "PlayOnce"
    },
    "CurveType": {
      "type": "string",
      "title": "CurveType",
      "enum": [
        "Linear",
        "QuartIn",
        "QuartOut",
        "QuartInOut"
      ],
      "default": "Linear"
    },
    "HighlightColor": {
      "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"
        }
      ]
    },
    "HighlightThickness": {
      "$ref": "base.schema.json#/$defs/NullableNumberOrSpecial"
    },
    "UseBloomOnHighlight": {
      "type": "boolean",
      "default": false
    },
    "UseProgessiveHighlight": {
      "type": "boolean",
      "default": false
    },
    "NoiseScale": {
      "anyOf": [
        {
          "default": {
            "X": 50,
            "Y": 50
          },
          "$ref": "common.schema.json#/$defs/Vector2f"
        },
        {
          "type": "null"
        }
      ]
    },
    "NoiseScrollSpeed": {
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/Vector2f"
        },
        {
          "type": "null"
        }
      ]
    },
    "PostColor": {
      "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"
        }
      ]
    },
    "PostColorOpacity": {
      "$ref": "base.schema.json#/$defs/NullableNumberOrSpecial"
    }
  }
}