GetDistance3D: Difference between revisions

From Onset Developer Wiki
No edit summary
(Add example and units specifications)
Line 1: Line 1:
{{Info|Function|Server & Client|1.0}}
{{Info|Function|Server & Client|1.0}}


{{FuncDescription|Gets the distance between to 3 dimensional points.}}
{{FuncDescription|Gets the distance in centimeters between 3 dimensional points.}}


{{FuncSyntax|GetDistance3D(x, y, z, x2, y2, z2)}}
{{FuncSyntax|GetDistance3D(x, y, z, x2, y2, z2)}}
Line 13: Line 13:
{{FuncParam|z2|z of the second point.}}
{{FuncParam|z2|z of the second point.}}


{{FuncReturnValue|The distance between the 2 points.}}
{{FuncReturnValue|The distance between the 2 points in centimeters.}}


== Example ==
== Example ==
<syntaxhighlight lang="Lua">
<syntaxhighlight lang="Lua">
-- code
local x, y, z = GetPlayerLocation()
local distance = GetDistance3D(x, y, z, 2000, 13245, 1000)
 
AddPlayerChat("You're " .. (tonumber(distance) / 100) .. " meters from the position.")
</syntaxhighlight>
</syntaxhighlight>



Revision as of 10:03, 10 December 2019

GetDistance3D

Type: Function
Context: Server & Client
Introduced: v1.0

Description

Gets the distance in centimeters between 3 dimensional points.

Syntax

GetDistance3D(x, y, z, x2, y2, z2)

Parameters

  • x
    x of the first point.
  • y
    y of the first point.
  • z
    z of the first point.
  • x2
    x of the second point.
  • y2
    y of the second point.
  • z2
    z of the second point.

Return Value

  • The distance between the 2 points in centimeters.

Example

local x, y, z = GetPlayerLocation()
local distance = GetDistance3D(x, y, z, 2000, 13245, 1000)

AddPlayerChat("You're " .. (tonumber(distance) / 100) .. " meters from the position.")

See also