roadsConnectedTo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{since" to "{{Since")
m (Text replacement - "{{Feature|Important|" to "{{Feature|important|")
 
(31 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma2 |Game name=
|game1= arma2
|version1= 1.00


|1.00|Game version=
|game2= arma2oa
|version2= 1.50


|gr1= Roads and Airports |GROUP1=
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| Find the road segments connected to the given road segment.
|game4= arma3
{{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=
|version4= 0.50
____________________________________________________________________________________________


| '''roadsConnectedTo''' roadSegment |SYNTAX=
|gr1= Roads and Airports


|p1= roadSegment: [[Object]] - road segment |PARAMETER1=
|descr= Find the road segments connected to the given road segment.
 
{{Feature|important|
| [[Array]] of [[Object]]s - connected road segments|RETURNVALUE=
* Pedestrian roads such as {{hl|"TRAIL"}}s are missing connection information by design, therefore the primary syntax will return empty array for those - use the alternative syntax to return pedestrian roads.
* Road connection is not bidirectional; e.g road segment Y can be connected to road segment Z, but road segment Z can lack a connection with road segment Y.
}}


|s2 = [[roadsConnectedTo]] [roadSegment, extended] {{Since|arma3|1.99.146461|y}} |SYNTAX2=
|s1= [[roadsConnectedTo]] roadSegment


|p21= roadSegment: [[Object]] - road segment |PARAMETER21=
|p1= roadSegment: [[Object]] - road segment


|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=
|r1= [[Array]] of [[Object]]s - connected road segments


|r2= [[Array]] of [[Object]]s - connected road segments|RETURNVALUE2=
|s2= [[roadsConnectedTo]] [roadSegment, extended]


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


|x2= <code>_road = ([[player]] [[nearRoads]] 50) [[select]] 0;
|p21= roadSegment: [[Object]] - road segment
_connectedRoadsIncPedestrian = [[roadsConnectedTo]] [_road, [[true]]];</code> |EXAMPLE2=
____________________________________________________________________________________________


| [[nearRoads]], [[isOnRoad]], [[roadAt]], [[surfaceIsWater]], [[getRoadInfo]], [[nearestTerrainObjects]]  |SEEALSO=
|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
}}


<h3 style='display:none'>Notes</h3>
|r2= [[Array]] of [[Object]]s - connected road segments
<dl class='command_description'>
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x1= <sqf>_road = (player nearRoads 50) select 0;
</dl>
_connectedRoads = roadsConnectedTo _road;</sqf>


<h3 style='display:none'>Bottom Section</h3>
|x2= <sqf>_road = (player nearRoads 50) select 0;
_connectedRoadsIncPedestrian = roadsConnectedTo [_road, true];</sqf>


{{GameCategory|arma3|Scripting Commands}}
|seealso= [[nearRoads]] [[isOnRoad]] [[roadAt]] [[surfaceIsWater]] [[getRoadInfo]] [[nearestTerrainObjects]]
{{GameCategory|tkoh|Scripting Commands}}
}}

Latest revision as of 01:23, 2 February 2024

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
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 the primary syntax will return empty array for those - use the alternative syntax to return pedestrian roads.
  • Road connection is not bidirectional; e.g road segment Y can be connected to road segment Z, but road segment Z can lack a connection with road segment Y.
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
Retrieved from "https://community.bistudio.com/wiki?title=roadsConnectedTo&oldid=352000"