roadsConnectedTo

From Bohemia Interactive Community
Revision as of 14:00, 8 November 2023 by Lou Montana (talk | contribs) (Text replacement - "(\|[pr][0-9]+ *= *[^-]+) *- *C([a-eg-z])" to "$1 - c$2")
Jump to navigation Jump to search
Hover & click on the images for description

Description

Description:
Find the road segments connected to the given road segment.
Pedestrian roads such as "TRAIL"s are missing connection information by design, therefore basic command will return empty array for those. Use the alternative syntax to return pedestrian roads.
Groups:
Roads and Airports

Syntax

Syntax:
roadsConnectedTo roadSegment
Parameters:
roadSegment: Object - Road segment
Return Value:
Array of Objects - connected road segments

Alternative Syntax

Syntax:
roadsConnectedTo [roadSegment, extended]
Parameters:
roadSegment: Object - Road segment
extended: Boolean - (Optional, default false) when true, performs a more thorough search on top of base behaviour, slower but returns pedestrian and other missing road segments
Return Value:
Array of Objects - connected road segments

Examples

Example 1:
_road = (player nearRoads 50) select 0; _connectedRoads = roadsConnectedTo _road;
Example 2:
_road = (player nearRoads 50) select 0; _connectedRoadsIncPedestrian = roadsConnectedTo [_road, true];

Additional Information

See also:
nearRoads isOnRoad roadAt surfaceIsWater getRoadInfo nearestTerrainObjects

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