API
Return to top
UIObject
编辑

界面 / UIObject

UIObject Class
​

UI 对象

当你 UIPrefab 制作完成挂载到对象管理器中时，他便成为场景中的一份子，可以使用 GameObject 来查找。

此类中的方法均在客户端调用。

Hierarchy ​

Table of contents ​

Properties
​

click

Properties
​

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

Accessors
​

uiPath(): string client
获取挂载在对象管理器的 UIPrefab 完整路径
uiScript(): UIScript other
获取在对象管理器中的 UIPrefab 上挂载的脚本
uiWidgetBase(): UserWidget client
获取该对象下所绑定的 UI 根控件
click

Accessors
​

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

Methods
​

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
给定对象属性修改时触发的事件代理
getPropertyChangeDelegate(property): Readonly<MulticastDelegate<(path: string, value: unknown, oldValue: unknown) => void>> other
给定对象属性修改时触发的事件代理
getVisibility(): 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 ​

uiPath
​

• get uiPath(): string client

获取挂载在对象管理器的 UIPrefab 完整路径

Returns ​

stringUIPrefab 路径
使用示例:创建一个名为"NewScript"默认脚本脚本，放置在对象栏中，打开脚本，输入以下代码保存，运行游戏。代码如下：
ts
@Component
export default class NewScript extends Script {
    protected onStart(): void {
        if(SystemUtil.isClient()){
            // 传入的ID需要修改为你编辑器中挂载在对象管理器中的UIPrefab ID
            let ui = GameObject.findGameObjectById("28504DC8") as UIObject;
            console.log("The complete path of this UIPrefab is:" + ui.uiPath);
        }
    }
}
@Component
export default class NewScript extends Script {
    protected onStart(): void {
        if(SystemUtil.isClient()){
            // 传入的ID需要修改为你编辑器中挂载在对象管理器中的UIPrefab ID
            let ui = GameObject.findGameObjectById("28504DC8") as UIObject;
            console.log("The complete path of this UIPrefab is:" + ui.uiPath);
        }
    }
}

uiScript
​

• get uiScript(): UIScript other

获取在对象管理器中的 UIPrefab 上挂载的脚本

Returns ​

UIScriptUI绑定的脚本
使用示例:创建一个名为"NewScript"默认脚本脚本，放置在对象栏中，打开脚本，输入以下代码保存，运行游戏。代码如下：
ts
@Component
export default class NewScript extends Script {
    protected onStart    (): void {
        if(SystemUtil.isClient()){
            // 传入的ID需要修改为你编辑器中挂载在对象管理器中的UIPrefab ID
            let ui = GameObject.findGameObjectById("28504DC8") as UIObject;
            console.log("The name of the script root control mounted by this UIPrefab:" + ui.uiScript.rootCanvas.name);
        }
    }
}
@Component
export default class NewScript extends Script {
    protected onStart    (): void {
        if(SystemUtil.isClient()){
            // 传入的ID需要修改为你编辑器中挂载在对象管理器中的UIPrefab ID
            let ui = GameObject.findGameObjectById("28504DC8") as UIObject;
            console.log("The name of the script root control mounted by this UIPrefab:" + ui.uiScript.rootCanvas.name);
        }
    }
}

uiWidgetBase
​

• get uiWidgetBase(): UserWidget client

获取该对象下所绑定的 UI 根控件

Returns ​

使用示例:创建一个名为"NewScript"默认脚本脚本，放置在对象栏中，打开脚本，输入以下代码保存，运行游戏。代码如下：
ts
@Component
export default class NewScript extends Script {
    protected onStart(): void {
        if(SystemUtil.isClient()){
            // 传入的ID需要修改为你编辑器中挂载在对象管理器中的UIPrefab ID
            let ui = GameObject.findGameObjectById("28504DC8") as UIObject;
            console.log("The name of the script canvas mounted by this UIPrefab:" + ui.uiWidgetBase.name);
        }
    }
}
@Component
export default class NewScript extends Script {
    protected onStart(): void {
        if(SystemUtil.isClient()){
            // 传入的ID需要修改为你编辑器中挂载在对象管理器中的UIPrefab ID
            let ui = GameObject.findGameObjectById("28504DC8") as UIObject;
            console.log("The name of the script canvas mounted by this UIPrefab:" + ui.uiWidgetBase.name);
        }
    }
}
UserWidgetUIPrefab 中的根控件

Methods ​