setParticleCircle: Difference between revisions

Latest revision as of 02:52, 11 October 2025

Hover & click on the images for description

Description:: Updates particle source, creates particles in circle with given radius. Velocity is transformed and added to total velocity. The random particle positioning is calculated in relation to the nearest surface. Since Arma 3 2.22, this could be overridden (will also override onSurface = true).
Groups:: Particles

Syntax:: particleSource setParticleCircle [circleRadius, circleVelocity, ignoreSurfaces]
Parameters:: particleSource: Object
: circleRadius: Number - the radius (x,y plain) in which particles are generated
: circleVelocity: Array of Numbers in format [X, Y, Z] - direction and speed of particles movement
since 2.22: ignoreSurfaces: Boolean - (Optional) true to calculate particle position relative to the source position. Default: false
Return Value:: Nothing

See also:: setParticleParams setParticleRandom ParticleTemplates setParticleClass particlesQuality setParticleFire

: Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

@@ Line 21: / Line 21: @@
 |gr1= Particles
-|descr= Updates particle source, creates particles in circle with given radius. Velocity is transformed and added to total velocity.
+|descr= Updates particle source, creates particles in circle with given radius. Velocity is transformed and added to total velocity. The random particle positioning is calculated in relation to the nearest surface. Since Arma 3 2.22, this could be overridden (will also override onSurface = true).
-|s1= particleSource [[setParticleCircle]] [circleRadius, circleVelocity]
+|s1= particleSource [[setParticleCircle]] [circleRadius, circleVelocity, ignoreSurfaces]
 |p1= particleSource: [[Object]]
-|p2= circleRadius: [[Number]]
+|p2= circleRadius: [[Number]] - the radius (x,y plain) in which particles are generated
-|p3= circleVelocity: [[Array]] of [[Number]]s in format [X, Y, Z]
+|p3= circleVelocity: [[Array]] of [[Number]]s in format [X, Y, Z] - direction and speed of particles movement
+|p4= ignoreSurfaces: [[Boolean]] - (Optional) [[true]] to calculate particle position relative to the source position. Default: [[false]]
+|p4since= arma3 2.22
 |r1= [[Nothing]]
 |x1= <sqf>_myParticleSource setParticleCircle [3, [0,0,5]];</sqf>
+|x2= <sqf>_myParticleSource setParticleCircle [3, [0,0,5], true];</sqf>
 |seealso= [[setParticleParams]] [[setParticleRandom]] [[ParticleTemplates]] [[setParticleClass]] [[particlesQuality]] [[setParticleFire]]
 }}