ParticleSpawner

← Back to Asset Types

Documentation for the ParticleSpawner asset type.

Location

Particles

Use in Your Files

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

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

Schema

Tree

Shape string

Enum:"Sphere""Cube"

Default:"Sphere"

EmitOffset unknown

Any of

RangeVector3f

null

UseEmitDirection boolean

Use spawn position to determine direction. Overrides pitch/yaw in InitialVelocity.

Default:false

TotalParticles unknown

Any of

Range

null

LifeSpan NullableNumberOrSpecial

MaxConcurrentParticles integer

Default:0

ParticleLifeSpan unknown

Any of

Rangef

null

SpawnRate unknown

Any of

Rangef

null

SpawnBurst boolean

Default:false

WaveDelay unknown

Any of

Rangef

null

InitialVelocity unknown

Any of

InitialVelocity

null

ParticleRotationInfluence string

Enum:"None""Billboard""BillboardY""BillboardVelocity""Velocity"

Default:"None"

ParticleRotateWithSpawner boolean

Default:false

TrailSpawnerPositionMultiplier NullableNumberOrSpecial

TrailSpawnerRotationMultiplier NullableNumberOrSpecial

VelocityStretchMultiplier NullableNumberOrSpecial

Attractors arraynull

Array items: ParticleAttractor

RenderMode string

Enum:"BlendLinear""BlendAdd""Erosion""Distortion"

Default:"BlendLinear"

LightInfluence NullableNumberOrSpecial

IntersectionHighlight unknown

Any of

IntersectionHighlight

null

LinearFiltering boolean

Default:false

UVMotion unknown

Any of

UVMotion

null

CameraOffset NullableNumberOrSpecial

ParticleCollision unknown

Any of

ParticleCollision

null

IsLowRes boolean

Default:false

Particle Particle

All of

base

Raw JSON

Copy

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "ParticleSpawner.json",
  "title": "ParticleSpawner",
  "description": "ParticleSpawner asset type",
  "type": "object",
  "allOf": [
    {
      "$ref": "base.schema.json"
    }
  ],
  "properties": {
    "Shape": {
      "type": "string",
      "title": "EmitShape",
      "enum": [
        "Sphere",
        "Cube"
      ],
      "default": "Sphere"
    },
    "EmitOffset": {
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/RangeVector3f"
        },
        {
          "type": "null"
        }
      ]
    },
    "UseEmitDirection": {
      "type": "boolean",
      "description": "Use spawn position to determine direction. Overrides pitch/yaw in InitialVelocity.",
      "default": false
    },
    "TotalParticles": {
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/Range"
        },
        {
          "type": "null"
        }
      ]
    },
    "LifeSpan": {
      "$ref": "base.schema.json#/$defs/NullableNumberOrSpecial"
    },
    "MaxConcurrentParticles": {
      "type": "integer",
      "default": 0
    },
    "ParticleLifeSpan": {
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/Rangef"
        },
        {
          "type": "null"
        }
      ]
    },
    "SpawnRate": {
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/Rangef"
        },
        {
          "type": "null"
        }
      ]
    },
    "SpawnBurst": {
      "type": "boolean",
      "default": false
    },
    "WaveDelay": {
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/Rangef"
        },
        {
          "type": "null"
        }
      ]
    },
    "InitialVelocity": {
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/InitialVelocity"
        },
        {
          "type": "null"
        }
      ]
    },
    "ParticleRotationInfluence": {
      "type": "string",
      "title": "ParticleRotationInfluence",
      "enum": [
        "None",
        "Billboard",
        "BillboardY",
        "BillboardVelocity",
        "Velocity"
      ],
      "default": "None"
    },
    "ParticleRotateWithSpawner": {
      "type": "boolean",
      "default": false
    },
    "TrailSpawnerPositionMultiplier": {
      "$ref": "base.schema.json#/$defs/NullableNumberOrSpecial"
    },
    "TrailSpawnerRotationMultiplier": {
      "$ref": "base.schema.json#/$defs/NullableNumberOrSpecial"
    },
    "VelocityStretchMultiplier": {
      "$ref": "base.schema.json#/$defs/NullableNumberOrSpecial"
    },
    "Attractors": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "common.schema.json#/$defs/ParticleAttractor"
      }
    },
    "RenderMode": {
      "type": "string",
      "title": "FXRenderMode",
      "enum": [
        "BlendLinear",
        "BlendAdd",
        "Erosion",
        "Distortion"
      ],
      "default": "BlendLinear"
    },
    "LightInfluence": {
      "$ref": "base.schema.json#/$defs/NullableNumberOrSpecial"
    },
    "IntersectionHighlight": {
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/IntersectionHighlight"
        },
        {
          "type": "null"
        }
      ]
    },
    "LinearFiltering": {
      "type": "boolean",
      "default": false
    },
    "UVMotion": {
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/UVMotion"
        },
        {
          "type": "null"
        }
      ]
    },
    "CameraOffset": {
      "$ref": "base.schema.json#/$defs/NullableNumberOrSpecial"
    },
    "ParticleCollision": {
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/ParticleCollision"
        },
        {
          "type": "null"
        }
      ]
    },
    "IsLowRes": {
      "type": "boolean",
      "default": false
    },
    "Particle": {
      "$ref": "common.schema.json#/$defs/Particle"
    }
  }
}