nearestBuilding: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Command|Comments=
{{Command|Comments=
____________________________________________________________________________________________


| ofp |Game name=
| ofp |Game name=
Line 7: Line 6:


|gr1= Object Detection |GROUP1=
|gr1= Object Detection |GROUP1=
____________________________________________________________________________________________


| Finds the nearest building to a given object or position. A "building" is defined as an object that is of class "House" and contains a path LOD. |DESCRIPTION=
| Finds the nearest building to a given object or position. A "building" is defined as an object that is of class "House" and contains a path LOD. |DESCRIPTION=
____________________________________________________________________________________________


| '''nearestBuilding''' position |SYNTAX= 1
| '''nearestBuilding''' position |SYNTAX= 1
Line 18: Line 15:
| [[Object]] |RETURNVALUE= 1
| [[Object]] |RETURNVALUE= 1


____________________________________________________________________________________________
   
   
|x1= <code>_nBuilding = [[nearestBuilding]] [[player]];</code> |EXAMPLE1=
|x1= <code>_nBuilding = [[nearestBuilding]] [[player]];</code> |EXAMPLE1=


|x2= <code>_nBuilding = [[nearestBuilding]] [[position]] [[player]];</code> |EXAMPLE2=
|x2= <code>_nBuilding = [[nearestBuilding]] [[position]] [[player]];</code> |EXAMPLE2=
____________________________________________________________________________________________


| [[buildingPos]], [[nearestObject]], [[nearestObjects]], [[nearObjects]], [[nearestLocation]], [[nearEntities]], [[nearTargets]], [[nearSupplies]], [[nearestLocationWithDubbing]], [[nearObjectsReady]], [[nearRoads]] |SEEALSO=
| [[buildingPos]], [[nearestObject]], [[nearestObjects]], [[nearObjects]], [[nearestLocation]], [[nearEntities]], [[nearTargets]], [[nearSupplies]], [[nearestLocationWithDubbing]], [[nearObjectsReady]], [[nearRoads]] |SEEALSO=

Revision as of 02:57, 17 January 2021

Hover & click on the images for description

Description

Description:
Finds the nearest building to a given object or position. A "building" is defined as an object that is of class "House" and contains a path LOD.
Groups:
Object Detection

Syntax

Syntax:
nearestBuilding position
Parameters:
position: Object or Array in format PositionAGL or Position2D
Return Value:
Object

Examples

Example 1:
_nBuilding = nearestBuilding player;
Example 2:
_nBuilding = nearestBuilding position player;

Additional Information

See also:
buildingPosnearestObjectnearestObjectsnearObjectsnearestLocationnearEntitiesnearTargetsnearSuppliesnearestLocationWithDubbingnearObjectsReadynearRoads

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

Posted on February 18, 2016 - 20:18 (UTC)
Pierre MGI
This command doesn't return any house or building placed in editor (with createVehicle). Use nearestObjects instead: nearestObjects [player, ["House", "Building"], 50] select 0
Posted on December 30, 2020 - 16:04 (UTC)
Tankbuster
Some large buildings aren't found by this command. "Land_Airport_Tower_F", "Land_Offices_01_V1_F" and "Land_Hotel_02_F" are examples.