模块规范与示例

所有的代码文件可以大致分为 插件脚本模块 两种,该部分内容主要介绍模块相关。

模块 是 TypeScript/JavaScript 代码的一种组织方式,按照模块组织的代码一般又被非正式地称为 脚本/项目脚本。在 Cocos Creator 中,除 插件脚本 外所有代码都以模块的形式组织,根据来源的不同,大致分为:

  • 项目中创建的代码,包括 组件脚本项目类(非组件)脚本

  • 引擎提供的功能,详情请参考 引擎模块

  • 第三方模块,例如 npm 模块。详情请参考 外部模块使用案例

Cocos Creator 原生支持并推荐使用 ECMAScript 模块格式(简称 ESM 模块格式)。为了支持对外部模块的使用,Cocos Creator 也在某种限度上支持了 CommonJS 模块格式。关于 Creator 中模块的格式及使用,详情请参考 模块规范

从 Cocos Creator 3.3 开始,支持导入映射(实验性),详情请参考 导入映射

模块加载顺序

模块加载顺序如下:

  1. 首次导入 Cocos Creator 3.x 的 引擎模块 "cc"

  2. 插件脚本:所有插件脚本将按照指定的插件脚本依赖关系顺序执行,不存在依赖关系的插件脚本之间是无序的。详情可参考 插件脚本

  3. 普通脚本:所有普通脚本将被并发导入。导入时将严格遵循由 import 确定的引用关系和执行顺序。