roadAt: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma3 |Game name=
| arma3
|1.58|Game Version (number surrounded by NO SPACES)=
|1.58
|arg= global|Multiplayer Arguments=
|arg= global


|gr1= Roads and Airports |GROUP1=
|gr1= Roads and Airports


| Returns a road segment containing given position, [[objNull]] otherwise. Same as [[isOnRoad]] only returns the actual road object instead of boolean. |DESCRIPTION=
| Returns a road segment containing given position, [[objNull]] otherwise. Same as [[isOnRoad]] only returns the actual road object instead of boolean.


| '''roadAt''' position |SYNTAX=
| '''roadAt''' position


|p1= position: [[Object]] or  [[Array]] in format [[PositionAGL]] (especially on bridges) or (since Arma 3 v1.99.146460) [[Position2D]], in which case Z will be automatically deduced as the height of the road surface |PARAMETER1=
|p1= position: [[Object]] or  [[Array]] in format [[PositionAGL]] (especially on bridges) or (since Arma 3 v1.99.146460) [[Position2D]], in which case Z will be automatically deduced as the height of the road surface


| [[Object]] - road segment or [[objNull]] |RETURNVALUE=
| [[Object]] - road segment or [[objNull]]


|x1= <code>_road = [[roadAt]] [[ASLToAGL]] [[getPosASL]] [[player]];</code>|EXAMPLE1=
|x1= <code>_road = [[roadAt]] [[ASLToAGL]] [[getPosASL]] [[player]];</code>


|x2= <code>_isOnRoad = ![[isNull]] [[roadAt]] [[player]];</code>|EXAMPLE2=
|x2= <code>_isOnRoad = ![[isNull]] [[roadAt]] [[player]];</code>


|x3= For detecting bridges, for example<code>[[getModelInfo]] ([[roadAt]] [[ASLToAGL]] [[getPosASL]] [[player]]); {{cc|["bridgesea_01_f.p3d","a3\structures_f_exp\infrastructure\bridges\bridgesea_01_f.p3d",true]}}</code>|EXAMPLE3=
|x3= For detecting bridges, for example<code>[[getModelInfo]] ([[roadAt]] [[ASLToAGL]] [[getPosASL]] [[player]]); {{cc|["bridgesea_01_f.p3d","a3\structures_f_exp\infrastructure\bridges\bridgesea_01_f.p3d",true]}}</code>




| [[nearRoads]], [[roadsConnectedTo]], [[isOnRoad]], [[surfaceIsWater]], [[getRoadInfo]], [[nearestTerrainObjects]] |SEEALSO=
| [[nearRoads]], [[roadsConnectedTo]], [[isOnRoad]], [[surfaceIsWater]], [[getRoadInfo]], [[nearestTerrainObjects]]


|  |MPBEHAVIOUR=  
|  |MPBEHAVIOUR=  

Revision as of 02:20, 18 January 2021

Hover & click on the images for description

Description

Description:
Returns a road segment containing given position, objNull otherwise. Same as isOnRoad only returns the actual road object instead of boolean.
Groups:
Roads and Airports

Syntax

Syntax:
roadAt position
Parameters:
position: Object or Array in format PositionAGL (especially on bridges) or (since Arma 3 v1.99.146460) Position2D, in which case Z will be automatically deduced as the height of the road surface
Return Value:
Object - road segment or objNull

Examples

Example 1:
_road = roadAt ASLToAGL getPosASL player;
Example 2:
_isOnRoad = !isNull roadAt player;
Example 3:
For detecting bridges, for examplegetModelInfo (roadAt ASLToAGL getPosASL player); // ["bridgesea_01_f.p3d","a3\structures_f_exp\infrastructure\bridges\bridgesea_01_f.p3d",true]

Additional Information

See also:
nearRoadsroadsConnectedToisOnRoadsurfaceIsWatergetRoadInfonearestTerrainObjects

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

Posted on December 30, 2016 - 21:40 (UTC)
OOKexOo
This command does not nessecarly return the segment which center is the closest to the given position.
In order to get such segment use nearRoads.
_closest_road = (_pos nearRoads 0.1) select 0;