BIS fnc destroyCity: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " |r1=[[" to " |r1= [[")
m (Text replacement - "(Optional, default {{hl|[]}})" to "(Optional, default <sqf inline>[]</sqf>)")
 
(7 intermediate revisions by the same user not shown)
Line 18: Line 18:
|descr= Destroys building in given area based on input seed.
|descr= Destroys building in given area based on input seed.


|s1=[position, ''areaSize'', ''seed'', ''blacklist''] call [[BIS_fnc_destroyCity]]
|s1= [position, ''areaSize'', ''seed'', ''blacklist''] call [[BIS_fnc_destroyCity]]


|p1= position: [[Object]], [[String]] or [[Position]] - center of the area:
|p1= position: [[Object]], [[String]] or [[Position]] - center of the area:
Line 29: Line 29:
|p3= seed: [[Number]] - (Optional, default 1138) destruction's random seed
|p3= seed: [[Number]] - (Optional, default 1138) destruction's random seed


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


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


|x1= <code>["destroyBase", 500, 42, [ourHouseInTheMiddleOfTheStreet]] [[call]] [[BIS_fnc_destroyCity]];</code>
|x1= <sqf>["destroyBase", 500, 42, [ourHouseInTheMiddleOfTheStreet]] call BIS_fnc_destroyCity;</sqf>


|seealso= [[setDamage]], [[nearestBuilding]], [[buildingPos]]
|seealso= [[setDamage]] [[nearestBuilding]] [[buildingPos]]
}}
}}

Latest revision as of 19:09, 8 November 2023

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