BIS fnc destroyCity: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Changed layout template from Command to Function)
m (Text replacement - "(Optional, default {{hl|[]}})" to "(Optional, default <sqf inline>[]</sqf>)")
 
(44 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Function|=
{{RV|type=function
____________________________________________________________________________________________


| arma2oa |=
|game1= arma2oa
|version1= 1.56


|1.56|=
|game2= tkoh
|version2= 1.00


|arg= |= MPARGUMENTS
|game3= arma3
|version3= 0.50


|eff= global |= Effects in MP
|eff= global |MPeff= Effects in MP
____________________________________________________________________________________________


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


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


|p1= position: [[Array]] (in format [[position]]) or [[Object]] (object position) or [[String]] (marker position) |= PARAMETER1 
|descr= Destroys building in given area based on input seed.


|p2= areaSize ''(Optional)'': [[Number]] - area diameter (default is 1000) |= PARAMETER2
|s1= [position, ''areaSize'', ''seed'', ''blacklist''] call [[BIS_fnc_destroyCity]]


|p3= seed ''(Optional)'': [[Number]] - random seed (default is 1138) |= PARAMETER3
|p1= position: [[Object]], [[String]] or [[Position]] - center of the area:
* [[Object]] - position of the object will be used
* [[String]] - marker name
* [[Position]]


|p4= blacklist ''(Optional)'': [[Array]] of blacklisted objects (default is an empty array) |= PARAMETER4
|p2= areaSize: [[Number]] - (Optional, default 1000) area radius


| [[Boolean]] - true when completed |= RETURNVALUE
|p3= seed: [[Number]] - (Optional, default 1138) destruction's random seed


|x1= <code>["destroyBase", 500, 42, [bis_vila]] [[call]] bis_fnc_destroyCity;</code>|= EXAMPLE1
|p4= blacklist: [[Array]] - (Optional, default <sqf inline>[]</sqf>) array of spared buildings
____________________________________________________________________________________________


| [[Functions Library]] |= SEEALSO
|r1= [[Boolean]] - [[true]] when completed


| |= MPBEHAVIOUR
|x1= <sqf>["destroyBase", 500, 42, [ourHouseInTheMiddleOfTheStreet]] call BIS_fnc_destroyCity;</sqf>
____________________________________________________________________________________________
 
|seealso= [[setDamage]] [[nearestBuilding]] [[buildingPos]]
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<h3 style='display:none'>Bottom Section</h3>
[[Category:ArmA 2: Functions|DESTROYCITY}}]]
[[Category:Function Group: Environment|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"