Skip to content

⚡️ 类型安全:将游戏资源同步到代码

手动在代码中输入一长串资源路径字符串(如 "model/12345.vb")是一种极易出错的开发方式。你可能会输错一个字符,或者资源在编辑器中被删除或重命名,而代码对此一无所知,最终只会在游戏运行时导致 Bug。

类型安全的资源同步功能,就是为了从根本上解决这个问题。

核心思想:将资源“注入”到 TypeScript

该功能会扫描你链接的地图中的所有资源,并自动为它们生成一个 TypeScript 类型定义文件 (types/GameAssets.d.ts)。

这份文件就像一份“资源清单”,它将你所有的资源路径注册到了 TypeScript 的类型系统中。这会立刻给你带来两大好处:

  1. 代码自动补全:编辑器会像提示普通变量一样,为你列出所有可用的资源路径。
  2. 编译时检查:如果你使用了一个不存在或已改名的资源,TypeScript 会在编译时立刻报错,而不是等到游戏运行时。

如何使用?

第 1 步:执行同步命令

我们提供了多种方式来触发资源同步:

  • 快捷键: 按下 Alt + Y
  • 命令面板 (F1): 运行 同步地图资源

插件会开始扫描资源并生成类型文件。

第 2 步:在代码中享受类型安全

同步完成后,当你再次调用需要资源路径的 API 时(例如 world.createEntity),就能获得完整的类型提示和自动补全。

脚本中使用类型约束示例

最佳实践:何时进行同步?

我们建议在以下时机手动执行一次资源同步 (Alt + Y):

  • 项目初次搭建完成后。
  • 在 ArenaPro 创作端新增、删除或重命名了任何资源后。

保持这份“资源清单”的更新,是确保你的项目长期健康、可维护的关键。

这套类型安全的资源管理系统,是 ArenaPro 相比传统开发方式的一大优势。它能极大地提升你的开发效率和代码的健壮性。


上一篇:资源管理器

下一篇:管理环境变量