DCS func getClosestPointOnRoads: Difference between revisions

Latest revision as of 10:25, 28 January 2023

Envrioment:	Mission Scripting

Function:	getClosestPointOnRoads	Added with: 2.5

Member Of:	land
Syntax:	number, number land.getClosestPointOnRoads(string roadType , number xCoord , number yCoord )
Description:	Returns the X and Y values of a coordinate on the nearest road from the given point. NOTE that this function does not use vec2 or vec3. It uses individual values representing a vec2 for x and y. Valid road type values: 'roads' and 'railroads'

Return Value:	number, number
Return Example:	233324, 423423

Examples:	The following returns the closest road to a point. local testPoint = trigger.misc.getZone('test').point local x, y = land.getClosestPointOnRoads('roads',testPoint.x, testPoint.z)
Related Functions:	land functions: getHeight, getSurfaceHeightWithSeabed, getSurfaceType, isVisible, getIP, profile, getClosestPointOnRoads, findPathOnRoads
Notes:

@@ Line 13: / Line 13: @@
 |par4=
-|desc= Returns a coordinate of the nearest road from the passed point.
+|desc= Returns the X and Y values of a coordinate on the nearest road from the given point.
 NOTE that this function does not use vec2 or vec3. It uses individual values representing a vec2 for x and y.
+Valid road type values: 'roads' and 'railroads'
 |rtnType= number, number
@@ Line 52: / Line 54: @@
 }}
 [[Category:Singleton Functions|getHeight]]
+[[Category:Game Patch 2.5.0|getClosestPointOnRoads]]