HumanBreak/docs/api/class/game-ui.md
2024-03-01 19:52:30 +08:00

1.3 KiB

类 GameUi

渲染进程类,游戏进程不能直接使用,继承自 EventEmitter

component

declare var component: Component

id

declare var id: string

symbol

declare var symbol: symbol

constructor()

interface GameUi {
    new(id: string, component: Component): GameUi
}
  • 参数说明
    • id: UI 的名称,也就是 id
    • component: UI 组件,一般是函数式组件或者导出组件

with()

declare function with(vBind?: any, vOn?: any): ShowableGameUi
  • 方法说明

    传入参数与监听事件,返回一个可显示 UI 对象

uiList

declare var uiList: GameUi[]
  • 静态成员说明

    包含了所有注册的 GameUi 实例

close 事件

interface GameUiEvent {
    close: () => void
}
  • 事件说明

    当这个 UI 被打开时触发该事件

open 事件

interface GameUiEvent {
    open: () => void
}
  • 事件说明

    当这个 UI 被关闭时触发该事件