HytaleDocs
Misc

ExplosionConfig

DamageEntities

Determines whether the explosion should damage entities.

Type information: Boolean defaults to: true

DamageBlocks

Determines whether the explosion should damage blocks.

Type information: Boolean defaults to: true

DetonateExplosiveBlocks

Determines whether the explosion should detonate explosive blocks within the explosion radius.

Type information: Boolean defaults to: true

BlockDamageRadius

The radius in which blocks should be damaged by the explosion.

Type information: Integer defaults to: 3

BlockDamageFalloff

The falloff applied to the block damage.

Type information:

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

BlockDropChance

The chance in which a block drops its loot after breaking.

Type information:

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

EntityDamageRadius

The radius in which entities should be damaged by the explosion.

Type information:

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

EntityDamage

The amount of damage to be applied to entities within range.

Type information:

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

EntityDamageCause

The cause of the damage to be applied to entities within range.

Type information: String defaults to: Environment

Reference to a DamageCause asset

EntityDamageFalloff

The falloff applied to the entity damage.

Type information:

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

Knockback

Determines the knockback effect applied to damaged entities.

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

ItemTool

The item tool to reference when applying damage to blocks.

Type information:

(Nullable)

ItemTool with the following properties:

KeyTypeDescription
Specs(Nullable) Array of the type: ItemToolSpec
SpeedNumber defaults to: 0.0
DurabilityLossBlockTypes(Nullable) Array of the type:
DurabilityLossBlockTypes

DurabilityLossBlockTypes with the following properties:

KeyTypeDescription
BlockTypes(Nullable) Array of String
BlockSets(Nullable) Array of String
DurabilityLossOnHitNumber defaults to: 0.0
BreakShape(Nullable) Either
BoxBreakShape

BoxBreakShape with the following properties:

KeyTypeDescription
IdConstant value: Box

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

WidthInteger defaults to: 1

The size of the shape along the user's horizontal view axis (right).

HeightInteger defaults to: 1

The size of the shape along the user's vertical view axis (up).

DepthInteger defaults to: 1

How many blocks deep the shape extends into the targeted surface. Defaults to 1.

CenteredBoolean defaults to: true

Whether the shape's width/height are centered on the targeted block. Defaults to true.

OffsetVector3d

Shifts the shape's center off the targeted block, in the view basis (x = right, y = up, z = into the surface). Rounded to whole blocks.

OrientationBreakShapeOrientation

How the shape is oriented: 'View' (the dominant axis of the look direction, the default) or 'Surface' (into the targeted block face that the look ray hits).

or
CylinderBreakShape

CylinderBreakShape with the following properties:

KeyTypeDescription
IdConstant value: Cylinder

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

WidthInteger defaults to: 1

The size of the shape along the user's horizontal view axis (right).

HeightInteger defaults to: 1

The size of the shape along the user's vertical view axis (up).

DepthInteger defaults to: 1

How many blocks deep the shape extends into the targeted surface. Defaults to 1.

CenteredBoolean defaults to: true

Whether the shape's width/height are centered on the targeted block. Defaults to true.

OffsetVector3d

Shifts the shape's center off the targeted block, in the view basis (x = right, y = up, z = into the surface). Rounded to whole blocks.

OrientationBreakShapeOrientation

How the shape is oriented: 'View' (the dominant axis of the look direction, the default) or 'Surface' (into the targeted block face that the look ray hits).

Optional break shape. When set, breaking with this tool affects the set of blocks the shape covers (oriented to the user's view) instead of only the targeted block.

BreakShapeDurabilityModeAny one of the following String (defaults to PerSwing):
BreakShapeDurabilityMode
NameDescription
"PerSwing"
"PerBlock"

How durability is consumed when a break shape affects multiple blocks: once per swing, or once per block broken.

HitSoundLayer(Nullable) String

Reference to a SoundEvent asset

Sound to play in addition to the block breaking sound when hitting a block this tool is designed to break.

IncorrectMaterialSoundLayer(Nullable) String

Reference to a SoundEvent asset

Sound to play in addition to the block breaking sound when hitting a block this tool cannot break.

Particles

The particles to spawn when the explosion is triggered.

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.

SoundEventId

The sound event played to surrounding players when the explosion is triggered.

Type information: (Nullable) String

Reference to a SoundEvent asset

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.

BreakShapeOrientation

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

NameDescription
"View"
"Surface"

On this page