Class FontString
A LayeredRegion that can draw text on the screen.
This class holds a string and a reference to a font, which is used to draw the string on the screen. The appearance of the string can be changed (font, size, color, alignment, wrapping). In addition, it is possible to change the color of a portion of the string, for example to highlight a particular name.
Sizing. The FontString class has a special property when it comes to determining the size of its region on the screen, hence how other object anchor to it, and how it anchors to other objects. See the documentation for Region for more information on anchors. While other Regions must either have a fixed size or more than two anchors constraining their size, the FontString does not. If only one anchor is specified, the width and height of the FontString will be determined by the area occupied by the displayed text, however long and tall this may be. If the width is already constrained by the fixed size or anchors, then the text will word wrap (if allowed) and the FontString's height will be as tall as the height of the wrapped text. Finally, if both the width and height are constrained by fixed sizes or anchors, the text will simply word wrap (if allowed) and be cut to fit in the specified area.
Formatting. If FontString:is_formatting_enabled is true (default),
the string displayed by the FontString class can have special
formatting. This is done by entering the pipe | character, followed by
a command:
|caarrggbbsets the color of the text.aa,rr,gg, andbbmust be two-digit hexadecimal values representing each color component. For example, an opaque red color would be|cffff0000, while a semi-transparent blue would be|c880000ff.|rcancels the change of color from the previous|c[...]command. Color change commands stack up, and can be nested. In the formatted string|cffff0000 hello |cff00ff00 world |r example |r formatting, the wordhellowould be displayed in red,worldin blue,examplein red again, andformattingwould be of whatever color is the default for the FontString object (see FontString:get_text_color).|Tpath/to/texture.png:w:h|tdisplays a texture. The command parameters must be contained within an opening|Tand a closing|t. The parameters are separated by colons:. The first parameter must be the path to the texture file, and it is mandatory. The other two parameters are optional, and define the size of the displayed texture. If omitted, the texture will be displayed as a square matching the size of the current font. If onlywis supplied, the texture will be displayed as a square of sizewpixels. If bothwandhare supplied, they set the width and height of the displayed texture, in pixels.||displays a single|character.
Inherits all methods from: Region, LayeredRegion.
Child classes: none.
Methods
Methods
- fontstring:disable_formatting()
- fontstring:disable_non_space_wrap()
- fontstring:disable_shadow()
- fontstring:disable_word_ellipsis()
- fontstring:disable_word_wrap()
- fontstring:enable_formatting()
- fontstring:enable_non_space_wrap()
- fontstring:enable_shadow()
- fontstring:enable_word_ellipsis()
- fontstring:enable_word_wrap()
- fontstring:get_font()
- fontstring:get_alignment_x()
- fontstring:get_alignment_y()
- fontstring:get_shadow_color()
- fontstring:get_shadow_offset()
- fontstring:get_spacing()
- fontstring:get_line_spacing()
- fontstring:get_text_color()
- fontstring:set_font()
- fontstring:set_alignment_x()
- fontstring:set_alignment_y()
- fontstring:set_shadow_color()
- fontstring:set_shadow_offset()
- fontstring:set_spacing()
- fontstring:set_line_spacing()
- fontstring:set_text_color()
- fontstring:is_non_space_wrap_enabled()
- fontstring:is_word_wrap_enabled()
- fontstring:enable_formatting()
- fontstring:get_string_height()
- fontstring:get_string_width()
- fontstring:get_text()
- fontstring:get_vertex_cache_strategy()
- fontstring:is_formatting_enabled()
- fontstring:set_non_space_wrap_enabled()
- fontstring:set_word_wrap_enabled()
- fontstring:set_word_ellipsis_enabled()
- fontstring:set_text()
- fontstring:set_vertex_cache_strategy()