Skip to content

Commit fe4ed45

Browse files
committed
Add caution for INSTANT_EFFECT and EFFECt
1 parent 5637c91 commit fe4ed45

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/content/docs/paper/dev/api/particles.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -613,6 +613,12 @@ These particles will use `offsetY` as the particle's y-axis velocity.
613613
If you set `offsetX` AND `offsetZ` to `0`, the particle will have almost no x or z-axis velocity, but will still have
614614
a y-axis velocity set by the `offsetY` argument. In both cases, `offsetX` and `offsetZ` are not used in the velocity vector.
615615

616+
:::caution
617+
`EFFECT` and `INSTANT_EFFECT` are [powered particles](#powered-particles) and use [`Particle.Spell`](jd:paper:org.bukkit.Particle$Spell)
618+
as their data. Due to the nature of rising particles' final calculated vertical velocity being very low (in range \[-0.056, 0.056\])
619+
and how powered particles calculate the vertical velocity the resulting vertical velocity will always be the opposite of power.
620+
:::
621+
616622
Example of spawning a `GLOW` particle that moves up:
617623
<Tabs syncKey="spawn-type">
618624
<TabItem label="ParticleBuilder">

0 commit comments

Comments
 (0)