Math.distances

From GiderosMobile
Revision as of 14:28, 13 July 2023 by Hgy29 (talk | contribs) (Text replacement - "<source" to "<syntaxhighlight")

Available since: Gideros 2020.9
Class: math

Description

Returns the distance betwen a point and each point of a list. <syntaxhighlight lang="lua"> (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) </source>

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)