BIS fnc nearestRoad: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " |r1=[[" to " |r1= [[")
m (Text replacement - "code>_([a-zA-Z0-9_]+) = " to "code>private _$1 = ")
Line 18: Line 18:
|r1= [[Object]] - nearest road object, [[objNull]] if not found
|r1= [[Object]] - nearest road object, [[objNull]] if not found


|x1= <code>_nearestRoad = [<nowiki/>[[getPosATL]] [[player]], 500] [[call]] [[BIS_fnc_nearestRoad]];</code>
|x1= <code>[[private]] _nearestRoad = [<nowiki/>[[getPosATL]] [[player]], 500] [[call]] [[BIS_fnc_nearestRoad]];</code>


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


|seealso= [[nearRoads]], [[isOnRoad]], [[roadAt]], [[roadsConnectedTo]]
|seealso= [[nearRoads]], [[isOnRoad]], [[roadAt]], [[roadsConnectedTo]]
}}
}}

Revision as of 12:07, 6 May 2022

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

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