FontString
widget type57 methodsavailable in: camelot
CreateFrame("FontString", …) makes one. It has every method of Region, plus 57 of its own.
Inherits from
- FontString · 57
- Region · 16
- ScriptRegion · 55
- ScriptRegionResizing · 13
- AnimatableObject · 3
- Object · 5
- FrameScriptObject · 21
The number is each type's own documented methods. A FontString has all of them.
Methods
In the emulator: 33 implemented, 24 guessed.
| method | what it does | status |
|---|---|---|
CalculateScreenAreaFromCharacterSpan | Returns the screen rectangles a span of the font string's characters covers. · by wowlua(leftIndex: number, rightIndex: number): uiBoundsRect[]? | guessed |
CanNonSpaceWrap | Whether the font string can wrap lines in the middle of a word. · by wowlua(): boolean | guessed |
CanWordWrap | Whether the font string wraps long lines. · by wowlua(): boolean | guessed |
ClearAlphaGradient | Removes the font string's alpha gradient. · by wowlua() | guessed |
ClearText | Sets text to an empty string and removes the Text secret aspect. · warcraft.wiki.gg ↗() | implemented |
FindCharacterIndexAtCoordinate | Returns the index of the character at a point in the font string, and whether the point is on it. · by wowlua(x: number, y: number): (number?, boolean?) | guessed |
GetAlphaGradient | Returns the font string's alpha gradient. · by wowlua(): (number, number) | guessed |
GetFieldSize | Returns the font string's field size. · by wowlua(): number | guessed |
GetFont | Returns the basic font properties. · warcraft.wiki.gg ↗(): (FontAsset?, number, TBFFlags) | implemented |
GetFontHeight | Returns the font string's font height. · by wowlua(calculated: boolean): number | guessed |
GetFontObject | Returns the font string's font object. · by wowlua(): Font | guessed |
GetIndentedWordWrap | Whether wrapped lines in the font string are indented. · by wowlua(): boolean | guessed |
GetJustifyH | Returns the font string's horizontal text alignment. · by wowlua(): JustifyHorizontal | guessed |
GetJustifyV | Returns the font string's vertical text alignment. · by wowlua(): JustifyVertical | guessed |
GetLineHeight | Returns the height of one line of the font string. · by wowlua(): number | implemented |
GetMaxLines | Returns the most lines the font string shows. · by wowlua(): number | guessed |
GetNumLines | Returns the number of lines the font string shows. · by wowlua(): number | implemented |
GetRotation | Returns the font string's rotation in radians. · by wowlua(): number | guessed |
GetScaleAnimationMode | Returns how the font string behaves when a scale animation plays on it. · by wowlua(): FontStringScaleAnimationMode | guessed |
GetShadowColor | Returns the color of the font string's shadow as red, green, blue and alpha. · by wowlua(): (number, number, number, number) | guessed |
GetShadowOffset | Returns the offset of the font string's shadow. · by wowlua(): (number, number) | guessed |
GetSmoothScaling | Returns whether the font string's text height scales smoothly instead of snapping to whole numbers. · by wowlua(): boolean | guessed |
GetSpacing | Returns the spacing between the font string's lines. · by wowlua(): number | guessed |
GetStringHeight | Returns how tall the string would be, in pixels, without wrapping: Height= MyFontString:GetStringHeight(); · warcraft.wiki.gg ↗(): number | implemented |
GetStringWidth | FontString provides three methods to determine the width of its text independently from the value returned by Region:GetWidth: *GetStringWidth() ignores FontString:CanWordWrap but includes FontString:IsTruncated *GetUnboundedStringWidth() ignores word wrap and truncation *GetWrappedWidth() includes word wrap and truncation · warcraft.wiki.gg ↗(): number | implemented |
GetText | Returns the text from a FontString widget. · warcraft.wiki.gg ↗(): string | implemented |
GetTextColor | Returns the font string's text color as red, green, blue and alpha. · by wowlua(): (number?, number?, number?, number?) | guessed |
GetTextScale | Returns the font string's text scale. · by wowlua(): number | implemented |
GetUnboundedStringWidth | Returns the width the font string's text needs on one line, without wrapping. · by wowlua(): number | implemented |
GetUnboundedStringWidthForText | Returns the width some text would need on one line in the font string, without setting it. · by wowlua(text: string): number | guessed |
GetWrappedWidth | Returns the width of the font string's text after it is wrapped. · by wowlua(): number | guessed |
IsTruncated | Whether the font string's text is cut off. · by wowlua(): boolean | implemented |
OnColorsUpdated | Updates the font string after its colors changed. · by wowlua() | guessed |
SetAlphaGradient | Creates or removes an alpha gradient over the text in the FontString fading from 100% opaque to 100% transparent. · warcraft.wiki.gg ↗(start: number, length: number): boolean | guessed |
SetDesaturateEmbeddedTextures | Sets whether textures embedded in the font string's text are drawn without color. · by wowlua(desaturate: boolean) | implemented |
SetFixedColor | Sets whether the font string's color stays fixed. · by wowlua(fixedColor: boolean) | implemented |
SetFont | Sets the basic font properties. · warcraft.wiki.gg ↗(fontFile: FontAsset, fontHeight: uiFontHeight, flags: TBFFlags?): boolean | implemented |
SetFontHeight | Sets the font string's font height. · by wowlua(height: number) | implemented |
SetFontObject | Sets the font string's font object. · by wowlua(font: Font) | implemented |
SetFormattedText | Sets the text with format specifiers. · warcraft.wiki.gg ↗(text: string) | implemented |
SetIndentedWordWrap | Sets whether wrapped lines in the font string are indented. · by wowlua(wrap: boolean) | implemented |
SetJustifyH | Sets the font string's horizontal text alignment. · by wowlua(justifyH: JustifyHorizontal) | implemented |
SetJustifyV | Sets the font string's vertical text alignment. · by wowlua(justifyV: JustifyVertical) | implemented |
SetMaxLines | Sets the most lines the font string shows. · by wowlua(maxLines: number) | implemented |
SetNonSpaceWrap | Set whether long strings without spaces are wrapped or truncated. · warcraft.wiki.gg ↗(wrap: boolean) | implemented |
SetRotation | Sets the font string's rotation. · by wowlua(radians: number) | implemented |
SetScaleAnimationMode | Sets how the font string behaves when a scale animation plays on it. · by wowlua(scaleAnimationMode: FontStringScaleAnimationMode) | implemented |
SetShadowColor | Sets the color of the font string's shadow. · by wowlua(colorR: number, colorG: number, colorB: number, a: number?) | implemented |
SetShadowOffset | Sets the offset of the font string's shadow. · by wowlua(offsetX: number, offsetY: number) | implemented |
SetSmoothScaling | Sets whether the font string's text height scales smoothly instead of snapping to whole numbers when the font string is scaled. · by wowlua(smoothScaling: boolean) | implemented |
SetSpacing | Sets the spacing between the font string's lines. · by wowlua(spacing: number) | implemented |
SetText | Sets the text to be displayed in the FontString. · warcraft.wiki.gg ↗(text: string) | implemented |
SetTextColor | Sets the text color. · warcraft.wiki.gg ↗(colorR: number, colorG: number, colorB: number, a: number?) | implemented |
SetTextHeight | Sets the height of the font string's text by scaling it. · by wowlua(height: number) | implemented |
SetTextScale | Sets the font string's text scale. · by wowlua(textScale: number) | implemented |
SetTextToFit | Changes the text displayed by a fontstring and enables auto-calculation of width based upon the content. · warcraft.wiki.gg ↗(text: string) | implemented |
SetWordWrap | Sets whether the font string wraps long lines. · by wowlua(wrap: boolean) | implemented |
sources
Methods and inheritance: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (camelot 1.60.1). Descriptions: warcraft.wiki.gg's API pages, by its contributors, CC BY-SA 4.0 ↗; written by wowlua where no documentation describes the entry.