Math.distance

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 two points. <syntaxhighlight lang="lua"> (number) = math.distance(x1,y1,z1,x2,y2,z2) (number) = math.distance({x1,y1,z1},{x2,y2,z2}) (number) = math.distance({x=x1,y=y1,z=z1},{x=x2,y=y2,z=z2}) </source>

Note: the number will always be a positive number

Parameters

x1: (number) X component of the first point
y1: (number) Y component of the first point
z1: (number) Z component of the first point optional
x2: (number) X component of the second point
y2: (number) Y component of the second point
z2: (number) Z component of the second point optional

Return values

Returns (number) the distance between the two points (always positive)

Example

<syntaxhighlight lang="lua"> local mydist = 256 function LevelX:onEnterFrame(e) -- player position posx, posy = self.player1.body:getPosition() -- for perfs for k, v in pairs(self.myobjects) do -- k=sprite, v=box2d body local x1, y1 = v:getPosition() if math.distance(x1, y1, posx, posy) > mydist then k:setVisible(false) else k:setVisible(true) end end end </source>