ArenaEdit API手册

Appearance

🖼️游戏用户界面 ​

  • GameUI 是管理游戏界面的对象，用于对玩家界面UI的操作。
  • 在客户端脚本中，可以通过全局对象 ui，input，navigator ，screenWidth ，screenHeight 来使用它。

提示

在推出此功能前，已有GUI功能，基于xml编写。但已不推荐使用，因有更优方案且支持可视化编辑。推荐使用最新的GameUI。 对旧版GUI感兴趣可查阅d.ts文件。

类 ​

typescript
declare const ui: UiNode;
declare const navigator: Navigator;
declare const input: InputSystem;
declare const screenWidth: number; // 全局对象，获取当前玩家屏幕宽度
declare const screenHeight: number; // 全局对象，获取当前玩家屏幕高度

declare class InputSystem {
    //...
}
declare class Navigator {
    //...
}
declare class UiNode {
    //...
}

属性 ​

方法 ​

  • findChildByName : 按名称查找子节点，返回对应子节点对象
  • clone : 按名称查找子节点，返回对应子节点对象
  • create : 创建一个新的 Ui屏幕 实例
  • getAllScreen : 获取当前所有存在的屏幕实例
  • create : 创建一个新的 Ui盒子 实例
  • create : 创建一个新的 Ui图片 实例
  • create : 创建一个新的 Ui文本 实例
  • create : 创建一个新的 Ui输入 实例
  • focus : 使输入框聚焦
  • blur : 使输入框失去焦点
  • getDeviceInfo : 获取该客户端当前设备以及屏幕分辨率
  • unlockPointer : 调用后在游戏界面显示鼠标指针
  • lockPointer : 调用后在游戏界面隐藏鼠标指针
  • on : 监听指定的事件
  • once : 与 on 的区别是仅触发一次
  • remove : 移除找到的第一个 listener
  • removeAll : 移除找到的所有 listener，不传则移除事件下所有
  • add : 与 on 是同一个方法,只是方法名不同
  • emit : 触发指定的事件
  • off : 与 remove 是同一个方法,只是方法名不同

枚举 ​