API
Return to top
WorldUI
编辑

界面 / WorldUI

WorldUI Class
​

世界 UI

  1. UI 界面分为两种：屏幕 UI 和世界 UI。

WorldUI 是专门用来制作世界 UI 的。屏幕 UI 的详细制作方式请参考 UIService 或 UserWidget。

  1. WorldUI 有两种方式制作世界 UI ：
  • 🌵 动态加载（只使用代码动态创建一个世界 UI）
使用示例: 创建一个名为 WorldUI 的脚本，放置在对象栏中，打开脚本，将原本内容修改为如下内容，保存并运行游戏，会在场景中生成一个世界 UI - 滑动条
ts
@Component
export default class WorldUI extends Script {

    user:UserWidget;
    widget:WorldUI;
    progressBar:ProgressBar;

    protected onStart(): void {
        if(SystemUtil.isClient()){
            this.creatUI();
            this.widget = GameObject.spawn<WorldUI>("WorldUI",{replicates:false});
            this.widget.worldTransform.position = new Vector(0,0,100);
            this.widget.setTargetUIWidget(this.user);
        }
    }

    public creatUI(){
        this.user = UserWidget.newObject();

        let rootCanvas = Canvas.newObject();
        rootCanvas.position = Vector2.zero;
        this.user.rootContent = rootCanvas;

        this.progressBar = ProgressBar.newObject(rootCanvas);
    }
}
@Component
export default class WorldUI extends Script {

    user:UserWidget;
    widget:WorldUI;
    progressBar:ProgressBar;

    protected onStart(): void {
        if(SystemUtil.isClient()){
            this.creatUI();
            this.widget = GameObject.spawn<WorldUI>("WorldUI",{replicates:false});
            this.widget.worldTransform.position = new Vector(0,0,100);
            this.widget.setTargetUIWidget(this.user);
        }
    }

    public creatUI(){
        this.user = UserWidget.newObject();

        let rootCanvas = Canvas.newObject();
        rootCanvas.position = Vector2.zero;
        this.user.rootContent = rootCanvas;

        this.progressBar = ProgressBar.newObject(rootCanvas);
    }
}
  • 🌵 在对象管理器中提前在物体上挂载世界 UI 逻辑对象，在属性面板中放置对应的 UIPrefab。

Hierarchy ​

Table of contents ​

Properties
​

click

Properties
​

onBeforeDestroyDelegate: MulticastDelegate<() => void>
物体销毁前事件回调
onCustomPropertyChange: Readonly<MulticastDelegate<(path: string, value: unknown, oldValue: unknown) => void>> other
监听自定义属性同步事件
onDestroyDelegate: MulticastDelegate<() => void>
物体销毁后事件回调

Accessors
​

alwaysFaceCamera(): boolean client
获取是否保持朝向相机
alwaysOnTop(): boolean client
获取是否保持最上显示
brightness(): number client
获取亮度值
distanceScaleEnabled(): boolean
获取是否开启近大远小
distanceScaleFactor(): number
获取缩放距离系数
lightInfluence(): number client
获取光照影响
maxVisibleDistance(): number
获取最大UI可见距离
maxVisibleDistanceEnabled(): boolean
获取是否启用最大可见距离
occlusionEnable(): boolean
获取是否可被遮挡
pivot(): Vector2
获取锚点位置
selfOcclusionEnabled(): boolean
获取是否可被自己遮挡
spaceMode(): SpaceMode
获取显示方式
touchEnable(): boolean client
获取世界UI交互状态
zOrder(): number client
获取渲染层级，较高渲染层级的对象会优先显示在离视线较近的地方
click

Accessors
​

actorFlagValue(): number other
获取对象标记
actorLevel(): number other
获取Actor等级
assetId(): string
获取当前物体使用资源的GUID
gameObjectId(): string
获取物体的唯一标识（唯一标识一个对象的字符串）。
isDestroyed(): boolean
当前物体是否被销毁
isReady(): boolean
当前物体状态
localTransform(): Transform
当前物体本地变换
name(): string
返回当前物体名称
netStatus(): NetStatus
获取当前物体同步状态
parent(): GameObject
获取当前父物体
tag(): string
获取当前物体的标签
worldTransform(): Transform
当前物体世界变换

Methods
​

getTargetUIWidget(): UserWidget client
获取UI对象资源
refresh(): void client
请求重新绘制
setTargetUIWidget(uiUserWidget: UserWidget): void client
设置UI，可以对当前的UI设置UI资源，UI资源可以从路径获取或直接取其他UI组件引用的资源
setUIbyID(ID: string): void client
通过 GUID 设置 UI
click

Methods
​

addComponent<T: extends Script<T>>(constructor: (...args: unknown[]) => T: extends Script<T>, bInReplicates?: boolean): T: extends Script<T>
添加一个脚本组件
asyncGetChildByName(name: string): Promise<GameObject>
异步根据名称查找子物体
asyncReady(): Promise<GameObject>
物体准备好后返回
clone(gameObjectInfo?: GameObjectInfo): GameObject
复制对象
destroy(): void
删除对象
getBoundingBox(nonColliding?: boolean, includeFromChild?: boolean, outer?: Vector): Vector
获取物体包围盒大小
getBounds(onlyCollidingComponents: boolean, originOuter: Vector, boxExtentOuter: Vector, includeFromChild?: boolean): void
获取物体边界
getChildByGameObjectId(gameObjectId: string): GameObject
根据 gameObjectId 查找子物体
getChildByName(name: string): GameObject
根据名称查找子物体
getChildByPath(path: string): GameObject
根据路径查找子物体
getChildren(): GameObject[]
获取子物体
getChildrenBoundingBoxCenter(outer?: Vector): Vector
获取所有子对象包围盒中心点(不包含父对象,父对象不可用返回[0,0,0])
getChildrenByName(name: string): GameObject[]
通过名字查找所有的子物体
getComponent<T: extends Script<T>>(constructor?: (...args: unknown[]) => T: extends Script<T>): T: extends Script<T>
获取指定类型的组件
getComponentPropertys<T: extends Script<T>>(constructor: (...args: unknown[]) => T: extends Script<T>): Map<string, IPropertyOptions>
获取脚本组件属性
getComponents<T: extends Script<T>>(constructor?: (...args: unknown[]) => T: extends Script<T>): T: extends Script<T>[]
获取指定类型的所有组件
getCustomProperties(): string[]
获取所有自定义属性
getCustomProperty<T: extends CustomPropertyType>(propertyName: string): T: extends CustomPropertyType
获取自定义属性
getCustomPropertyChangeDelegate(property): Readonly<MulticastDelegate<(path: string, value: unknown, oldValue: unknown) => void>> other
给定对象属性修改时触发的事件代理
getVisibility(): boolean
获取物体是否被显示
isPrefabActor(): boolean
返回当前物体是否为预制体
moveBy(velocity: Vector, isLocal?: boolean): void other
按给定的速度矢量随时间平滑地移动对象
moveTo(targetPosition: Vector, time: number, isLocal?: boolean, onComplete?: () => void): void other
在指定时间内从当前位置平滑移动至目标位置
rotateBy(rotation: Quaternion Rotation, multiplier: number, isLocal?: boolean): void other
按给定的旋转量随时间平滑地旋转对象
rotateTo(targetRotation: Quaternion Rotation, time: number, isLocal?: boolean, onComplete?: () => void): void other
在指定时间内从当前旋转平滑变化至目标旋转
scaleBy(scale: Vector, isLocal?: boolean): void other
按每秒给定的缩放矢量随时间平滑缩放对象
scaleTo(targetScale: Vector, time: number, isLocal?: boolean, onComplete?: () => void): void other
在指定时间内从当前缩放平滑变化至目标缩放
setAbsolute(absolutePosition?: boolean, absoluteRotation?: boolean, absoluteScale?: boolean): void
设置物体localTransform是相对于父物体或者世界
setCustomProperty(propertyName: string, value: undefined CustomPropertyType): void
设置自定义属性
setVisibility(status: boolean PropertyStatus, propagateToChildren?: boolean): void
设置物体是否被显示
stopMove(): void other
中断moveTo()、moveBy()的进一步移动
stopRotate(): void other
中断从rotateTo()或rotateBy()的进一步旋转
stopScale(): void other
中断从ScaleTo()或ScaleBy()的进一步缩放
asyncFindGameObjectById(gameObjectId: string): Promise<GameObject>
通过 gameObjectId 异步查找 GameObject
asyncGetGameObjectByPath(path: string): Promise<GameObject>
通过路径异步查找物体
asyncSpawn<T: extends GameObject<T>>(assetId: string, gameObjectInfo?: GameObjectInfo): Promise<T: extends GameObject<T>>
异步构造一个物体
bulkPivotTo(gameObjects: GameObject[], transforms: Transform[]): void
批量设置位置
findGameObjectById(gameObjectId: string): GameObject
通过 gameObjectId 查找物体
findGameObjectByName(name: string): GameObject
通过名字查找物体
findGameObjectsByName(name: string): GameObject[]
通过名字查找物体
findGameObjectsByTag(tag: string): GameObject[]
通过自定义标签获取物体
getGameObjectByPath(path: string): GameObject
通过路径查找物体
spawn<T: extends GameObject<T>>(assetId: string, gameObjectInfo?: GameObjectInfo): T: extends GameObject<T>
构造一个物体

Properties ​

Accessors ​

alwaysFaceCamera
​

• get alwaysFaceCamera(): boolean client

• set alwaysFaceCamera(value): void client

获取是否保持朝向相机

Precautions

请在客户端调用，世界空间类型专用

Returns ​

boolean

设置是否保持朝向相机

Precautions

请在客户端调用，世界空间类型专用

Parameters ​

value booleanUI是否保持朝向相机

alwaysOnTop
​

• get alwaysOnTop(): boolean client

• set alwaysOnTop(value): void client

获取是否保持最上显示

Precautions

请在客户端调用，世界空间类型专用

Returns ​

boolean

设置是否保持最上显示

Precautions

请在客户端调用，世界空间类型专用

Parameters ​

value booleanUI是否保持最上显示

brightness
​

• get brightness(): number client

• set brightness(value): void client

获取亮度值

Precautions

请在客户端调用，世界空间类型专用

Returns ​

number

设置亮度

Precautions

请在客户端调用，世界空间类型专用

Parameters ​

value numberUI亮度，值范围为 [0, 10]

distanceScaleEnabled
​

• get distanceScaleEnabled(): boolean

• set distanceScaleEnabled(Value): void

获取是否开启近大远小

Precautions

请在客户端调用，屏幕空间类型专用

Returns ​

booleantrue：开启

设置是否开启近大远小

Precautions

请在客户端调用，屏幕空间类型专用

Parameters ​

Value boolean布尔值

distanceScaleFactor
​

• get distanceScaleFactor(): number

• set distanceScaleFactor(Value): void

获取缩放距离系数

Precautions

请在客户端调用，屏幕空间类型专用

Returns ​

number距离系数

设置缩放距离系数

Precautions

请在客户端调用，屏幕空间类型专用

Parameters ​

Value number距离系数

lightInfluence
​

• get lightInfluence(): number client

• set lightInfluence(value): void client

获取光照影响

Precautions

请在客户端调用，世界空间类型专用

Returns ​

number

设置光照影响

Precautions

请在客户端调用，世界空间类型专用

Parameters ​

value numberUI光照影响度，值范围为 [0, 1]

maxVisibleDistance
​

• get maxVisibleDistance(): number

• set maxVisibleDistance(Value): void

获取最大UI可见距离

Returns ​

number可见距离

设置最大UI可见距离

Parameters ​

Value number可见距离

maxVisibleDistanceEnabled
​

• get maxVisibleDistanceEnabled(): boolean

• set maxVisibleDistanceEnabled(Value): void

获取是否启用最大可见距离

Returns ​

booleantrue：开启

设置是否启用最大可见距离

Parameters ​

Value boolean布尔值

occlusionEnable
​

• get occlusionEnable(): boolean

• set occlusionEnable(Value): void

获取是否可被遮挡

Precautions

请在客户端调用，屏幕空间类型专用

Returns ​

booleantrue：可被遮挡

设置是否可被遮挡

Precautions

请在客户端调用，屏幕空间类型专用

Parameters ​

Value boolean布尔值

pivot
​

• get pivot(): Vector2

• set pivot(position): void

获取锚点位置

Returns ​

Vector2位置信息

设置锚点位置

Parameters ​

position Vector2位置信息

selfOcclusionEnabled
​

• get selfOcclusionEnabled(): boolean

• set selfOcclusionEnabled(Value): void

获取是否可被自己遮挡

Precautions

请在客户端调用，屏幕空间类型专用

Returns ​

boolean布尔值

设置是否可被自己遮挡

Precautions

请在客户端调用，屏幕空间类型专用

Parameters ​

Value boolean布尔值

spaceMode
​

• get spaceMode(): SpaceMode

• set spaceMode(spaceMode): void

获取显示方式

Returns ​

SpaceMode显示方式枚举

设置显示方式

Parameters ​

spaceModeSpaceMode

touchEnable
​

• get touchEnable(): boolean client

• set touchEnable(touchEnable): void client

获取世界UI交互状态

Precautions

对世界UI，头顶UI生效

Returns ​

boolean是否可交互

设置世界UI交互状态

Precautions

对世界UI，头顶UI生效

Parameters ​

touchEnable boolean是否可交互

是否设置成功

zOrder
​

• get zOrder(): number client

• set zOrder(value): void client

获取渲染层级，较高渲染层级的对象会优先显示在离视线较近的地方

Precautions

请在客户端调用

Returns ​

number

设置渲染层级，较高渲染层级的对象会优先显示在离视线较近的地方

Precautions

请在客户端调用

Parameters ​

value number新的渲染层级，值范围为 [0, 31]

Methods ​

getTargetUIWidget
​

• getTargetUIWidget(): UserWidget client

获取UI对象资源

Returns ​

UserWidgetUI对象资源

refresh
​

• refresh(): void client

请求重新绘制

setTargetUIWidget
​

• setTargetUIWidget(uiUserWidget): void client

设置UI，可以对当前的UI设置UI资源，UI资源可以从路径获取或直接取其他UI组件引用的资源

Parameters ​

uiUserWidget UserWidgetUI资源对象

setUIbyID
​

• setUIbyID(ID): void client

通过 GUID 设置 UI

Parameters ​

ID stringUI 的 ID range: 依据资源 Id 长度决定