BIS fnc getCloudletParams: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - " +\]" to "]")
 
(22 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.76


| arma3 |= Game name
|gr1= Systems


|1.76|= Game version
|descr= Return particle params of CfgCloudlets class.
____________________________________________________________________________________________


| <pre>/*
|s1= [cfgCloudletClass] call [[BIS_fnc_getCloudletParams]]


Description:
|p1= cfgCloudletClass: [[String]] - wanted class in cfgCloudlets
Return particle params of CfgCloudlets class


Parameter(s):
|r1= [[Array]] - format [<nowiki/>[[setParticleParams]], [[setParticleRandom]], [[setDropInterval]]]<br>
0: STRING - CfgCloudlets class
<spoiler text="Show format">
[
[
[particleShape, particleFSNtieth, particleFSIndex, particleFSFrameCount, particleFSLoop],
animationName,
particleType,
timerPeriod,
lifeTime,
position,
moveVelocity,
rotationVelocity,
weight,
volume,
rubbing,
size,
color,
animationSpeed,
randomDirectionPeriod,
randomDirectionIntensity,
onTimerScript,
beforeDestroyScript,
"",
angle,
onSurface,
bounceOnSurface,
emissiveColor
],
[
lifeTimeVar,
positionVar,
moveVelocityVar,
rotationVelocityVar,
sizeVar,
colorVar,
randomDirectionPeriodVar,
randomDirectionIntensityVar,
angleVar,
bounceOnSurfaceVar
],
interval
]</spoiler>


Returns:
|x1= <sqf>["AmmoLightSmokeParticles"] call BIS_fnc_getCloudletParams;</sqf>
ARRAY in format [setParticleParams, setParticleRandom, setDropInterval]
*/
 
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
 
| <!-- [] call [[BIS_fnc_getCloudletParams]]; --> |= Syntax
 
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[Arma 3: Particle Effects]] [[setParticleParams]] [[setParticleRandom]] [[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:Function Group: Misc|{{uc:getCloudletParams}}]]
[[Category:Functions|{{uc:getCloudletParams}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:getCloudletParams}}]]

Latest revision as of 18:16, 8 November 2023

Hover & click on the images for description

Description

Description:
Return particle params of CfgCloudlets class.
Execution:
call
Groups:
Systems

Syntax

Syntax:
[cfgCloudletClass] call BIS_fnc_getCloudletParams
Parameters:
cfgCloudletClass: String - wanted class in cfgCloudlets
Return Value:
Array - format [setParticleParams, setParticleRandom, setDropInterval]
[
	[
		[particleShape, particleFSNtieth, particleFSIndex, particleFSFrameCount, particleFSLoop],
		animationName,
		particleType,
		timerPeriod,
		lifeTime,
		position,
		moveVelocity,
		rotationVelocity,
		weight,
		volume,
		rubbing,
		size,
		color,
		animationSpeed,
		randomDirectionPeriod,
		randomDirectionIntensity,
		onTimerScript,
		beforeDestroyScript,
		"",
		angle,
		onSurface,
		bounceOnSurface,
		emissiveColor
	],
	[
		lifeTimeVar,
		positionVar,
		moveVelocityVar,
		rotationVelocityVar,
		sizeVar,
		colorVar,
		randomDirectionPeriodVar,
		randomDirectionIntensityVar,
		angleVar,
		bounceOnSurfaceVar
	],
	interval

]

↑ Back to spoiler's top

Examples

Example 1:
["AmmoLightSmokeParticles"] call BIS_fnc_getCloudletParams;

Additional Information

See also:
Arma 3: Particle Effects setParticleParams setParticleRandom 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