Skip to content

TextUnit ​

场景中的三维文字单位,用于在世界空间渲染带样式设置的文本,可通过 Content 指定文字内容,通过 FontName、FontSize 控制字体与字号,并借助 TextColor、GradientColorEnable、GradientC...

概览 ​

场景中的三维文字单位,用于在世界空间渲染带样式设置的文本,可通过 Content 指定文字内容,通过 FontName、FontSize 控制字体与字号,并借助 TextColor、GradientColorEnable、GradientColors、GradientAngle 实现纯色或渐变色文字,用 OutlineColor、OutlineWidth 添加描边。它同时提供 Width、Height、LineWrap、LineSpacing、HoriAlign、VertAlign 等排版属性,以及 OverflowStrategy、OverflowScrollSpeed、OverflowScrollSpacing 处理文字超框时的裁切或滚动。Position、Rotation、Scale 与 BindSocket 负责该文字在场景中的摆放与挂点绑定。

继承自 Unit;可通过 World:CreateUnit("TextUnit", ...) 创建;返回单个单位

属性 ​

名称类型默认值说明
PositionVector3[0.0, 0.0, 0.0]文字在场景中的位置。
RotationQuaternion[0.0, 0.0, 0.0, 1.0]文字的旋转(四元数)。
WidthFloat5.0文字框宽度。
HeightFloat5.0文字框高度。
ScaleVector3[1.0, 1.0, 1.0]文字的缩放。
ContentString""要展示的文字内容。
FontNameTextFontTypeEnums.TextFontType.HKXZYT_W9_GB文字使用的字体。
FontSizeInt100文字字号。
VisibleBooltrue文字是否可见。
HoriAlignHorizontalAlignmentTypeEnums.HorizontalAlignmentType.ALIGN_LEFT文字的水平对齐方式。
VertAlignVerticalAlignmentTypeEnums.VerticalAlignmentType.ALIGN_TOP文字的垂直对齐方式。
LineWrapBooltrue文字超出宽度时是否自动换行。
OverflowStrategyTextOverflowStrategyEnums.TextOverflowStrategy.OVERFLOW_NONE文本超出文字框时的处理策略。
OverflowScrollSpeedFloat2.0超框跑马灯滚动速度。取值范围 [-5.0, 5.0]。
OverflowScrollSpacingFloat0超框跑马灯滚动间距。取值范围 [0.0, 3.0]。
VerticalDirectionBoolfalse文字是否纵向排列显示。
ReverseDirectionBoolfalse纵向排列时是否从右到左显示。
LineSpacingFloat0.0多行文字的行间距。取值范围 [0.0, 2.0]。
TextSkewFloat0.0文本倾斜角度(度)。取值范围 [-45.0, 45.0]。
GradientColorEnableBoolfalse是否使用渐变色文字。
TextColorColorColor.New(255, 255, 255, 255)文本颜色(未开启渐变时生效)。
GradientColorsArray-渐变色的颜色列表(开启渐变后生效)。
GradientAngleFloat0.0渐变方向角度(度)。取值范围 [0.0, 180.0]。
OutlineColorColorColor.New(0, 0, 0, 255)文字描边颜色。
OutlineWidthFloat0.0文字描边宽度。取值范围 [0.0, 7.0]。
BindSocketString""文字绑定的骨骼挂点名称。