BIS fnc destroyCity: 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= global |= Effects in MP
____________________________________________________________________________________________
____________________________________________________________________________________________


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


Description:
| [position,''areaSize'',''seed'',''blacklist''] call '''BIS_fnc_destroyCity'''  |=
Destroys building in given area based on input seed.


Parameter(s):
|p1= position: [[Array]] (in format [[position]]) or [[Object]] (object position) or [[String]] (marker position) |= PARAMETER1 
_this select 0: OBJECT - Destruction center
_this select 1 (Optional): NUMBER - Destruction area diameter
_this select 2 (Optional): NUMBER - Random seed
_this select 3 (Optional): ARRAY - Array of blacklisted objects


Returns:
|p2= areaSize ''(Optional)'': [[Number]] - area diameter (default is 1000) |= PARAMETER2
ARRAY - Particle sources
*/
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_destroyCity]]; --> |= Syntax
|p3= seed ''(Optional)'': [[Number]] - random seed (default is 1138) |= PARAMETER3


|p1= |= Parameter 1
|p4= blacklist ''(Optional)'': [[Array]] of blacklisted objects (default is an empty array) |= PARAMETER4


| |= Return value
| [[Boolean]] - true when completed |= RETURNVALUE
____________________________________________________________________________________________


|x1= <code></code> |=  
|x1= <code>["destroyBase",500,42,[bis_vila]] call bis_fnc_destroyCity;</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:destroyCity}}]]
 
[[Category:Functions|{{uc:destroyCity}}]]
[[Category:ArmA 2: Functions|DESTROYCITY}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:destroyCity}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:destroyCity}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:destroyCity}}]]

Revision as of 10:53, 29 November 2010

Hover & click on the images for description

Description

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

Syntax

Syntax:
[position,areaSize,seed,blacklist] call BIS_fnc_destroyCity
Parameters:
position: Array (in format position) or Object (object position) or String (marker position)
areaSize (Optional): Number - area diameter (default is 1000)
seed (Optional): Number - random seed (default is 1138)
blacklist (Optional): Array of blacklisted objects (default is an empty array)
Return Value:
Boolean - true when completed

Examples

Example 1:
["destroyBase",500,42,[bis_vila]] call bis_fnc_destroyCity;

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