isOnRoad: Difference between revisions

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


| arma2 |= Game name
|game1= arma2
|1.00|= Game version
|version1= 1.00
|arg= global|Multiplayer Arguments=
____________________________________________________________________________________________


| Checks if given position is on road. Same as [[roadAt]], only return is boolean instead of road object. |DESCRIPTION=
|game2= arma2oa
____________________________________________________________________________________________
|version2= 1.50


| '''isOnRoad''' position|SYNTAX=
|game3= tkoh
|version3= 1.00


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


| [[Boolean]] |RETURNVALUE=  
|arg= global


|x1= <code>_objOnRoad = [[isOnRoad]] [[player]];</code>|EXAMPLE1=  
|gr1= Roads and Airports


|x2= <code>_posOnRoad = [[isOnRoad]] [[ASLToAGL]] [[getPosASL]] [[player]];</code>|EXAMPLE2=
|descr= Checks if given position is inside road segment. Same as [[roadAt]], only return is boolean instead of road object.


__________________________________________________________________________________________
|s1= [[isOnRoad]] position


|[[nearRoads]], [[roadsConnectedTo]], [[roadAt]], [[surfaceIsWater]] |SEEALSO=
|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


| |MPBEHAVIOUR=  
|r1= [[Boolean]]
____________________________________________________________________________________________
}}


<h3 style='display:none'>Notes</h3>
|x1= <sqf>_objOnRoad = isOnRoad player;</sqf>
<dl class='command_description'>
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x2= <sqf>_posOnRoad = isOnRoad ASLToAGL getPosASL player;</sqf>
</dl>


<h3 style='display:none'>Bottom Section</h3>
|seealso= [[nearRoads]] [[roadsConnectedTo]] [[roadAt]] [[surfaceIsWater]] [[getRoadInfo]] [[nearestTerrainObjects]]
[[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}}}}]]


<!-- CONTINUE Notes -->
{{Note
<dl class="command_description">
|user= Tankbuster
<dd class="notedate">Posted on November 24, 2017 - 21:31 (UTC)</dd>
|timestamp= 20171124213100
<dt class="note">[[User:Tankbuster|Tankbuster]]</dt>
|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.
<dd class="note">
}}
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.
</dd>
</dl>
<!-- DISCONTINUE Notes -->

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"