getDistanceBetweenPoints2D | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

getDistanceBetweenPoints2D

Client-side
Server-side
Shared

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

This function returns the distance between two 2 dimensional points using the pythagorean theorem.

Note

This function is equivalent to the Vector2 class getLength method when used with a vector that holds the direction and distance between two points. In other words, it produces exactly the same result as substracting the points' coordinates and getting the length of the result vector.

Syntax

float getDistanceBetweenPoints2D ( float x1, float y1, float x2, float y2 )
Required Arguments
  • x1: The X position of the first point
  • y1: The Y position of the first point
  • x2: The X position of the second point
  • y2: The Y position of the second point

Returns

  • float: value

Returns a float containing the 2D distance between the two points. Returns false if invalid parameters are passed.

Code Examples

shared

This example gets the distance between two vehicles, stored in variablesvehicle1andvehicle2.

vehicle1x, vehicle1y, vehicle1z = getElementPosition ( vehicle1 )
vehicle2x, vehicle2y, vehicle2z = getElementPosition ( vehicle2 )
outputChatBox ( "The map distance between vehicle1 and vehicle2 is ", getDistanceBetweenPoints2D ( vehicle1x, vehicle1y, vehicle2x, vehicle2y ) )

See Also

Utility Functions
Reference