YuanEngine

Appearance

💻 API 参考手册 ​

如果说节点是身体，组件是器官，那么 API 就是连接大脑与全身的神经系统。在 YuanEngine 中，通过 JavaScript 编写逻辑脚本，你可以打破静态场景的限制，赋予游戏真正的交互灵魂。

1. 脚本组件 (Script Component) ​

在 YuanEngine 中，脚本被视为一种特殊的自定义组件。你不需要修改引擎底层，只需要通过脚本扩展功能。

如何挂载脚本？ ​

  1. 在属性检查器中点击 [Add Component]。
  2. 选择 Scripts -> New Script。
  3. 在弹出的输入框中，填写脚本文件的相对路径（例如 scripts/PlayerController.js）。

关于路径

脚本路径是相对于项目根目录的。建议你在项目文件夹的 scripts 目录专门存放 .js 文件，以便于管理。

2. 为什么选择 JavaScript？ ​

YuanEngine 深度集成了现代 JavaScript 生态，这意味着：

  • 零编译等待：修改代码后，在编辑器内可以即时生效。
  • 极低的学习成本：如果你熟悉 Web 开发或 Vue，你几乎可以无缝上手。
  • 强大的 UI 联动：由于 YuanEngine 的 UI 层基于 Vue 3，JavaScript API 可以非常轻松地在游戏逻辑与 UI 界面之间传递数据。

3. 脚本能做什么？ ​

只要你能想到的逻辑，几乎都能通过 API 实现：

  • 物理交互：检测碰撞、给物体施加冲量或持续的力。
  • 输入控制：响应键盘（WASD）、鼠标点击或手柄输入。
  • 场景管理：动态创建节点、销毁节点或切换场景。
  • UI 逻辑：更新进度条、显示对话框、管理游戏得分。
  • 动画驱动：手动控制模型骨骼动画的播放与切换。

📖 如何使用本手册 ​

为了方便开发者快速查阅，本类别文档将采取字典的形式进行组织，旨在清晰、准确地描述每一个 API 的输入、输出与功能。

  • 如果你想查阅某个具体的函数或类：请直接在左侧菜单寻找对应的 API 词条。
  • 如果你是初学者，想通过案例学习：本手册可能对你来说稍显枯燥。我们强烈建议你先阅读 「动手试试」 类别，通过实战案例快速掌握开发套路。

💡 核心概念预览 ​

在深入 API 之前，你可能需要了解脚本的生命周期钩子（Lifecycle Hooks）：

  • onLoad(): 脚本加载时触发，适合初始化变量。
  • onUpdate(dt): 每一帧都会执行，适合处理移动和实时逻辑。
  • onDestroy(): 脚本或节点被销毁时触发，用于清理资源。

准备好了吗？

点击左侧菜单，开始探索 YuanEngine 强大的 API 世界吧！