Difference between revisions of "BIS fnc sandstorm"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
 
(10 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 +
{{Function|Comments=
 +
____________________________________________________________________________________________
  
{{Function|= Comments
+
| arma2oa |Game name=
____________________________________________________________________________________________
+
 
 +
|1.56|Game version=
  
| arma2oa |= Game name
+
|arg= |MPARGUMENTS=  
  
|1.00|= Game version
+
|eff= local |MPEffects=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| <pre>
+
| Creates particle sandstorm round given object. |Description=
/*
+
____________________________________________________________________________________________
  
Description:
+
| [object, ''interval'', ''brightness'', ''newspapers''] call [[BIS_fnc_sandstorm]] |SYNTAX=
Creates particle sandstorma round given object.
 
  
Parameter(s):
+
|p1= position: [[Object]] - sandstorm center (should be player) |PARAMETER1=
_this select 0: OBJECT - Sandstorm center
 
_this select 1 (Optional): NUMBER - particle refresh time
 
_this select 2 (Optional): NUMBER - color brightness coeficient (1 - bright, 0 dark)
 
_this select 3 (Optional): BOOL - true for flying newspapers
 
  
Returns:
+
|p2= interval ''(Optional)'': [[Number]] - particle refresh time (default is 0.07) |PARAMETER2=  
ARRAY - Particle sources
 
*/
 
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
 
____________________________________________________________________________________________
 
  
| <!-- [] call [[BIS_fnc_sandstorm]]; --> |= Syntax
+
|p3= brightness ''(Optional)'': [[Number]] - brightness coeficient (default is 1) |PARAMETER3=
  
|p1= |= Parameter 1
+
|p4= newspapers ''(Optional)'': [[Boolean]] - true if flying newspapers will be present (default is true) |PARAMETER4=
  
| |= Return value
+
| [[Array]] of created particle effect |RETURNVALUE=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
|x1= <code></code> |=  
+
|x1= <code>[<nowiki/>[[player]], -1, 0.8, [[false]]] [[call]] [[BIS_fnc_sandstorm]];</code> |EXAMPLE1=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| |= See also
+
| [[Functions Library]] |SEEALSO=  
 
 
 
}}
 
}}
  
<h3 style="display:none">Notes</h3>
+
<h3 style='display:none'>Notes</h3>
<dl class="command_description">
+
<dl class='command_description'>
 
<!-- Note Section BEGIN -->
 
<!-- Note Section BEGIN -->
  
Line 47: Line 40:
 
</dl>
 
</dl>
  
<h3 style="display:none">Bottom Section</h3>
+
<h3 style='display:none'>Bottom Section</h3>
 
[[Category:Function Group: Environment|{{uc:sandstorm}}]]
 
[[Category:Function Group: Environment|{{uc:sandstorm}}]]
 
[[Category:Functions|{{uc:sandstorm}}]]
 
[[Category:Functions|{{uc:sandstorm}}]]

Latest revision as of 01:45, 1 October 2019

Introduced with Arma 2: Operation Arrowhead version 1.561.56
Effects 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. Use the Talk page or the Forums for discussions.

Notes

Bottom Section