roadAt: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(corrected the wording of a comment)
m (template:command argument fix)
Line 12: Line 12:
| '''roadAt''' position |= Syntax
| '''roadAt''' 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=  


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


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


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


____________________________________________________________________________________________
____________________________________________________________________________________________


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


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

Revision as of 10:36, 7 April 2019

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

Description

Description:
Returns road segment at given position, objNull otherwise. Same as isOnRoad only returns the actual road object instead of boolean.
Groups:
Uncategorised

Syntax

Syntax:
roadAt position
Parameters:
position: Object or Array in format PositionAGL (especially on bridges)
Return Value:
Object - road segment or objNull

Examples

Example 1:
_road = roadAt ASLToAGL getPosASL player;
Example 2:
_isOnRoad = !isNull roadAt player;

Additional Information

See also:
nearRoadsroadsConnectedToisOnRoadsurfaceIsWater

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 A3 version 1.58]][[ Category: A3: New Scripting Commands | ROADAT]][[ Category: A3: Scripting Commands | ROADAT]]

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;