Skip to content

EUIRichTextLabel

概览

字段
KindUnit · 单位 Unit
Realmcommon

继承关系

  • Unit(4 属性 / 25 函数 / 6 事件)
    • EUINodeBase(34 属性 / 8 函数 / 4 事件)
      • [EUIRichTextLabel](30 属性)

继承成员

2 个来源 / 38 属性 / 33 函数 / 10 事件

EUIRichTextLabel 是富文本标签控件,用于在界面中展示带样式的文本内容。它支持设置字体、颜色、描边、阴影、斜体等外观属性,并提供自动缩小字号、换行限制、溢出滚动等高级排版功能。

适用场景

当需要在玩家界面上显示一段可配置样式的文本时,例如聊天消息、提示信息或动态内容展示,可使用 EUIRichTextLabel 创建富文本标签。

使用要点

通过 World:CreateUnit 创建实例,并将 Parent 设置为当前玩家 PlayerGui.EuiManager:GetRootNode()。然后直接读写 Text、TextColor、FontSize 等属性来配置文本样式,或设置 WrapWidth、AutoSizeEnabled 等属性控制排版行为。

注意事项

EUIRichTextLabel 是富文本标签控件,通过 World:CreateUnit 创建,并把 Parent 设置为当前玩家 PlayerGui.EuiManager:GetRootNode()(不能自行直接构造,也不能通过 GetService 获取 EUIManager)。Color 类型必须用 0-255 RGBA 四参数构造(如 Color.New(255, 0, 0, 255)),不能用 0-1 归一化值。

代码示例

创建富文本标签并设置排版样式

lua
-- @runtime client
local Players = game:GetService("Players")
local localPlayer = Players.LocalPlayer
if localPlayer == nil then return end
local rootNode = localPlayer.PlayerGui.EuiManager:GetRootNode()
local World = game:GetService("World")
local label = World:CreateUnit("EUIRichTextLabel", {
    Parent = rootNode,
    Position = Vector2.New(160, 80),
    Size = Vector2.New(300, 100),
    Text = "任务奖励:金币 x100",
    FontSize = 24,
    TextColor = Color.New(255, 230, 120, 255),
    OutlineEnabled = true,
    OutlineColor = Color.New(0, 0, 0, 255),
    WrapWidth = 280,
})

属性 (30)

Name类型默认值说明
TextStringRichTextLabel富文本标签显示的文本内容。
TextColorColor[255, 255, 255, 255]富文本标签的文本颜色。
FontSizeInt42文本的字体大小。
FontTextFontTypeEnums.TextFontType.HKXZYT_W9_GB文本使用的字体。
OutlineEnabledBoolfalse是否启用文本描边效果。
OutlineColorColor[0, 0, 0, 0]富文本标签的描边颜色。
OutlineWidthInt1文本描边的宽度。
OutlineOpacityFloat1.0文本描边的透明度。
ShadowEnabledBoolfalse是否启用文本阴影效果。
ShadowColorColor[0, 0, 0, 0]富文本标签的阴影颜色。
ShadowOffsetVector2[1, 1]富文本标签的阴影偏移量。
ItalicEnabledBoolfalse是否启用斜体样式。
TextHorizontalAlignmentInt0 (Left)文本的水平对齐方式。
TextVerticalAlignmentInt0 (Top)文本的垂直对齐方式。
WrapWidthInt-文本换行的宽度。
SingleLineMinWidthInt-单行文本的最小宽度。
SingleLineMaxWidthInt-单行文本的最大宽度。
WrapMaxHeightInt-文本换行区域的最大高度。
WrapMinHeightInt-文本换行区域的最小高度。
AutoSizeEnabledBoolfalse是否启用自动缩小字号以适应标签尺寸。
MinFontSizeInt12自动缩放字号时的最小允许字号。
TextSpacingInt0字符之间的间距。
LineSpacingInt-文本行与行之间的间距。
EnableMaxHeightBoolfalse是否启用最大高度限制。
ShrinkFontSizeStepFloat1.0自动缩小字号时的步长。
OverflowPolicyInt1 (Culling)文本溢出时的处理策略。
AutoScrollSpeedFloat100.0自动滚动的速度。
AutoScrollProgressFloat0.0自动滚动时的循环间距。
ArrangeModeInt2 (AutoWrap)文本的排列模式。
EnableMaxWidthBoolfalse是否启用最大宽度限制。

关联类型