BIS fnc destroyCity: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " *\|= " to " ")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma2oa |Game name=
| arma2oa


|1.56|Game version=
|1.56


|eff= global |MPeff= Effects in MP
|eff= global |MPeff= Effects in MP
Line 9: Line 9:
|serverExec= server
|serverExec= server


|gr1 = Environment |GROUP1=
|gr1 = Environment


| Destroys building in given area based on input seed.
| Destroys building in given area based on input seed.


| [position, ''areaSize'', ''seed'', ''blacklist''] call [[BIS_fnc_destroyCity]] |SYNTAX=
| [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:
* [[Object]] - position of the object will be used
* [[Object]] - position of the object will be used
* [[String]] - marker name
* [[String]] - marker name
* [[Position]] |PARAMETER1=
* [[Position]]


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


|p3= seed: [[Number]] - (Optional, default 1138) destruction's random seed |PARAMETER3=
|p3= seed: [[Number]] - (Optional, default 1138) destruction's random seed


|p4= blacklist: [[Array]] - (Optional, default []) array of spared buildings |PARAMETER4=
|p4= blacklist: [[Array]] - (Optional, default []) array of spared buildings


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


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


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



Revision as of 00:03, 18 January 2021

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:
setDamagenearestBuildingbuildingPos

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