HytaleDocs

Projectiles

Asset path: Server/Projectiles/*.json

Parent

When set this asset will inherit properties from the named asset.

When inheriting from another Projectile most properties will simply be copied from the parent asset to this asset. In the case where both child and parent provide a field the child field will simply replace the value provided by the parent, in the case of nested structures this will apply to the fields within the structure. In some cases the field may decide to act differently, for example: by merging the parent and child fields together.

Type information: String

Tags

Tags are a general way to describe an asset that can be interpreted by other systems in a way they see fit.

For example you could tag something with a Material tag with the values Solid and Stone, And another single tag Ore.

Tags will be expanded into a single list of tags automatically. Using the above example with Material and Ore the end result would be the following list of tags: Ore, Material, Solid, Stone, Material=Solid and Material=Stone.

Type information:

(Nullable) Map of the following:

KeyType
any StringArray of String

Appearance

Type information: (Nullable) String

Reference to a ModelAsset asset

Radius

Type information: Number defaults to: 0.0

Height

Type information: Number defaults to: 0.0

VerticalCenterShot

Type information: Number defaults to: 0.0

HorizontalCenterShot

Type information: Number defaults to: 0.0

DepthShot

Type information: Number defaults to: 0.0

PitchAdjustShot

Type information: Boolean defaults to: false

MuzzleVelocity

Type information: Number defaults to: 0.0

TerminalVelocity

Type information: Number defaults to: 0.0

Gravity

Type information: Number defaults to: 0.0

Bounciness

Type information: Number defaults to: 0.0

ImpactSlowdown

Type information: Number defaults to: 0.0

SticksVertically

Type information: Boolean defaults to: false

ComputeYaw

Type information: Boolean defaults to: true

ComputePitch

Type information: Boolean defaults to: true

ComputeRoll

Type information: Boolean defaults to: true

TimeToLive

Type information: Number defaults to: 0.0

BounceSoundEventId

Type information: (Nullable) String

Reference to a SoundEvent asset

BounceParticles

Type information:

(Nullable) 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.

HitSoundEventId

Type information: (Nullable) String

Reference to a SoundEvent asset

HitParticles

Type information:

(Nullable) 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.

Damage

Type information: Integer defaults to: 0

DeadTime

Type information: Number defaults to: 0.0

MissSoundEventId

Type information: (Nullable) String

Reference to a SoundEvent asset

MissParticles

Type information:

(Nullable) 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.

DeadTimeMiss

Type information: Number defaults to: 10.0

DeathSoundEventId

Type information: (Nullable) String

Reference to a SoundEvent asset

DeathParticles

Type information:

(Nullable) 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.

DeathEffectsOnHit

Type information: Boolean defaults to: false

ExplosionConfig

The explosion config associated with this projectile

Type information:

(Nullable)

ExplosionConfig with the following properties:

KeyTypeDescription
DamageEntitiesBoolean defaults to: true

Determines whether the explosion should damage entities.

DamageBlocksBoolean defaults to: true

Determines whether the explosion should damage blocks.

DetonateExplosiveBlocksBoolean defaults to: true

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

BlockDamageRadiusInteger defaults to: 3

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

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

The falloff applied to the block damage.

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

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

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

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

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

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

EntityDamageCauseString defaults to: Environment

Reference to a DamageCause asset

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

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

The falloff applied to the entity damage.

Knockback(Nullable) Type Selector

Determines the knockback effect applied to damaged entities.

ItemTool(Nullable)
ItemTool

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
BreakShape(Nullable) Either BoxBreakShape or CylinderBreakShape

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.

BreakShapeDurabilityModeBreakShapeDurabilityMode

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.

The item tool to reference when applying damage to blocks.

Particles(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.

The particles to spawn when the explosion is triggered.

SoundEventId(Nullable) String

Reference to a SoundEvent asset

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

Density

Type information: Number defaults to: 2000.0

WaterTerminalVelocityMultiplier

Type information: Number defaults to: 1.0

WaterHitImpulseLoss

Type information: Number defaults to: 0.0

DampingRotation

Type information: Number defaults to: 0.0

RotationSpeedVelocityRatio

Type information: Number defaults to: 2.0

SwimmingDampingFactor

Type information: Number defaults to: 1.0

RotationMode

Type information:

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

NameDescription
"None"
"Velocity"
"VelocityDamped"

Notes:

Types referenced by this type

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.

BreakShapeDurabilityMode

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

NameDescription
"PerSwing"
"PerBlock"

EntityPart

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

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

ProjectileConfigs

Previous Page

ResponseCurves

Next Page

On this page

ParentTagsAppearanceRadiusHeightVerticalCenterShotHorizontalCenterShotDepthShotPitchAdjustShotMuzzleVelocityTerminalVelocityGravityBouncinessImpactSlowdownSticksVerticallyComputeYawComputePitchComputeRollTimeToLiveBounceSoundEventIdBounceParticlesHitSoundEventIdHitParticlesDamageDeadTimeMissSoundEventIdMissParticlesDeadTimeMissDeathSoundEventIdDeathParticlesDeathEffectsOnHitExplosionConfigDensityWaterTerminalVelocityMultiplierWaterHitImpulseLossDampingRotationRotationSpeedVelocityRatioSwimmingDampingFactorRotationModeNotes:Type SelectorChangeVelocityTypeBreakShapeDurabilityModeEntityPart