roadsConnectedTo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(added see also links)
m (Text replacement - "<sqf>([^↵][^\/]*↵[^\/]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(53 intermediate revisions by 6 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


| Find the road segments connected to the given road segment.  |= Description
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| '''roadsConnectedTo''' road segment |= Syntax
|game4= arma3
|version4= 0.50


|p1= road segment:  -  |= PARAMETER1
|gr1= Roads and Airports


|p2= |= PARAMETER2
|descr= Find the road segments connected to the given road segment.
{{Feature|important|
* 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.
}}
 
|s1= [[roadsConnectedTo]] roadSegment


|p3= |= PARAMETER3
|p1= roadSegment: [[Object]] - road segment


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


|s2= [[roadsConnectedTo]] [roadSegment, extended]


|x1= <code>(example)</code>|= EXAMPLE1
|s2since= arma3 2.00


____________________________________________________________________________________________
|p21= roadSegment: [[Object]] - road segment


| [[roadsConnectedTo_(VBS2)|roadsConnectedTo (VBS2)]], [[nearRoads_(VBS2)| nearRoads (VBS2)]], [[nearRoads]] |= 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


| |= MPBEHAVIOUR
|r2= [[Array]] of [[Object]]s - connected road segments
____________________________________________________________________________________________
}}


<h3 style='display:none'>Notes</h3>
|x1= <sqf>
<dl class='command_description'>
_road = (player nearRoads 50) select 0;
<!-- Note Section BEGIN -->
_connectedRoads = roadsConnectedTo _road;
</sqf>


<!-- Note Section END -->
|x2= <sqf>
</dl>
_road = (player nearRoads 50) select 0;
_connectedRoadsIncPedestrian = roadsConnectedTo [_road, true];
</sqf>


<h3 style='display:none'>Bottom Section</h3>
|seealso= [[nearRoads]] [[isOnRoad]] [[roadAt]] [[surfaceIsWater]] [[getRoadInfo]] [[nearestTerrainObjects]]
[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
}}
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 11:34, 3 September 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=369200"