isOnRoad: Difference between revisions

From Bohemia Interactive Community
No edit summary
mNo edit summary
 
Line 21: Line 21:
|s1= [[isOnRoad]] position
|s1= [[isOnRoad]] position


|p1= position: [[Object]] or [[Array]] format [[Position#PositionAGL|PositionAGL]] (especially on bridges) or {{GVI|arma3|2.00|size= 0.75}} [[Position#Introduction|Position2D]], in which case Z will be automatically deduced as the height of the road surface
|p1= position: [[Object]] or [[Position#PositionAGL|PositionAGL]] (especially on bridges) or {{GVI|arma3|2.00|size= 0.75}} [[Position#Introduction|Position2D]], in which case Z will be automatically deduced as the height of the road surface


|r1= [[Boolean]]
|r1= [[Boolean]]

Latest revision as of 07:45, 2 January 2026

Hover & click on the images for description

Description

Description:
Checks if given position is inside road segment. Same as roadAt, only return is boolean instead of road object.
Groups:
Roads and Airports

Syntax

Syntax:
isOnRoad position
Parameters:
position: Object or PositionAGL (especially on bridges) or Arma 3 logo black.png 2.00 Position2D, in which case Z will be automatically deduced as the height of the road surface
Return Value:
Boolean

Examples

Example 1:
_objOnRoad = isOnRoad player;
Example 2:
_posOnRoad = isOnRoad ASLToAGL getPosASL player;

Additional Information

See also:
nearRoads roadsConnectedTo roadAt surfaceIsWater getRoadInfo nearestTerrainObjects

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord.
Only post proven facts here! Add Note
Tankbuster - c
Posted on Nov 24, 2017 - 21:31 (UTC)
Some roadobjects will return false when using this command. invisibleroadway_square_f.p3d is found by the nearRoads command, yet will return false for isOnRoad.