- _guiInput
void _guiInput(InputEvent arg0)
- _scrollChanged
void _scrollChanged(double arg0)
- addImage
void addImage(Texture image)
Adds an image's opening and closing tags to the tag stack.
- addText
void addText(StringArg0 text)
Adds raw non-bbcode-parsed text to the tag stack.
- appendBbcode
GodotError appendBbcode(StringArg0 bbcode)
Parses bbcode and adds tags to the tag stack as needed. Returns the result of the parsing, OK if successful.
- clear
void clear()
Clears the tag stack and sets bbcodeText to an empty string.
- getBbcode
String getBbcode()
- getContentHeight
long getContentHeight()
Returns the height of the content.
- getLineCount
long getLineCount()
Returns the total number of newlines in the tag stack's text tags. Considers wrapped text as one line.
- getPercentVisible
double getPercentVisible()
- getTabSize
long getTabSize()
- getText
String getText()
- getTotalCharacterCount
long getTotalCharacterCount()
Returns the total number of characters from text tags. Does not include bbcodes.
- getVScroll
VScrollBar getVScroll()
Returns the vertical scrollbar.
- getVisibleCharacters
long getVisibleCharacters()
- getVisibleLineCount
long getVisibleLineCount()
Returns the number of visible lines.
- isMetaUnderlined
bool isMetaUnderlined()
- isOverridingSelectedFontColor
bool isOverridingSelectedFontColor()
- isScrollActive
bool isScrollActive()
- isScrollFollowing
bool isScrollFollowing()
- isSelectionEnabled
bool isSelectionEnabled()
- isUsingBbcode
bool isUsingBbcode()
- newline
void newline()
Adds a newline tag to the tag stack.
- opAssign
RichTextLabel opAssign(T n)
Undocumented in source. Be warned that the author may not have intended to support it.
- opEquals
bool opEquals(RichTextLabel other)
Undocumented in source. Be warned that the author may not have intended to support it.
- opEquals
bool opEquals(typeof(null) n)
Undocumented in source. Be warned that the author may not have intended to support it.
- parseBbcode
GodotError parseBbcode(StringArg0 bbcode)
The assignment version of appendBbcode. Clears the tag stack and inserts the new content. Returns OK if parses bbcode successfully.
- pop
void pop()
Terminates the current tag. Use after push_* methods to close bbcodes manually. Does not need to follow add_* methods.
- pushAlign
void pushAlign(long _align)
Adds an alignment tag based on the given align value. See _align for possible values.
- pushCell
void pushCell()
Adds a $(D cell) tag to the tag stack. Must be inside a table tag. See pushTable for details.
- pushColor
void pushColor(Color color)
Adds a $(D color) tag to the tag stack.
- pushFont
void pushFont(Font font)
Adds a $(D font) tag to the tag stack. Overrides default fonts for its duration.
- pushIndent
void pushIndent(long level)
Adds an $(D indent) tag to the tag stack. Multiplies "level" by current tab_size to determine new margin length.
- pushList
void pushList(long type)
Adds a list tag to the tag stack. Similar to the bbcodes $(D ol) or $(D ul), but supports more list types. Not fully implemented!
- pushMeta
void pushMeta(VariantArg0 data)
Adds a meta tag to the tag stack. Similar to the bbcode $(D url=something){text}$(D /url), but supports non-String metadata types.
- pushStrikethrough
void pushStrikethrough()
Adds a $(D s) tag to the tag stack.
- pushTable
void pushTable(long columns)
Adds a $(D table=columns) tag to the tag stack.
- pushUnderline
void pushUnderline()
Adds a $(D u) tag to the tag stack.
- removeLine
bool removeLine(long line)
Removes a line of content from the label. Returns true if the line exists.
- scrollToLine
void scrollToLine(long line)
Scrolls the window's top line to match line.
- setBbcode
void setBbcode(StringArg0 text)
- setMetaUnderline
void setMetaUnderline(bool enable)
- setOverrideSelectedFontColor
void setOverrideSelectedFontColor(bool _override)
- setPercentVisible
void setPercentVisible(double percent_visible)
- setScrollActive
void setScrollActive(bool active)
- setScrollFollow
void setScrollFollow(bool follow)
- setSelectionEnabled
void setSelectionEnabled(bool enabled)
- setTabSize
void setTabSize(long spaces)
- setTableColumnExpand
void setTableColumnExpand(long column, bool expand, long ratio)
Edits the selected columns expansion options. If expand is true, the column expands in proportion to its expansion ratio versus the other columns' ratios.
For example, 2 columns with ratios 3 and 4 plus 70 pixels in available width would expand 30 and 40 pixels, respectively.
Columns with a false expand will not contribute to the total ratio.
- setText
void setText(StringArg0 text)
- setUseBbcode
void setUseBbcode(bool enable)
- setVisibleCharacters
void setVisibleCharacters(long amount)
- bbcodeEnabled
bool bbcodeEnabled [@property getter]
bool bbcodeEnabled [@property setter]
If true the label uses BBCode formatting. Default value: false.
- bbcodeText
String bbcodeText [@property getter]
String bbcodeText [@property setter]
The label's text in BBCode format. Is not representative of manual modifications to the internal tag stack. Erases changes made by other methods when edited.
- metaUnderlined
bool metaUnderlined [@property getter]
bool metaUnderlined [@property setter]
If true, the label underlines meta tags such as url{text}/url. Default value: true.
- overrideSelectedFontColor
bool overrideSelectedFontColor [@property setter]
If true the label uses the custom font color. Default value: false.
- overrideSelectedFontColor
bool overrideSelectedFontColor [@property getter]
If true the label uses the custom font color. Default value: false.
- percentVisible
double percentVisible [@property getter]
double percentVisible [@property setter]
The text's visibility, as a double between 0.0 and 1.0.
- scrollActive
bool scrollActive [@property getter]
bool scrollActive [@property setter]
If true, the scrollbar is visible. Does not block scrolling completely. See scrollToLine. Default value: true.
- scrollFollowing
bool scrollFollowing [@property getter]
bool scrollFollowing [@property setter]
If true, the window scrolls down to display new content automatically. Default value: false.
- selectionEnabled
bool selectionEnabled [@property getter]
bool selectionEnabled [@property setter]
If true, the label allows text selection.
- tabSize
long tabSize [@property getter]
long tabSize [@property setter]
The number of spaces associated with a single tab length. Does not affect "\t" in text tags, only indent tags.
- text
String text [@property getter]
String text [@property setter]
The raw text of the label.
When set, clears the tag stack and adds a raw text tag to the top of it. Does not parse bbcodes. Does not modify bbcodeText.
- visibleCharacters
long visibleCharacters [@property getter]
long visibleCharacters [@property setter]
The restricted number of characters to display in the label.
Label that displays rich text.
Rich text can contain custom text, fonts, images and some basic formatting. The label manages these as an internal tag stack. It also adapts itself to given width/heights. Note that assignments to bbcodeText clear the tag stack and reconstruct it from the property's contents. Any edits made to bbcodeText will erase previous edits made from other manual sources such as appendBbcode and the push_* / pop methods.