BIS fnc sandstorm: Difference between revisions

Latest revision as of 16:55, 25 July 2022

1.56

1.00

0.50

GAGlobal LELocal

Hover & click on the images for description

Description

Description:: Creates particle sandstorm round given object.
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

@@ Line 1: / Line 1: @@
-{{Function|Comments=
+{{RV|type=function
-____________________________________________________________________________________________
-| arma2oa |Game name=
+|game1= arma2oa
+|version1= 1.56
-|1.56|Game version=
+|game2= tkoh
+|version2= 1.00
-|arg= |MPARGUMENTS=
+|game3= arma3
+|version3= 0.50
-|eff= local |MPEffects=
+|arg= global
-|gr1 = Environment |GROUP1=
+|eff= local
-____________________________________________________________________________________________
-| Creates particle sandstorm round given object. {{Feature|arma3| '''newspapers''' parameter is disabled in {{arma3}} {{Inline code|if (_newspapers && false)...}}}} |Description=
+|gr1= Environment
-____________________________________________________________________________________________
-| [object, ''interval'', ''brightness'', ''newspapers''] call [[BIS_fnc_sandstorm]] |SYNTAX=
+|descr= Creates particle sandstorm round given object. {{Feature|arma3|The ''newspapers'' parameter is disabled in {{arma3}}.}}
-|p1= position: [[Object]] - sandstorm center (should be [[player]]) |PARAMETER1=
+|s1= [object, interval, brightness, newspapers] call [[BIS_fnc_sandstorm]]
-|p2= interval ''(Optional)'': [[Number]] - particle refresh time (default is 0.07) Lower number makes the sandstorm more dense |PARAMETER2=
+|p1= position: [[Object]] - sandstorm center (should usually be [[player]])
-|p3= brightness ''(Optional)'': [[Number]] - brightness coeficient (default is 1)  (1 - bright, 0 dark) |PARAMETER3=
+|p2= interval: [[Number]] - (Optional, default 0.07) particle refresh time; a lower number makes the sandstorm more dense
-|p4= newspapers ''(Optional)'': [[Boolean]] - true if flying newspapers will be present (default is [[true]]) |PARAMETER4=
+|p3= brightness: [[Number]] - (Optional, default 1) brightness coeficient; 1 is bright, 0 is dark
-| [[Array]] of created particle effect |RETURNVALUE=
+|p4= newspapers: [[Boolean]] - (Optional, default [[true]]) [[true]] if flying newspapers should be present
-____________________________________________________________________________________________
-|x1= <code>[<nowiki/>[[player]], 0.04, 0.8, [[false]]] [[call]] [[BIS_fnc_sandstorm]];</code> |EXAMPLE1=
+|r1= [[Array]] of created particle effect
-____________________________________________________________________________________________
-| [[Functions Library]] |SEEALSO=
+|x1= <sqf>[player, 0.04, 0.8, false] call BIS_fnc_sandstorm;</sqf>
+|seealso= [[Functions Library]]
 }}
-<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:Functions|{{uc:sandstorm}}]]
-[[Category:{{Name|arma2oa}}: Functions|{{uc:sandstorm}}]]
-[[Category:{{Name|tkoh}}: Functions|{{uc:sandstorm}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:sandstorm}}]]