脚本编程

脚本是 PlayCanvas 交互功能的核心。它们是可以复用的代码，附加到实体后，可以定义行为、处理用户输入、管理游戏逻辑，让项目真正运行起来。

使用编辑器？

如果你使用 PlayCanvas Editor，请阅读编辑器脚本编程，了解脚本管理、代码编辑器、VS Code 集成和热重载。

两套脚本系统

PlayCanvas 支持两种脚本编写方式：

• ESM 脚本（.mjs 文件）：基于现代 ES 模块，使用类语法。推荐新项目使用。
• 经典脚本（.js 文件）：PlayCanvas 最初的脚本系统，使用基于原型的语法。

两套系统可以在同一项目中共存，方便逐步迁移，或根据需求选择合适的方式。

简单示例

下面的简单脚本可以让实体旋转：

ESM（推荐）

import { Script } from 'playcanvas';

export class Rotate extends Script {
    static scriptName = 'rotate';

    /** @attribute */
    speed = 10;

    update(dt) {
        this.entity.rotate(0, this.speed * dt, 0);
    }
}

经典脚本

var Rotate = pc.createScript('rotate');

Rotate.attributes.add('speed', { type: 'number', default: 10 });

Rotate.prototype.update = function(dt) {
    this.entity.rotate(0, this.speed * dt, 0);
};

本节内容

• 快速入门：基本脚本结构和语法。
• ESM 脚本：使用 ES 模块进行现代脚本开发。
• 脚本生命周期：脚本方法的调用时机与方式。
• 应用生命周期：理解应用初始化和逐帧更新。
• 脚本属性：暴露可配置的属性。
• 引擎 API：关键类和常见用法。
• 事件：脚本之间的通信。
• 调试：排查问题的工具和方法。
• 迁移指南：从经典脚本升级到 ESM 脚本。