setParticleParams: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(description)
(More detailed description on the type of particleParams)
Line 12: Line 12:
<code>particleSource [[setParticleParams]]
<code>particleSource [[setParticleParams]]
[
[
/* [[String]] or [[Array]] - If string then the name of the particleShape. And following default values are used:
<nowiki>particleFSNtieth = 1</nowiki>
<nowiki>particleFSIndex = 0</nowiki>
<nowiki>particleFSFrameCount = 1</nowiki>
<nowiki>particleFSLoop = true</nowiki>
*/
[
[
particleShape,
particleShape, /*[[String]]*/
particleFSNtieth,
particleFSNtieth, /*[[Number]]*/
particleFSIndex,
particleFSIndex, /*[[Number]]*/
particleFSFrameCount,
particleFSFrameCount, /*[[Number]]*/
particleFSLoop
particleFSLoop /*Optional - [[Boolean]]. Default: [[true]]*/
],
],
animationName,
animationName, /*[[String]]*/
particleType,
particleType, /*[[String]] - Enum: Billboard, SpaceObject*/
timerPeriod,
timerPeriod, /*[[Number]]*/
lifeTime,
lifeTime, /*[[Number]]*/
position,
position, /*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,
moveVelocity, /*3D [[Array]] of numbers.*/
rotationVelocity,
rotationVelocity, /*[[Number]]*/
weight,
weight, /*[[Number]]*/
volume,
volume, /*[[Number]]*/
rubbing,
rubbing, /*[[Number]]*/
size,
size, /*[[Array]] of [[Number]]*/
color,
color, /*[[Array]] of [[ARRAY] of RGBA [[Number]]s*/
animationSpeed,
animationSpeed, /*[[Array]] of [[Number]]*/
randomDirectionPeriod,
randomDirectionPeriod, /*[[Number]]*/
randomDirectionIntensity,
randomDirectionIntensity, /*[[Number]]*/
onTimerScript,
onTimerScript, /*[[String]]*/
beforeDestroyScript,
beforeDestroyScript, /*[[String]]*/
[[this]],
[[this]], /*[[Object]]*/
angle,
angle, /*Optional [[Number]] - Default: 0*/
onSurface,
onSurface, /*Optional [[Boolean]]*/
bounceOnSurface,
bounceOnSurface, /*Optional [[Number]]*/
emissiveColor
emissiveColor /*Optional [[Array]] of [[ARRAY] of RGBA [[Number]]s*/
];</code>|= Description
];</code>|= Description
____________________________________________________________________________________________
____________________________________________________________________________________________

Revision as of 12:31, 6 November 2017

{{Command|= Comments ____________________________________________________________________________________________

| arma |= Game name

|1.00|= Game version ____________________________________________________________________________________________

| 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 = true */ [ particleShape, /*String*/ particleFSNtieth, /*Number*/ particleFSIndex, /*Number*/ particleFSFrameCount, /*Number*/ particleFSLoop /*Optional - Boolean. Default: true*/ ], animationName, /*String*/ particleType, /*String - Enum: Billboard, SpaceObject*/ timerPeriod, /*Number*/ lifeTime, /*Number*/ position, /*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*/ size, /*Array of Number*/ color, /*Array of [[ARRAY] of RGBA Numbers*/ animationSpeed, /*Array of Number*/ randomDirectionPeriod, /*Number*/ randomDirectionIntensity, /*Number*/ onTimerScript, /*String*/ beforeDestroyScript, /*String*/ this, /*Object*/ angle, /*Optional Number - Default: 0*/ onSurface, /*Optional Boolean*/ bounceOnSurface, /*Optional Number*/ emissiveColor /*Optional Array of [[ARRAY] of RGBA Numbers*/ ];|= Description ____________________________________________________________________________________________

| particleSource setParticleParams array |= Syntax

|p1= particleSource: Object |= Parameter 1

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

| Nothing |= Return value

|x1= see ParticleArray|= EXAMPLE1 ____________________________________________________________________________________________

| Arma 3 Particle Effects, ParticleArray, setParticleClass, setParticleRandom, setParticleCircle, setParticleFire, setDropInterval, drop|= See also

}}

Notes

Bottom Section