HytaleDocs
Misc

DamageEffects

ModelParticles

Type information:

(Nullable) Array of the type:

ModelParticle with the following properties:

KeyTypeDescription
SystemIdString

Reference to a ParticleSystem asset

TargetEntityPartAny one of the following String (defaults to Self):
EntityPart
NameDescription
"Self"
"Entity"
"PrimaryItem"
"SecondaryItem"
TargetNodeName(Nullable) String
Color(Nullable) A color in the form:

  • #RRGGBB

  • rgb(rrr, ggg, bbb)

ScaleNumber defaults to: 1.0
PositionOffset(Nullable)
Vector3f

Vector3f with the following properties:

KeyTypeDescription
XEither Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
YEither Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
ZEither Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
RotationOffset(Nullable)
Direction

Direction with the following properties:

KeyTypeDescription
Yaw(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Pitch(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Roll(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
DetachedFromModelBoolean defaults to: false

To indicate if the spawned particle should be attached to the model and follow it, or spawn in world space.

ClearParticlesOnRemoveBoolean defaults to: false

When the owning entity is removed, clear this effect's already-emitted particles instantly instead of letting them finish their lifespan.

WorldParticles

Type information:

(Nullable) Array of the type: Particle System that can be spawned in the world.

WorldParticle with the following properties:

KeyTypeDescription
SystemIdString

Reference to a ParticleSystem asset

The id of the particle system.

Color(Nullable) A color in the form:

  • #RRGGBB

  • rgb(rrr, ggg, bbb)

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

Scale(Nullable) Either Number defaults to: 1.0 or String that matches the pattern: ^(-?Infinity|NaN)$

The scale of the particle system.

PositionOffset(Nullable)
Vector3f

Vector3f with the following properties:

KeyTypeDescription
XEither Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
YEither Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
ZEither Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$

The position offset from the spawn position.

RotationOffset(Nullable)
Direction

Direction with the following properties:

KeyTypeDescription
Yaw(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Pitch(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Roll(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$

The rotation offset from the spawn rotation.

LocalSoundEventId

Type information: (Nullable) String

Reference to a SoundEvent asset

WorldSoundEventId

Type information: (Nullable) String

Reference to a SoundEvent asset

PlayerSoundEventId

The sound to play to a player receiving the damage.

Type information: (Nullable) String

Reference to a SoundEvent asset

ViewDistance

Type information: Number defaults to: 75.0

Knockback

Type information:

(Nullable) Any of these:

Key: TypeType
default case: Directional
DirectionalKnockback

DirectionalKnockback with the following properties:

KeyTypeDescription
Type(Nullable) String

This field controls the type, it must be set to the constant value "Directional" to function as this type.

ForceNumber defaults to: 0.0
Duration(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$

The duration for which the knockback force should be continuously applied. If 0, force is applied once.

VelocityType(Nullable) ChangeVelocityType
VelocityConfig(Nullable) VelocityConfig
RelativeXNumber defaults to: 0.0
VelocityYNumber defaults to: 0.0
RelativeZNumber defaults to: 0.0
Force
ForceKnockback

ForceKnockback with the following properties:

KeyTypeDescription
TypeConstant value: Force

This field controls the type, it must be set to the constant value "Force" to function as this type.

ForceNumber defaults to: 0.0
Duration(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$

The duration for which the knockback force should be continuously applied. If 0, force is applied once.

VelocityType(Nullable) ChangeVelocityType
VelocityConfig(Nullable) VelocityConfig
DirectionVector3d
Point
PointKnockback

PointKnockback with the following properties:

KeyTypeDescription
TypeConstant value: Point

This field controls the type, it must be set to the constant value "Point" to function as this type.

ForceNumber defaults to: 0.0
Duration(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$

The duration for which the knockback force should be continuously applied. If 0, force is applied once.

VelocityType(Nullable) ChangeVelocityType
VelocityConfig(Nullable) VelocityConfig
VelocityYNumber defaults to: 0.0
RotateYInteger defaults to: 0
OffsetXInteger defaults to: 0
OffsetZInteger defaults to: 0

CameraEffect

Type information:

(Nullable) Either String or CameraEffect

Reference to a CameraEffect asset

StaminaDrainMultiplier

A multiplier to apply to any stamina drain caused by this damage.

Type information:

(Nullable) Either Number defaults to: 1.0 or String that matches the pattern: ^(-?Infinity|NaN)$

Notes:

Types referenced by this type

ChangeVelocityType

(Nullable) Any one of the following String (defaults to Add):

NameDescription
"Add"

Adds the velocity to any existing velocity

"Set"

Changes the velocity to the given value. Overriding existing values.

On this page