Difference between revisions of "Sprite:getHeight"

From GiderosMobile
(mostly formatting :-) and removed language)
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
+
'''Available since:''' Gideros 2011.6<br/>
'''<translate>Class</translate>:''' [[Special:MyLanguage/Sprite|Sprite]]<br/>
+
'''Class:''' [[Sprite]]<br/>
=== <translate>Description</translate> ===
+
 
<translate><br />
+
=== Description ===
Returns the height of the sprite, in pixels. The height is calculated based on the<br />
+
Returns the height of the sprite in pixels. The height is calculated based on the bounds of the content of the sprite.
bounds of the content of the sprite.<br />
 
<br />
 
If "true" is passed to this method, the original height is returned without accounting for transformations.</translate>
 
 
<source lang="lua">
 
<source lang="lua">
 
(number) = Sprite:getHeight(withoutTransform)
 
(number) = Sprite:getHeight(withoutTransform)
 
</source>
 
</source>
=== <translate>Parameters</translate> ===
+
 
'''withoutTransform''': (boolean) <translate>If true, return the height without transformation, else return the transformed height</translate> '''optional'''<br/>
+
 
=== <translate>Return values</translate> ===
+
If '''withoutTransform''' is set to true, the original height is returned without accounting for transformations.
'''<translate>Returns</translate>''' (number) <translate>Height of the sprite.</translate><br/>
+
 
 +
=== Parameters ===
 +
'''withoutTransform''': (boolean) if true, returns the height without transformation, else returns the transformed height '''optional'''<br/>
 +
 
 +
=== Return values ===
 +
'''Returns''' (number) the height of the sprite<br/>
 +
 
 +
{{Sprite}}

Revision as of 23:39, 3 February 2021

Available since: Gideros 2011.6
Class: Sprite

Description

Returns the height of the sprite in pixels. The height is calculated based on the bounds of the content of the sprite.

(number) = Sprite:getHeight(withoutTransform)


If withoutTransform is set to true, the original height is returned without accounting for transformations.

Parameters

withoutTransform: (boolean) if true, returns the height without transformation, else returns the transformed height optional

Return values

Returns (number) the height of the sprite