RichTextLabel

Inherits: Control < CanvasItem < Node < Object

Category: Core

Brief Description

Label that displays rich text.

Member Functions

void	add_image ( Texture image )
void	add_text ( String text )
int	append_bbcode ( String bbcode )
void	clear ( )
String	get_bbcode ( ) const
float	get_percent_visible ( ) const
int	get_tab_size ( ) const
String	get_text ( )
int	get_total_character_count ( ) const
VScrollBar	get_v_scroll ( )
int	get_visible_characters ( ) const
bool	is_meta_underlined ( ) const
bool	is_scroll_active ( ) const
bool	is_scroll_following ( ) const
bool	is_selection_enabled ( ) const
bool	is_using_bbcode ( ) const
void	newline ( )
int	parse_bbcode ( String bbcode )
void	pop ( )
void	push_align ( int align )
void	push_cell ( )
void	push_color ( Color color )
void	push_font ( Font font )
void	push_indent ( int level )
void	push_list ( int type )
void	push_meta ( Variant data )
void	push_table ( int columns )
void	push_underline ( )
bool	remove_line ( int arg0 )
void	scroll_to_line ( int line )
void	set_bbcode ( String text )
void	set_meta_underline ( bool enable )
void	set_percent_visible ( float percent_visible )
void	set_scroll_active ( bool active )
void	set_scroll_follow ( bool follow )
void	set_selection_enabled ( bool enabled )
void	set_tab_size ( int spaces )
void	set_table_column_expand ( int column, bool expand, int ratio )
void	set_text ( String text )
void	set_use_bbcode ( bool enable )
void	set_visible_characters ( int amount )

Signals

• meta_clicked ( Nil meta )

Numeric Constants

• ALIGN_LEFT = 0
• ALIGN_CENTER = 1
• ALIGN_RIGHT = 2
• ALIGN_FILL = 3
• LIST_NUMBERS = 0
• LIST_LETTERS = 1
• LIST_DOTS = 2
• ITEM_FRAME = 0
• ITEM_TEXT = 1
• ITEM_IMAGE = 2
• ITEM_NEWLINE = 3
• ITEM_FONT = 4
• ITEM_COLOR = 5
• ITEM_UNDERLINE = 6
• ITEM_ALIGN = 7
• ITEM_INDENT = 8
• ITEM_LIST = 9
• ITEM_META = 11

Description

Label that displays rich text. Rich text can contain custom text, fonts, images and some basic formatting. It also adapts itself to given width/heights.

Member Function Description

void add_image ( Texture image )

void add_text ( String text )

int append_bbcode ( String bbcode )

void clear ( )

String get_bbcode ( ) const

float get_percent_visible ( ) const

int get_tab_size ( ) const

String get_text ( )

Returns the raw text, stripping out the formatting information.

int get_total_character_count ( ) const

VScrollBar get_v_scroll ( )

int get_visible_characters ( ) const

bool is_meta_underlined ( ) const

bool is_scroll_active ( ) const

bool is_scroll_following ( ) const

bool is_selection_enabled ( ) const

Return true if selecting the text inside this richtext is allowed.

bool is_using_bbcode ( ) const

void newline ( )

int parse_bbcode ( String bbcode )

void pop ( )

void push_align ( int align )

void push_cell ( )

void push_color ( Color color )

void push_font ( Font font )

void push_indent ( int level )

void push_list ( int type )

void push_meta ( Variant data )

void push_table ( int columns )

void push_underline ( )

bool remove_line ( int arg0 )

void scroll_to_line ( int line )

void set_bbcode ( String text )

void set_meta_underline ( bool enable )

void set_percent_visible ( float percent_visible )

void set_scroll_active ( bool active )

void set_scroll_follow ( bool follow )

void set_selection_enabled ( bool enabled )

Set to true if selecting the text inside this richtext is allowed.

void set_tab_size ( int spaces )

void set_table_column_expand ( int column, bool expand, int ratio )

void set_text ( String text )

void set_use_bbcode ( bool enable )

void set_visible_characters ( int amount )