HytaleDocs
Misc

TargetedDamage

DamageCalculator

Type information:

(Nullable)

DamageCalculator with the following properties:

KeyTypeDescription
Type(Nullable) Any one of the following String (defaults to Absolute):
Type
NameDescription
"Dps"
"Absolute"
ClassAny one of the following String (defaults to Unknown):
DamageClass
NameDescription
"Unknown"
"Light"
"Charged"
"Signature"

The class of the damage being created, used by the damage system to apply modifiers based on equipment of the source.

BaseDamage(Nullable) Map of the following:
Map of string to float
SequentialModifierStep(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
SequentialModifierMinimum(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$
RandomPercentageModifier(Nullable) Either Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$

TargetEntityEffects

Type information:

(Nullable) Map of the following:

KeyType
any String
TargetEntityEffect

TargetEntityEffect with the following properties:

KeyTypeDescription
DurationNumber defaults to: 0.0
ChanceNumber defaults to: 1.0
EntityTypeDurationModifiers(Nullable) Map of string to double
OverlapBehavior(Nullable) OverlapBehavior

DamageEffects

Type information:

(Nullable)

DamageEffects with the following properties:

KeyTypeDescription
ModelParticles(Nullable) Array of the type:
ModelParticle

ModelParticle with the following properties:

KeyTypeDescription
SystemIdString

Reference to a ParticleSystem asset

TargetEntityPartEntityPart
TargetNodeName(Nullable) String
Color(Nullable) A color in the form:

  • #RRGGBB

  • rgb(rrr, ggg, bbb)

ScaleNumber defaults to: 1.0
PositionOffset(Nullable) Vector3f
RotationOffset(Nullable) Direction
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(Nullable) Array of the type:
WorldParticle

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

The position offset from the spawn position.

RotationOffset(Nullable) Direction

The rotation offset from the spawn rotation.

LocalSoundEventId(Nullable) String

Reference to a SoundEvent asset

WorldSoundEventId(Nullable) String

Reference to a SoundEvent asset

PlayerSoundEventId(Nullable) String

Reference to a SoundEvent asset

The sound to play to a player receiving the damage.

ViewDistanceNumber defaults to: 75.0
Knockback(Nullable) Type Selector
CameraEffect(Nullable) Either String or CameraEffect

Reference to a CameraEffect asset

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

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

Next

The interactions to run when this interaction succeeds.

Type information:

(Nullable) Either String or Interaction

Reference to a Interaction asset

Notes:

Types referenced by this type

Map of string to double

(Nullable) Map of the following:

KeyType
StringNumber

OverlapBehavior

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

NameDescription
"Extend"
"Overwrite"
"Ignore"

EntityPart

Any one of the following String (defaults to Self):

NameDescription
"Self"
"Entity"
"PrimaryItem"
"SecondaryItem"

Type Selector

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

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