BIS fnc nearestHelipad: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| tkoh |Game name=
| tkoh


|1.00|Game version=
|1.00


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


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


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


|p1= position: [[Position]] - (Optional, default [[position]] [[vehicle]] [[player]]) Center position |PARAMETER1=
|p1= position: [[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:
|[[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= <code></code>


| |SEEALSO=
|


}}
}}

Revision as of 23:40, 17 January 2021

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

Example 1:

Additional Information

See also:
See also needed

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

Bottom Section