particle_animation
Plays a particle animation at the trigger location over time using a named animation pattern.
Categories: visual
Required arguments
| Key(s) | Description | Type |
|---|---|---|
particle | The particle type to spawn during the animation. | STRING |
animation | The 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
| Key | Description | Type | Required |
|---|---|---|---|
particle_args.radius | The radius of the circle in blocks. | STRING | yes |
particle_args.duration | How long in ticks the animation runs for, and the period of one full circle. | STRING | yes |
particle_args.height | The height above the anchor location to draw the circle at. | STRING | yes |
particle_args.pitch | The pitch to rotate the circle by, in degrees. 0 draws a flat, horizontal circle. | STRING | yes |
particle_args.roll | The roll to rotate the circle by, in degrees. 0 draws a flat, horizontal circle. | STRING | yes |
particle_args.tick-multiplier | How 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. | STRING | no |
particle_args for double_helix
| Key | Description | Type | Required |
|---|---|---|---|
particle_args.height | The total height the helix climbs over one duration. | STRING | yes |
particle_args.duration | How long in ticks the animation runs for. | STRING | yes |
particle_args.speed | How quickly the helix rotates as it climbs. | STRING | yes |
particle_args.radius | The radius of each strand of the helix in blocks. | STRING | yes |
particle_args.tick-multiplier | How 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. | STRING | no |
particle_args for ground_spiral
| Key | Description | Type | Required |
|---|---|---|---|
particle_args.scalar | How quickly the spiral rotates around the entity. | STRING | yes |
particle_args.distance-scalar | How quickly the spiral expands outwards from the entity. | STRING | yes |
particle_args.duration | How long in ticks the animation runs for. | STRING | yes |
particle_args.tick-multiplier | How 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. | STRING | no |
particle_args for helix
| Key | Description | Type | Required |
|---|---|---|---|
particle_args.height | The total height the helix climbs over one duration. | STRING | yes |
particle_args.duration | How long in ticks the animation runs for. | STRING | yes |
particle_args.speed | How quickly the helix rotates as it climbs. | STRING | yes |
particle_args.radius | The radius of the helix in blocks. | STRING | yes |
particle_args.tick-multiplier | How 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. | STRING | no |
particle_args for trace
| Key | Description | Type | Required |
|---|---|---|---|
particle_args.spacing | The distance between each particle along the traced line. | STRING | yes |
particle_args.tick-multiplier | How 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. | STRING | no |
particle_args for twirl
| Key | Description | Type | Required |
|---|---|---|---|
particle_args.small-radius | The radius the twirl starts at, in blocks. | STRING | yes |
particle_args.large-radius | The radius the twirl ends at, in blocks. | STRING | yes |
particle_args.duration | How long in ticks the animation runs for. | STRING | yes |
particle_args.start-height | The height above the anchor location the twirl starts at. | STRING | yes |
particle_args.end-height | The height above the anchor location the twirl ends at. | STRING | yes |
particle_args.speed | How quickly the twirl rotates as it grows. | STRING | yes |
particle_args.tick-multiplier | How 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. | STRING | no |
particle_args for wing_tips
| Key | Description | Type | Required |
|---|---|---|---|
particle_args.tick-multiplier | How 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. | STRING | no |
particle_args for projectile_trail
| Key | Description | Type | Required |
|---|---|---|---|
particle_args.gap | How many ticks to wait between each particle of the trail. | STRING | yes |
particle_args.tick-multiplier | How 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. | STRING | no |
Optional arguments
| Key(s) | Description | Type | Default |
|---|---|---|---|
particle-amount | The number of particles to spawn per animation point per tick. Supports expressions. | EXPRESSION | 1 |
entity | The entity to anchor the animation to. Choices: player, victim, projectile | STRING | player |
use-eye-location | Whether to use the entity's eye location instead of their feet. | BOOLEAN | false |
Trigger parameters required
PLAYERLOCATION
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
| Setting | Value |
|---|---|
| Run order | NORMAL |
| Supports delay | true |
| Reloads on plugin reload | true |