Difference between revisions of "FontBase:getBounds"

From GiderosMobile
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
 
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Available since:''' Gideros 2011.6<br/>
 +
'''Class:''' [[FontBase]]<br/>
 +
 
=== Description ===
 
=== Description ===
<translate><br />
+
Returns the tight bounding rectangle of the characters in the string specified by ''text''.
Returns the tight bounding rectangle of the characters in the string specified by [[Special:MyLanguage/text|text]].<br />
+
 
<br /></translate>
+
<syntaxhighlight lang="lua">
<source lang="lua">
 
 
(number), (number), (number), (number) = FontBase:getBounds(text)
 
(number), (number), (number), (number) = FontBase:getBounds(text)
</source>
+
</syntaxhighlight>
 +
 
 
=== Parameters ===
 
=== Parameters ===
'''text''': (string) <translate></translate> <br/>
+
'''text''': (string) <br/>
 +
 
 
=== Return values ===
 
=== Return values ===
'''Returns''' (number) <translate>x coordinate of the bound</translate><br/>
+
'''Returns''' (number) x coordinate of the bound <br/>
'''Returns''' (number) <translate>y coordinate of the bound</translate><br/>
+
'''Returns''' (number) y coordinate of the bound <br/>
'''Returns''' (number) <translate>width of the bound</translate><br/>
+
'''Returns''' (number) width of the bound <br/>
'''Returns''' (number) <translate>height of the bound</translate><br/>
+
'''Returns''' (number) height of the bound <br/>
 +
 
 +
{{FontBase}}

Latest revision as of 15:29, 13 July 2023

Available since: Gideros 2011.6
Class: FontBase

Description

Returns the tight bounding rectangle of the characters in the string specified by text.

(number), (number), (number), (number) = FontBase:getBounds(text)

Parameters

text: (string)

Return values

Returns (number) x coordinate of the bound
Returns (number) y coordinate of the bound
Returns (number) width of the bound
Returns (number) height of the bound