Difference between revisions of "Math.distances"
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__ | ||
− | + | '''Available since:''' Gideros 2020.9<br/> | |
− | ''' | + | '''Class:''' [[math]]<br/> |
− | ''' | + | |
− | === | + | === Description === |
− | + | Returns the distance betwen a point and each point of a list. | |
− | < | + | <syntaxhighlight lang="lua"> |
− | (table) = math.distances({ | + | (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) | ||
− | </ | + | </syntaxhighlight> |
− | === | + | |
− | '''x''': (number) | + | '''Note''': the distances will always be positive numbers |
− | '''y''': (number) | + | |
− | '''z''': (number) | + | === Parameters === |
− | '''xn''': (number) | + | '''x''': (number) X component of the origin point<br/> |
− | '''yn''': (number) | + | '''y''': (number) Y component of the origin point<br/> |
− | '''zn''': (number) | + | '''z''': (number) Z component of the origin point '''optional'''<br/> |
− | '''sort''': (number) | + | '''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/> | ||
− | === | + | === Return values === |
− | ''' | + | '''Returns''' (number) the distances between the origin and each point (distances are always positive)<br/> |
{{Math}} | {{Math}} |
Latest revision as of 14: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)
- Math
- Math.abs
- Math.acos
- Math.asin
- Math.atan
- Math.atan2
- Math.ceil
- Math.clamp
- Math.cos
- Math.cosh
- Math.cross
- Math.deg
- Math.distance
- Math.distances
- Math.dot
- Math.edge
- Math.exp
- Math.fft
- Math.floor
- Math.fmod
- Math.frexp
- Math.ifft
- Math.inside
- Math.ldexp
- Math.length
- Math.log
- Math.log10
- Math.max
- Math.min
- Math.modf
- Math.nearest
- Math.noise
- Math.normalize
- Math.pow
- Math.rad
- Math.random
- Math.randomseed
- Math.raycast
- Math.round
- Math.sign
- Math.sin
- Math.sinh
- Math.sqrt
- Math.tan
- Math.tanh