nearestBuilding: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (template:command argument fix)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| 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


|p1= position: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]] |= Parameter 1
|p1= position: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]] |PARAMETER1=


| [[Object]] |= Return value 1
| [[Object]] |RETURNVALUE= 1


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


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


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


}}
}}

Revision as of 14:44, 7 April 2019

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

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