setParticleParams: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}")
m (Text replacement - "<sqf>([^↵][^<]*↵[^<]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(72 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma1 |Game name=
|game1= arma1
|version1= 1.00


|1.00|Game version=
|game2= arma2
|arg= global |Multiplayer Arguments=
|version2= 1.00
|eff= local |Multiplayer Effects=


|gr1= Particles |GROUP1=
|game3= arma2oa
____________________________________________________________________________________________
|version3= 1.50


| Set parameters to particle source. Array is in format [[ParticleArray]]. <br>
|game4= tkoh
|version4= 1.00
 
|game5= arma3
|version5= 0.50
 
|arg= global
|eff= local
 
|gr1= Particles
 
|descr= Set parameters to particle source. Array is in format [[ParticleArray]]. <br>


Since Arma 3 version 1.11.114706 you can use this command to overwrite many values set by [[setParticleClass]], particularity those defined in [[ParticleArray]]. Correspondence between CfgCloudlets class param names and command array of params:
Since Arma 3 version 1.11.114706 you can use this command to overwrite many values set by [[setParticleClass]], particularity those defined in [[ParticleArray]]. Correspondence between CfgCloudlets class param names and command array of params:
<code>particleSource [[setParticleParams]]
<sqf>
particleSource setParticleParams
[
[
/* [[String]] or [[Array]] - If string then the name of the particleShape. And following default values are used:
/*
particleFSNtieth {{=}} 1
String or Array - If string then the name of the particleShape. And following default values are used:
particleFSIndex {{=}} 0
particleFSNtieth = 1
particleFSFrameCount {{=}} 1
particleFSIndex = 0
particleFSLoop {{=}} 1
particleFSFrameCount = 1
particleFSLoop = 1
*/
*/
[
[
particleShape, /*[[String]]*/
particleShape, /* String */
particleFSNtieth, /*[[Number]]*/
particleFSNtieth, /* Number */
particleFSIndex, /*[[Number]]*/
particleFSIndex, /* Number */
particleFSFrameCount, /*[[Number]]*/
particleFSFrameCount, /* Number */
particleFSLoop /*Optional - [[Number]]. Default: 1*/
particleFSLoop /* Optional - Number. Default: 1 */
],
],
animationName, /*[[String]]*/
animationName, /* String */
particleType, /*[[String]] - Enum: Billboard, SpaceObject*/
particleType, /* String - Enum: Billboard, SpaceObject */
timerPeriod, /*[[Number]]*/
timerPeriod, /* Number */
lifeTime, /*[[Number]]*/
lifeTime, /* Number */
position, /*3D [[Array]] of numbers as relative position to particleSource or (if object at index 18 is set) object.  
pos3D, /* 3D Array of numbers as relative position to particleSource or (if object at index 18 is set) object.  
Or (if object at index 18 is set) [[String]] as memoryPoint of object.*/
Or (if object at index 18 is set) String as memoryPoint of object. */
moveVelocity, /*3D [[Array]] of numbers.*/
moveVelocity, /* 3D Array of numbers. */
rotationVelocity, /*[[Number]]*/
rotationVelocity, /* Number */
weight, /*[[Number]]*/
weight, /* Number */
volume, /*[[Number]]*/
volume, /* Number */
rubbing, /*[[Number]]*/
rubbing, /* Number */
size, /*[[Array]] of [[Number]]*/
sizeOverLifetime, /* Array of Numbers */
color, /*[[Array]] of [[Array]] of RGBA [[Number]]s*/
color, /* Array of Array of RGBA Numbers */
animationSpeed, /*[[Array]] of [[Number]]*/
animationSpeed, /* Array of Number */
randomDirectionPeriod, /*[[Number]]*/
randomDirectionPeriod, /* Number */
randomDirectionIntensity, /*[[Number]]*/
randomDirectionIntensity, /* Number */
onTimerScript, /*[[String]]*/
onTimerScript, /* String */
beforeDestroyScript, /*[[String]]*/
beforeDestroyScript, /* String */
[[this]], /*[[Object]]*/
obj, /* Object */
angle, /*Optional [[Number]] - Default: 0*/
angle, /* Optional Number - Default: 0 */
onSurface, /*Optional [[Boolean]]*/
onSurface, /* Optional Boolean */
bounceOnSurface, /*Optional [[Number]]*/
bounceOnSurface, /* Optional Number */
emissiveColor, /*Optional [[Array]] of [[Array]] of RGBA [[Number]]s*/
emissiveColor, /* Optional Array of Array of RGBA Numbers */
vectorDir /*Optional 3D [[Array]] Vector dir. Since Arma 3 v1.92 it is possible to set the initial direction of the SpaceObject */
vectorDirOrVectorDirAndUp /* Optional vector dir or [vectorDir, vectorUp]
];</code>|DESCRIPTION=
Since Arma 3 v1.92 it is possible to set the initial direction of the SpaceObject
____________________________________________________________________________________________
Since Arma 3 v2.12 it is possible to use a [vectorDir, vectorUp] array */
 
];
| particleSource '''setParticleParams''' array |SYNTAX=
</sqf>


|p1= particleSource: [[Object]] |PARAMETER1=
|s1= particleSource [[setParticleParams]] array


|p2= array: [[Array]] - format [[ParticleArray]] |PARAMETER2=
|p1= particleSource: [[Object]]


| [[Nothing]] |RETURNVALUE=
|p2= array: [[Array]] - format [[ParticleArray]]


|x1= see [[ParticleArray]]|EXAMPLE1=
|r1= [[Nothing]]
____________________________________________________________________________________________


| [[Arma 3 Particle Effects]], [[ParticleArray]], [[setParticleClass]], [[setParticleRandom]], [[setParticleCircle]], [[setParticleFire]], [[setDropInterval]], [[drop]]|SEEALSO=
|x1= see [[ParticleArray]]


|seealso= [[Arma 3: Particle Effects]] [[ParticleArray]] [[setParticleClass]] [[setParticleRandom]] [[setParticleCircle]] [[setParticleFire]] [[setDropInterval]] [[drop]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|SETPARTICLEPARAMS]]
[[Category:Scripting Commands OFP Elite |SETPARTICLEPARAMS]]
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 19:42, 3 September 2024

Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
GAGlobalLELocal
Hover & click on the images for description

Description

Description:
Set parameters to particle source. Array is in format ParticleArray.
Since Arma 3 version 1.11.114706 you can use this command to overwrite many values set by setParticleClass, particularity those defined in ParticleArray. Correspondence between CfgCloudlets class param names and command array of params:
particleSource setParticleParams [ /* String or Array - If string then the name of the particleShape. And following default values are used: particleFSNtieth = 1 particleFSIndex = 0 particleFSFrameCount = 1 particleFSLoop = 1 */ [ particleShape, /* String */ particleFSNtieth, /* Number */ particleFSIndex, /* Number */ particleFSFrameCount, /* Number */ particleFSLoop /* Optional - Number. Default: 1 */ ], animationName, /* String */ particleType, /* String - Enum: Billboard, SpaceObject */ timerPeriod, /* Number */ lifeTime, /* Number */ pos3D, /* 3D Array of numbers as relative position to particleSource or (if object at index 18 is set) object. Or (if object at index 18 is set) String as memoryPoint of object. */ moveVelocity, /* 3D Array of numbers. */ rotationVelocity, /* Number */ weight, /* Number */ volume, /* Number */ rubbing, /* Number */ sizeOverLifetime, /* Array of Numbers */ color, /* Array of Array of RGBA Numbers */ animationSpeed, /* Array of Number */ randomDirectionPeriod, /* Number */ randomDirectionIntensity, /* Number */ onTimerScript, /* String */ beforeDestroyScript, /* String */ obj, /* Object */ angle, /* Optional Number - Default: 0 */ onSurface, /* Optional Boolean */ bounceOnSurface, /* Optional Number */ emissiveColor, /* Optional Array of Array of RGBA Numbers */ vectorDirOrVectorDirAndUp /* Optional vector dir or [vectorDir, vectorUp] Since Arma 3 v1.92 it is possible to set the initial direction of the SpaceObject Since Arma 3 v2.12 it is possible to use a [vectorDir, vectorUp] array */ ];
Groups:
Particles

Syntax

Syntax:
particleSource setParticleParams array
Parameters:
particleSource: Object
array: Array - format ParticleArray
Return Value:
Nothing

Examples

Example 1:
see ParticleArray

Additional Information

See also:
Arma 3: Particle Effects ParticleArray setParticleClass setParticleRandom setParticleCircle setParticleFire setDropInterval drop

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
Retrieved from "https://community.bistudio.com/wiki?title=setParticleParams&oldid=369320"