BIS fnc sandstorm: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (example and additional information to parameters)
Line 13: Line 13:
____________________________________________________________________________________________
____________________________________________________________________________________________


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


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


|p2= interval ''(Optional)'': [[Number]] - particle refresh time (default is 0.07) |PARAMETER2=  
|p2= interval ''(Optional)'': [[Number]] - particle refresh time (default is 0.07) Lower number makes the sandstorm more dense |PARAMETER2=  


|p3= brightness ''(Optional)'': [[Number]] - brightness coeficient (default is 1) |PARAMETER3=
|p3= brightness ''(Optional)'': [[Number]] - brightness coeficient (default is 1)  (1 - bright, 0 dark) |PARAMETER3=


|p4= newspapers ''(Optional)'': [[Boolean]] - true if flying newspapers will be present (default is true) |PARAMETER4=
|p4= newspapers ''(Optional)'': [[Boolean]] - true if flying newspapers will be present (default is [[true]]) |PARAMETER4=


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


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



Revision as of 17:48, 29 October 2020

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