神岛 API 文档 - ArenaPro版
    Preparing search index...

    UI文本

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    anchor: Vec2

    节点的锚点,用于确定节点的位置。

    autoResize: "X" | "Y" | "NONE" | "XY"

    节点的自动调整尺寸的方式。

    autoWordWrap: boolean

    是否开启自动换行。

    backgroundColor: Vec3

    节点的背景颜色。

    backgroundOpacity: number

    节点的背景透明度。

    children: readonly UiNode[]

    节点的子节点。如需要调整子节点结构,应修改子节点的parent属性。

    clone: () => this

    克隆节点,包括其子节点。

    事件管理器。

    name: string

    该节点的标识,可重复。

    parent: UiNode

    节点的父节点,非根节点的父节点为空时,该节点将不会被渲染。

    pointerEventBehavior: PointerEventBehavior

    配置鼠标指针事件的响应方式

    position: Coord2

    节点的位置,相对于父节点的位置。

    richText: boolean

    富文本标记,表示内容是否支持富文本格式 当前支持的xml标签有:

    • <font size="16" color="#D03737">内容</font>
    • <stroke color="#00FFFF" thickness="10" opacity="0.6">内容</stroke>
    rotation: number

    节点的旋转(角度)

    size: Coord2

    节点的尺寸。

    textColor: Vec3

    节点显示的文本的颜色。

    textContent: string

    文本元素的内容,支持转义字符与换行,会对自身元素的自适应大小产生影响。

    • 换行后,所有受到元素大小影响的属性,均需以新的大小进行计算,
    • UiText.richText为真时,将开启富文本解析。
    textFontFamily: UITextFontFamily

    定义文本使用的字体。

    textFontSize: number

    节点显示的文本的字体大小。

    textLineHeight: number

    文本的行高。

    textStrokeColor: Vec3

    只读属性,定义文本的描边颜色。

    textStrokeOpacity: number

    定义文本描边的不透明度。

    textStrokeThickness: number

    定义文本描边的厚度。

    textXAlignment: "Center" | "Left" | "Right"

    节点显示的文本的水平对齐方式。

    textYAlignment: "Center" | "Top" | "Bottom"

    节点显示的文本的垂直对齐方式。

    uiScale: UiScale

    节点等比例缩放数据。

    visible: boolean

    节点的可见性。

    zIndex: number

    节点的层级,用于确定节点的渲染顺序。

    Methods