Difference between revisions of "BIS fnc sandstorm"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (example and additional information to parameters)
 
(One intermediate revision by the same user not shown)
Line 9: Line 9:
  
 
|eff= local |MPEffects=
 
|eff= local |MPEffects=
 +
 +
|gr1 = Environment |GROUP1=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| 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=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
Line 41: Line 43:
  
 
<h3 style='display:none'>Bottom Section</h3>
 
<h3 style='display:none'>Bottom Section</h3>
[[Category:Function Group: Environment|{{uc:sandstorm}}]]
 
 
[[Category:Functions|{{uc:sandstorm}}]]
 
[[Category:Functions|{{uc:sandstorm}}]]
 
[[Category:{{Name|arma2oa}}: Functions|{{uc:sandstorm}}]]
 
[[Category:{{Name|arma2oa}}: Functions|{{uc:sandstorm}}]]
 
[[Category:{{Name|tkoh}}: Functions|{{uc:sandstorm}}]]
 
[[Category:{{Name|tkoh}}: Functions|{{uc:sandstorm}}]]
 
[[Category:{{Name|arma3}}: Functions|{{uc:sandstorm}}]]
 
[[Category:{{Name|arma3}}: Functions|{{uc:sandstorm}}]]

Latest revision as of 17:48, 29 October 2020

Introduced with Arma 2: Operation Arrowhead version 1.561.56Effects of this scripting function are not broadcasted over the network and remain local to the client the function is executed on
Hover & click on the images for descriptions

Description

Description:
Creates particle sandstorm round given object.
Arma 3 logo black.png
newspapers parameter is disabled in Arma 3 if (_newspapers && false)...

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

Execution:
call
See also:
Functions Library
Groups:
Environment

Notes

i
Only post proven facts here. Report bugs on the Feedback Tracker and discuss on the Arma Discord or on the Forums.

Notes

Bottom Section