_Mechanic Particle Effect - Eniripsa96/SkillAPI GitHub Wiki
Plays an advanced particle animation based on formulas.
| Name | YAML Key | Type | Description |
|---|---|---|---|
| Effect Key | effect-key | String | The key to refer to this effect by. This can be used in the Cancel Effect Mechanic. Note: this must be unique to other effects as the first effect to play for a given key is cached and will overwrite other effects with the same key. |
| Duration | duration | Scaling Time | How long the effect should play for |
| Shape | -shape | String | The pattern defined in effects.yml for the arrangement of particles each tick |
| Shape Direction | -shape-dir | Dropdown | The direction to align the particle shape (XZ being flat) |
| Shape Size | -shape-size | String | The formula to use for how large the shape is. See below for available variables |
| Animation | -animation | String | The pattern defined in effects.yml for the particles to follow |
| Animation Direction | -anim-dir | Dropdown | The direction to align the path (XZ being flat) |
| Animation Size | -anim-size | String | The formula to use for how large the path is. See below for available variables |
| Interval | -interval | Integer | How often to play particles in ticks |
| View Range | -view-range | Integer | How far away the particles can be seen from |
| Particle Type | -particle-type | Dropdown | The type of particle to show |
| Particle Num | -particle-num | Integer | Integer data for packet particles |
| DX | -particle-dx | Number | The "X" or red value for packet particles |
| DY | -particle-dy | Number | The "Y" or green value for packet particles |
| DZ | -particle-dz | Number | The "Z" or blue value for packet particles |
| Speed | -particle-speed | Number | The "speed" value of packet particles |
The animation and shape formulas can use the following variables:
| Variable | Description |
|---|---|
| t | domain * currentStep / step |
| p | currentStep / step |
| c | cos(Math.PI * 2 * domain * currentStep / step) |
| s | sin(Math.PI * 2 * domain * currentStep / step) |
| x | base X value |
| y | base Y value |
| z | base Z value |
| v | level of the effect (associated skill level) |
Each entry in effects.yml has 7 options:
| formula | Equation for determining the locations of particles |
| steps | how many positions to go through |
| copies | how many times to copy the particles (will be copied symmetrically around the center |
| domain | rotation that the formula goes through (0 is a straight line, 1 is a full circle) |
| x | offset in the x direction |
| y | offset in the y direction |
| z | offset in the z direction |
-- To be added --