Files

火焰库拉 74d49d79c1 修复: create_prefab IPC 调用签名错误导致预制体创建失败

- 修复 create_prefab 使用错误的 sendToMain 改为 sendToPanel

- 修复节点 ID 未包裹数组及传入完整路径而非目录路径的问题

- 修复 prefabManagement 的 create 分支中 targetDir 未定义的 Bug

- 更新 UPDATE_LOG.md、注意事项.md、IPC_MESSAGES.md 文档

2026-02-28 23:07:04 +08:00

33 KiB

Raw Blame History

Cocos Creator 2.4.12 IPC Messages Documentation

本文档详细记录了Cocos Creator 2.4.12版本中定义的所有IPC（进程间通信）消息，包括它们的用途、参数以及返回值。

App相关IPC消息
Asset-DB相关IPC消息
Dashboard相关IPC消息
Scene相关IPC消息
Editor相关IPC消息
Selection相关IPC消息
Scene-Animation相关IPC消息
Scene-Layout相关IPC消息
Metrics相关IPC消息
Package Template相关IPC消息
Additional Scene相关IPC消息
广播事件
渲染进程监听的事件

App相关IPC消息

`app:explore-project`

用途: 打开项目所在文件夹
参数: 无
返回值: 无
类型: 主进程监听
状态: 可用

`app:explore-app`

用途: 打开应用程序所在文件夹
参数: 无
返回值: 无
类型: 主进程监听
状态: 可用

`app:build-project`

用途: 构建项目
参数: 包含构建选项的对象
返回值: 无
类型: 主进程监听
状态: 可用

`app:query-cocos-templates`

用途: 查询Cocos模板
参数: 无
返回值: 模板列表
类型: 主进程监听
状态: 可用

`app:query-android-apilevels`

用途: 查询Android API级别
参数: 无
返回值: API级别列表
类型: 主进程监听
状态: 可用

`app:query-android-instant-apilevels`

用途: 查询Android Instant API级别
参数: 无
返回值: API级别列表
类型: 主进程监听
状态: 可用

`app:compile-project`

用途: 编译项目
参数: 编译选项对象
返回值: 无
类型: 主进程监听
状态: 可用

`app:open-cocos-console-log`

用途: 打开Cocos控制台日志
参数: 无
返回值: 无
类型: 主进程监听
状态: 可用

`app:stop-compile`

用途: 停止编译
参数: 无
返回值: 无
类型: 主进程监听
状态: 可用

`app:run-project`

用途: 运行项目
参数: 包含平台信息的对象
返回值: 无
类型: 主进程监听
状态: 可用

`app:save-keystore`

用途: 保存密钥库
参数: 密钥库信息
返回值: 错误信息或成功确认
类型: 主进程监听
状态: 可用

`app:update-build-preview-path`

用途: 更新构建预览路径
参数: 预览路径
返回值: 无
类型: 主进程监听
状态: 可用

`app:update-android-instant-preview-path`

用途: 更新Android Instant预览路径
参数: 预览路径
返回值: 无
类型: 主进程监听
状态: 可用

`app:play-on-device`

用途: 在设备上播放
参数: 平台信息
返回值: 无
类型: 主进程监听
状态: 可用

`app:reload-on-device`

用途: 在设备上重新加载
参数: 无
返回值: 无
类型: 主进程监听
状态: 可用

`app:query-plugin-scripts`

用途: 查询插件脚本
参数: 构建平台名称
返回值: 插件脚本列表
类型: 主进程监听
状态: 可用

`app:rebuild-editor-engine`

用途: 重建编辑器引擎
参数: 回调函数
返回值: 错误信息
类型: 主进程监听
状态: 可用

Asset-DB相关IPC消息

`asset-db:explore`

用途: 打开资源所在文件夹
参数: 资源URL
返回值: 无
类型: 主进程监听
状态: 可用

`asset-db:exists`

用途: 查询资源是否存在
参数: 资源URL
返回值: 存在性布尔值
类型: 主进程监听
状态: 可用

`asset-db:query-path-by-url`

用途: 根据URL查询路径
参数: 资源URL
返回值: 文件系统路径
类型: 主进程监听
状态: 可用

`asset-db:query-uuid-by-url`

用途: 根据URL查询UUID
参数: 资源URL
返回值: UUID字符串
类型: 主进程监听
状态: 可用

`asset-db:query-path-by-uuid`

用途: 根据UUID查询路径
参数: UUID字符串
返回值: 文件系统路径
类型: 主进程监听
状态: 可用

`asset-db:query-url-by-uuid`

用途: 根据UUID查询URL
参数: UUID字符串
返回值: 资源URL
类型: 主进程监听
状态: 可用

`asset-db:query-info-by-uuid`

用途: 根据UUID查询资源信息
参数: UUID字符串
返回值: 资源信息对象
类型: 主进程监听
状态: 可用

`asset-db:query-meta-info-by-uuid`

用途: 根据UUID查询元数据信息
参数: UUID字符串
返回值: 元数据信息对象
类型: 主进程监听
状态: 可用

`asset-db:deep-query`

用途: 深度查询资源
参数: 无
返回值: 完整资源数据库信息
类型: 主进程监听
状态: 可用

`asset-db:query-assets`

用途: 查询资源
参数: 查询条件、类型
返回值: 资源列表
类型: 主进程监听
状态: 可用

`asset-db:query-mounts`

用途: 查询挂载点
参数: 无
返回值: 挂载点列表
类型: 主进程监听
状态: 可用

`asset-db:import-assets`

参数: 导入路径列表、目标路径、刷新标志
用途: 导入资源
返回值: 无
类型: 主进程监听
状态: 可用

`asset-db:create-asset`

用途: 创建资源
参数: URL、内容
返回值: 错误信息或创建结果
类型: 主进程监听
状态: 可用

`asset-db:move-asset`

用途: 移动资源
参数: 源URL、目标URL、是否显示错误对话框
返回值: 错误信息或移动结果
类型: 主进程监听
状态: 可用

`asset-db:delete-assets`

用途: 删除资源
参数: URL数组
返回值: 错误信息或删除结果
类型: 主进程监听
状态: 可用

`asset-db:save-exists`

用途: 保存已存在的资源
参数: URL、内容
返回值: 错误信息或保存结果
类型: 主进程监听
状态: 可用

`asset-db:create-or-save`

用途: 创建或保存资源
参数: URL、内容
返回值: 错误信息或操作结果
类型: 主进程监听
状态: 可用

`asset-db:save-meta`

用途: 保存元数据
参数: UUID、元数据对象
返回值: 无
类型: 主进程监听
状态: 可用

`asset-db:refresh`

用途: 刷新资源
参数: 路径（可选）
返回值: 错误信息或刷新结果
类型: 主进程监听
状态: 可用

`asset-db:attach-mountpath`

用途: 挂载路径
参数: 挂载路径对象
返回值: 错误信息或挂载结果
类型: 主进程监听
状态: 可用

`asset-db:unattach-mountpath`

用途: 取消挂载路径
参数: 挂载路径
返回值: 错误信息或取消挂载结果
类型: 主进程监听
状态: 可用

`asset-db:query-watch-state`

用途: 查询监听状态
参数: 无
返回值: 无（向主窗口发送状态）
类型: 主进程监听
状态: 可用

`asset-db:asset-changed`

用途: 资源变更处理
参数: 变更详情
返回值: 无
类型: 主进程监听
状态: 可用

`asset-db:asset-uuid-changed`

用途: 资源UUID变更处理
参数: 变更详情
返回值: 无
类型: 主进程监听
状态: 可用

`asset-db:assets-moved`

用途: 资源移动处理
参数: 移动详情数组
返回值: 无
类型: 主进程监听
状态: 可用

`asset-db:assets-created`

用途: 资源创建处理
参数: 创建详情数组
返回值: 无
类型: 主进程监听
状态: 可用

`asset-db:assets-deleted`

用途: 资源删除处理
参数: 删除详情数组
返回值: 无
类型: 主进程监听
状态: 可用

`asset-db:script-import-failed`

用途: 脚本导入失败处理
参数: 失败详情
返回值: 无
类型: 主进程监听
状态: 可用

`asset-db:meta-backup`

用途: 元数据备份处理
参数: 备份详情数组
返回值: 无
类型: 主进程监听
状态: 可用

Dashboard相关IPC消息

`app:query-recent`

用途: 查询最近打开的项目
参数: 无
返回值: 最近项目列表
类型: 主进程监听
状态: 不可用 (无响应)

`app:query-templates`

用途: 查询项目模板
参数: 无
返回值: 模板列表
类型: 主进程监听
状态: 不可用 (无响应)

`app:create-project`

用途: 创建项目
参数: 项目配置对象
返回值: 错误信息或创建结果
类型: 主进程监听
状态: 不可用 (无响应)

`app:open-project`

用途: 打开项目
参数: 项目路径、是否需要登录
返回值: 错误信息或打开结果
类型: 主进程监听
状态: 不可用 (无响应)

`app:delete-project`

用途: 删除项目
参数: 项目路径
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`app:close-project`

用途: 关闭项目
参数: 项目路径
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`app:window-minimize`

用途: 最小化窗口
参数: 无
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`app:window-close`

用途: 关闭窗口
参数: 无
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`app:get-last-create`

用途: 获取上次创建的项目
参数: 无
返回值: 上次创建的项目信息
类型: 主进程监听
状态: 不可用 (无响应)

`app:open-manual-doc`

用途: 打开手册文档
参数: 文档路径
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`app:open-api-doc`

用途: 打开API文档
参数: 文档路径
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`app:query-last-create-path`

用途: 查询上次创建的路径
参数: 无
返回值: 上次创建的路径
类型: 主进程监听
状态: 不可用 (无响应)

Scene相关IPC消息

`scene:is-ready`

用途: 检查场景编辑器是否准备就绪
参数: 无
返回值: 准备就绪状态
类型: 主进程监听
状态: 不可用 (无响应)

`scene:new-scene`

用途: 创建新场景
参数: 无
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`scene:saved`

用途: 场景保存完成后的通知
参数: 无
返回值: 无
类型: 广播事件
状态: 未测试

`scene:play-on-device`

用途: 在设备上播放场景
参数: 无
返回值: 无
类型: 广播事件
状态: 未测试

`scene:reload-on-device`

用途: 在设备上重新加载场景
参数: 无
返回值: 无
类型: 广播事件
状态: 未测试

`scene:preview-server-scene-stashed`

用途: 预览服务器场景暂存
参数: 无
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`scene:load-package-scene-script`

用途: 加载包场景脚本
参数: 脚本路径、包名
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`scene:unload-package-scene-script`

用途: 卸载包场景脚本
参数: 脚本路径
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`scene:soft-reload`

用途: 软重载场景
参数: 重载参数
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`scene:enter-prefab-edit-mode`

用途: 进入预制件编辑模式
参数: 预制件UUID
返回值: 无
类型: 主进程监听
状态: 可用

`scene:stash-and-save`

用途: 暂存并保存场景
参数: 无
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`scene:print-simulator-log`

用途: 打印模拟器日志
参数: 日志信息、日志类型
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`scene:generate-texture-packer-preview-files`

用途: 生成纹理打包预览文件
参数: 资源路径
返回值: 错误信息或操作结果
类型: 主进程监听
状态: 不可用 (无响应)

`scene:query-texture-packer-preview-files`

用途: 查询纹理打包预览文件
参数: 资源路径
返回值: 预览文件信息
类型: 主进程监听
状态: 可用

`scene:export-particle-plist`

用途: 导出粒子plist文件
参数: 粒子数据
返回值: 无
类型: 主进程监听
状态: 可用

`scene:update-edit-mode`

用途: 更新编辑模式
参数: 编辑模式信息
返回值: 无
类型: 主进程监听
状态: 可用

`scene:undo`

用途: 撤销操作
参数: 无
返回值: 无
类型: 主进程监听
状态: 可用

`scene:redo`

用途: 重做操作
参数: 无
返回值: 无
类型: 主进程监听
状态: 可用

`scene:undo-record`

用途: 记录撤销操作
参数: 对象ID、操作信息
返回值: 无
类型: 主进程监听
状态: 可用

`scene:undo-commit`

用途: 提交撤销操作
参数: 无
返回值: 无
类型: 主进程监听
状态: 可用

`scene:undo-cancel`

用途: 取消撤销操作
参数: 无
返回值: 无
类型: 主进程监听
状态: 可用

`scene:query-dirty-state`

用途: 查询场景脏状态
参数: 无
返回值: 脏状态信息
类型: 主进程监听
状态: 可用

`scene:query-group-list`

用途: 查询分组列表
参数: 无
返回值: 分组列表
类型: 主进程监听
状态: 可用

`scene:query-hierarchy`

用途: 查询场景层级结构
参数: 无
返回值: 场景UUID和节点层次
类型: 主进程监听
状态: 可用

`scene:query-nodes-by-comp-name`

用途: 根据组件名称查询节点
参数: 组件名称
返回值: 节点UUID列表
类型: 主进程监听
状态: 可用

`scene:query-node`

用途: 查询节点信息
参数: 节点UUID
返回值: 节点信息
类型: 主进程监听
状态: 可用

`scene:query-node-info`

用途: 查询节点详细信息
参数: 节点UUID、类型
返回值: 节点详细信息
类型: 主进程监听
状态: 可用

`scene:query-node-functions`

用途: 查询节点函数
参数: 节点UUID
返回值: 节点函数列表
类型: 主进程监听
状态: 可用

`scene:choose-last-rigid-body`

用途: 选择上一个刚体
参数: 当前节点UUID
返回值: 无
类型: 主进程监听
状态: 可用

`scene:choose-next-rigid-body`

用途: 选择下一个刚体
参数: 当前节点UUID
返回值: 无
类型: 主进程监听
状态: 可用

`scene:is-child-class-of`

用途: 检查是否为子类
参数: 类ID、父类ID
返回值: 是否为子类的布尔值
类型: 主进程监听
状态: 可用

`scene:has-copied-component`

用途: 检查是否有复制的组件
参数: 无
返回值: 是否有复制组件的布尔值
类型: 主进程监听
状态: 可用

`scene:query-animation-hierarchy`

用途: 查询动画层级
参数: 节点UUID
返回值: 动画层级结构
类型: 主进程监听
状态: 可用

`scene:query-animation-list`

用途: 查询动画列表
参数: 节点UUID
返回值: 动画剪辑UUID列表
类型: 主进程监听
状态: 可用

`scene:query-animation-properties`

用途: 查询动画属性
参数: 节点UUID
返回值: 动画属性列表
类型: 主进程监听
状态: 可用

`scene:query-animation-record`

用途: 查询动画记录状态
参数: 无
返回值: 动画记录状态信息
类型: 主进程监听
状态: 可用

`scene:query-animation-clip`

用途: 查询动画剪辑
参数: 动画剪辑UUID
返回值: 动画剪辑序列化数据
类型: 主进程监听
状态: 可用

`scene:query-asset-info`

用途: 查询资源信息
参数: 资源UUID
返回值: 资源信息
类型: 主进程监听
状态: 可用

`scene:query-nodes-by-usedby-uuid`

用途: 根据使用的资源UUID查询节点
参数: 资源UUID
返回值: 使用该资源的节点UUID列表
类型: 主进程监听
状态: 可用

`scene:create-nodes-by-uuids`

用途: 根据UUID创建节点
参数: UUID列表、位置、父节点、选项
返回值: 无
类型: 主进程监听
状态: 可用

`scene:create-node-by-classid`

用途: 根据类ID创建节点
参数: 类ID、位置、父节点、选项
返回值: 无
类型: 主进程监听
状态: 可用

`scene:create-node-by-prefab`

用途: 根据预制件创建节点
参数: 预制件名称、位置、父节点、选项
返回值: 无
类型: 主进程监听
状态: 可用

`scene:create-prefab`

用途: 将场景中的节点保存为预制体资源
参数: 节点UUID数组 ([uuid])、目标目录路径 (db:// 格式，如 db://assets)
返回值: 无
类型: 渲染进程监听 (需使用 sendToPanel("scene", ...))
状态: 可用
⚠️ 注意事项:
1. 必须使用 Editor.Ipc.sendToPanel("scene", "scene:create-prefab", ...) 而非 sendToMain。
2. 第一个参数为数组（即使只有单个节点也必须包裹在数组中）。
3. 第二个参数为目标目录路径（不含文件名），如 db://assets。预制体文件名取决于节点名称。

`scene:new-property`

用途: 创建新属性
参数: 属性信息
返回值: 无
类型: 主进程监听
状态: 可用

`scene:reset-property`

用途: 重置属性
参数: 属性信息
返回值: 无
类型: 主进程监听
状态: 可用

`scene:set-property`

用途: 设置属性
参数: 属性信息
返回值: 无
类型: 主进程监听
状态: 可用

`scene:add-component`

用途: 添加组件
参数: 节点UUID、组件名称
返回值: 无
类型: 主进程监听
状态: 可用

`scene:remove-component`

用途: 移除组件
参数: 节点UUID、组件ID
返回值: 无
类型: 主进程监听
状态: 可用

`scene:reset-node`

用途: 重置节点
参数: 节点UUID
返回值: 无
类型: 主进程监听
状态: 可用

`scene:reset-all`

用途: 重置所有组件
参数: 节点UUID
返回值: 无
类型: 主进程监听
状态: 可用

`scene:move-up-component`

用途: 向上移动组件
参数: 节点UUID、组件ID
返回值: 无
类型: 主进程监听
状态: 可用

`scene:move-down-component`

用途: 向下移动组件
参数: 节点UUID、组件ID
返回值: 无
类型: 主进程监听
状态: 可用

`scene:reset-component`

用途: 重置组件
参数: 节点UUID、组件ID
返回值: 无
类型: 主进程监听
状态: 可用

`scene:copy-component`

用途: 复制组件
参数: 组件ID
返回值: 无
类型: 主进程监听
状态: 可用

`scene:paste-component`

用途: 粘贴组件
参数: 节点UUID
返回值: 无
类型: 主进程监听
状态: 可用

`scene:move-nodes`

用途: 移动节点
参数: 节点UUID列表、位置、父节点
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`scene:delete-nodes`

用途: 删除节点
参数: 节点UUID列表
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`scene:copy-nodes`

用途: 复制节点
参数: 节点UUID列表
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`scene:paste-nodes`

用途: 粘贴节点
参数: 无
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`scene:duplicate-nodes`

用途: 复制节点（Duplicate）
参数: 节点UUID列表
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`scene:create-prefab`

用途: 创建预制件
参数: 节点UUID、预制件路径
返回值: 无
类型: 主进程监听
状态: 可用

`scene:apply-prefab`

用途: 应用预制件
参数: 节点UUID、预制件路径
返回值: 无
类型: 主进程监听
状态: 可用

`scene:revert-prefab`

用途: 还原预制件
参数: 节点UUID、预制件路径
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`scene:set-prefab-sync`

用途: 设置预制件同步
参数: 节点UUID
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`scene:break-prefab-instance`

用途: 打破预制件实例关联
参数: 无
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`scene:link-prefab`

用途: 链接预制件
参数: 无
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`scene:regenerate-polygon-points`

用途: 重新生成多边形点
参数: 节点UUID
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`scene:search-skeleton-animation-clips`

用途: 搜索骨骼动画剪辑
参数: 节点UUID
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`scene:change-node-lock`

用途: 更改节点锁定状态
参数: 节点UUID、锁定状态
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`scene:copy-editor-camera-data-to-nodes`

用途: 将编辑器相机数据复制到节点
参数: 无
返回值: 无
类型: 主进程监听
状态: 可用

`scene:set-group-sync`

用途: 设置组同步
参数: 节点UUID、组名
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`scene:generate_attached_node`

用途: 生成附加节点
参数: 节点UUID
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

Editor相关IPC消息

`editor:dragstart`

用途: 开始拖拽操作
参数: 无
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`editor:dragend`

用途: 结束拖拽操作
参数: 无
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`editor:project-profile-updated`

用途: 项目配置文件更新
参数: 配置对象
返回值: 无
类型: 主进程监听
状态: 可用

Selection相关IPC消息

`selection:selected`

用途: 选择节点
参数: 类型、ID
返回值: 无
类型: 主进程监听
状态: 可用

`selection:unselected`

用途: 取消选择节点
参数: 类型、ID
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`selection:activated`

用途: 激活节点
参数: 类型、ID
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`selection:deactivated`

用途: 取消激活节点
参数: 类型、ID
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`selection:hoverin`

用途: 鼠标悬停进入节点
参数: 类型、ID
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`selection:hoverout`

用途: 鼠标悬停离开节点
参数: 类型、ID
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

Scene-Animation相关IPC消息

`scene-animation:query-animation-time`

用途: 查询动画时间
参数: 动画剪辑信息
返回值: 时间信息
类型: 主进程监听
状态: 不可用 (无响应)

`scene-animation:animation-time-changed`

用途: 动画时间改变
参数: 新的时间值
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`scene-animation:animation-clip-changed`

用途: 动画剪辑改变
参数: 剪辑信息
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`scene-animation:save-clip`

用途: 保存动画剪辑
参数: 无
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`scene-animation:set-animation-speed`

用途: 设置动画速度
参数: 速度值
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`scene-animation:change-animation-record`

用途: 更改动画记录状态
参数: 记录状态
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`scene-animation:mount-clip`

用途: 挂载动画剪辑
参数: 剪辑信息、选项
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`scene-animation:change-animation-state`

用途: 更改动画播放状态
参数: 状态（播放/暂停）
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`scene-animation:change-animation-current-clip`

用途: 更改当前动画剪辑
参数: 剪辑信息
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

Scene-Layout相关IPC消息

`scene-layout:center-nodes`

用途: 将摄像机中心对准节点
参数: 节点列表
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

Metrics相关IPC消息

`metrics:track-event`

用途: 跟踪事件
参数: 事件类别、动作、标签等
返回值: 无
类型: 主进程监听
状态: 可用

`editor:renderer-console-error`

用途: 发送渲染器控制台错误
参数: 错误堆栈信息
返回值: 无
类型: 主进程监听
状态: 可用

`metrics:track-exception`

用途: 跟踪异常
参数: 异常信息
返回值: 无
类型: 主进程监听
状态: 可用

Package Template相关IPC消息

`package-template:clicked`

用途: 包模板被点击
参数: 无
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`package-template:hello`

用途: 包模板的问候消息
参数: 事件对象
返回值: 无
类型: 广播事件
状态: 未测试

`package-template:open`

用途: 打开包模板面板
参数: 无
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

`package-template:say-hello`

用途: 发送问候语
参数: 无
返回值: 无
类型: 主进程监听
状态: 不可用 (无响应)

Additional Scene相关IPC消息

`asset-db:asset-changed`

用途: 资源变更处理
参数: 变更详情
返回值: 无
类型: 广播事件
状态: 可用

`asset-db:assets-moved`

用途: 资源移动处理
参数: 移动详情数组
返回值: 无
类型: 广播事件
状态: 可用

`asset-db:assets-created`

用途: 资源创建处理
参数: 创建详情数组
返回值: 无
类型: 广播事件
状态: 可用

`asset-db:assets-deleted`

用途: 资源删除处理
参数: 删除详情数组
返回值: 无
类型: 广播事件
状态: 可用

`editor:ready`

用途: 编辑器就绪通知
参数: 无
返回值: 无
类型: 广播事件
状态: 未测试

`editor:console-failed`

用途: 控制台失败消息
参数: 失败信息
返回值: 无
类型: 广播事件
状态: 未测试

`editor:console-warn`

用途: 控制台警告消息
参数: 警告信息
返回值: 无
类型: 广播事件
状态: 未测试

`editor:console-error`

用途: 控制台错误消息
参数: 错误信息
返回值: 无
类型: 广播事件
状态: 未测试

`editor:console-clear`

用途: 清空控制台
参数: 无
返回值: 无
类型: 广播事件
状态: 未测试

`compiler:state-changed`

用途: 编译器状态变化
参数: 状态
返回值: 无
类型: 广播事件
状态: 未测试

`preview-server:preview-port-changed`

用途: 预览服务器端口变化
参数: 无
返回值: 无
类型: 广播事件
状态: 未测试

`preview-server:connects-changed`

用途: 预览服务器连接数变化
参数: 连接数
返回值: 无
类型: 广播事件
状态: 未测试

`im-plugin:update-im-html`

用途: 更新IM插件HTML
参数: HTML内容
返回值: 无
类型: 广播事件
状态: 未测试

`asset-db:state-changed`

用途: 资源数据库状态变化
参数: 状态
返回值: 无
类型: 广播事件
状态: 未测试

`asset-db:watch-state-changed`

用途: 资源数据库监听状态变化
参数: 状态
返回值: 无
类型: 广播事件
状态: 未测试

`editor:online-status-changed`

用途: 编辑器在线状态变化
参数: 状态 ('online' 或 'offline')
返回值: 无
类型: 广播事件
状态: 未测试

`scene:node-component-updated`

用途: 节点组件更新
参数: 包含节点、组件和属性信息的对象
返回值: 无
类型: 广播事件
状态: 未测试

`scene:node-component-added`

用途: 节点组件添加
参数: 包含节点和组件信息的对象
返回值: 无
类型: 广播事件
状态: 未测试

`scene:node-component-removed`

用途: 节点组件移除
参数: 包含节点和组件信息的对象
返回值: 无
类型: 广播事件
状态: 未测试

广播事件

以下是专门用于广播给渲染进程的事件，通常由主进程发出，渲染进程接收：

scene:saved
scene:play-on-device
scene:reload-on-device
asset-db:asset-changed
asset-db:assets-moved
asset-db:assets-created
asset-db:assets-deleted
editor:ready
editor:console-failed
editor:console-warn
editor:console-error
editor:console-clear
compiler:state-changed
preview-server:preview-port-changed
preview-server:connects-changed
im-plugin:update-im-html
asset-db:state-changed
asset-db:watch-state-changed
editor:online-status-changed
scene:node-component-updated
scene:node-component-added
scene:node-component-removed
package-template:hello

渲染进程监听的事件

以下是渲染进程主动监听的事件，这些事件通常由主进程发出：

asset-db:assets-moved
asset-db:assets-deleted
asset-db:assets-created
compiler:state-changed
preview-server:preview-port-changed
preview-server:connects-changed
im-plugin:update-im-html
asset-db:state-changed
asset-db:watch-state-changed
editor:console-failed
editor:console-warn
editor:console-error
editor:console-clear

33 KiB Raw Blame History Unescape Escape

Cocos Creator 2.4.12 IPC Messages Documentation

目录

App相关IPC消息

app:explore-project

app:explore-app

app:build-project

app:query-cocos-templates

app:query-android-apilevels

app:query-android-instant-apilevels

app:compile-project

app:open-cocos-console-log

app:stop-compile

app:run-project

app:save-keystore

app:update-build-preview-path

app:update-android-instant-preview-path

app:play-on-device

app:reload-on-device

app:query-plugin-scripts

app:rebuild-editor-engine

Asset-DB相关IPC消息

asset-db:explore

asset-db:exists

asset-db:query-path-by-url

asset-db:query-uuid-by-url

asset-db:query-path-by-uuid

asset-db:query-url-by-uuid

asset-db:query-info-by-uuid

asset-db:query-meta-info-by-uuid

asset-db:deep-query

asset-db:query-assets

asset-db:query-mounts

asset-db:import-assets

asset-db:create-asset

asset-db:move-asset

asset-db:delete-assets

asset-db:save-exists

asset-db:create-or-save

asset-db:save-meta

asset-db:refresh

asset-db:attach-mountpath

asset-db:unattach-mountpath

asset-db:query-watch-state

asset-db:asset-changed

asset-db:asset-uuid-changed

asset-db:assets-moved

asset-db:assets-created

asset-db:assets-deleted

asset-db:script-import-failed

asset-db:meta-backup

Dashboard相关IPC消息

app:query-recent

app:query-templates

app:create-project

app:open-project

app:delete-project

app:close-project

app:window-minimize

app:window-close

app:get-last-create

app:open-manual-doc

app:open-api-doc

app:query-last-create-path

Scene相关IPC消息

scene:is-ready

scene:new-scene

scene:saved

scene:play-on-device

scene:reload-on-device

scene:preview-server-scene-stashed

scene:load-package-scene-script

scene:unload-package-scene-script

scene:soft-reload

scene:enter-prefab-edit-mode

scene:stash-and-save

scene:print-simulator-log

scene:generate-texture-packer-preview-files

scene:query-texture-packer-preview-files

scene:export-particle-plist

33 KiB

Raw Blame History

`app:explore-project`

`app:explore-app`

`app:build-project`

`app:query-cocos-templates`

`app:query-android-apilevels`

`app:query-android-instant-apilevels`

`app:compile-project`

`app:open-cocos-console-log`

`app:stop-compile`

`app:run-project`

`app:save-keystore`

`app:update-build-preview-path`

`app:update-android-instant-preview-path`

`app:play-on-device`

`app:reload-on-device`

`app:query-plugin-scripts`

`app:rebuild-editor-engine`

`asset-db:explore`

`asset-db:exists`

`asset-db:query-path-by-url`

`asset-db:query-uuid-by-url`

`asset-db:query-path-by-uuid`

`asset-db:query-url-by-uuid`

`asset-db:query-info-by-uuid`

`asset-db:query-meta-info-by-uuid`

`asset-db:deep-query`

`asset-db:query-assets`

`asset-db:query-mounts`

`asset-db:import-assets`

`asset-db:create-asset`

`asset-db:move-asset`

`asset-db:delete-assets`

`asset-db:save-exists`

`asset-db:create-or-save`

`asset-db:save-meta`

`asset-db:refresh`

`asset-db:attach-mountpath`

`asset-db:unattach-mountpath`

`asset-db:query-watch-state`

`asset-db:asset-changed`

`asset-db:asset-uuid-changed`

`asset-db:assets-moved`

`asset-db:assets-created`

`asset-db:assets-deleted`

`asset-db:script-import-failed`

`asset-db:meta-backup`

`app:query-recent`

`app:query-templates`

`app:create-project`

`app:open-project`

`app:delete-project`

`app:close-project`

`app:window-minimize`

`app:window-close`

`app:get-last-create`

`app:open-manual-doc`

`app:open-api-doc`

`app:query-last-create-path`

`scene:is-ready`

`scene:new-scene`

`scene:saved`

`scene:play-on-device`

`scene:reload-on-device`

`scene:preview-server-scene-stashed`

`scene:load-package-scene-script`

`scene:unload-package-scene-script`

`scene:soft-reload`

`scene:enter-prefab-edit-mode`

`scene:stash-and-save`

`scene:print-simulator-log`

`scene:generate-texture-packer-preview-files`

`scene:query-texture-packer-preview-files`

`scene:export-particle-plist`

`scene:update-edit-mode`

`scene:undo`

`scene:redo`

`scene:undo-record`

`scene:undo-commit`

`scene:undo-cancel`