Difference between revisions of "Math.nearest"

From GiderosMobile
(removed language stuff)
m (Text replacement - "<source" to "<syntaxhighlight")
Line 5: Line 5:
 
=== Description ===
 
=== Description ===
 
Returns the nearest point from a list.
 
Returns the nearest point from a list.
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
(table),(number) = math.nearest({x,y,z},{{x1,y1,z1},{x2,y2,z2},...})
 
(table),(number) = math.nearest({x,y,z},{{x1,y1,z1},{x2,y2,z2},...})
 
(table),(number) = math.nearest({x=x,y=y,z=z},{{x=x1,y=y1,z=z1},{x=x2,y=y2,z=z2},...})
 
(table),(number) = math.nearest({x=x,y=y,z=z},{{x=x1,y=y1,z=z1},{x=x2,y=y2,z=z2},...})

Revision as of 14:28, 13 July 2023

Available since: Gideros 2020.9
Class: math

Description

Returns the nearest point from a list. <syntaxhighlight lang="lua"> (table),(number) = math.nearest({x,y,z},{{x1,y1,z1},{x2,y2,z2},...}) (table),(number) = math.nearest({x=x,y=y,z=z},{{x=x1,y=y1,z=z1},{x=x2,y=y2,z=z2},...}) </source>

Parameters

x: (number) X component of the origin point
y: (number) Y component of the origin point
z: (number) Z component of the origin point optional
xn: (number) X component of the n-th point
yn: (number) Y component of the n-th point
zn: (number) Z component of the n-th point optional

Return values

Returns (table) the nearest point
Returns (number) the distance to the nearest point