particle_animation

Plays a particle animation at the trigger location over time using a named animation pattern.

Categories: visual

Required arguments

Key(s)DescriptionType
particleThe particle type to spawn during the animation.STRING
animationThe animation pattern to use (e.g. circle, helix).
Choices: circle, double_helix, ground_spiral, helix, trace, twirl, wing_tips, projectile_trail
STRING

Inherited argument blocks

  • subsection particle_args — The shape arguments for the chosen animation. The accepted keys depend on the animation — see its own documentation. Every animation additionally accepts an optional tick-multiplier, the number of animation steps to advance per tick.

particle_args for circle

KeyDescriptionTypeRequired
particle_args.radiusThe radius of the circle in blocks.STRINGyes
particle_args.durationHow long in ticks the animation runs for, and the period of one full circle.STRINGyes
particle_args.heightThe height above the anchor location to draw the circle at.STRINGyes
particle_args.pitchThe pitch to rotate the circle by, in degrees. 0 draws a flat, horizontal circle.STRINGyes
particle_args.rollThe roll to rotate the circle by, in degrees. 0 draws a flat, horizontal circle.STRINGyes
particle_args.tick-multiplierHow many animation steps to advance per tick. Raise it to draw the shape faster or more densely; omit it to advance one step per tick.STRINGno

particle_args for double_helix

KeyDescriptionTypeRequired
particle_args.heightThe total height the helix climbs over one duration.STRINGyes
particle_args.durationHow long in ticks the animation runs for.STRINGyes
particle_args.speedHow quickly the helix rotates as it climbs.STRINGyes
particle_args.radiusThe radius of each strand of the helix in blocks.STRINGyes
particle_args.tick-multiplierHow many animation steps to advance per tick. Raise it to draw the shape faster or more densely; omit it to advance one step per tick.STRINGno

particle_args for ground_spiral

KeyDescriptionTypeRequired
particle_args.scalarHow quickly the spiral rotates around the entity.STRINGyes
particle_args.distance-scalarHow quickly the spiral expands outwards from the entity.STRINGyes
particle_args.durationHow long in ticks the animation runs for.STRINGyes
particle_args.tick-multiplierHow many animation steps to advance per tick. Raise it to draw the shape faster or more densely; omit it to advance one step per tick.STRINGno

particle_args for helix

KeyDescriptionTypeRequired
particle_args.heightThe total height the helix climbs over one duration.STRINGyes
particle_args.durationHow long in ticks the animation runs for.STRINGyes
particle_args.speedHow quickly the helix rotates as it climbs.STRINGyes
particle_args.radiusThe radius of the helix in blocks.STRINGyes
particle_args.tick-multiplierHow many animation steps to advance per tick. Raise it to draw the shape faster or more densely; omit it to advance one step per tick.STRINGno

particle_args for trace

KeyDescriptionTypeRequired
particle_args.spacingThe distance between each particle along the traced line.STRINGyes
particle_args.tick-multiplierHow many animation steps to advance per tick. Raise it to draw the shape faster or more densely; omit it to advance one step per tick.STRINGno

particle_args for twirl

KeyDescriptionTypeRequired
particle_args.small-radiusThe radius the twirl starts at, in blocks.STRINGyes
particle_args.large-radiusThe radius the twirl ends at, in blocks.STRINGyes
particle_args.durationHow long in ticks the animation runs for.STRINGyes
particle_args.start-heightThe height above the anchor location the twirl starts at.STRINGyes
particle_args.end-heightThe height above the anchor location the twirl ends at.STRINGyes
particle_args.speedHow quickly the twirl rotates as it grows.STRINGyes
particle_args.tick-multiplierHow many animation steps to advance per tick. Raise it to draw the shape faster or more densely; omit it to advance one step per tick.STRINGno

particle_args for wing_tips

KeyDescriptionTypeRequired
particle_args.tick-multiplierHow many animation steps to advance per tick. Raise it to draw the shape faster or more densely; omit it to advance one step per tick.STRINGno

particle_args for projectile_trail

KeyDescriptionTypeRequired
particle_args.gapHow many ticks to wait between each particle of the trail.STRINGyes
particle_args.tick-multiplierHow many animation steps to advance per tick. Raise it to draw the shape faster or more densely; omit it to advance one step per tick.STRINGno

Optional arguments

Key(s)DescriptionTypeDefault
particle-amountThe number of particles to spawn per animation point per tick. Supports expressions.EXPRESSION1
entityThe entity to anchor the animation to.
Choices: player, victim, projectile
STRINGplayer
use-eye-locationWhether to use the entity's eye location instead of their feet.BOOLEANfalse

Trigger parameters required

  • PLAYER

  • LOCATION

Example

effects:
  - id: particle_animation
    args:
      particle: flame
      animation: circle|double_helix|ground_spiral|helix|trace|twirl|wing_tips|projectile_trail
      particle-amount: <expression> # ← Optional
      entity: player|victim|projectile # ← Optional
      use-eye-location: true # ← Optional

Behaviour

SettingValue
Run orderNORMAL
Supports delaytrue
Reloads on plugin reloadtrue