渲染脚本

简介

Cavalry 可以执行脚本：

• 用于设置渲染队列项目。
• 在渲染队列项目执行的每次渲染之前。
• 在渲染队列项目执行的每次渲染之后。

以下 API 都在 render 命名空间中。它们仅在渲染队列项目中可用。可以在渲染管理器中的渲染队列项目的脚本选项卡上将脚本添加到相应的编辑器中。

使用动态渲染时，动态索引可以通过 api.getDynamicIndex() 成员访问。

任何 JavaScript 执行都将阻止后续渲染，直到脚本运行完成。这是有意为之，以便在任何下载/替换资源或以某种方式更改场景的过程完成后，再开始下一次渲染。

脚本在整个序列渲染之前和之后执行，而不是在每张单独图像之前和之后执行。

类型

设置渲染脚本

添加在任何渲染设置开始之前运行的脚本，因此可用于影响渲染队列项目本身。

预渲染脚本

添加可用于操作和准备场景进行渲染的脚本。

后渲染脚本

添加在渲染队列项目完成后运行的脚本。

脚本可以包括使用 JavaScript API 执行诸如修改属性、从网络拉取新信息、替换和重新加载资源等任务。

成员函数

composition → string

返回渲染队列项目中每个合成画面的 layerId。作为预渲染和后渲染脚本的一部分可用。

console.log(render.composition);

path → string

返回渲染的文件路径——任何动态令牌/路径都已完全解析。作为后渲染脚本的一部分可用。

console.log(render.path);

renderQueueItem → string

返回 renderQueueItemId 以便对其进行更改。作为设置渲染脚本的一部分可用。

console.log(render.renderQueueItem);