レンダースクリプト

概要

Cavalry は以下のタイミングでスクリプトを実行できます：

• レンダーキューアイテムのセットアップ時。
• レンダーキューアイテムによる各レンダリングの前。
• レンダーキューアイテムによる各レンダリングの後。

以下の API はすべて render 名前空間にあります。これらはレンダーキューアイテムでののみ利用可能です。レンダーマネージャーのレンダーキューアイテムのスクリプトタブで、対応するエディターにスクリプトを追加できます。

動的レンダリングを使用する場合、動的インデックスは api.getDynamicIndex() メンバーでアクセスできます。

JavaScript の実行は、スクリプトが完了するまで後続のレンダリングをブロックします。これは、アセットのダウンロード/置換やシーンの変更などのプロセスが完了してから次のレンダリングを開始するための意図的な設計です。

スクリプトはシーケンス全体のレンダリング前後に実行され、個々の画像の前後ではありません。

タイプ

セットアップレンダースクリプト

レンダーセットアップが始まる前に実行されるスクリプトで、レンダーキューアイテム自体に影響を与えるために使用できます。

プレレンダースクリプト

レンダリング用のシーンを操作・準備するために使用できるスクリプト。

ポストレンダースクリプト

レンダーキューアイテムが完了したときに実行されるスクリプト。

スクリプトでは、JavaScript API を使用して属性の変更、Web からの新情報の取得、アセットの置換や再読み込みなどのタスクを実行できます。

メンバー関数

composition → string

レンダーキューアイテム内の各コンポジションの layerId を返します。プレレンダーおよびポストレンダースクリプトの一部として利用可能。

console.log(render.composition);

path → string

レンダーのファイルパスを返します — 動的トークン/パスは完全に解決されています。ポストレンダースクリプトの一部として利用可能。

console.log(render.path);

renderQueueItem → string

変更を加えるための renderQueueItemId を返します。セットアップレンダースクリプトの一部として利用可能。

console.log(render.renderQueueItem);