Difference between revisions of "Text:setf"

(Created page)
 
(Added colored text variant)
Line 13: Line 13:
 
=== Returns ===
 
=== Returns ===
 
Nothing.
 
Nothing.
 +
 +
== Function ==
 +
=== Synopsis ===
 +
<source lang="lua">
 +
Text:setf( coloredtext, wraplimit, alignmode )
 +
</source>
 +
=== Arguments ===
 +
{{param|table|coloredtext|A table containing colors and strings to use as the new text, in the form of <code>{color1, string1, color2, string2, ...}</code>.}}
 +
{{subparam|table|color1|A table containing red, green, blue, and optional alpha components to use as a color for the next string in the table, in the form of <code>{red, green, blue, alpha}</code>.}}
 +
{{subparam|string|string1|A string of text which has a color specified by the previous color.}}
 +
{{subparam|table|color2|A table containing red, green, blue, and optional alpha components to use as a color for the next string in the table, in the form of <code>{red, green, blue, alpha}</code>.}}
 +
{{subparam|string|string2|A string of text which has a color specified by the previous color.}}
 +
{{param|number|wraplimit|The maximum width in pixels of the text before it gets automatically wrapped to a new line.}}
 +
{{param|AlignMode|align ("left")|The alignment of the text.}}
 +
=== Returns ===
 +
Nothing.
 +
=== Notes ===
 +
The color set by [[love.graphics.setColor]] will be combined (multiplied) with the colors of the text, when drawing the Text object.
  
 
== See Also ==
 
== See Also ==

Revision as of 08:12, 24 November 2015

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

Replaces the contents of the Text object with a new formatted string.

Function

Synopsis

Text:setf( textstring, wraplimit, alignmode )

Arguments

string textstring
The new string of text to use.
number wraplimit
The maximum width in pixels of the text before it gets automatically wrapped to a new line.
AlignMode align ("left")
The alignment of the text.

Returns

Nothing.

Function

Synopsis

Text:setf( coloredtext, wraplimit, alignmode )

Arguments

table coloredtext
A table containing colors and strings to use as the new text, in the form of {color1, string1, color2, string2, ...}.
table color1
A table containing red, green, blue, and optional alpha components to use as a color for the next string in the table, in the form of {red, green, blue, alpha}.
string string1
A string of text which has a color specified by the previous color.
table color2
A table containing red, green, blue, and optional alpha components to use as a color for the next string in the table, in the form of {red, green, blue, alpha}.
string string2
A string of text which has a color specified by the previous color.
number wraplimit
The maximum width in pixels of the text before it gets automatically wrapped to a new line.
AlignMode align ("left")
The alignment of the text.

Returns

Nothing.

Notes

The color set by love.graphics.setColor will be combined (multiplied) with the colors of the text, when drawing the Text object.

See Also

Other Languages