BIS fnc nearestPosition: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "|= Game name" to "|Game name=")
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{Function|Comments=
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma2 |= Game name
| arma2 |Game name=


|1.00|= Game version
|1.00|Game version=
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>
| Function to find the nearest Object or position from a list, when compared to a given reference. |DESCRIPTION=
/*
____________________________________________________________________________________________
File: nearestPosition.sqf
 
Description:
Function to find the nearest Object or position from a list,  
when compared to a given Object or position.
 
Parameter(s):
_this select 0: Array of Objects, Locations, Groups, markers (String) and / or positions (Array)
_this select 1: Comparator Object, Location, Group, marker (String) or position (Array)
Notes:
[*] For type Group the position of its leader is used.
Returns:
Object / Location / Group / marker (String) or position (Array) which is nearest to the comparator
*/


//Valid parameter count
| [items, origin] call [[BIS_fnc_nearestPosition]] |SYNTAX=
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_nearestPosition]]; --> |= Syntax
|p1= items: [[Array]] of [[Object]], [[Location]], [[Group]], [[String]] (marker) '''and/or''' [[Position]] - note that for a group, '''leader's position''' is used |PARAMETER1=


|p1= |= Parameter 1
|p2= origin: [[Object]], [[Location]], [[Group]], [[String]] (marker) or [[Position]] |PARAMETER2=


| |= Return value
| [[Object]], [[Location]], [[Group]], [[String]] (marker) or [[Position]] - the closest from ''items'' |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code>
|x1= <code>{{codecomment|// Find the nearest marker from player}}
Define nearest marker to player
_nearestMarker = <nowiki>[</nowiki>[[allMapMarkers]], [[player]]] [[call]] [[BIS_fnc_nearestPosition]];</code> |EXAMPLE1=
_nearestMarker = [allMapMarkers, player] call BIS_fnc_nearestPosition;


Define nearest marker to trigger using trigger onactivation code
|x2= <code>{{codecomment|// Find the nearest marker to trigger using trigger onActivation code}}
_nearestMarker = [allMapMarkers, thisTrigger] call BIS_fnc_nearestPosition;
_nearestMarker = <nowiki>[</nowiki>[[allMapMarkers]], [[thisTrigger]]] [[call]] [[BIS_fnc_nearestPosition]];</code> |EXAMPLE1=
</code> |=  
____________________________________________________________________________________________
____________________________________________________________________________________________


| |= See also
| [[nearObjects]], [[nearestObject]], [[nearestObjects]], [[BIS_fnc_nearestPoint]], [[BIS_fnc_nearestNum]], [[BIS_fnc_nearestRoad]], [[BIS_fnc_nearestHelipad]], [[BIS_fnc_isPosBlacklisted]] |SEEALSO=
 
}}
}}


Revision as of 00:27, 31 August 2019

Logo A2.png1.00
Hover & click on the images for description

Description

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

Syntax

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

Examples

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;

Additional Information

See also:
nearObjectsnearestObjectnearestObjectsBIS_fnc_nearestPointBIS_fnc_nearestNumBIS_fnc_nearestRoadBIS_fnc_nearestHelipadBIS_fnc_isPosBlacklisted

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

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_nearestPosition&oldid=129094"