插件脚本

在 资源管理器 中选中任意一个脚本，就能在 属性检查器 中看到这样一个设置界面，我们可以在这里设置脚本是否 “导入为插件”。

• 对组件脚本，数据逻辑而言，一般默认都取消这个选项，这样的脚本简称 普通脚本。
• 对第三方插件，或者底层插件，就有可能需要选中选项，这样的脚本简称 插件脚本。

这个选项只和脚本有关，具体影响有几个方面，一般简单了解即可：

注意： 普通脚本我们鼓励使用 TypeScript，而插件脚本由于不会被编译，所以需要使用目标平台可以直接运行的 JavaScript。

require 不推荐使用，但是也可以使用。在ES6中应使用import。

勾选“导入为插件”后，还能够进一步在 属性检查器 设置这个插件脚本什么时候才会生效：

脚本加载顺序

脚本加载顺序如下：

1. Cocos Creator 3D 引擎
2. 插件脚本（有多个的话按项目中的路径字母顺序依次加载）
3. 普通脚本（打包后只有一个文件，内部按 import 的依赖顺序依次初始化）

目标平台兼容性

插件发布后将直接被目标平台加载，所以请检查插件的目标平台兼容性，否则项目发布后插件有可能不能运行。

• 目标平台不提供原生 node.js 支持
  例如很多 npm 模块都直接或间接依赖于 node.js，这样的话发布到原生或网页平台后是不能用的。
• 依赖 DOM API 的插件将无法发布到原生平台
  网页中可以使用大量的前端插件，例如 jQuery，不过它们有可能依赖于浏览器的 DOM API。依赖这些 API 的插件不能用于原生平台中。

注意事项

• 如果插件包含了多个脚本，则需要把插件用到的所有脚本合并为单个的 js 文件
  以 Async（https://github.com/caolan/async）为例，这个库包含了非常多的零散的源文件，如果把所有源文件都放到项目里，则每个源文件都要设置一次“导入为插件”，并且 Creator 3D无法保证这些源文件之间的加载顺序，很容易报错。所以我们要找到插件作者提供的预编译好的单个脚本，例如 async.js 或 async.min.js，这样的文件可以直接用浏览器加载运行，不需要做额外的编译操作，一般可以直接放入 Creator 3D中使用。如果插件作者没提供打包好的版本，通常也会在文档中说明如何编译出浏览器可执行的脚本，照着操作就行。

• 如果插件还依赖于其它插件，也需要把多个插件合并为单个 js 文件
  以 protobuf.js 为例，这个库还依赖于 bytebuffer.js，但是插件作者并没有提供整合好的独立运行版本。我们可以先下载到这两个库各自编译后的两个文件 protobuf.js 和 bytebuffer.js，然后使用文本编辑器或类似 cat 这样的命令行工具将这两个脚本拼合成一个新的脚本 protobuf_all.js。然后就能在 Creator 3D中直接使用这个 protobuf_all.js 了。

• 不支持插件主动加载其它脚本
  以 lzma 插件为例，这个插件默认提供的 lzma.js 脚本会通过浏览器的 Worker 加载另一个工作者脚本，目前 Creator 3D不支持这样的额外加载。解决方式是 单独使用 lzma_worker.js 就好。其它像是内部采用 document.createElement("script") 自行加载依赖项的插件，也需要做类似处理才能导入 Creator3D。

全局变量

由于所有插件脚本都保证了会在普通脚本之前加载，那么除了用来加载插件，你还可以利用这个特性声明一些特殊的全局变量。你可以在项目中添加这样一个脚本，并且设置“导入为插件”：

/* globals.js */

// 定义新建组件的默认值
window.DEFAULT_IP = "192.168.1.1";

// 定义组件开关
window.ENABLE_NET_DEBUGGER = true;

// 定义引擎 API 缩写（仅适用于构造函数）
window.V3 = Vec3;

接下来你就能在任意的 普通 脚本中直接使用它们，像是在声明类型的同时使用 DEFAULT_IP 等全局变量：

/* network.js */

import { _decorator, Component, Node } from "cc";
const { ccclass, property } = _decorator;

@ccclass("network")
export class network extends Component {

    @property()
    private id = window.DEFAULT_IP;

}

/* network_debugger.js */

if(window.ENABLE_NET_DEBUGGER){
class Debugger extends cc.Component{
    @property()
    private id = new Vec3(100,200,300);
    update (deltaTime: number) {
        // Your update function goes here.
    }
}
}
else{
    class Debugger extends cc.Component{
        start(){
            this.node.destroy();
        }
    }
}

在这个案例中，由于 network.js 和 network_debugger.js 等脚本加载时就已经用到了 globals.js 的变量。如果 globals.js 不是插件脚本，则每个可能用到那些全局变量的脚本都要在最上面声明 require("globals");，才能保证 globals.js 先加载。

但假如一个全局变量本身就是要在组件 onLoad 时才能初始化，那么建议直接在普通脚本的 onLoad 里直接使用 window.foo = bar 来声明全局变量，不需要使用插件脚本。

请注意：游戏脱离编辑器运行时，插件脚本将直接运行在全局作用域，脚本内不在任何函数内的局部变量都会暴露成全局变量，请小心因此引发的全局变量污染。

你应当很谨慎地使用全局变量，当你要用全局变量时，应该很清楚自己在做什么，我们并不推荐滥用全局变量，即使要用也最好保证全局变量只读。
添加全局变量时，请小心不要和系统已有的全局变量重名。
你可以在插件脚本中自由封装或者扩展 Cocos Creator 3D引擎，但这会提高团队沟通成本，导致脚本难以复用。

返回 脚本开发。