BIS fnc nearestRoad: 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 - "(Optional, default {{hl|[]}})" to "(Optional, default <sqf inline>[]</sqf>)")
 
(30 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function


| arma3 |Game name=
|game1= arma3
|version1= 0.76


|0.76|Game version=
|gr1= Positions


|gr1 = Positions |GROUP1=
|descr= Find the nearest road segment to certain position, within given radius.


| Find the nearest road segment to certain position, within given radius. |Description=
|s1= [center'', radius, blacklist''] call [[BIS_fnc_nearestRoad]]


| [center'', radius, blacklist''] call [[BIS_fnc_nearestRoad]] |Syntax=
|p1= center: [[Position]]


|p1= center: [[Position]] |Parameter 1=
|p2= radius: [[Number]] - (Optional, default 50) search radius from ''center''


|p2= radius: [[Number]] - (Optional, default 50) search radius from ''center'' |Parameter 2=
|p3= blacklist: [[Array]] - (Optional, default <sqf inline>[]</sqf>) blacklisted road objects


|p3= blacklist: [[Array]] - (Optional, default []) blacklisted road objects |Parameter 3=
|r1= [[Object]] - nearest road object, [[objNull]] if not found


| [[Object]] - nearest road object, [[objNull]] if not found |Return value=
|x1= <sqf>private _nearestRoad = [getPosATL player, 500] call BIS_fnc_nearestRoad;</sqf>


|x1= <code>_nearestRoad = [<nowiki/>[[getPosATL]] [[player]], 500] [[call]] [[BIS_fnc_nearestRoad]];</code> |Example 1=
|x2= <sqf>private _nearestRoad = [getPosATL vehicle player, 50, getPosATL vehicle player nearRoads 20] call BIS_fnc_nearestRoad;</sqf>


|x2= <code>_nearestRoad = [<nowiki/>[[getPosATL]] [[vehicle]] [[player]], 50, [[getPosATL]] [[vehicle]] [[player]] [[nearRoads]] 20] [[call]] [[BIS_fnc_nearestRoad]];</code> |Example 2=
|seealso= [[nearRoads]] [[isOnRoad]] [[roadAt]] [[roadsConnectedTo]]
 
| [[nearRoads]], [[isOnRoad]], [[roadAt]], [[roadsConnectedTo]] |See also=
}}
}}
<h3 style="display:none">Bottom Section</h3>
[[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"