isOnRoad: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Some wiki formatting)
 
(62 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma2 |= Game name
|game1= arma2
|version1= 1.00


|1.00|= Game version
|game2= arma2oa
____________________________________________________________________________________________
|version2= 1.50


| Check whether given position is on road. |= Description
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| '''isOnRoad''' position or object |= Syntax
|game4= arma3
|version4= 0.50


|p1= position or object: [[Object]] or [[Array]] -  |= PARAMETER1
|arg= global


|p2= |= PARAMETER2
|gr1= Roads and Airports


|p3= |= PARAMETER3
|descr= Checks if given position is inside road segment. Same as [[roadAt]], only return is boolean instead of road object.


| [[Boolean]] |= RETURNVALUE
|s1= [[isOnRoad]] position


|p1= position: [[Object]] or [[Array]] in 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


|x1= <code>_ConeRoad <nowiki>=</nowiki> [[isOnRoad]] getPos cone1;</code>|= EXAMPLE1
|r1= [[Boolean]]


____________________________________________________________________________________________
|x1= <sqf>_objOnRoad = isOnRoad player;</sqf>


| |= SEEALSO
|x2= <sqf>_posOnRoad = isOnRoad ASLToAGL getPosASL player;</sqf>


| |= MPBEHAVIOUR
|seealso= [[nearRoads]] [[roadsConnectedTo]] [[roadAt]] [[surfaceIsWater]] [[getRoadInfo]] [[nearestTerrainObjects]]
____________________________________________________________________________________________
}}
}}


<h3 style='display:none'>Notes</h3>
{{Note
<dl class='command_description'>
|user= Tankbuster
<!-- Note Section BEGIN -->
|timestamp= 20171124213100
 
|text= 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.
<!-- Note Section END -->
}}
</dl>
 
<h3 style='display:none'>Bottom Section</h3>
[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 15:30, 17 April 2023

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
GAGlobal
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 Array in format PositionAGL (especially on bridges) or Arma 3 logo black.png2.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 or on the Forums.
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.
Retrieved from "https://community.bistudio.com/wiki?title=isOnRoad&oldid=338905"