跳转至

UiBox 框架节点

这是一个客户端API

该API仅在客户端脚本使用

查阅官方文档
查阅社区文档
框架节点,继承于

属性

提示

虽然下面部分类型为的属性标记为只读,但只是你不能直接给这个属性赋值,你仍然可以使用属性自带的方法赋值或者直接给属性的属性赋值
同时你也不能像服务端那样x = ...;的写法了

name:
该节点的名称
在客户端中,你可以不指定节点的名称(然后你就不能(很难)通过其他方法获取到这个节点了)
节点的名称可以相同
children: <>
只读,该节点的所有子节点
parent: |
该节点的父节点
若为,节点不会被渲染,同时若没有任何变量引用该节点,该节点会被浏览器回收;否则,节点会被渲染到页面上
uiScale: |
该节点的缩放系数
anchor:
该节点的锚点,决定了该如何定位该节点
xy的范围皆为\([0, 1]\)
position:

该节点的位置

如何实现右侧对齐

position.scale.x设为1,再将anchor.x设为1,根据需要设定y值即可
若希望节点不挨着屏幕右边界,修改position.offset.x为一个负数。数值越小,节点越远离屏幕右边界
实现其他方向对齐大概也是这个思路

backgroundColor: = new Vec3([255, 255, 255])
该节点的背景颜色
rgb的范围皆为\([0, 255]\)
backgroundOpacity: = 1
该节点的背景 不透明度,范围\([0, 1]\)
size:
该节点的大小
zIndex:
该节点的渲染层级,数值越大,节点越靠近上层
若两个节点的zIndex相同,那么后创建的节点越靠近上层
autoResize: 'NONE' | 'X' | 'Y' | 'XY'

该节点自动调整大小的方式
若自动调整大小的结果小于手动设定的大小,将应用手动设定的大小;否则应用自动设定的大小

说明
'NONE' 不自动调整大小
'X' 在水平方向上自动调整大小
'Y' 在竖直方向上自动调整大小
'XY' 在水平和竖直方向上自动调整大小
visible: = true
该节点是否可见
pointerEventBehavior: = .ENABLE
该节点对鼠标指针事件的响应方式

方法

clone():
克隆该节点
create():
创建一个框架节点

评论区