setParticleParams

From Bohemia Interactive Community
Revision as of 20:42, 3 September 2024 by Lou Montana (talk | contribs) (Text replacement - "<sqf>([^↵][^<]*↵[^<]*)<\/sqf>" to "<sqf> $1 </sqf>")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
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