简介
SandMod 的 UI 自动生成脚本功能,为您在脚本中定位 UI 对象(UI Object)以及编辑 UI 事件方法提供了快速、便捷的方式。
生成方法
- 在 UI 编辑器(UI Editor)的 顶部工具栏(Top Tool Bar)中点击 生成 TS 脚本(Generate TS Code) 按钮。
【UI_Automatically_Generated_Script001.png】
- 选择创建的脚本的自定义分类、类名(Class Name)和 脚本资产(Script Asset)保存的路径。其中分类是为类名添加后缀的快捷方式,没有硬性要求。
【UI_Automatically_Generated_Script002.png】
- 点击 创建(Create)按钮 UI 自动生成脚本资产将会在指定位置上生成。
【UI_Automatically_Generated_Script003.png】
脚本内容
SandMod 会根据当前 UI 所拥有的 UI 对象(UI Object)生成脚本,其中脚本会包含以下内容:
【UI_Automatically_Generated_Script004.png】
- 类名(Class Name)。
- 私有变量(Private Variables),定义用于保存 UI 对象(UI Object)的私有变量。
- 获取 UI 组件类(UI Component)的代码。
- 获取 UI 画布(Canvas)的代码。
- 生成脚本的时候该 UI 资产(UI Asset)拥有的所有 UI 对象的获取方法。
- UI 对象的事件方法。
- 在脚本运行时执行获取 UI 对象和注册 UI 对象事件的相关方法。
UI 对象相关设置
生成 UI 对应的脚本后,在 层级窗口(Hierachy)中,鼠标指向 UI 对象(UI Object),并点击鼠标右键,即会打开 UI 对象对应的上下文菜单,在上下文菜单中您可以对此 UI 对象进行以下内容的设置。
【UI_Automatically_Generated_Script003.png】
| 名称 | 描述 |
| 删除并清理脚本(Delete And Clear Script) | 在 UI 画布中删除选中的 UI 对象,并在 UI 自动生成脚本中删除获取对应 UI 对象的代码和保存对应 UI 对象的私有变量。 |
| 前往代码位置(Go To Script Position) | 自动启动 UI 自动生成脚本,并让光标显示在获取对应 UI 对象的该行代码上。 |
| 添加方法(Add Script Function) | 弹出事件方法选择弹窗,您可以根据事件的类型在弹窗中选择为 UI 对象添加的事件,选择对应的事件后会在自动生成脚本中自动生成对应事件的方法。 【UI_Automatically_Generated_Script004.png】 |
添加 UI 对象
如果您在生成了 UI 自动生成脚本后于 UI 画布上添加了新的 UI 对象(UI Object),为确保您原有脚本逻辑正常,UI 自动生成脚本中是不会实时更新新添加的 UI 对象,但是您可以使用以下方法将新添加的 UI 对象更新至脚本。
添加指定 UI 对象
如果您希望将指定的新增 UI 对象更新至自动生成脚本中,您可以在 层级窗口(Hierachy)中,用鼠标指向 UI 对象(UI Object),并点击鼠标右键打开上下文菜单,并选择 前往代码位置(Go To Script Position) 选项,如此操作将自动开启对应脚本,并在脚本中添加对应 UI 对象的获取方式和保存该 UI 对象的私有变量。
【UI_Automatically_Generated_Script005.png】
添加所有新增 UI 对象
如果您在 UI 画布中添加多个 UI 对象,并想将它们批量添加到脚本中,您可以在 UI 编辑器(UI Editor)的 顶部工具栏(Top Tool Bar)中点击 生成 TS 脚本(Generate TS Code) 按钮,并在 TS 脚本生成器(TS Script Generator)弹窗中点击 更新(Update) 按钮,如此操作将自动开启对应脚本,并在脚本中添加该 UI 画布的所有 UI 对象的获取方式和保存对应 UI 对象的私有变量。
【UI_Automatically_Generated_Script006.png】
