Effect file
Effect files live at assets/<namespace>/kinesis/effects/<path>.json and are played by the id <namespace>:<path>.
effect
Section titled “effect”A Kinesis effect.
| Field | Type | Default | Description |
|---|---|---|---|
duration |
number | 2 |
Length in seconds. |
loop |
boolean | false |
Repeat until stopped. |
params |
params | Params with their defaults: numbers, booleans or colours. Builders and commands override them; expressions use them by name and colour fields as $name. |
|
tracks |
list of particles, trail, tendrils, beam, lightning, ring, mesh, decal, model, screen, effect | The layers of the effect. | |
events |
list of event | Sounds, child effects and named events. |
params
Section titled “params”An object of param names to defaults. Numbers and booleans are numbers; strings are colours such as "#ff3b1f". Expressions read params by name, and colour fields read them as "$name". EffectBuilder.param(...), /kinesis play ... name=value and EffectHandle.set(...) change them.
A sound, child effect or named event at a moment in time.
| Field | Type | Default | Description |
|---|---|---|---|
time |
number | 0 |
When it fires, in seconds. |
sound |
string | Sound event to play. | |
volume |
number | 1 |
Sound volume. |
pitch |
number | 1 |
Sound pitch. |
play |
string | Effect to play. | |
event |
string | Name passed to EffectHandle.on(name, ...) listeners. |
|
at |
attach | Where the sound or child effect happens. |
