roadsConnectedTo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Add since template usage)
Line 10: Line 10:


| Find the road segments connected to the given road segment.
| Find the road segments connected to the given road segment.
{{Important | Pedestrian roads such as <tt>"TRAIL"</tt>s are missing connection information by design, therefore basic command will return empty array for those. Use alternative syntax to return pedestrian roads (available since Arma 3 v1.99.146461) }} |DESCRIPTION=
{{Important | Pedestrian roads such as <tt>"TRAIL"</tt>s are missing connection information by design, therefore basic command will return empty array for those. Use the alternative syntax to return pedestrian roads.}} |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''roadsConnectedTo''' roadSegment |SYNTAX=
| '''roadsConnectedTo''' roadSegment |SYNTAX=


|p1= roadSegment: [[Object]] - road segment |PARAMETER1=  
|p1= roadSegment: [[Object]] - road segment |PARAMETER1=


|p2= |PARAMETER2=  
| [[Array]] of [[Object]]s - connected road segments|RETURNVALUE=


|p3= |PARAMETER3=  
|s2 = [[roadsConnectedTo]] [roadSegment, extended] {{since|arma3|1.99.146461|y}} |SYNTAX2=


| [[Array]] of [[Object]]s - connected road segments|RETURNVALUE=  
|p21= roadSegment: [[Object]] - road segment |PARAMETER21=


|s2 = [[roadsConnectedTo]] [roadSegment, extended] &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <i>(Since Arma 3 v1.99.146461)</i> |SYNTAX2=
|p22= 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 |PARAMETER22=
|p21 = [roadSegment, extended] - [[Array]] |PARAMETER21=
|p22= roadSegment: [[Object]] - road segment |PARAMETER22=
|p23= extended (Optional): [[Boolean]] - when [[true]] performs more thorough search on top of base behaviour, slower but returns pedestrian and other missing road segments. Default: [[false]] - base behaviour |PARAMETER23=  


|r2= [[Array]] of [[Object]]s - connected road segments|RETURNVALUE2=  
|r2= [[Array]] of [[Object]]s - connected road segments|RETURNVALUE2=  


|x1= <code>_road = ([[player]] [[nearRoads]] 50) [[select]] 0;
|x1= <code>_road = ([[player]] [[nearRoads]] 50) [[select]] 0;
_connectedRoads = [[roadsConnectedTo]] _road;</code>|EXAMPLE1=  
_connectedRoads = [[roadsConnectedTo]] _road;</code> |EXAMPLE1=


|x2= <code>_road = ([[player]] [[nearRoads]] 50) [[select]] 0;
|x2= <code>_road = ([[player]] [[nearRoads]] 50) [[select]] 0;
_connectedRoadsIncPedestrian = [[roadsConnectedTo]] [_road, [[true]]];</code>|EXAMPLE2=  
_connectedRoadsIncPedestrian = [[roadsConnectedTo]] [_road, [[true]]];</code> |EXAMPLE2=
 
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[nearRoads]], [[isOnRoad]], [[roadAt]], [[surfaceIsWater]], [[getRoadInfo]], [[nearestTerrainObjects]]  |SEEALSO=  
| [[nearRoads]], [[isOnRoad]], [[roadAt]], [[surfaceIsWater]], [[getRoadInfo]], [[nearestTerrainObjects]]  |SEEALSO=
 
|  |MPBEHAVIOUR=
____________________________________________________________________________________________
}}
}}


Line 53: Line 46:
<h3 style='display:none'>Bottom Section</h3>
<h3 style='display:none'>Bottom Section</h3>


[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Revision as of 22:20, 23 December 2020

Logo A2.png1.00
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] Template:since
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:
nearRoadsisOnRoadroadAtsurfaceIsWatergetRoadInfonearestTerrainObjects

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=roadsConnectedTo&oldid=170820"