HyperScript
Docs

← All of the Docs The world

Particle shapes

expressioncircle

draw particle circle with radius <r> using particle <name> at <position> · A flat ring. Around a player it lies on the ground at their feet

draw particle circle with radius 2 using particle "flame" at player's location
Try it
expressionsphere

draw particle sphere with radius <r> using particle <name> at <position> · A hollow ball with evenly spread points

draw particle sphere with radius 3 using particle "dust" colored "#00ffaa" with 200 points at 0, 80, 0
Try it
expressionline

draw particle line from <position> to <position> using particle <name> · A straight line; both ends must be in the same world

draw particle line from player to 0, 80, 0 using particle "end_rod"
Try it
expressionboxsince 1.7.53

draw particle box from <position> to <position> using particle <name> · The edges of a box between two corners

draw particle box from 0, 60, 0 to 10, 70, 10 using particle "flame" for 10 seconds
Try it
expressionoutlinesince 1.7.53

draw particle outline of region <name> using particle <name> · The edges of a script region

draw particle outline of region arg.1 using particle "end_rod" visible to player for 10 seconds
Try it
expressionhelixsince 1.7.53

draw particle helix with radius <r> and height <h> using particle <name> at <position> · A coil that winds upwards; add and 3 turns to say how often

draw particle helix with radius 1 and height 2 using particle "end_rod" at effect location rising 1 blocks over 1 second
Try it
expressionspiralsince 1.7.53

draw particle spiral with radius <r> using particle <name> at <position> · A flat line winding outwards from the middle

draw particle spiral with radius 3 using particle "end_rod" at player
Try it
expressionstarsince 1.7.53

draw particle star with radius <r> using particle <name> at <position> · A flat star with five tips

draw particle star with radius 2 using particle "flame" at player spinning for 5 seconds
Try it
expressionheartsince 1.7.53

draw particle heart with size <n> using particle <name> at <position> · A heart standing upright, turned towards the player of the trigger

draw particle heart with size 2 using particle "dust" colored "#ff3366" at player for 3 seconds
Try it
expressionbeamsince 1.7.53

draw particle beam from <position> to <position> using particle <name> · A short stretch of light that travels from one end to the other; over 1 second says how long it takes

draw particle beam from player to 0, 80, 0 using particle "end_rod" over 1 second
Try it
expressiontextsince 1.7.53

draw particle text <text> using particle <name> at <position> · Letters made of particles, turned towards the player of the trigger; with size 2 after the text for bigger ones

show floating text "&6+5" at player
Try it
structurefor <duration>since 1.7.53

The shape stays that long instead of fading after a second

give player a trail of "dust" colored "#ffaa00" for 5 minutes
Try it
expressionuntil <condition> / while <condition>since 1.7.53

It stays until the condition holds, or while it does

set {_left} to time until schedule "restart"
Try it
expressionaround <who> (in place of at <position>)since 1.7.53

It stays with that creature or player as they move

draw particle circle with radius 1 using particle "flame" around player for 30 seconds
Try it
expressionvisible to <who>since 1.7.53

Only they see it; only for <who> says the same

draw particle outline of region arg.1 using particle "end_rod" visible to player for 10 seconds
Try it
expressionspinningsince 1.7.53

It turns round its middle; spinning at speed 2 for two turns a second

draw particle circle with radius 1 using particle "dust" colored "#ff66cc" to "#66ccff" around player spinning for 30 seconds
Try it
expressiongrowing to radius <r> over <duration>since 1.7.53

It grows (or shrinks) from its radius to that one: a shockwave

draw particle circle with radius 0.5 using particle "flame" at effect location growing to radius 3 over 1 second
Try it
expressionrising <n> blocks over <duration>since 1.7.53

It lifts that far

draw particle helix with radius 1 and height 2 using particle "end_rod" at effect location rising 1 blocks over 1 second
Try it
expressioncolored "<#rrggbb>"since 1.7.53

The colour, for "dust"

give player a trail of "dust" colored "#ffaa00" for 5 minutes
Try it
expressioncolored "<#a>" to "<#b>"since 1.7.53

A shape that runs from one colour at its start to another at its end

draw particle circle with radius 1 using particle "dust" colored "#ff66cc" to "#66ccff" around player spinning for 30 seconds
Try it
expressionfading to "<#rrggbb>"since 1.7.53

Each particle changes to that colour while it lives. Needs Minecraft 1.17 or newer

spawn particle "dust" colored "#ff0000" fading to "#000000" count 20 at player
Try it
expressionof <block or item>since 1.7.53

For "block" and "item": what the crumbs are made of, as in "block" of stone

give player a trail of "dust" colored "#ffaa00" for 5 minutes
Try it
expressioncount <n>since 1.7.53

How many at each point

spawn particle "witch" count 20 at event.location
Try it
effectwith speed <n>since 1.7.15

How fast they fly apart

summon 5 zombie at player with speed 1.6
Try it
expressionspread <n> or spread <x>, <y>, <z>since 1.7.53

How far from the point each may appear

spawn particle "cloud" count 30 spread 2, 0.2, 2 at player
Try it
Guide and examples

draw particle renders a whole shape in one statement.

draw particle circle with radius 2 using particle "flame" at player's location
draw particle sphere with radius 3 using particle "dust" colored "#00ffaa" with 200 points at 0, 80, 0
draw particle line from player to 0, 80, 0 using particle "end_rod"
ShapeSyntaxResult
circledraw particle circle with radius <r> using particle <name> at <position>A flat ring. Around a player it lies on the ground at their feet
spheredraw particle sphere with radius <r> using particle <name> at <position>A hollow ball with evenly spread points
linedraw particle line from <position> to <position> using particle <name>A straight line; both ends must be in the same world

Options, written after the particle name: colored "<#rrggbb>" (for "dust") and with <n> points. Without a point count the shape picks a density that looks solid for its size. A shape never uses more than 1000 particles.

  • Particles last about a second. For a lasting shape or a trail, draw from a timer:
every 5 ticks for all players:
    if {%player%.trail}:
        draw particle circle with radius 0.6 using particle "dust" colored "#ff66cc" at player

More shapes.

ShapeSyntaxDraws
boxdraw particle box from <position> to <position> using particle <name>The edges of a box between two corners
outlinedraw particle outline of region <name> using particle <name>The edges of a script region
helixdraw particle helix with radius <r> and height <h> using particle <name> at <position>A coil that winds upwards; add and 3 turns to say how often
spiraldraw particle spiral with radius <r> using particle <name> at <position>A flat line winding outwards from the middle
stardraw particle star with radius <r> using particle <name> at <position>A flat star with five tips
heartdraw particle heart with size <n> using particle <name> at <position>A heart standing upright, turned towards the player of the trigger
beamdraw particle beam from <position> to <position> using particle <name>A short stretch of light that travels from one end to the other; over 1 second says how long it takes
textdraw particle text <text> using particle <name> at <position>Letters made of particles, turned towards the player of the trigger; with size 2 after the text for bigger ones

What can follow any shape, after its place:

WrittenDoes
for <duration>The shape stays that long instead of fading after a second
until <condition> / while <condition>It stays until the condition holds, or while it does
around <who> (in place of at <position>)It stays with that creature or player as they move
visible to <who>Only they see it; only for <who> says the same
spinningIt turns round its middle; spinning at speed 2 for two turns a second
growing to radius <r> over <duration>It grows (or shrinks) from its radius to that one: a shockwave
rising <n> blocks over <duration>It lifts that far

What can follow the particle's name, in spawn particle and in a shape:

WrittenDoes
colored "<#rrggbb>"The colour, for "dust"
colored "<#a>" to "<#b>"A shape that runs from one colour at its start to another at its end
fading to "<#rrggbb>"Each particle changes to that colour while it lives. Needs Minecraft 1.17 or newer
of <block or item>For "block" and "item": what the crumbs are made of, as in "block" of stone
count <n>How many at each point
with speed <n>How fast they fly apart
spread <n> or spread <x>, <y>, <z>How far from the point each may appear
command /aura:
    trigger:
        draw particle circle with radius 1 using particle "dust" colored "#ff66cc" to "#66ccff" around player spinning for 30 seconds

on player death:
    draw particle circle with radius 0.5 using particle "cloud" at victim's location growing to radius 5 over 1 second

command /show <region>:
    trigger:
        draw particle outline of region arg.1 using particle "end_rod" visible to player for 10 seconds

Trails. give <who> a trail of <particle> leaves particles where a player walks, until remove trail of <who>, or with for, until or while. Standing still leaves none.

command /trail:
    trigger:
        give player a trail of "dust" colored "#ffaa00" for 5 minutes

Effects with a name. A particle effect "<name>": block, at the left margin like a function, holds the particle lines of one effect; play particle effect "<name>" at <position> plays it there. Inside the block, effect location is that place.

particle effect "level up":
    draw particle helix with radius 1 and height 2 using particle "end_rod" at effect location rising 1 blocks over 1 second
    draw particle circle with radius 0.5 using particle "flame" at effect location growing to radius 3 over 1 second

on level up:
    play particle effect "level up" at player

Things to know:

  • A shape that stays is drawn again several times a second, which costs more than one puff. Up to 200 can be going at once on a server; a new one beyond that takes the place of the oldest.
  • Everything ends when the scripts are reloaded or the server stops.
  • Text has capital letters, digits and ! ? . - + :; small letters are drawn as capitals, and it takes up to 24 characters.
  • "block" and "item" are the crumbs of breaking a block and of eating; the game calls them block_crack and item_crack before 1.20.5, and either name works.