RichTextLabel

Inherits: Control < CanvasItem < Node < Object

There is currently no description for this class. Please help us by contributing one!

Properties

AutowrapMode	autowrap_mode	`3`
bool	bbcode_enabled	`false`
bool	clip_contents	`true` (overrides Control)
bool	context_menu_enabled	`false`
Array	custom_effects	`[]`
bool	deselect_on_focus_loss_enabled	`true`
bool	drag_and_drop_selection_enabled	`true`
bool	fit_content	`false`
bool	hint_underlined	`true`
String	language	`""`
bool	meta_underlined	`true`
int	progress_bar_delay	`1000`
bool	scroll_active	`true`
bool	scroll_following	`false`
bool	selection_enabled	`false`
bool	shortcut_keys_enabled	`true`
StructuredTextParser	structured_text_bidi_override	`0`
Array	structured_text_bidi_override_options	`[]`
int	tab_size	`4`
String	text	`""`
TextDirection	text_direction	`0`
bool	threaded	`false`
int	visible_characters	`-1`
VisibleCharactersBehavior	visible_characters_behavior	`0`
float	visible_ratio	`1.0`

Methods

void	add_image ( Texture2D image, int width=0, int height=0, Color color=Color(1, 1, 1, 1), InlineAlignment inline_align=5, Rect2 region=Rect2(0, 0, 0, 0), Variant key=null, bool pad=false, String tooltip=””, bool size_in_percent=false )
void	add_text ( String text )
void	append_text ( String bbcode )
void	clear ( )
void	deselect ( )
int	get_character_line ( int character )
int	get_character_paragraph ( int character )
int	get_content_height ( ) const
int	get_content_width ( ) const
int	get_line_count ( ) const
float	get_line_offset ( int line )
PopupMenu	get_menu ( ) const
int	get_paragraph_count ( ) const
float	get_paragraph_offset ( int paragraph )
String	get_parsed_text ( ) const
String	get_selected_text ( ) const
int	get_selection_from ( ) const
int	get_selection_to ( ) const
int	get_total_character_count ( ) const
VScrollBar	get_v_scroll_bar ( )
int	get_visible_line_count ( ) const
int	get_visible_paragraph_count ( ) const
void	install_effect ( Variant effect )
bool	invalidate_paragraph ( int paragraph )
bool	is_menu_visible ( ) const
bool	is_ready ( ) const
void	menu_option ( int option )
void	newline ( )
void	parse_bbcode ( String bbcode )
Dictionary	parse_expressions_for_values ( PackedStringArray expressions )
void	pop ( )
void	pop_all ( )
void	pop_context ( )
void	push_bgcolor ( Color bgcolor )
void	push_bold ( )
void	push_bold_italics ( )
void	push_cell ( )
void	push_color ( Color color )
void	push_context ( )
void	push_customfx ( RichTextEffect effect, Dictionary env )
void	push_dropcap ( String string, Font font, int size, Rect2 dropcap_margins=Rect2(0, 0, 0, 0), Color color=Color(1, 1, 1, 1), int outline_size=0, Color outline_color=Color(0, 0, 0, 0) )
void	push_fgcolor ( Color fgcolor )
void	push_font ( Font font, int font_size=0 )
void	push_font_size ( int font_size )
void	push_hint ( String description )
void	push_indent ( int level )
void	push_italics ( )
void	push_language ( String language )
void	push_list ( int level, ListType type, bool capitalize, String bullet=”•” )
void	push_meta ( Variant data, MetaUnderline underline_mode=1 )
void	push_mono ( )
void	push_normal ( )
void	push_outline_color ( Color color )
void	push_outline_size ( int outline_size )
void	push_paragraph ( HorizontalAlignment alignment, TextDirection base_direction=0, String language=””, StructuredTextParser st_parser=0, BitField<JustificationFlag> justification_flags=163, PackedFloat32Array tab_stops=PackedFloat32Array() )
void	push_strikethrough ( )
void	push_table ( int columns, InlineAlignment inline_align=0, int align_to_row=-1 )
void	push_underline ( )
bool	remove_paragraph ( int paragraph, bool no_invalidate=false )
void	scroll_to_line ( int line )
void	scroll_to_paragraph ( int paragraph )
void	scroll_to_selection ( )
void	select_all ( )
void	set_cell_border_color ( Color color )
void	set_cell_padding ( Rect2 padding )
void	set_cell_row_background_color ( Color odd_row_bg, Color even_row_bg )
void	set_cell_size_override ( Vector2 min_size, Vector2 max_size )
void	set_table_column_expand ( int column, bool expand, int ratio=1 )
void	update_image ( Variant key, BitField<ImageUpdateMask> mask, Texture2D image, int width=0, int height=0, Color color=Color(1, 1, 1, 1), InlineAlignment inline_align=5, Rect2 region=Rect2(0, 0, 0, 0), bool pad=false, String tooltip=””, bool size_in_percent=false )

Theme Properties

Color	default_color	`Color(1, 1, 1, 1)`
Color	font_outline_color	`Color(0, 0, 0, 1)`
Color	font_selected_color	`Color(0, 0, 0, 0)`
Color	font_shadow_color	`Color(0, 0, 0, 0)`
Color	selection_color	`Color(0.1, 0.1, 1, 0.8)`
Color	table_border	`Color(0, 0, 0, 0)`
Color	table_even_row_bg	`Color(0, 0, 0, 0)`
Color	table_odd_row_bg	`Color(0, 0, 0, 0)`
int	line_separation	`0`
int	outline_size	`0`
int	shadow_offset_x	`1`
int	shadow_offset_y	`1`
int	shadow_outline_size	`1`
int	table_h_separation	`3`
int	table_v_separation	`3`
int	text_highlight_h_padding	`3`
int	text_highlight_v_padding	`3`
Font	bold_font
Font	bold_italics_font
Font	italics_font
Font	mono_font
Font	normal_font
int	bold_font_size
int	bold_italics_font_size
int	italics_font_size
int	mono_font_size
int	normal_font_size
StyleBox	focus
StyleBox	normal

Signals

finished ( )

There is currently no description for this signal. Please help us by contributing one!

meta_clicked ( Variant meta )

There is currently no description for this signal. Please help us by contributing one!

meta_hover_ended ( Variant meta )

There is currently no description for this signal. Please help us by contributing one!

meta_hover_started ( Variant meta )

There is currently no description for this signal. Please help us by contributing one!

Enumerations

enum ListType:

ListType LIST_NUMBERS = 0

There is currently no description for this enum. Please help us by contributing one!

ListType LIST_LETTERS = 1

There is currently no description for this enum. Please help us by contributing one!

ListType LIST_ROMAN = 2

There is currently no description for this enum. Please help us by contributing one!

ListType LIST_DOTS = 3

There is currently no description for this enum. Please help us by contributing one!

enum MenuItems:

MenuItems MENU_COPY = 0

There is currently no description for this enum. Please help us by contributing one!

MenuItems MENU_SELECT_ALL = 1

There is currently no description for this enum. Please help us by contributing one!

MenuItems MENU_MAX = 2

There is currently no description for this enum. Please help us by contributing one!

enum MetaUnderline:

MetaUnderline META_UNDERLINE_NEVER = 0

There is currently no description for this enum. Please help us by contributing one!

MetaUnderline META_UNDERLINE_ALWAYS = 1

There is currently no description for this enum. Please help us by contributing one!

MetaUnderline META_UNDERLINE_ON_HOVER = 2

There is currently no description for this enum. Please help us by contributing one!

flags ImageUpdateMask:

ImageUpdateMask UPDATE_TEXTURE = 1

There is currently no description for this enum. Please help us by contributing one!

ImageUpdateMask UPDATE_SIZE = 2

There is currently no description for this enum. Please help us by contributing one!

ImageUpdateMask UPDATE_COLOR = 4

There is currently no description for this enum. Please help us by contributing one!

ImageUpdateMask UPDATE_ALIGNMENT = 8

There is currently no description for this enum. Please help us by contributing one!

ImageUpdateMask UPDATE_REGION = 16

There is currently no description for this enum. Please help us by contributing one!

ImageUpdateMask UPDATE_PAD = 32

There is currently no description for this enum. Please help us by contributing one!

ImageUpdateMask UPDATE_TOOLTIP = 64

There is currently no description for this enum. Please help us by contributing one!

ImageUpdateMask UPDATE_WIDTH_IN_PERCENT = 128

There is currently no description for this enum. Please help us by contributing one!

Property Descriptions

AutowrapMode autowrap_mode = 3

void set_autowrap_mode ( AutowrapMode value )
AutowrapMode get_autowrap_mode ( )

There is currently no description for this property. Please help us by contributing one!

bool bbcode_enabled = false

void set_use_bbcode ( bool value )
bool is_using_bbcode ( )

There is currently no description for this property. Please help us by contributing one!

bool context_menu_enabled = false

void set_context_menu_enabled ( bool value )
bool is_context_menu_enabled ( )

There is currently no description for this property. Please help us by contributing one!

Array custom_effects = []

void set_effects ( Array value )
Array get_effects ( )

There is currently no description for this property. Please help us by contributing one!

bool deselect_on_focus_loss_enabled = true

void set_deselect_on_focus_loss_enabled ( bool value )
bool is_deselect_on_focus_loss_enabled ( )

There is currently no description for this property. Please help us by contributing one!

bool drag_and_drop_selection_enabled = true

void set_drag_and_drop_selection_enabled ( bool value )
bool is_drag_and_drop_selection_enabled ( )

There is currently no description for this property. Please help us by contributing one!

bool fit_content = false

void set_fit_content ( bool value )
bool is_fit_content_enabled ( )

There is currently no description for this property. Please help us by contributing one!

bool hint_underlined = true

void set_hint_underline ( bool value )
bool is_hint_underlined ( )

There is currently no description for this property. Please help us by contributing one!

String language = ""

void set_language ( String value )
String get_language ( )

There is currently no description for this property. Please help us by contributing one!

bool meta_underlined = true

void set_meta_underline ( bool value )
bool is_meta_underlined ( )

There is currently no description for this property. Please help us by contributing one!

int progress_bar_delay = 1000

void set_progress_bar_delay ( int value )
int get_progress_bar_delay ( )

There is currently no description for this property. Please help us by contributing one!

bool scroll_active = true

void set_scroll_active ( bool value )
bool is_scroll_active ( )

There is currently no description for this property. Please help us by contributing one!

bool scroll_following = false

void set_scroll_follow ( bool value )
bool is_scroll_following ( )

There is currently no description for this property. Please help us by contributing one!

bool selection_enabled = false

void set_selection_enabled ( bool value )
bool is_selection_enabled ( )

There is currently no description for this property. Please help us by contributing one!

bool shortcut_keys_enabled = true

void set_shortcut_keys_enabled ( bool value )
bool is_shortcut_keys_enabled ( )

There is currently no description for this property. Please help us by contributing one!

StructuredTextParser structured_text_bidi_override = 0

void set_structured_text_bidi_override ( StructuredTextParser value )
StructuredTextParser get_structured_text_bidi_override ( )

There is currently no description for this property. Please help us by contributing one!

Array structured_text_bidi_override_options = []

void set_structured_text_bidi_override_options ( Array value )
Array get_structured_text_bidi_override_options ( )

There is currently no description for this property. Please help us by contributing one!

int tab_size = 4

void set_tab_size ( int value )
int get_tab_size ( )

There is currently no description for this property. Please help us by contributing one!

String text = ""

void set_text ( String value )
String get_text ( )

There is currently no description for this property. Please help us by contributing one!

TextDirection text_direction = 0

void set_text_direction ( TextDirection value )
TextDirection get_text_direction ( )

There is currently no description for this property. Please help us by contributing one!

bool threaded = false

void set_threaded ( bool value )
bool is_threaded ( )

There is currently no description for this property. Please help us by contributing one!

int visible_characters = -1

void set_visible_characters ( int value )
int get_visible_characters ( )

There is currently no description for this property. Please help us by contributing one!

VisibleCharactersBehavior visible_characters_behavior = 0

void set_visible_characters_behavior ( VisibleCharactersBehavior value )
VisibleCharactersBehavior get_visible_characters_behavior ( )

There is currently no description for this property. Please help us by contributing one!

float visible_ratio = 1.0

void set_visible_ratio ( float value )
float get_visible_ratio ( )

There is currently no description for this property. Please help us by contributing one!

Method Descriptions

void add_image ( Texture2D image, int width=0, int height=0, Color color=Color(1, 1, 1, 1), InlineAlignment inline_align=5, Rect2 region=Rect2(0, 0, 0, 0), Variant key=null, bool pad=false, String tooltip=””, bool size_in_percent=false )