setParticleCircle: Difference between revisions

Latest revision as of 01:52, 11 October 2025

1.00

Hover & click on the images for description

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

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

Examples

Example 1:: _myParticleSource setParticleCircle [3, [0,0,5]];
Example 2:: _myParticleSource setParticleCircle [3, [0,0,5], true];

Additional Information

See also:: setParticleParams setParticleRandom ParticleTemplates setParticleClass particlesQuality setParticleFire

Notes

: 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 1: / Line 1: @@
-{{Command|Comments=
+{{RV|type=command
-____________________________________________________________________________________________
-| arma |Game name=
+|game1= arma1
+|version1= 1.00
-|1.00|Game version=
+|game2= arma2
-|arg= global |Multiplayer Arguments=
+|version2= 1.00
-|eff= local |Multiplayer Effects=
-____________________________________________________________________________________________
-| Updates particle source, creates particles in circle with given radius. Velocity is transformed and added to total velocity. Correspondence between CfgCloudlets class param names and command array of params:
+|game3= arma2oa
-<code>particleSource [[setParticleCircle]]
+|version3= 1.50
-[
-	circleRadius,
-	circleVelocity
-];</code> |DESCRIPTION=
-____________________________________________________________________________________________
-| particleSource '''setParticleCircle''' [radius, velocity] |SYNTAX=
+|game4= tkoh
+|version4= 1.00
-|p1= particleSource: [[Object]] |PARAMETER1=
+|game5= arma3
-|p2= [radius, velocity]: [[Array]] |PARAMETER2=
+|version5= 0.50
-|p3= radius: [[Number]] |PARAMETER3=
-|p4= velocity: [[Array]] (x,y,z) |PARAMETER4=
-| [[Nothing]] |RETURNVALUE=
+|arg= global
-____________________________________________________________________________________________
+|eff= local
-| [[setParticleParams]], [[setParticleRandom]], [[ParticleTemplates]], [[setParticleClass]], [[particlesQuality]], [[setParticleFire]] |SEEALSO=
+|gr1= Particles
-}}
+|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, ignoreSurfaces]
+|p1= particleSource: [[Object]]
+|p2= circleRadius: [[Number]] - the radius (x,y plain) in which particles are generated
+|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
-<h3 style="display:none">Notes</h3>
+|r1= [[Nothing]]
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
+|x1= <sqf>_myParticleSource setParticleCircle [3, [0,0,5]];</sqf>
-</dl>
+|x2= <sqf>_myParticleSource setParticleCircle [3, [0,0,5], true];</sqf>
-<h3 style="display:none">Bottom Section</h3>
+|seealso= [[setParticleParams]] [[setParticleRandom]] [[ParticleTemplates]] [[setParticleClass]] [[particlesQuality]] [[setParticleFire]]
-[[Category:Scripting Commands|SETPARTICLECIRCLE]]
+}}
-[[Category:Scripting Commands OFP Elite |SETPARTICLECIRCLE]]
-[[Category:Scripting Commands ArmA|SETPARTICLECIRCLE]]
-[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
-[[Category: Particle System]]