Difference between revisions of "Math.distances"

From GiderosMobile
(removed language stuff)
(positives)
Line 4: Line 4:
  
 
=== Description ===
 
=== Description ===
Returns the distance betwwen a point and each point of a list.
+
Returns the distance betwen a point and each point of a list.
 
<source lang="lua">
 
<source lang="lua">
 
(table) = math.distances({x,y,z},{{x1,y1,z1},{x2,y2,z2},...},sort)
 
(table) = math.distances({x,y,z},{{x1,y1,z1},{x2,y2,z2},...},sort)
 
(table) = math.distances({x=x,y=y,z=z},{{x=x1,y=y1,z=z1},{x=x2,y=y2,z=z2},...},sort)
 
(table) = math.distances({x=x,y=y,z=z},{{x=x1,y=y1,z=z1},{x=x2,y=y2,z=z2},...},sort)
 
</source>
 
</source>
 +
 +
'''Note''': the distances will always be positive numbers
  
 
=== Parameters ===
 
=== Parameters ===
Line 20: Line 22:
  
 
=== Return values ===
 
=== Return values ===
'''Returns''' (number) the distances between the origin and each point<br/>
+
'''Returns''' (number) the distances between the origin and each point (distances are always positive)<br/>
  
 
{{Math}}
 
{{Math}}

Revision as of 00:42, 28 November 2021

Available since: Gideros 2020.9
Class: math

Description

Returns the distance betwen a point and each point of a list.

(table) = math.distances({x,y,z},{{x1,y1,z1},{x2,y2,z2},...},sort)
(table) = math.distances({x=x,y=y,z=z},{{x=x1,y=y1,z=z1},{x=x2,y=y2,z=z2},...},sort)

Note: the distances will always be positive numbers

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
sort: (number) Sorting order: positive for ascending, negative for descending, 0 for unsorted optional

Return values

Returns (number) the distances between the origin and each point (distances are always positive)