particles
Spawns and simulates particles.
| Field | Type | Default | Description |
|---|---|---|---|
type |
"particles" |
required | Track type. |
name |
string | Optional name, used in error messages. | |
start |
number | 0 |
When the track starts, in seconds. |
end |
number | -1 |
When the track ends, in seconds. Defaults to the end of the effect; looping effects run forever. |
at |
attach | Where the track sits. | |
material |
material | How the track is shaded. | |
emitter |
emitter | When and where particles are born. | |
particle |
particle | How each particle looks and moves. | |
forces |
list of gravity, drag, wind, vortex, attractor, curl, orbit | Forces acting on every particle. | |
spawn |
particle spawn | Effects that particles start. |
emitter
Section titled “emitter”When and where particles are born.
| Field | Type | Default | Description |
|---|---|---|---|
rate |
number | 0 |
Particles per second. Animatable over the track. |
burst |
burst | Particles spawned at once: a count at the track start, or [[time, count], …] in track seconds. | |
per_block |
number | 0 |
Particles per block the emitter moves. |
max |
integer | 2000 |
Most particles alive at once: up to 20000 on the CPU and 262144 on the GPU. |
simulation |
"auto" | "cpu" | "gpu" |
"auto" |
cpu supports everything. gpu simulates on the graphics card for very large counts, without collisions, trails or particle-spawned effects; alpha-blended GPU particles are not sorted, and values over a particle’s life come from a lookup table. auto uses the GPU for tracks of 1500 or more additive particles that need nothing the GPU lacks, and the CPU otherwise. |
space |
"world" | "local" |
"world" |
world: particles stay where they spawn. local: they move with the emitter. |
shape |
point or sphere or box or disc or cone or line or surface or bones or aabb | Where particles spawn. | |
inherit |
number | 0 |
Fraction of the anchor’s velocity new particles take. |
particle
Section titled “particle”How each particle looks and moves. t is its life, 0..1.
| Field | Type | Default | Description |
|---|---|---|---|
lifetime |
number | 1 |
Seconds each particle lives. |
speed |
number | 0 |
Initial speed in blocks per second. |
direction |
"outward" | "up" | "forward" | "random" | "vector" |
"outward" |
Initial direction: away from the shape centre, up, along the frame’s forward axis, random, or vector. |
vector |
vector | [0,1,0] |
Direction when direction is vector. |
spread |
number | 0 |
Random cone around the direction, in degrees. |
velocity |
vector | [0,0,0] |
Extra initial velocity in blocks/s. |
size |
number | 0.1 |
Size in blocks; evaluated over the particle’s life. |
color |
color | "#ffffff" |
Colour over the particle’s life. Values above 1 glow. |
rotation |
number | 0 |
Initial sprite rotation in degrees. |
spin |
number | 0 |
Sprite rotation speed in degrees per second. |
stretch |
number | 0 |
Stretch the sprite along its velocity: seconds of motion it spans. |
orient |
"camera" | "flat" | "velocity" |
"camera" |
camera faces the viewer, flat lies on the ground, velocity follows motion. |
frames |
"life" | "random" | "loop" |
"life" |
How flipbook frames are chosen: over life, one random frame, or looping at the material fps. |
collide |
"none" | "bounce" | "stick" | "die" |
"none" |
What happens when a particle hits a block. |
bounce |
number | 0.4 |
Speed kept after a bounce. |
trail |
integer | 0 |
Leave a ribbon of this many past positions behind each particle. |
trail_width |
number | 0.05 |
Trail width in blocks; t runs from head (0) to tail (1). |
particle spawn
Section titled “particle spawn”Effects that particles start, so particles can spawn particles.
| Field | Type | Default | Description |
|---|---|---|---|
death |
string | Effect played where a particle dies. | |
collide |
string | Effect played where a particle hits a block. | |
chance |
number | 1 |
Chance each particle triggers it. |
Spawn shapes
Section titled “Spawn shapes”A single point.
| Field | Type | Default | Description |
|---|---|---|---|
type |
"point" |
required | Shape type. |
sphere
Section titled “sphere”A ball, or its surface.
| Field | Type | Default | Description |
|---|---|---|---|
type |
"sphere" |
required | Shape type. |
radius |
number | 0.5 |
Radius in blocks. |
surface |
boolean | false |
Spawn on the surface instead of inside. |
A box, or its surface.
| Field | Type | Default | Description |
|---|---|---|---|
type |
"box" |
required | Shape type. |
size |
vector | [1,1,1] |
Box size in blocks. |
surface |
boolean | false |
Spawn on the surface instead of inside. |
A flat disc on the frame’s XZ plane, or its rim.
| Field | Type | Default | Description |
|---|---|---|---|
type |
"disc" |
required | Shape type. |
radius |
number | 0.5 |
Radius in blocks. |
inner |
number | 0 |
Inner radius for discs, 0..1 of the radius. |
surface |
boolean | false |
Spawn on the surface instead of inside. |
Directions inside a cone along the frame’s forward axis; particles start at its tip.
| Field | Type | Default | Description |
|---|---|---|---|
type |
"cone" |
required | Shape type. |
angle |
number | 30 |
Cone half-angle in degrees. |
radius |
number | 0.5 |
Radius in blocks. |
Along a line to to, or length blocks forward.
| Field | Type | Default | Description |
|---|---|---|---|
type |
"line" |
required | Shape type. |
to |
attach | Line end point. | |
length |
number | 1 |
Line length in blocks when there is no to. |
surface
Section titled “surface”On the anchored entity’s model surface. Particles take the texture colour there.
| Field | Type | Default | Description |
|---|---|---|---|
type |
"surface" |
required | Shape type. |
Along the anchored entity’s skeleton.
| Field | Type | Default | Description |
|---|---|---|---|
type |
"bones" |
required | Shape type. |
Inside the anchored entity’s bounding box.
| Field | Type | Default | Description |
|---|---|---|---|
type |
"aabb" |
required | Shape type. |
Forces
Section titled “Forces”gravity
Section titled “gravity”Pulls down at strength blocks/s².
| Field | Type | Default | Description |
|---|---|---|---|
type |
"gravity" |
required | Force type. |
strength |
number | 1 |
Force strength. |
Slows particles; strength is the fraction of speed lost per second.
| Field | Type | Default | Description |
|---|---|---|---|
type |
"drag" |
required | Force type. |
strength |
number | 1 |
Force strength. |
Pushes along vector (blocks/s²).
| Field | Type | Default | Description |
|---|---|---|---|
type |
"wind" |
required | Force type. |
vector |
vector | [0,1,0] |
Direction or axis. |
strength |
number | 1 |
Force strength. |
vortex
Section titled “vortex”Spins around vector through center.
| Field | Type | Default | Description |
|---|---|---|---|
type |
"vortex" |
required | Force type. |
strength |
number | 1 |
Force strength. |
vector |
vector | [0,1,0] |
Direction or axis. |
center |
vector | [0,0,0] |
Centre, relative to the track’s frame. |
attractor
Section titled “attractor”Pulls toward center (or the target). Negative strength repels.
| Field | Type | Default | Description |
|---|---|---|---|
type |
"attractor" |
required | Force type. |
strength |
number | 1 |
Force strength. |
center |
vector | [0,0,0] |
Centre, relative to the track’s frame. |
radius |
number | 0 |
Range; particles closer than this to an attractor die. |
target |
boolean | false |
Use the effect’s target as the centre. |
Smooth swirling turbulence from curl noise.
| Field | Type | Default | Description |
|---|---|---|---|
type |
"curl" |
required | Force type. |
strength |
number | 1 |
Force strength. |
scale |
number | 1 |
Noise frequency. |
speed |
number | 0.5 |
How fast the noise field changes. |
Keeps particles circling center at their current radius.
| Field | Type | Default | Description |
|---|---|---|---|
type |
"orbit" |
required | Force type. |
strength |
number | 1 |
Force strength. |
vector |
vector | [0,1,0] |
Direction or axis. |
center |
vector | [0,0,0] |
Centre, relative to the track’s frame. |
