BIS fnc nearestPosition: Difference between revisions

Latest revision as of 17:00, 13 July 2022

Hover & click on the images for description

Description:: Function to find the nearest Object or position from a list, when compared to a given reference.
Execution:: call
Groups:: Positions

Syntax:: [items, origin] call BIS_fnc_nearestPosition
Parameters:: items: Array of Object, Location, Group, String (marker) and/or Position - note that for a group, leader's position is used
: origin: Object, Location, Group, String (marker) or Position
Return Value:: Object, Location, Group, String (marker) or Position - the closest from items

Example 1:: // Find the nearest marker from player _nearestMarker = [allMapMarkers, player] call BIS_fnc_nearestPosition;
Example 2:: // Find the nearest marker to trigger using trigger onActivation code _nearestMarker = [allMapMarkers, thisTrigger] call BIS_fnc_nearestPosition;

See also:: nearObjects nearestObject nearestObjects BIS_fnc_nearestPoint BIS_fnc_nearestNum BIS_fnc_nearestRoad BIS_fnc_nearestHelipad BIS_fnc_isPosBlacklisted

: 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

@@ Line 25: / Line 25: @@
 |r1= [[Object]], [[Location]], [[Group]], [[String]] (marker) or [[Position]] - the closest from ''items''
-|x1= <code>{{cc|Find the nearest marker from player}}
+|x1= <sqf>// Find the nearest marker from player
-_nearestMarker = [<nowiki/>[[allMapMarkers]], [[player]]] [[call]] [[BIS_fnc_nearestPosition]];</code>
+_nearestMarker = [allMapMarkers, player] call BIS_fnc_nearestPosition;</sqf>
-|x2= <code>{{cc|Find the nearest marker to trigger using trigger onActivation code}}
+|x2= <sqf>// Find the nearest marker to trigger using trigger onActivation code
-_nearestMarker = [<nowiki/>[[allMapMarkers]], [[thisTrigger]]] [[call]] [[BIS_fnc_nearestPosition]];</code>
+_nearestMarker = [allMapMarkers, thisTrigger] call BIS_fnc_nearestPosition;</sqf>
-|seealso= [[nearObjects]], [[nearestObject]], [[nearestObjects]], [[BIS_fnc_nearestPoint]], [[BIS_fnc_nearestNum]], [[BIS_fnc_nearestRoad]], [[BIS_fnc_nearestHelipad]], [[BIS_fnc_isPosBlacklisted]]
+|seealso= [[nearObjects]] [[nearestObject]] [[nearestObjects]] [[BIS_fnc_nearestPoint]] [[BIS_fnc_nearestNum]] [[BIS_fnc_nearestRoad]] [[BIS_fnc_nearestHelipad]] [[BIS_fnc_isPosBlacklisted]]
 }}
-[[Category:{{Name|arma2oa}}: Functions|{{uc:nearestPosition}}]]
-[[Category:{{Name|tkoh}}: Functions|{{uc:nearestPosition}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:nearestPosition}}]]