跳到主要内容

运行时

运行时插件使你可以扩展场景和播放器等运行时组件。

首先创建入口点——一个导出我们插件的简单文件。目前,我们将其放在 Motion Canvas 项目的 src 目录中。如果你发现需要在多个项目中复用该插件,可以将其放入一个单独的包中。

要定义插件,我们将一个配置对象传递给 makePlugin 辅助函数并导出结果。 name 是唯一必需的属性。player 是一个可选的钩子,它会在 Player 实例创建完成后立即接收该实例。有关可用钩子的完整列表,请查看 Plugin 接口。

Project structure
project/
├── src/
│ ├── scenes/
│ │ └── example.tsx
+ │ ├── plugin.ts
│ └── project.ts
├── package.json
├── tsconfig.json
└── vite.config.ts
src/plugin.ts
import {makePlugin} from '@motion-canvas/core';

export default makePlugin({
name: 'motion-canvas-plugin-example',
player(player) {
player.onRecalculated.subscribe(() => {
player.requestReset();
player.togglePlayback(true);
});
},
});

在此示例中,我们订阅 onRecalculated 事件, 以便在该事件发生时从头播放动画。当我们在编辑器中或在代码中编辑动画时,都会发生 重新计算。

现在我们可以在项目文件中导入该插件。请注意,makePlugin 返回的是一个 函数,我们需要调用它来创建实际的插件对象(这在 开发 Node.js 插件时可能很有用):

src/project.ts
import {makeProject} from '@motion-canvas/core';
import myPlugin from './plugin';
import example from './scenes/example?scene';

export default makeProject({
scenes: [example],
plugins: [myPlugin()],
// ^^ we need to call the function
});

就这样!现在我们可以运行项目,查看插件的实际效果。有关可用钩子的完整列表,请查看 Plugin 接口。