RichTextLabel

Inherits: Control < CanvasItem < Node < Object

类别： 核心

简要说明

显示格式文本的标签。

属性

bool	bbcode_enabled	假
String	bbcode_text	“
bool	meta_underlined	真
bool	override_selected_font_color	假
float	percent_visible	1.0
bool	scroll_active	真
bool	scroll_following	假
bool	selection_enabled	假
int	tab_size	4
String	text	“
int	visible_characters	-1

方法

无效	add_image ( Texture image )
无效	add_text ( String text )
Error	append_bbcode ( String bbcode )
无效	clear ( )
int	get_content_height ( )
int	get_line_count ( ) const
int	get_total_character_count ( ) const
VScrollBar	get_v_scroll ( )
int	get_visible_line_count ( ) const
无效	newline ( )
Error	parse_bbcode ( String bbcode )
无效	pop ( )
无效	push_align ( Align align )
无效	push_cell ( )
无效	push_color ( Color color )
无效	push_font ( Font font )
无效	push_indent ( int level )
无效	push_list ( ListType type )
无效	push_meta ( Variant data )
无效	push_strikethrough ( )
无效	push_table ( int columns )
无效	push_underline ( )
bool	remove_line ( int line )
无效	scroll_to_line ( int line )
无效	set_table_column_expand ( int column, bool expand, int ratio )

主题属性

Font	bold_font
Font	bold_italics_font
Color	default_color	颜色（1，1，1，1）
StyleBox	集中
Color	font_color_selected	颜色（0.49、0.49、0.49、1）
Color	font_color_shadow	颜色（0，0，0，0）
Font	italics_font
int	line_separation	1
Font	mono_font
StyleBox	正常的
Font	normal_font
Color	selection_color	颜色（0.1、0.1、1、0.8）
int	shadow_as_outline	0
int	shadow_offset_x	1
int	shadow_offset_y	1
int	table_hseparation	3
int	table_vseparation	3

信号

• meta_clicked ( Nil meta )

当用户单击之间的内容时触发 [url] 标签。如果meta是以文本形式定义的，例如 [url={{"data"="hi"}}]hi[/url] ，则此信号的参数将是 String 类型。如果需要特定类型或对象，则 push_meta 方法必须用于手动将数据插入标记堆栈。

• meta_hover_ended ( Nil meta )

当鼠标退出元标记时触发。

• meta_hover_started ( Nil meta )

当鼠标进入元标记时触发。

枚举

枚举 排列 ：

• ALIGN_LEFT = 0

• ALIGN_CENTER = 1

• ALIGN_RIGHT = 2

• ALIGN_FILL = 3

枚举 ListType ：

• LIST_NUMBERS = 0

• LIST_LETTERS = 1

• LIST_DOTS = 2

枚举 ItemType ：

• ITEM_FRAME = 0

• ITEM_TEXT = 1

• ITEM_IMAGE = 2

• ITEM_NEWLINE = 3

• ITEM_FONT = 4

• ITEM_COLOR = 5

• ITEM_UNDERLINE = 6

• ITEM_STRIKETHROUGH = 7

• ITEM_ALIGN = 8

• ITEM_INDENT = 9

• ITEM_LIST = 10

• ITEM_TABLE = 11

• ITEM_META = 12

描述

富文本可以包含自定义文本、字体、图像和一些基本格式。标签将它们作为一个内部标记堆栈进行管理。它还可以适应给定的宽度/高度。

注： 作业到 bbcode_text 清除标记堆栈并从属性的内容重新构造它。对所做的任何编辑 bbcode_text 将删除以前从其他手动源（如 append_bbcode 以及 push_* / pop 方法。

教程

• bb RichTextLabel中的代码

属性描述

• bool bbcode_enabled

违约	假
设定器	设置使用代码（值）
吸气剂	使用的是bbcode（））

如果 true ，标签使用bbcode格式。

• String bbcode_text

违约	“
设定器	设置代码（值）
吸气剂	获取bbcode（）

标签的文本为bbcode格式。不代表手动修改内部标签堆栈。删除编辑时其他方法所做的更改。

• bool meta_underlined

违约	真
设定器	设置元下划线（值）
吸气剂	是元下划线（））

如果 true ，该标签为元标记加下划线，例如 [url]{{text}}[/url] .

• bool override_selected_font_color

违约	假
设定器	设置“覆盖”选定的“字体”颜色（值）
吸气剂	是否覆盖所选字体颜色（）。

如果 true ，标签使用自定义字体颜色。

• float percent_visible

违约	1.0
设定器	设置“可见百分比”（值）
吸气剂	获取可见的百分比（）。

文本的可见性，作为 float 介于0.0和1.0之间。

• bool scroll_active

违约	真
设定器	设置滚动激活（值）
吸气剂	“滚动”是否处于活动状态（）

如果 true ，滚动条可见。不会完全阻止滚动。见 scroll_to_line .

• bool scroll_following

违约	假
设定器	设置滚动跟随（值）
吸气剂	在（）后面滚动吗？

如果 true ，窗口向下滚动以自动显示新内容。

• bool selection_enabled

违约	假
设定器	设置选择启用（值）
吸气剂	_selection_enabled（）是否启用？

如果 true ，标签允许文本选择。

• int tab_size

违约	4
设定器	设置制表符大小（值）
吸气剂	获取标签大小（）。

与单个制表符长度关联的空格数。不影响 \t 在文本标记中，仅缩进标记。

• String text

违约	“
设定器	设置文本（值）
吸气剂	获取文本（）

标签的原始文本。

设置后，清除标记堆栈并在其顶部添加一个原始文本标记。不分析bbcodes。不修改 bbcode_text .

• int visible_characters

违约	-1
设定器	设置可见字符（值）
吸气剂	获取u可见的u字符（）

要在标签中显示的限制字符数。如果 -1 ，将显示所有字符。

方法说明

• void add_image ( Texture image )

将图像的开始和结束标记添加到标记堆栈。

• void add_text ( String text )

将原始的非bbcode解析文本添加到标记堆栈。

• Error append_bbcode ( String bbcode )

解析 bbcode 并根据需要将标记添加到标记堆栈中。返回分析结果， @GlobalScope.OK 如果成功。

• void clear ( )

清除标记堆栈和集合 bbcode_text 到空字符串。

• int get_content_height ( )

返回内容的高度。

• int get_line_count ( ) const

返回标记堆栈的文本标记中换行的总数。将换行文本视为一行。

• int get_total_character_count ( ) const

返回文本标记中的字符总数。不包括BBcodes。

• VScrollBar get_v_scroll ( )

返回垂直滚动条。

• int get_visible_line_count ( ) const

返回可见行数。

• void newline ( )

将换行标记添加到标记堆栈。

• Error parse_bbcode ( String bbcode )

的分配版本 append_bbcode . 清除标记堆栈并插入新内容。退换商品 @GlobalScope.OK 如果分析 bbcode 成功。

• void pop ( )

终止当前标记。之后使用 push_* 方法手动关闭bbcodes。不需要跟随 add_* 方法。

• void push_align ( Align align )

添加一个 [align] 基于给定的 align 值。见 Align 对于可能的值。

• void push_cell ( )

添加一个 [cell] 标记到标记堆栈。必须在 [table] 标签。见 push_table 有关详细信息。

• void push_color ( Color color )

添加一个 [color] 标记到标记堆栈。

• void push_font ( Font font )

添加一个 [font] 标记到标记堆栈。覆盖其持续时间的默认字体。

• void push_indent ( int level )

添加一个 [indent] 标记到标记堆栈。将“级别”乘以当前制表符的大小以确定新的页边距长度。

• void push_list ( ListType type )

添加一个 [list] 标记到标记堆栈。类似于BBcodes [ol] 或 [ul] ，但支持更多列表类型。没有完全实现！

• void push_meta ( Variant data )

添加一个 [meta] 标记到标记堆栈。类似于bbcode [url=something]{{text}}[/url] ，但不支持 -String 元数据类型。

• void push_strikethrough ( )

添加一个 [s] 标记到标记堆栈。

• void push_table ( int columns )

添加一个 [table=columns] 标记到标记堆栈。

• void push_underline ( )

添加一个 [u] 标记到标记堆栈。

• bool remove_line ( int line )

从标签中删除一行内容。退换商品 true 如果该行存在。

• void scroll_to_line ( int line )

滚动窗口的顶行以匹配 line .

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

编辑所选列的扩展选项。如果 expand 是 true ，该列的展开率与其他列的展开率成比例。

例如，2列的可用宽度比为3和4加70像素，将分别扩展30和40像素。

如果 expand 是 false ，该列将不占总比率。