BIS fnc sandstorm: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Some wiki formatting)
 
(43 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma2oa
____________________________________________________________________________________________
|version1= 1.56


| arma2oa |= Game name
|game2= tkoh
|version2= 1.00


|1.00|= Game version
|game3= arma3
____________________________________________________________________________________________
|version3= 0.50


| <pre>
|arg= global
/*


Description:
|eff= local
Creates particle sandstorma round given object.


Parameter(s):
|gr1= Environment
_this select 0: OBJECT - Sandstorm center
_this select 1 (Optional): NUMBER - particle refresh time
_this select 2 (Optional): NUMBER - color brightness coeficient (1 - bright, 0 dark)
_this select 3 (Optional): BOOL - true for flying newspapers


Returns:
|descr= Creates particle sandstorm round given object. {{Feature|arma3|The ''newspapers'' parameter is disabled in {{arma3}}.}}
ARRAY - Particle sources
*/
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_sandstorm]]; --> |= Syntax
|s1= [object, interval, brightness, newspapers] call [[BIS_fnc_sandstorm]]


|p1= |= Parameter 1
|p1= position: [[Object]] - sandstorm center (should usually be [[player]])


| |= Return value
|p2= interval: [[Number]] - (Optional, default 0.07) particle refresh time; a lower number makes the sandstorm more dense
____________________________________________________________________________________________


|x1= <code></code> |=
|p3= brightness: [[Number]] - (Optional, default 1) brightness coeficient; 1 is bright, 0 is dark
____________________________________________________________________________________________


| |= See also
|p4= newspapers: [[Boolean]] - (Optional, default [[true]]) [[true]] if flying newspapers should be present


}}
|r1= [[Array]] of created particle effect


<h3 style="display:none">Notes</h3>
|x1= <sqf>[player, 0.04, 0.8, false] call BIS_fnc_sandstorm;</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|seealso= [[Functions Library]]
</dl>
}}
 
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Environment|{{uc:sandstorm}}]]
[[Category:Functions|{{uc:sandstorm}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:sandstorm}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:sandstorm}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:sandstorm}}]]

Latest revision as of 16:55, 25 July 2022

A2 OA Logo.png1.56tkoh logo small.png1.00Arma 3 logo black.png0.50
GAGlobalLELocal
Hover & click on the images for description

Description

Description:
Creates particle sandstorm round given object.
Arma 3
The newspapers parameter is disabled in Arma 3.
Execution:
call
Groups:
Environment

Syntax

Syntax:
[object, interval, brightness, newspapers] call BIS_fnc_sandstorm
Parameters:
position: Object - sandstorm center (should usually be player)
interval: Number - (Optional, default 0.07) particle refresh time; a lower number makes the sandstorm more dense
brightness: Number - (Optional, default 1) brightness coeficient; 1 is bright, 0 is dark
newspapers: Boolean - (Optional, default true) true if flying newspapers should be present
Return Value:
Array of created particle effect

Examples

Example 1:
[player, 0.04, 0.8, false] call BIS_fnc_sandstorm;

Additional Information

See also:
Functions Library

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=BIS_fnc_sandstorm&oldid=329203"