Difference between revisions of "BIS fnc sandstorm"

From Bohemia Interactive Community
Jump to navigation Jump to search
(Changed layout template from Command to Function)
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|=
+
{{Function|Comments=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| arma2oa |=
+
| arma2oa |Game name=
  
|1.56|=
+
|1.56|Game version=
  
|arg= |= MPARGUMENTS
+
|arg= |MPARGUMENTS=  
  
|eff= local |= Effects in MP
+
|eff= local |MPEffects=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| Creates particle sandstorm round given object. |=
+
| Creates particle sandstorm round given object. |Description=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| [object,''interval'',''brightness'',''newspapers''] call '''BIS_fnc_sandstorm'''  |=
+
| [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) |PARAMETER2=  
  
|p3= brightness ''(Optional)'': [[Number]] - brightness coeficient (default is 1) |= PARAMETER3
+
|p3= brightness ''(Optional)'': [[Number]] - brightness coeficient (default is 1) |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>[</nowiki>[[player]], -1, 0.8, [[false]]<nowiki>]</nowiki> [[call]] [[BIS_fnc_sandstorm]];</code>|= EXAMPLE1
+
|x1= <code>[<nowiki/>[[player]], -1, 0.8, [[false]]] [[call]] [[BIS_fnc_sandstorm]];</code> |EXAMPLE1=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| [[Functions Library]] |= SEEALSO  
+
| [[Functions Library]] |SEEALSO=  
 
 
|  |= MPBEHAVIOUR
 
____________________________________________________________________________________________
 
 
}}
 
}}
  
Line 43: Line 41:
  
 
<h3 style='display:none'>Bottom Section</h3>
 
<h3 style='display:none'>Bottom Section</h3>
 
+
[[Category:Function Group: Environment|{{uc:sandstorm}}]]
[[Category:ArmA 2: Functions|SANDSTORM}}]]
+
[[Category:Functions|{{uc:sandstorm}}]]
[[Category:Function Group: Environment|sandstorm]]
+
[[Category:{{Name|arma2oa}}: Functions|{{uc:sandstorm}}]]
 +
[[Category:{{Name|tkoh}}: Functions|{{uc:sandstorm}}]]
 +
[[Category:{{Name|arma3}}: Functions|{{uc:sandstorm}}]]

Latest revision as of 02:45, 1 October 2019

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.

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)
brightness (Optional): Number - brightness coeficient (default is 1)
newspapers (Optional): Boolean - true if flying newspapers will be present (default is true)
Return Value:
Array of created particle effect

Examples

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

Additional Information

Execution:
call
See also:
Functions Library

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