BIS fnc nearestRoad: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "(Optional, default {{hl|[]}})" to "(Optional, default <sqf inline>[]</sqf>)")
 
(38 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 0.76


| arma3 |= Game name
|gr1= Positions


|1.00|= Game version
|descr= Find the nearest road segment to certain position, within given radius.
____________________________________________________________________________________________


| <pre>/*
|s1= [center'', radius, blacklist''] call [[BIS_fnc_nearestRoad]]


Description:
|p1= center: [[Position]]
Find the nearest road segment to certain position, within given radius


Parameter(s):
|p2= radius: [[Number]] - (Optional, default 50) search radius from ''center''
_this select 0: ARRAY - The center position
_this select 1: NUMBER - The distance from center position
_this select 2: ARRAY - List of blacklisted road objects
Returns:
OBJECT - Nearest road object on success
NULL - If no road object is found within given radius
*/
//Parameters
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_nearestRoad]]; --> |= Syntax
|p3= blacklist: [[Array]] - (Optional, default <sqf inline>[]</sqf>) blacklisted road objects


|p1= |= Parameter 1
|r1= [[Object]] - nearest road object, [[objNull]] if not found


| |= Return value
|x1= <sqf>private _nearestRoad = [getPosATL player, 500] call BIS_fnc_nearestRoad;</sqf>
____________________________________________________________________________________________


|x1= <code></code> |=
|x2= <sqf>private _nearestRoad = [getPosATL vehicle player, 50, getPosATL vehicle player nearRoads 20] call BIS_fnc_nearestRoad;</sqf>
____________________________________________________________________________________________
 
| |= See also


|seealso= [[nearRoads]] [[isOnRoad]] [[roadAt]] [[roadsConnectedTo]]
}}
}}
<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:Function Group: Misc|{{uc:nearestRoad}}]]
[[Category:Functions|{{uc:nearestRoad}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:nearestRoad}}]]

Latest revision as of 18:09, 8 November 2023

Arma 3 logo black.png0.76
Hover & click on the images for description

Description

Description:
Find the nearest road segment to certain position, within given radius.
Execution:
call
Groups:
Positions

Syntax

Syntax:
[center, radius, blacklist] call BIS_fnc_nearestRoad
Parameters:
center: Position
radius: Number - (Optional, default 50) search radius from center
blacklist: Array - (Optional, default []) blacklisted road objects
Return Value:
Object - nearest road object, objNull if not found

Examples

Example 1:
private _nearestRoad = [getPosATL player, 500] call BIS_fnc_nearestRoad;
Example 2:
private _nearestRoad = [getPosATL vehicle player, 50, getPosATL vehicle player nearRoads 20] call BIS_fnc_nearestRoad;

Additional Information

See also:
nearRoads isOnRoad roadAt roadsConnectedTo

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_nearestRoad&oldid=349500"