setParticleParams: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(description)
(Add Arma 3 v2.12's [vectorDir, vectorUp])
 
(99 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


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


|1.00|= Game version
|game2= arma2
____________________________________________________________________________________________
|version2= 1.00


| Set parameters to particle source. Array is in format [[ParticleArray]].  
|game3= arma2oa
|version3= 1.50
 
|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
particleFSIndex = 0
particleFSFrameCount = 1
particleFSLoop = 1
*/
[
[
particleShape,
particleShape, /* String */
particleFSNtieth,
particleFSNtieth, /* Number */
particleFSIndex,
particleFSIndex, /* Number */
particleFSFrameCount,
particleFSFrameCount, /* Number */
particleFSLoop
particleFSLoop /* Optional - Number. Default: 1 */
],
],
animationName,
animationName, /* String */
particleType,
particleType, /* String - Enum: Billboard, SpaceObject */
timerPeriod,
timerPeriod, /* Number */
lifeTime,
lifeTime, /* Number */
position,
pos3D, /* 3D Array of numbers as relative position to particleSource or (if object at index 18 is set) object.
moveVelocity,
Or (if object at index 18 is set) String as memoryPoint of object. */
rotationVelocity,
moveVelocity, /* 3D Array of numbers. */
weight,
rotationVelocity, /* Number */
volume,
weight, /* Number */
rubbing,
volume, /* Number */
size,
rubbing, /* Number */
color,
sizeOverLifetime, /* Array of Numbers */
animationSpeed,
color, /* Array of Array of RGBA Numbers */
randomDirectionPeriod,
animationSpeed, /* Array of Number */
randomDirectionIntensity,
randomDirectionPeriod, /* Number */
onTimerScript,
randomDirectionIntensity, /* Number */
beforeDestroyScript,
onTimerScript, /* String */
[[this]],
beforeDestroyScript, /* String */
angle,
obj, /* Object */
onSurface,
angle, /* Optional Number - Default: 0 */
bounceOnSurface,
onSurface, /* Optional Boolean */
emissiveColor
bounceOnSurface, /* Optional Number */
];</code>|= Description
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>


| particleSource '''setParticleParams''' array |= Syntax
|s1= particleSource [[setParticleParams]] array


|p1= particleSource: [[Object]] |= Parameter 1
|p1= particleSource: [[Object]]


|p2= array: [[Array]] - format [[ParticleArray]] |= Parameter 2
|p2= array: [[Array]] - format [[ParticleArray]]


| [[Nothing]] |= Return value
|r1= [[Nothing]]


|x1= see [[ParticleArray]]|= EXAMPLE1
|x1= see [[ParticleArray]]
____________________________________________________________________________________________
 
| [[Arma 3 Particle Effects]], [[ParticleArray]], [[setParticleClass]], [[setParticleRandom]], [[setParticleCircle]], [[setParticleFire]], [[setDropInterval]], [[drop]]|= See also


|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]]
[[Category:Scripting Commands ArmA|SETPARTICLEPARAMS]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]

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"