Difference between revisions of "Font:getHeight"

 
(6 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
 
Gets the height of the Font.
 
Gets the height of the Font.
 
The height of the font is the size including any spacing; the height which it will need.
 
The height of the font is the size including any spacing; the height which it will need.
Line 5: Line 4:
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
height = Font:getHeight( )
+
height = font:getHeight( text )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
None.
+
{{param|string|text|A string.}}
 
=== Returns ===
 
=== Returns ===
{{param|number|height|The height of the Font.}}
+
{{param|number|height|The height of the text in pixels.}}
 
== See Also ==
 
== See Also ==
 
* [[parent::Font]]
 
* [[parent::Font]]
 +
* [[Font:getWidth]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=Gets the height of the Font.
+
{{#set:Description=Gets the height of the Font in pixels.}}
}}
+
{{#set:Since=000}}
 +
 
 +
== Other Languages ==
 +
{{i18n|Font:getHeight}}

Latest revision as of 13:23, 21 February 2025

Gets the height of the Font. The height of the font is the size including any spacing; the height which it will need.

Function

Synopsis

height = font:getHeight( text )

Arguments

string text
A string.

Returns

number height
The height of the text in pixels.

See Also


Other Languages