Math.distances: Difference between revisions

From GiderosMobile
Created page with "__NOTOC__ <languages /> '''<translate>Available since</translate>:''' Gideros 2020.9<br/> '''<translate>Class</translate>:''' math<br/> === <transl..."
 
m Text replacement - "</source>" to "</syntaxhighlight>"
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
<languages />
'''Available since:''' Gideros 2020.9<br/>
'''<translate>Available since</translate>:''' Gideros 2020.9<br/>
'''Class:''' [[math]]<br/>
'''<translate>Class</translate>:''' [[Special:MyLanguage/math|math]]<br/>
 
=== <translate>Description</translate> ===
=== Description ===
<translate>Returns the distance betwwen a point and each point of a list.</translate>
Returns the distance betwen a point and each point of a list.
<source lang="lua">
<syntaxhighlight lang="lua">
(table) = math.distances({x1,y1,z1},{{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>
</syntaxhighlight>
=== <translate>Parameters</translate> ===
 
'''x''': (number) <translate>X component of the origin point</translate> <br/>
'''Note''': the distances will always be positive numbers
'''y''': (number) <translate>Y component of the origin point</translate> <br/>
 
'''z''': (number) <translate>Z component of the origin point</translate> '''optional''' <br/>
=== Parameters ===
'''xn''': (number) <translate>X component of the n-th point</translate> <br/>
'''x''': (number) X component of the origin point<br/>
'''yn''': (number) <translate>Y component of the n-th point</translate> <br/>
'''y''': (number) Y component of the origin point<br/>
'''zn''': (number) <translate>Z component of the n-th point</translate> '''optional''' <br/>
'''z''': (number) Z component of the origin point '''optional'''<br/>
'''sort''': (number) <translate>Sorting order: positive for ascending, negative for descending, 0 for unsorted</translate> '''optional''' <br/>
'''xn''': (number) X component of the n-th point<br/>
'''yn''': (number) Y component of the n-th point<br/>
'''zn''': (number) Z component of the n-th point '''optional'''<br/>
'''sort''': (number) Sorting order: positive for ascending, negative for descending, 0 for unsorted '''optional'''<br/>


=== <translate>Return values</translate> ===
=== Return values ===
'''<translate>Returns</translate>''' (number) <translate>the distances between the origin and each point</translate><br/>
'''Returns''' (number) the distances between the origin and each point (distances are always positive)<br/>


{{Math}}
{{Math}}

Latest revision as of 13:31, 13 July 2023

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)