getRoadInfo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (added see also)
No edit summary
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


|Returns road info in format [maptype, width, ispedestrian, texture, texture end, material] |DESCRIPTION=
|Returns road info in format [mapType, width, isPedestrian, texture, textureEnd, material, begPos, endPos, isBridge]
<br><br>
{{Informative | The bridges are special case. Only large bridges are part of Road Net. Small pedestrian bridges are not recognized as roads. Bridge `mapType` is <tt>"ROAD"</tt> so the best way to detect bridges is to check isBridge boolean. Bridges are not part of new roads and don't have the same info as other new roads, so only `mapType`, `texture` (maybe `textureEnd`), `begPos`, `endPos` and `isBridge` are  updated.}} |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[getRoadInfo]] road |SYNTAX=
| [[getRoadInfo]] road |SYNTAX=


|p1= road: [[object]] |PARAMETER1=
|p1= road: [[Object]] |PARAMETER1=


| [[Array]] |RETURNVALUE=
| [[Array]] in format [mapType, width, isPedestrian, texture, textureEnd, material, begPos, endPos, isBridge], where:
* mapType: [[String]] - road segment type, could be <tt>"ROAD"</tt>, <tt>"MAIN ROAD"</tt>, <tt>"TRACK"</tt>, <tt>"TRAIL"</tt> (see [[nearestTerrainObjects]])
* width: [[Number]] - road segment width
* isPedestrian: [[Boolean]] - when [[true]] road is for pedestrian use only
* texture: [[String]] - road segment surface texture
* textureEnd: [[String]] - road segment surface texture
* material: [[String]] - road segment surface material
* begPos: [[PositionASL]] - start of the road segment
* endPos: [[PositionASL]] - finish of the road segment
* isBridge: [[Boolean]] - when [[true]] road segment is a bridge
|RETURNVALUE=


____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code>[[getRoadInfo]] _road</code>|EXAMPLE1=  
|x1= <code>[[getRoadInfo]] _road</code>|EXAMPLE1=  
|x2= Get direction of the road segment:<code>[[private]] _info = [[getRoadInfo]] _road;
[[private]] _dir = (_info [[select]] 6) [[getDir]] (_info [[select]] 7);</code>|EXAMPLE2=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[nearRoads]] [[roadsConnectedTo]] [[isOnRoad]] [[roadAt]]|SEEALSO=
| [[nearRoads]] [[roadsConnectedTo]] [[isOnRoad]] [[roadAt]] [[nearestTerrainObjects]]|SEEALSO=


}}
}}

Revision as of 20:45, 11 June 2020

-wrong parameter ("arma3dev") defined!-[[:Category:Introduced with arma3dev version 1.99|1.99]]
Hover & click on the images for description

Description

Description:
Returns road info in format [mapType, width, isPedestrian, texture, textureEnd, material, begPos, endPos, isBridge]

The bridges are special case. Only large bridges are part of Road Net. Small pedestrian bridges are not recognized as roads. Bridge `mapType` is "ROAD" so the best way to detect bridges is to check isBridge boolean. Bridges are not part of new roads and don't have the same info as other new roads, so only `mapType`, `texture` (maybe `textureEnd`), `begPos`, `endPos` and `isBridge` are updated.
Groups:
Uncategorised

Syntax

Syntax:
getRoadInfo road
Parameters:
road: Object
Return Value:
Array in format [mapType, width, isPedestrian, texture, textureEnd, material, begPos, endPos, isBridge], where:
  • mapType: String - road segment type, could be "ROAD", "MAIN ROAD", "TRACK", "TRAIL" (see nearestTerrainObjects)
  • width: Number - road segment width
  • isPedestrian: Boolean - when true road is for pedestrian use only
  • texture: String - road segment surface texture
  • textureEnd: String - road segment surface texture
  • material: String - road segment surface material
  • begPos: PositionASL - start of the road segment
  • endPos: PositionASL - finish of the road segment
  • isBridge: Boolean - when true road segment is a bridge

Examples

Example 1:
getRoadInfo _road
Example 2:
Get direction of the road segment:private _info = getRoadInfo _road; private _dir = (_info select 6) getDir (_info select 7);

Additional Information

See also:
nearRoads roadsConnectedTo isOnRoad roadAt 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

[[Category:Introduced with arma3dev version 1.99]][[ Category: arma3dev: New Scripting Commands | GETROADINFO]][[ Category: arma3dev: Scripting Commands | GETROADINFO]]

Notes

Bottom Section