BIS fnc nearestHelipad: Difference between revisions

Latest revision as of 12:32, 8 November 2023

1.00

0.50

Hover & click on the images for description

Description

Description:: Finds the nearest helipad of given type.
Execution:: call
Groups:: Map and Markers

Syntax

Syntax:

[position, radius, random, types] call BIS_fnc_nearestHelipad

Parameters:

position: Array format Position - (Optional, default position vehicle player) center position

radius: Number - (Optional, default 999999) radius of the area to search in meters

random: Boolean - (Optional, default false) if true a random helipad will be selected if multiple are found

types: Array - (Optional, default ["Heliport"]) location types to be searched for. See nearestLocations for more information

Default value won't work in Arma 3. Only types listed in CfgLocationTypes are supported

Return Value:

Array in format:

0: Position - Position of the selected location
1: Object - Helipad
2: Position - Position of the helipad

Examples

Examples:: Example needed

Additional Information

See also:: nearestObjects

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

@@ Line 1: / Line 1: @@
+{{RV|type=function
-{{Function|Comments=
+|game1= tkoh
-____________________________________________________________________________________________
+|version1= 1.00
-| tkoh |= Game name
+|game2= arma3
+|version2= 0.50
-|1.00|= Game version
+|gr1= Map and Markers
-____________________________________________________________________________________________
-| ''N/A'' |DESCRIPTION=
+|descr= Finds the nearest helipad of given type.
-____________________________________________________________________________________________
-| <!-- [] call [[BIS_fnc_nearestHelipad]]; --> |SYNTAX=
+|s1= [position, radius, random, types] call [[BIS_fnc_nearestHelipad]]
-|p1= |PARAMETER1=
+|p1= position: [[Array]] format [[Position]] - (Optional, default [[position]] [[vehicle]] [[player]]) center position
-| |RETURNVALUE=
+|p2= radius: [[Number]] - (Optional, default 999999) radius of the area to search in meters
-____________________________________________________________________________________________
-|x1= <code></code> |=
+|p3= random: [[Boolean]] - (Optional, default [[false]]) if [[true]] a random helipad will be selected if multiple are found
-____________________________________________________________________________________________
-| |SEEALSO=
+|p4= types: [[Array]] - (Optional, default ["Heliport"]) location types to be searched for. See [[nearestLocations]] for more information {{Feature|arma3|Default value won't work in {{arma3}}. Only types listed in CfgLocationTypes are supported}}
-}}
+|r1= [[Array]] in format:
+* 0: [[Position]] - Position of the selected location
+* 1: [[Object]] - Helipad
+* 2: [[Position]] - Position of the helipad
-<h3 style="display:none">Notes</h3>
+|x1=
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
+|seealso= [[nearestObjects]]
-</dl>
+}}
-<h3 style="display:none">Bottom Section</h3>
-[[Category:Function Group: Map|{{uc:nearestHelipad}}]]
-[[Category:Functions|{{uc:nearestHelipad}}]]
-[[Category:{{Name|tkoh}}: Functions|{{uc:nearestHelipad}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:nearestHelipad}}]]