GetDistanceBetweenPoints3D: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
m (Changed template, added sections)
Line 1: Line 1:
{{Server function}}
{{Server client function}}
__NOTOC__
__NOTOC__
This function returns the distance between two 3D points using the pythagorean theorem.
This function returns the distance between two 3D points using the pythagorean theorem.


==Syntax==
==Syntax==
<section name="Server and client" class="both" show="true">
<syntaxhighlight lang="lua">float getDistanceBetweenPoints3D ( float x1, float y1, float z1, float x2, float y2, float z2 )</syntaxhighlight>
<syntaxhighlight lang="lua">float getDistanceBetweenPoints3D ( float x1, float y1, float z1, float x2, float y2, float z2 )</syntaxhighlight>


Line 15: Line 16:


===Returns===
===Returns===
Returns the distance between the two points as a [[float]]. Returns ''false'' if an argument passed was invalid.
Returns a float containing the distance between the two points as a [[float]]. Returns ''false'' if an argument passed was invalid.
</section>


==Example==
==Example==
<section name="Server and client" class="both" show="true">
This example gets the distance between two vehicles and outputs it to the chat box.
This example gets the distance between two vehicles and outputs it to the chat box.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
Line 23: Line 26:
vehicle2x, vehicle2y, vehicle2z = getElementPosition ( vehicle2 )
vehicle2x, vehicle2y, vehicle2z = getElementPosition ( vehicle2 )
outputChatBox ( "The distance between vehicle1 and vehicle2 is ", getDistanceBetweenPoints3D ( vehicle1x, vehicle1y, vehicle1z, vehicle2x, vehicle2y, vehicle2z ) )</syntaxhighlight>
outputChatBox ( "The distance between vehicle1 and vehicle2 is ", getDistanceBetweenPoints3D ( vehicle1x, vehicle1y, vehicle1z, vehicle2x, vehicle2y, vehicle2z ) )</syntaxhighlight>
</section>


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

Revision as of 15:42, 16 September 2007

This function returns the distance between two 3D points using the pythagorean theorem.

Syntax

Click to collapse [-]
Server and client
float getDistanceBetweenPoints3D ( float x1, float y1, float z1, float x2, float y2, float z2 )

Required Arguments

  • x1: The X position of the first point
  • y1: The Y position of the first point
  • z1: The Z position of the first point
  • x2: The X position of the second point
  • y2: The Y position of the second point
  • z2: The Z position of the second point

Returns

Returns a float containing the distance between the two points as a float. Returns false if an argument passed was invalid.

Example

Click to collapse [-]
Server and client

This example gets the distance between two vehicles and outputs it to the chat box. 

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

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetDistanceBetweenPoints3D?oldid=12031"