Difference between revisions of "Text:getHeight"

(Created page)
 
m (Removed extra spaces.)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
 
{{newin|[[0.10.0]]|100|type=function}}
 
{{newin|[[0.10.0]]|100|type=function}}
Gets the height in pixels of the text.
+
Gets the height of the text in pixels.
  
 
== Function ==
 
== Function ==
Line 10: Line 10:
 
None.
 
None.
 
=== Returns ===
 
=== Returns ===
{{param|number| height |The height of the text. If multiple sub-strings have been added with [[Text:add]], the height of the last sub-string is returned.}}
+
{{param|number|height|The height of the text. If multiple sub-strings have been added with [[Text:add]], the height of the last sub-string is returned.}}
  
 
== Function ==
 
== Function ==
Line 21: Line 21:
 
{{param|number|index|An index number returned by [[Text:add]] or [[Text:addf]].}}
 
{{param|number|index|An index number returned by [[Text:add]] or [[Text:addf]].}}
 
=== Returns ===
 
=== Returns ===
{{param|number|height|The height of the sub-string (before scaling and other transformations.)}}
+
{{param|number|height|The height of the sub-string (before scaling and other transformations).}}
  
 
== See Also ==
 
== See Also ==

Latest revision as of 23:20, 17 April 2020

Available since LÖVE 0.10.0
This function is not supported in earlier versions.

Gets the height of the text in pixels.

Function

Synopsis

height = Text:getHeight( )

Arguments

None.

Returns

number height
The height of the text. If multiple sub-strings have been added with Text:add, the height of the last sub-string is returned.

Function

Gets the height of a specific sub-string that was previously added to the Text object.

Synopsis

height = Text:getHeight( index )

Arguments

number index
An index number returned by Text:add or Text:addf.

Returns

number height
The height of the sub-string (before scaling and other transformations).

See Also

Other Languages