BIS fnc sandstorm: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{Feature arma3|" to "{{Feature|arma3|")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Function|Comments=
{{Function|Comments=
____________________________________________________________________________________________


| arma2oa |Game name=
| arma2oa |Game name=
Line 11: Line 10:


|gr1 = Environment |GROUP1=
|gr1 = Environment |GROUP1=
____________________________________________________________________________________________


| Creates particle sandstorm round given object. {{Feature|arma3| '''newspapers''' parameter is disabled in {{arma3}} {{Inline code|if (_newspapers && false)...}}}} |Description=
| Creates particle sandstorm round given object. {{Feature|arma3| '''newspapers''' parameter is disabled in {{arma3}} {{Inline code|if (_newspapers && false)...}}}} |Description=
____________________________________________________________________________________________


| [object, ''interval'', ''brightness'', ''newspapers''] call [[BIS_fnc_sandstorm]] |SYNTAX=
| [object, ''interval'', ''brightness'', ''newspapers''] call [[BIS_fnc_sandstorm]] |SYNTAX=
Line 27: Line 24:


| [[Array]] of created particle effect |RETURNVALUE=
| [[Array]] of created particle effect |RETURNVALUE=
____________________________________________________________________________________________


|x1= <code>[<nowiki/>[[player]], 0.04, 0.8, [[false]]] [[call]] [[BIS_fnc_sandstorm]];</code> |EXAMPLE1=
|x1= <code>[<nowiki/>[[player]], 0.04, 0.8, [[false]]] [[call]] [[BIS_fnc_sandstorm]];</code> |EXAMPLE1=
____________________________________________________________________________________________


| [[Functions Library]] |SEEALSO=  
| [[Functions Library]] |SEEALSO=  

Revision as of 00:55, 17 January 2021

Hover & click on the images for description

Description

Description:
Creates particle sandstorm round given object.
Arma 3
newspapers parameter is disabled in Arma 3 if (_newspapers && false)...
Execution:
call
Groups:
Environment

Syntax

Syntax:
[object, interval, brightness, newspapers] call BIS_fnc_sandstorm
Parameters:
position: Object - sandstorm center (should be player)
interval (Optional): Number - particle refresh time (default is 0.07) Lower number makes the sandstorm more dense
brightness (Optional): Number - brightness coeficient (default is 1) (1 - bright, 0 dark)
newspapers (Optional): Boolean - true if flying newspapers will be present (default is true)
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

Notes

Bottom Section