setParticleParams: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
 
(Add Arma 3 v2.12's [vectorDir, vectorUp])
 
(116 intermediate revisions by 14 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|R]]
{{RV|type=command
[[Category:Scripting Commands ArmA|R]]


<new command not populated>
|game1= arma1
|version1= 1.00


|game2= arma2
|version2= 1.00


<h2 style="color:#000066">''''' setParticleParams '''''</h2>
|game3= arma2oa
|version3= 1.50


|game4= tkoh
|version4= 1.00


'''Operand types:'''
|game5= arma3
|version5= 0.50


'''Type of returned value:'''
|arg= global
|eff= local


'''Compatibility:'''
|gr1= Particles


'''Description:'''
|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:
<sqf>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 */
];</sqf>


'''Example:'''
|s1= particleSource [[setParticleParams]] array
 
|p1= particleSource: [[Object]]
 
|p2= array: [[Array]] - format [[ParticleArray]]
 
|r1= [[Nothing]]
 
|x1= see [[ParticleArray]]
 
|seealso= [[Arma 3: Particle Effects]] [[ParticleArray]] [[setParticleClass]] [[setParticleRandom]] [[setParticleCircle]] [[setParticleFire]] [[setDropInterval]] [[drop]]
}}

Latest revision as of 14:34, 18 January 2023

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=337338"