ArenaEdit API手册

Appearance

C-🖼️ 游戏用户界面 ​

ClientUI 是管理游戏界面的主要接口，它提供了以下核心功能：

  • 界面布局：管理 UI 节点的层级、位置、尺寸等布局属性
  • 节点管理：创建和操作各类 UI 节点（屏幕、盒子、图片、文本、输入框等）
  • 事件系统：处理用户交互、节点状态变化等事件
  • 样式控制：自定义节点的颜色、透明度、旋转等视觉效果

提示

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

类定义 ​

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

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

属性列表 ​

基础属性 ​

  • name : 节点的标识符，可重复
  • visible : 节点的可见性
  • zIndex : 节点的层级，用于确定渲染顺序

节点结构 ​

  • parent : 父节点，非根节点的父节点为空时不会被渲染
  • children : 子节点列表，通过修改子节点的parent属性调整结构
  • events : 节点事件管理器

布局与变换 ​

外观样式 ​

图片节点 ​

文本节点 ​

输入节点 ​

方法 ​

节点操作 ​

节点创建 ​

  • create : 创建 UI 屏幕实例
  • create : 创建 UI 盒子实例
  • create : 创建 UI 图片实例
  • create : 创建 UI 文本实例
  • create : 创建 UI 输入实例

屏幕管理 ​

输入控制 ​

事件处理 ​

  • on : 监听事件
  • once : 监听一次性事件
  • add : 添加事件监听器（同 on）
  • emit : 触发事件
  • remove : 移除第一个匹配的监听器
  • off : 移除事件监听器（同 remove）
  • removeAll : 移除所有监听器

枚举值 ​