BIS fnc destroyCity: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "(Optional, default {{hl|[]}})" to "(Optional, default <sqf inline>[]</sqf>)")
 
(50 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma2oa
____________________________________________________________________________________________
|version1= 1.56


| arma2oa |= Game name
|game2= tkoh
|version2= 1.00


|1.00|= Game version
|game3= arma3
____________________________________________________________________________________________
|version3= 0.50


| <pre>
|eff= global |MPeff= Effects in MP
/*


Description:
|serverExec= server
Destroys building in given area based on input seed.


Parameter(s):
|gr1= Environment
_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:
|descr= Destroys building in given area based on input seed.
ARRAY - Particle sources
*/
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_destroyCity]]; --> |= Syntax
|s1= [position, ''areaSize'', ''seed'', ''blacklist''] call [[BIS_fnc_destroyCity]]


|p1= |= Parameter 1
|p1= position: [[Object]], [[String]] or [[Position]] - center of the area:
* [[Object]] - position of the object will be used
* [[String]] - marker name
* [[Position]]


| |= Return value
|p2= areaSize: [[Number]] - (Optional, default 1000) area radius
____________________________________________________________________________________________


|x1= <code></code> |=
|p3= seed: [[Number]] - (Optional, default 1138) destruction's random seed
____________________________________________________________________________________________


| |= See also
|p4= blacklist: [[Array]] - (Optional, default <sqf inline>[]</sqf>) array of spared buildings


}}
|r1= [[Boolean]] - [[true]] when completed


<h3 style="display:none">Notes</h3>
|x1= <sqf>["destroyBase", 500, 42, [ourHouseInTheMiddleOfTheStreet]] call BIS_fnc_destroyCity;</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|seealso= [[setDamage]] [[nearestBuilding]] [[buildingPos]]
</dl>
}}
 
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Environment|{{uc:destroyCity}}]]
[[Category:Functions|{{uc:destroyCity}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:destroyCity}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:destroyCity}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:destroyCity}}]]

Latest revision as of 18:09, 8 November 2023

A2 OA Logo.png1.56tkoh logo small.png1.00Arma 3 logo black.png0.50
GEGlobalSEServer
Hover & click on the images for description

Description

Description:
Destroys building in given area based on input seed.
Execution:
call
Groups:
Environment

Syntax

Syntax:
[position, areaSize, seed, blacklist] call BIS_fnc_destroyCity
Parameters:
position: Object, String or Position - center of the area:
areaSize: Number - (Optional, default 1000) area radius
seed: Number - (Optional, default 1138) destruction's random seed
blacklist: Array - (Optional, default []) array of spared buildings
Return Value:
Boolean - true when completed

Examples

Example 1:
["destroyBase", 500, 42, [ourHouseInTheMiddleOfTheStreet]] call BIS_fnc_destroyCity;

Additional Information

See also:
setDamage nearestBuilding buildingPos

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_destroyCity&oldid=349509"