BIS fnc nearestRoad: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (released sooner than 1.00, added 0.76. Source http://dev.arma3.com/post/spotrep-00009)
(Page filling)
Line 1: Line 1:
 
{{Function|Comments=
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma3 |= Game name
| arma3 |Game name=


|0.76|= Game version
|0.76|Game version=
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Find the nearest road segment to certain position, within given radius. |Description=
____________________________________________________________________________________________


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


Parameter(s):
|p1= center: [[Position]] |Parameter 1=
_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
|p2= radius: [[Number]] - (Optional, default 50) search radius from ''center'' |Parameter 2=


|p1= |= Parameter 1
|p3= blacklist: [[Array]] - (Optional, default []) blacklisted road objects |Parameter 3=


| |= Return value
| [[Object]] - nearest road object, [[objNull]] if not found |Return value=
____________________________________________________________________________________________
____________________________________________________________________________________________


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


| |= See also
| [[nearRoads]], [[isOnRoad]], [[roadAt]], [[roadsConnectedTo]] |See also=
 
}}
}}


Revision as of 16:55, 4 June 2018

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

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:
_nearestRoad = [getPosATL player, 500] call BIS_fnc_nearestRoad;
Example 2:
_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

Notes

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_nearestRoad&oldid=107992"