Class UiScreen

UI屏幕

Hierarchy (View Summary)

UiNode
- UiScreen

Index

Constructors

Properties

children clone events name parent uiScale visible zIndex

Methods

findChildByName create getAllScreen

Constructors

constructor

new UiScreen(): UiScreen
Returns UiScreen
Inherited from UiNode.constructor

Properties

`Readonly`children

children: readonly UiNode[]

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

clone

clone: () => this

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

events

events: EventEmitter<UiNodeEvents<UiNode>>

管理节点相关的事件。

name

name: string

该节点的标识，可重复。

parent

parent: UiNode

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

uiScale

uiScale: UiScale

节点等比例缩放数据。

visible

visible: boolean

屏幕是否可见。

zIndex

zIndex: number

屏幕层级，层级越高的屏幕会显示在顶部，遮盖住层级较低的屏幕。

Methods

findChildByName

findChildByName<T extends UiInput | UiBox | UiText | UiImage>(name: string): T
按名称查找子节点，返回对应子节点对象。（节点名称可在编辑模式下的属性面板中查看）
Type Parameters
- T extends UiInput | UiBox | UiText | UiImage
Parameters
- name: string
  子节点名称。
Returns T
Link
https://docs.box3lab.com/arenapro/difference/findChildByName.html
Inherited from UiNode.findChildByName
- Defined in client/types/ClientAPI.d.ts:294

`Static`create

create(): UiScreen
创建一个新的 Ui屏幕实例。

Returns UiScreen
- Defined in client/types/ClientAPI.d.ts:505

`Static`getAllScreen

getAllScreen(): UiScreen[]
获取当前所有存在的屏幕实例。

Returns UiScreen[]
- Defined in client/types/ClientAPI.d.ts:509