roadsConnectedTo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|seealso= *\[\[([^ ]+)\]\], \[\[([^ ]+)\]\]" to "|seealso= $1 $2")
m (Text replacement - "<sqf>([^↵][^\/]*↵[^\/]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(14 intermediate revisions by the same user not shown)
Line 16: Line 16:


|descr= Find the road segments connected to the given road segment.
|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 basic command will return empty array for those. Use the alternative syntax to return pedestrian roads.}}
{{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
|s1= [[roadsConnectedTo]] roadSegment


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


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


|s2= [[roadsConnectedTo]] [roadSegment, extended]
|s2= [[roadsConnectedTo]] [roadSegment, extended]
Line 28: Line 31:
|s2since= arma3 2.00
|s2since= arma3 2.00


|p21= roadSegment: [[Object]] - Road segment
|p21= 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
|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


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


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


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


|seealso= [[nearRoads]] [[isOnRoad]] [[roadAt]], [[surfaceIsWater]], [[getRoadInfo]], [[nearestTerrainObjects]]
|seealso= [[nearRoads]] [[isOnRoad]] [[roadAt]] [[surfaceIsWater]] [[getRoadInfo]] [[nearestTerrainObjects]]
}}
}}

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"