Skip to content

Commit 3b30e13

Browse files
authored
Clarify documentation regarding particlespawner's attract.strength parameter (#16726)
1 parent caa36c2 commit 3b30e13

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

doc/lua_api.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11861,9 +11861,10 @@ Types used are defined in the previous section.
1186111861
surface `origin` designates a point in world coordinate space. use this
1186211862
for e.g. particles entering or emerging from a portal.
1186311863

11864-
* float range `strength`: the speed with which particles will move towards
11865-
the attractor shape. If negative, the particles will instead move away from that
11866-
point.
11864+
* float range `strength`: a factor that determines the speed with which particles
11865+
will move towards the attractor shape. If negative, the particles will instead
11866+
move away from that point. The actual speed is the product of this parameter and
11867+
the particle's initial distance from the attractor's origin.
1186711868

1186811869
* vec3 `origin`: the origin point of the attractor shape towards which particles will
1186911870
initially be oriented. functions as an offset if `origin_attached` is also

0 commit comments

Comments
 (0)