isOnRoad: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (template:command argument fix)
Line 12: Line 12:
| '''isOnRoad''' position|= Syntax
| '''isOnRoad''' position|= Syntax


|p1= position: [[Object]] or [[Array]] in format [[PositionAGL]] (especially on bridges) |= PARAMETER1
|p1= position: [[Object]] or [[Array]] in format [[PositionAGL]] (especially on bridges) |PARAMETER1=  


| [[Boolean]] |= RETURNVALUE
| [[Boolean]] |RETURNVALUE=  


|x1= <code>_objOnRoad = [[isOnRoad]] [[player]];</code>|= EXAMPLE1
|x1= <code>_objOnRoad = [[isOnRoad]] [[player]];</code>|EXAMPLE1=  


|x2= <code>_posOnRoad = [[isOnRoad]] [[ASLToAGL]] [[getPosASL]] [[player]];</code>|= EXAMPLE2
|x2= <code>_posOnRoad = [[isOnRoad]] [[ASLToAGL]] [[getPosASL]] [[player]];</code>|EXAMPLE2=


__________________________________________________________________________________________
__________________________________________________________________________________________


|[[nearRoads]], [[roadsConnectedTo]], [[roadAt]], [[surfaceIsWater]] |= SEEALSO
|[[nearRoads]], [[roadsConnectedTo]], [[roadAt]], [[surfaceIsWater]] |SEEALSO=  


|  |= MPBEHAVIOUR
|  |MPBEHAVIOUR=  
____________________________________________________________________________________________
____________________________________________________________________________________________
}}
}}

Revision as of 10:34, 7 April 2019

Hover & click on the images for description

Description

Description:
Checks if given position is on road. Same as roadAt, only return is boolean instead of road object.
Groups:
Uncategorised

Syntax

Syntax:
isOnRoad position
Parameters:
position: Object or Array in format PositionAGL (especially on bridges)
Return Value:
Boolean

Examples

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

Additional Information

See also:
nearRoadsroadsConnectedToroadAtsurfaceIsWater

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 November 24, 2017 - 21:31 (UTC)
Tankbuster
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.