BlockParticleSet

← Back to Asset Types

Documentation for the BlockParticleSet asset type.

Location

Item/Block/Particles

Use in Your Files

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

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

Schema

Tree

Color unknown

The colour used if none was specified in the particle settings.

Any of

string

string

null

Scale NullableNumberOrSpecial

The scale of the particle system.

PositionOffset unknown

The position offset from the spawn position.

Any of

Vector3f

null

RotationOffset unknown

The rotation offset from the spawn rotation.

Any of

Direction

null

Particles object

Walk string

Run string

Sprint string

SoftLand string

HardLand string

MoveOut string

Hit string

Break string

Build string

Physics string

Additional properties: string

All of

base

Raw JSON

Copy

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "BlockParticleSet.json",
  "title": "BlockParticleSet",
  "description": "Particle Systems that can be spawned in relation to block events.",
  "type": "object",
  "allOf": [
    {
      "$ref": "base.schema.json"
    }
  ],
  "properties": {
    "Color": {
      "description": "The colour used if none was specified in the particle settings.",
      "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"
        }
      ]
    },
    "Scale": {
      "description": "The scale of the particle system.",
      "$ref": "base.schema.json#/$defs/NullableNumberOrSpecial"
    },
    "PositionOffset": {
      "description": "The position offset from the spawn position.",
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/Vector3f"
        },
        {
          "type": "null"
        }
      ]
    },
    "RotationOffset": {
      "description": "The rotation offset from the spawn rotation.",
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/Direction"
        },
        {
          "type": "null"
        }
      ]
    },
    "Particles": {
      "type": "object",
      "title": "Map of BlockParticleEvent",
      "properties": {
        "Walk": {
          "type": "string"
        },
        "Run": {
          "type": "string"
        },
        "Sprint": {
          "type": "string"
        },
        "SoftLand": {
          "type": "string"
        },
        "HardLand": {
          "type": "string"
        },
        "MoveOut": {
          "type": "string"
        },
        "Hit": {
          "type": "string"
        },
        "Break": {
          "type": "string"
        },
        "Build": {
          "type": "string"
        },
        "Physics": {
          "type": "string"
        }
      },
      "additionalProperties": {
        "type": "string"
      },
      "propertyNames": {
        "enum": [
          "Walk",
          "Run",
          "Sprint",
          "SoftLand",
          "HardLand",
          "MoveOut",
          "Hit",
          "Break",
          "Build",
          "Physics"
        ]
      }
    }
  }
}