Difference between revisions of "Sprite:getClip"

From GiderosMobile
(Created page with "__NOTOC__ '''Available since:''' in development<br/> === Description === Returns the coordinates of the Sprite clip range if set with setClip <source lang="lua"> (number) (num...")
 
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
'''Available since:''' in development<br/>
+
'''Available since:''' Gideros 2016.10<br/>
 +
'''Class:''' [[Sprite]]<br/>
 +
 
 
=== Description ===
 
=== Description ===
Returns the coordinates of the Sprite clip range if set with setClip
+
Returns the coordinates of the Sprite clip range if set with '''setClip'''.
<source lang="lua">
+
<syntaxhighlight lang="lua">
(number) (number) (number) (number), = Sprite:getClip()
+
(number), (number), (number), (number) = Sprite:getClip()
</source>
+
</syntaxhighlight>
 +
 
 +
=== Return values ===
 
'''Returns''' (number) x-coordinate of clip origin<br/>
 
'''Returns''' (number) x-coordinate of clip origin<br/>
 
'''Returns''' (number) y-coordinate of clip origin<br/>
 
'''Returns''' (number) y-coordinate of clip origin<br/>
 
'''Returns''' (number) width of clip region<br/>
 
'''Returns''' (number) width of clip region<br/>
'''Returns''' (number) Height of clip region<br/>
+
'''Returns''' (number) height of clip region<br/>
 +
 
 +
{{Sprite}}

Latest revision as of 15:33, 13 July 2023

Available since: Gideros 2016.10
Class: Sprite

Description

Returns the coordinates of the Sprite clip range if set with setClip.

(number), (number), (number), (number) = Sprite:getClip()

Return values

Returns (number) x-coordinate of clip origin
Returns (number) y-coordinate of clip origin
Returns (number) width of clip region
Returns (number) height of clip region