BIS fnc sandstorm: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
mNo edit summary
Line 1: Line 1:
{{Command|=
____________________________________________________________________________________________
| arma2oa |=


{{Function|= Comments
|1.56|=
____________________________________________________________________________________________


| arma2oa |= Game name
|arg= |= MPARGUMENTS


|1.00|= Game version
|eff= local |= Effects in MP
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>
| Creates particle sandstorm round given object.
/*
|=
____________________________________________________________________________________________


Description:
| [object,''interval'',''brightness'',''newspapers''] call '''BIS_fnc_sandstorm'''  |=
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>[player,-1,0.8,false] [[call]] bis_fnc_sandstorm;</code>|= EXAMPLE1
____________________________________________________________________________________________
____________________________________________________________________________________________


| |= See also
| [[Functions Library]] |= SEEALSO


|  |= MPBEHAVIOUR
____________________________________________________________________________________________
}}
}}


<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 43:
</dl>
</dl>


<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:ArmA 2: Functions|SANDSTORM}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:sandstorm}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:sandstorm}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:sandstorm}}]]

Revision as of 11:41, 29 November 2010

Hover & click on the images for description

Description

Description:
Creates particle sandstorm round given object.
Groups:
Uncategorised

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

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