DrawText (Harvest)
From OxeyeWiki
(Difference between revisions)
(Created page with '{{HarvestMethod | harvest.drawText(string, x, y[, alignment[, r, g, b[, a]]]) | Adds a text line to the render queue. These texts are drawn after the game, but before all other G...') |
|||
Line 1: | Line 1: | ||
{{HarvestMethod | {{HarvestMethod | ||
| | | | ||
- | harvest.drawText( | + | nil harvest.drawText(text, x, y[, alignment[, r, g, b[, a]]]) |
| | | | ||
Adds a text line to the render queue. These texts are drawn after the game, but before all other GUI. The 'alignment' parameter can either be 0 for left-, 1 for center- or 2 for right-aligned. RGBA parameters are given in the range from 0 to 255, and defaults to full opaque white color. | Adds a text line to the render queue. These texts are drawn after the game, but before all other GUI. The 'alignment' parameter can either be 0 for left-, 1 for center- or 2 for right-aligned. RGBA parameters are given in the range from 0 to 255, and defaults to full opaque white color. | ||
| | | | ||
- | {{MethodParam| | + | {{MethodParam|text|String|The text to draw.}} |
- | {{MethodParam|x| | + | {{MethodParam|x|Number|The x coordinate.}} |
- | {{MethodParam|y| | + | {{MethodParam|y|Number|The y coordinate.}} |
- | {{MethodParam|alignment| | + | {{MethodParam|alignment|Number|The alignment of the text, 0 is left-, 1 is center- and 2 is right-aligned.}} |
- | {{MethodParam| | + | {{MethodParam|r|Number|The text color's red component, 0 is min and 255 is max.}} |
- | {{MethodParam| | + | {{MethodParam|g|Number|The text color's green component, 0 is min and 255 is max.}} |
- | {{MethodParam| | + | {{MethodParam|b|Number|The text color's blue component, 0 is min and 255 is max.}} |
- | {{MethodParam| | + | {{MethodParam|a|Number|The text color's alpha component, 0 is min and 255 is max.}} |
| | | | ||
Returns nothing. | Returns nothing. |
Revision as of 21:49, 1 December 2009
nil harvest.drawText(text, x, y[, alignment[, r, g, b[, a]]]) | ||
Adds a text line to the render queue. These texts are drawn after the game, but before all other GUI. The 'alignment' parameter can either be 0 for left-, 1 for center- or 2 for right-aligned. RGBA parameters are given in the range from 0 to 255, and defaults to full opaque white color. | ||
Parameter | Expected Type | Description |
text | String | The text to draw. |
x | Number | The x coordinate. |
y | Number | The y coordinate. |
alignment | Number | The alignment of the text, 0 is left-, 1 is center- and 2 is right-aligned. |
r | Number | The text color's red component, 0 is min and 255 is max. |
g | Number | The text color's green component, 0 is min and 255 is max. |
b | Number | The text color's blue component, 0 is min and 255 is max. |
a | Number | The text color's alpha component, 0 is min and 255 is max. |
Returns | ||
Returns nothing. |
Example
harvest.drawText("Timer is now: " .. timer, 100, 100, 0, 255, 255, 0, 255)