Difference between revisions of "Sprite:globalToLocal"

Latest revision as of 14:33, 13 July 2023

Available since: Gideros 2011.6
Class: Sprite

Converts the x,y coordinates from the global to the sprite (local) coordinates.

(number), (number) = Sprite:globalToLocal(x,y)

x: (number) x coordinate of the global coordinate
y: (number) y coordinate of the global coordinate

Returns (number) x coordinate relative to the display object
Returns (number) y coordinate relative to the display object

@@ Line 1: / Line 1: @@
 __NOTOC__
 '''Available since:''' Gideros 2011.6<br/>
+'''Class:''' [[Sprite]]<br/>
 === Description ===
-<br />
+Converts the x,y coordinates from the global to the sprite (local) coordinates.
-Converts the x,y coordinates from the global to the sprite's (local) coordinates.<br />
+<syntaxhighlight lang="lua">
-<br />
+(number), (number) = Sprite:globalToLocal(x,y)
-<br />
+</syntaxhighlight>
-<source lang="lua">
-(number) (number), = Sprite:globalToLocal(xy,)
+=== Parameters ===
-</source>
+'''x''': (number) x coordinate of the global coordinate<br/>
-'''x:''' (number) x coordinate of the global coordinate. ''''''<br/>
+'''y''': (number) y coordinate of the global coordinate<br/>
-'''y:''' (number) y coordinate of the global coordinate. ''''''<br/>
-'''Returns''' (number) 1. x coordinate relative to the display object.<br/>
+=== Return values ===
-'''Returns''' (number) 2. y coordinate relative to the display object.<br/>
+'''Returns''' (number) x coordinate relative to the display object<br/>
+'''Returns''' (number) y coordinate relative to the display object<br/>
+{{Sprite}}