Sprite:getBounds: Difference between revisions

From GiderosMobile
m Text replacement - "<source" to "<syntaxhighlight"
m Text replacement - "</source>" to "</syntaxhighlight>"
Line 7: Line 7:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
(number), (number), (number), (number) = Sprite:getBounds(targetSprite)
(number), (number), (number), (number) = Sprite:getBounds(targetSprite)
</source>
</syntaxhighlight>


=== Parameters ===
=== Parameters ===
Line 22: Line 22:
local x, y, width, height = sprite:getBounds(sprite) -- returns local (untransformed) bounds
local x, y, width, height = sprite:getBounds(sprite) -- returns local (untransformed) bounds
local x, y, width, height = sprite:getBounds(stage) -- returns bounds as transformed to the stage coordinate system
local x, y, width, height = sprite:getBounds(stage) -- returns bounds as transformed to the stage coordinate system
</source>
</syntaxhighlight>


{{Sprite}}
{{Sprite}}

Revision as of 13:33, 13 July 2023

Available since: Gideros 2011.6
Class: Sprite

Description

Returns a rectangle (as x, y, width and height) that encloses the sprite as it appears in another sprite coordinate system.

(number), (number), (number), (number) = Sprite:getBounds(targetSprite)

Parameters

targetSprite: (Sprite) the sprite that defines the other coordinate system to transform

Return values

Returns (number) x coordinate
Returns (number) y coordinate
Returns (number) width of Sprite
Returns (number) height of Sprite

Examples

local x, y, width, height = sprite:getBounds(sprite) -- returns local (untransformed) bounds
local x, y, width, height = sprite:getBounds(stage) -- returns bounds as transformed to the stage coordinate system