GetDistance3D: Difference between revisions
From Onset Developer Wiki
No edit summary |
m (Client sided script precision in example and math.floor added) |
||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{Info|Function|Server & Client|1.0}} | {{Info|Function|Server & Client|1.0}} | ||
{{FuncDescription| | {{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)}} | ||
{{FuncParameters}} | {{FuncParameters}} | ||
{{FuncParam|x| | {{FuncParam|x|x of the first point.}} | ||
{{FuncParam|y| | {{FuncParam|y|y of the first point.}} | ||
{{FuncParam|z| | {{FuncParam|z|z of the first point.}} | ||
{{FuncParam|x2| | {{FuncParam|x2|x of the second point.}} | ||
{{FuncParam|y2| | {{FuncParam|y2|y of the second point.}} | ||
{{FuncParam|z2| | {{FuncParam|z2|z of the second point.}} | ||
{{FuncReturnValue| | {{FuncReturnValue|The distance between the 2 points in centimeters.}} | ||
== Example == | == Example == | ||
<syntaxhighlight lang="Lua"> | |||
-- Client sided script | |||
local x, y, z = GetPlayerLocation() | |||
local distance = GetDistance3D(x, y, z, 2000, 13245, 1000) | |||
AddPlayerChat("You're " .. math.floor(tonumber(distance) / 100) .. " meters from the position.") | |||
</syntaxhighlight> | |||
{{RelatedFunctions}} | {{RelatedFunctions}} | ||
* [[GetDistanceSquared3D]] | |||
* [[GetDistance2D]] | |||
Latest revision as of 20:04, 11 December 2019
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
-- Client sided script
local x, y, z = GetPlayerLocation()
local distance = GetDistance3D(x, y, z, 2000, 13245, 1000)
AddPlayerChat("You're " .. math.floor(tonumber(distance) / 100) .. " meters from the position.")
