GetDistanceBetweenPoints2D: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
__NOTOC__
__NOTOC__
==Description==
This function returns the distance between two 2 dimensional points using the pythagorean theorem.
This function returns the distance between two 2 dimensional points using the pythagorean theorem.


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">getDistanceBetweenPoints2D ( x1, y1, x2, y2 )</syntaxhighlight>
<syntaxhighlight lang="lua">getDistanceBetweenPoints2D ( float x1, float y1, float x2, float y2 )</syntaxhighlight>


===Required Arguments===
===Required Arguments===
* '''x1''': The X position of the first point
* '''x1''': The X position of the first point
* '''y1''': The Y position of the first point
* '''y1''': The Y position of the first point
* '''x2''': The X position of the second point
* '''x2''': The X position of the second point
* '''y2''': The Y position of the second point
* '''y2''': The Y position of the second point
===Returns===
Returns a [[float]] containing the 2D distance between the two points. Returns ''false'' if invalid parameters are passed.


==Example==
==Example==
<syntaxhighlight lang="lua">vehiclex, vehicley, vehiclez = getVehiclePosition ( vehicle )
This example gets the distance between two vehicles, stored in variables ''vehicle1'' and ''vehicle2''.
vehicle2x, vehicle2y, vehicle2z = getVehiclePosition ( vehicle2 )
<syntaxhighlight lang="lua">vehicle1x, vehicle1y, vehicle1z = getElementPosition ( vehicle1 )
outputChatBox ( "The map distance between vehicle and vehicl2 is ", getDistanceBetweenPoints2D ( vehiclex, vehicley, vehicle2x, vehicle2y ) )</syntaxhighlight>
vehicle2x, vehicle2y, vehicle2z = getElementPosition ( vehicle2 )
outputChatBox ( "The map distance between vehicle1 and vehicl2 is ", getDistanceBetweenPoints2D ( vehicle1x, vehicle1y, vehicle2x, vehicle2y ) )</syntaxhighlight>


==See Also==
==See Also==
{{Utility functions}}
{{Utility functions}}

Revision as of 14:25, 14 August 2006

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

Syntax

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

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

Example

This example gets the distance between two vehicles, stored in variables vehicle1 and vehicle2. 

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

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetDistanceBetweenPoints2D?oldid=4330"