Difference between revisions of "Text:addf"

m
(Added colored text variant)
Line 1: Line 1:
 
{{newin|[[0.10.0]]|100|type=function}}
 
{{newin|[[0.10.0]]|100|type=function}}
Adds additional formatted text to the Text object at the specified position.
+
Adds additional formatted / colored text to the Text object at the specified position.
  
 
== Function ==
 
== Function ==
Line 22: Line 22:
 
=== Returns ===
 
=== Returns ===
 
{{param|number|index|An index number that can be used with [[Text:getWidth]] or [[Text:getHeight]].}}
 
{{param|number|index|An index number that can be used with [[Text:getWidth]] or [[Text:getHeight]].}}
 +
 +
== Function ==
 +
=== Synopsis ===
 +
<source lang="lua">
 +
index = Text:addf( coloredtext, wraplimit, alignmode, x, y, angle, sx, sy, ox, oy, kx, ky )
 +
</source>
 +
=== Arguments ===
 +
{{param|table|coloredtext|A table containing colors and strings to add to the object, 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|The alignment of the text.}}
 +
{{param|number|x|The position of the new text (x-axis).}}
 +
{{param|number|y|The position of the new text (y-axis).}}
 +
{{param|number|angle (0)|Orientation (radians).}}
 +
{{param|number|sx (1)|Scale factor (x-axis).}}
 +
{{param|number|sy (sx)|Scale factor (y-axis).}}
 +
{{param|number|ox (0)|Origin offset (x-axis).}}
 +
{{param|number|oy (0)|Origin offset (y-axis).}}
 +
{{param|number|kx (0)|Shearing / skew factor (x-axis).}}
 +
{{param|number|ky (0)|Shearing / skew factor (y-axis).}}
 +
=== Returns ===
 +
{{param|number|index|An index number that can be used with [[Text:getWidth]] or [[Text:getHeight]].}}
 +
=== 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 ==
Line 30: Line 57:
 
* [[Text:clear]]
 
* [[Text:clear]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=Adds additional formatted text to the Text object at the specified position.}}
+
{{#set:Description=Adds additional formatted / colored text to the Text object at the specified position.}}
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|Text:addf}}
 
{{i18n|Text:addf}}

Revision as of 08:17, 24 November 2015

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

Adds additional formatted / colored text to the Text object at the specified position.

Function

Synopsis

index = Text:addf( textstring, wraplimit, alignmode, x, y, angle, sx, sy, ox, oy, kx, ky )

Arguments

string textstring
The text to add to the object.
number wraplimit
The maximum width in pixels of the text before it gets automatically wrapped to a new line.
AlignMode align
The alignment of the text.
number x
The position of the new text (x-axis).
number y
The position of the new text (y-axis).
number angle (0)
Orientation (radians).
number sx (1)
Scale factor (x-axis).
number sy (sx)
Scale factor (y-axis).
number ox (0)
Origin offset (x-axis).
number oy (0)
Origin offset (y-axis).
number kx (0)
Shearing / skew factor (x-axis).
number ky (0)
Shearing / skew factor (y-axis).

Returns

number index
An index number that can be used with Text:getWidth or Text:getHeight.

Function

Synopsis

index = Text:addf( coloredtext, wraplimit, alignmode, x, y, angle, sx, sy, ox, oy, kx, ky )

Arguments

table coloredtext
A table containing colors and strings to add to the object, 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
The alignment of the text.
number x
The position of the new text (x-axis).
number y
The position of the new text (y-axis).
number angle (0)
Orientation (radians).
number sx (1)
Scale factor (x-axis).
number sy (sx)
Scale factor (y-axis).
number ox (0)
Origin offset (x-axis).
number oy (0)
Origin offset (y-axis).
number kx (0)
Shearing / skew factor (x-axis).
number ky (0)
Shearing / skew factor (y-axis).

Returns

number index
An index number that can be used with Text:getWidth or Text:getHeight.

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