EntityEffect

← Back to Asset Types

Documentation for the EntityEffect asset type.

Location

Entity/Effects

Use in Your Files

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

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

Schema

Tree

Name stringnull

The name of this entity effect that will be displayed in the UI. This must be a localization key.

ApplicationEffects unknown

Any of

ApplicationEffects

null

WorldRemovalSoundEventId stringnull

LocalRemovalSoundEventId stringnull

DamageCalculator unknown

Any of

DamageCalculator

null

DamageCalculatorCooldown NullableNumberOrSpecial

DamageEffects unknown

Any of

DamageEffects

null

StatModifierEffects unknown

Effects to play when stat modifiers are applied and updated.

Any of

DamageEffects

null

ModelOverride unknown

Any of

ModelOverride

null

ModelChange stringnull

A model to change the affected entity's appearance to.

RawStatModifiers objectnull

Additional properties: array

StatModifiers objectnull

Modifiers to apply to EntityStats.

Additional properties: number

ValueType string

Enum to specify if the StatModifiers must be considered as absolute values or percent. Default value is Absolute. When using ValueType.Absolute, '100' matches the max value.

Enum:"Percent""Absolute"

Default:"Absolute"

Duration NullableNumberOrSpecial

Value used by default unless specified otherwise in the method's call.

OverlapBehavior stringnull

Value used by default unless specified otherwise in the method's call.

Enum:"Extend""Overwrite""Ignore"

Default:"Ignore"

Infinite boolean

Value used by default unless specified otherwise in the method's call.

Default:false

Debuff boolean

Value used by default unless specified otherwise in the method's call.

Default:false

Locale stringnull

An optional translation key, used to display the damage cause upon death.

StatusEffectIcon stringnull

Value used by default unless specified otherwise in the method's call.

RemovalBehavior stringnull

Value used by default unless specified otherwise in the method's call.

Enum:"Complete""Infinite""Duration"

Default:"Complete"

Invulnerable boolean

Determines whether this effect applies the invulnerable component to the entity whilst active.

Default:false

DamageResistance objectnull

Additional properties: array

All of

base

Raw JSON

Copy

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "EntityEffect.json",
  "title": "EntityEffect",
  "description": "EntityEffect asset type",
  "type": "object",
  "allOf": [
    {
      "$ref": "base.schema.json"
    }
  ],
  "properties": {
    "Name": {
      "type": [
        "string",
        "null"
      ],
      "description": "The name of this entity effect that will be displayed in the UI. This must be a localization key."
    },
    "ApplicationEffects": {
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/ApplicationEffects"
        },
        {
          "type": "null"
        }
      ]
    },
    "WorldRemovalSoundEventId": {
      "type": [
        "string",
        "null"
      ]
    },
    "LocalRemovalSoundEventId": {
      "type": [
        "string",
        "null"
      ]
    },
    "DamageCalculator": {
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/DamageCalculator"
        },
        {
          "type": "null"
        }
      ]
    },
    "DamageCalculatorCooldown": {
      "$ref": "base.schema.json#/$defs/NullableNumberOrSpecial"
    },
    "DamageEffects": {
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/DamageEffects"
        },
        {
          "type": "null"
        }
      ]
    },
    "StatModifierEffects": {
      "description": "Effects to play when stat modifiers are applied and updated.",
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/DamageEffects"
        },
        {
          "type": "null"
        }
      ]
    },
    "ModelOverride": {
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/ModelOverride"
        },
        {
          "type": "null"
        }
      ]
    },
    "ModelChange": {
      "type": [
        "string",
        "null"
      ],
      "description": "A model to change the affected entity's appearance to."
    },
    "RawStatModifiers": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": "array",
        "items": {
          "$ref": "common.schema.json#/$defs/StaticModifier"
        }
      }
    },
    "StatModifiers": {
      "type": [
        "object",
        "null"
      ],
      "title": "Map of string to float",
      "description": "Modifiers to apply to EntityStats.",
      "additionalProperties": {
        "type": "number"
      }
    },
    "ValueType": {
      "type": "string",
      "title": "ValueType",
      "description": "Enum to specify if the StatModifiers must be considered as absolute values or percent. Default value is Absolute. When using ValueType.Absolute, '100' matches the max value.",
      "enum": [
        "Percent",
        "Absolute"
      ],
      "default": "Absolute"
    },
    "Duration": {
      "description": "Value used by default unless specified otherwise in the method's call.",
      "$ref": "base.schema.json#/$defs/NullableNumberOrSpecial"
    },
    "OverlapBehavior": {
      "type": [
        "string",
        "null"
      ],
      "title": "OverlapBehavior",
      "description": "Value used by default unless specified otherwise in the method's call.",
      "enum": [
        "Extend",
        "Overwrite",
        "Ignore"
      ],
      "default": "Ignore"
    },
    "Infinite": {
      "type": "boolean",
      "description": "Value used by default unless specified otherwise in the method's call.",
      "default": false
    },
    "Debuff": {
      "type": "boolean",
      "description": "Value used by default unless specified otherwise in the method's call.",
      "default": false
    },
    "Locale": {
      "type": [
        "string",
        "null"
      ],
      "description": "An optional translation key, used to display the damage cause upon death."
    },
    "StatusEffectIcon": {
      "type": [
        "string",
        "null"
      ],
      "description": "Value used by default unless specified otherwise in the method's call."
    },
    "RemovalBehavior": {
      "type": [
        "string",
        "null"
      ],
      "title": "RemovalBehavior",
      "description": "Value used by default unless specified otherwise in the method's call.",
      "enum": [
        "Complete",
        "Infinite",
        "Duration"
      ],
      "default": "Complete"
    },
    "Invulnerable": {
      "type": "boolean",
      "description": "Determines whether this effect applies the invulnerable component to the entity whilst active.",
      "default": false
    },
    "DamageResistance": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": "array",
        "items": {
          "$ref": "common.schema.json#/$defs/StaticModifier"
        }
      }
    }
  }
}