BIS fnc nearestHelipad: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:Function Group: [a-zA-Z0-9_: ]+(\|\{\{[a-zA-Z0-9_: ]+\}\})?\]\]" to " ")
m (Text replacement - "(\|p[0-9]+ *= *[^(]+\(Optional(, default[^)]*)\) )R([a-z])" to "$1r$3")
 
(25 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| tkoh |Game name=
|game1= tkoh
|version1= 1.00


|1.00|Game version=
|game2= arma3
|version2= 0.50


|gr1 = Map and Markers |GROUP1=
|gr1= Map and Markers
____________________________________________________________________________________________


| Finds the nearest helipad of given type. |DESCRIPTION=
|descr= Finds the nearest helipad of given type.
____________________________________________________________________________________________


| [position, radius, random, types] [[call]] [[BIS_fnc_nearestHelipad]] |SYNTAX=
|s1= [position, radius, random, types] call [[BIS_fnc_nearestHelipad]]


|p1= position: [[Position]] - (Optional, default [[position]] [[vehicle]] [[player]]) Center position |PARAMETER1=
|p1= position: [[Array]] format [[Position]] - (Optional, default [[position]] [[vehicle]] [[player]]) center position


|p2= radius: [[Number]] - (Optional, default 999999) Radius of the area to search in meters |PARAMETER2=
|p2= radius: [[Number]] - (Optional, default 999999) radius of the area to search in meters


|p3= random: [[Boolean]] - (Optional, default [[false]]) If [[true]] a random helipad will be selected if multiple are found |PARAMETER3=
|p3= random: [[Boolean]] - (Optional, default [[false]]) if [[true]] a random helipad will be selected if multiple are found


|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}} |PARAMETER4=
|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}}


|[[Array]] in format:
|r1= [[Array]] in format:
* 0: [[Position]] - Position of the selected location
* 0: [[Position]] - Position of the selected location
* 1: [[Object]] - Helipad  
* 1: [[Object]] - Helipad  
* 2: [[Position]] - Position of the helipad |RETURNVALUE=
* 2: [[Position]] - Position of the helipad
____________________________________________________________________________________________


|x1= <code></code> |EXAMPLE1=
|x1=
____________________________________________________________________________________________
 
| |SEEALSO=


|seealso= [[nearestObjects]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Functions|{{uc:nearestHelipad}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:nearestHelipad}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:nearestHelipad}}]]

Latest revision as of 12:32, 8 November 2023

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
Arma 3
Default value won't work in Arma 3. Only types listed in CfgLocationTypes are supported
Return Value:
Array in format:

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