语言支持

JavaScript

语言特性

Creator 3D 支持的 JavaScript 语言规范为 ES6。

此外,以下几项更新于 ES6 规范的语言特性或提案仍旧在支持之列:

以下语言特性同样支持,但需要开启相关的编译选项:

特别地,Creator 3D 目前支持 “Legacy” 装饰器提案,其用法和含义见 babel-plugin-proposal-decorators。 由于该 提案 仍处于 阶段2, 引擎暴露的所有装饰器相关功能接口都在以下划线开头的 _decorator 命名空间下。

运行环境

从用户的角度来说,Creator 3D 未绑定任何 JavaScript 实现。因此,Creator 3D 建议开发者严格依照 JavaScript 规范编写脚本,以获取更好的跨平台支持。

举例来说,当希望使用全局对象时,应当使用标准特性 globalThis

globalThis.blahBlah // 任何环境下 globalThis 一定存在

而非 windowglobalselfthis

typeof window // 可能是 'undefined'
typeof global // 在浏览器环境下可能是 'undefined'

再如,Creator 3D 未提供 CommonJS 的模块系统,因此以下代码片段将带来问题:

const blah = require('./blah-blah'); // 错误:`require` 是未定义的
module.exports = blah; // 错误:`module` 是未定义的

反之,应使用标准模块语法:

import blah from './blah-blah';
export default blah;

TypeScript

Creator 3D 使用 babel 而非 tsc 编译 TypeScript 脚本。 特别地,使用了 @babel/plugin-transform-typescript 插件。基于此原因,TypeScript 的支持存在某些限制,以下列举出了一些重要的注意事项, 关于完整的说明,见 @babel/plugin-transform-typescript

  • tsconfig.json 不会被读取;
  • 隐含着 isolatedModules 选项,这意味着:
    • 不支持 const enums
    • 导出声明中不应该导出 TypeScript 类型和接口。
  • 不支持 export =import =
  • 命名空间导出的变量必须声明为 const 而非 varlet
  • 同一命名空间的不同声明不会共享作用域,需要显式使用限定符。

编译时不会读取 tsconfig.json 意味着 tsconfig.json 的编译选项并不影响编译, 但存在例外,见 模块解析

你仍然可以在项目中使用 tsconfig.json 以配合 IDE 实现类型检查等功能。 为了使得 IDE 的 TypeScript 检查功能 和 Creator 3D 行为兼容, 你需要额外注意一些事项,见 tsconfig

模块解析

Creator 3D 使用 NodeJS 模块解析算法。 等价于如下的 tsconfig.json

{"compilerOptions": {
    "moduleResolution": "node"
}}

Typescript 的路径映射功能也受支持。 以下 tsconfig.json 选项将被读取并保持和 tsc 相同的语义:

results matching ""

    No results matching ""