Legacy:Font/getStringHeight: Difference between revisions

Latest revision as of 22:50, 24 June 2013

Get the pixel height of word-wrapped text that would be drawn with Font.drawTextBox().

integer Font.getStringHeight(text, width);

The third example of Font.drawTextBox() contains a useful application of this function.

This function can be used to figure out the right number for the y_offset argument of the Font.drawTextBox() function.

@@ Line 1: / Line 1: @@
 Get the pixel height of word-wrapped text that would be drawn with [[API:Font/drawTextBox|Font.drawTextBox]]().
@@ Line 8: / Line 6: @@
 {{Usage|returns=integer|object=Font|func=getStringHeight|params=text, width}}
-* '''param1''' type. param1 description
+* '''text''' string. The text to calculate the word-wrapped height of
-* '''param2''' type. param2 description
+* '''width''' integer. The pixel width of the box in which word-wrapping occurs
-* '''paramN''' type. paramN description
 ==Examples==
-(examples with syntaxhighlighted code)
+The third example of [[API:Font/drawTextBox|Font.drawTextBox]]() contains a useful application of this function.
 ==Notes==
-(notes)
+*	This function can be used to figure out the right number for the <var>y_offset</var> argument of the [[API:Font/drawTextBox|Font.drawTextBox]]() function.
 ==See also==
-* see also
+*	Sphere [[API:Font|Font]] object
-* see also
+*	[[API:Font/drawText|Font.drawText]]()
-* see also
+*	[[API:Font/drawTextBox|Font.drawTextBox]]()
-* etc
+*	[[API:Font/getHeight|Font.getHeight]]()
+*	[[API:Font/getStringWidth|Font.getStringWidth]]()
 {{API:Font/navbox}}