935
edits
Changes
Jump to navigation
Jump to search
Line 1:
Line 1: − #REDIRECT [[drawString]]+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
top default in recent apilevels
'''drawString ''' is a function that is part of [[:Category:gc|gc]] (Graphics Context).
This function is used to display text, numbers etc. on the screen at specified coordinates.
Returns an integer corresponding to the width of the displayed string.
{{Since|3.0}}
== Syntax ==
gc:'''drawString'''(string, x, y [,position])
{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
| <u><center>string</center></u> || string || The text to display
|-
| <u><center>x</center></u> || number || the ''x'' coordinate of the beginning of the string. Relative to ''position''.
|-
| <u><center>y</center></u> || number || the ''y'' coordinate of the beginning of the string. Relative to ''position''.
|-
| <u><center>position</center></u> || string || the string’s anchor point (vertical alignment). It can either be "baseline", “bottom”, “middle”, or “top”. See screenshot below.
|}
The ''position'' argument is optional, and defaults to "bottom" when not specified in apilevels < 2.3. For apilevels >= 2.3, the default is "top".
== Example ==
<syntaxhighlight>function on.paint(gc)
gc:drawString("Hello World", 0, 0, "top")
end</syntaxhighlight>
will display Hello World at the top-left part of the screen.
== Good to know ==
In order to clear up what 'position' does, here's an animated image with the 4 possibilities, showing a text that is drawn at the same 60;60 coordinates, but with different "position" attributes.<br />
[[File:drawString_text_position.gif]]
<br /><br />
[[Category:gc]]
