[UE4] プレビュー版SpriteStudioプラグイン　Blueprintリファレンス

プレビュー版 SpriteStudio5 Player for UE4 プラグインの使い方解説です。

本プラグインの紹介ページはコチラ、SpriteStudioエディタの入手はコチラ、UE4プラグインの入手はコチラからになります。

今回は、SsPlayerコンポーネントから呼び出せる、各種Blueprintノードの意味を解説します。

Play / Play by Name

アニメーションの再生を開始します。

Play はインデックス，Play by Name は名前でアニメーションを指定します。

ループ回数を0に設定すると無限ループです。往復再生(Round Trip = true)の場合、片道で１回とカウントされます。

ループ回数を終了したアニメーションは、最終フレームの状態で停止します。

Is Playing

現在、アニメーションが再生中かどうかを取得します。

Pause / Resume

現在のアニメーション状態を保持したまま、一時停止/再開を行います。

Set Play Frame / Get Play Frame

アニメーションの現在フレームの設定と取得です。

Set Play Frame では特定のフレームへジャンプ出来ます。

Set Play Rate / Get Play Rate

アニメーションの再生速度の設定と取得です。

1.0で等速、0.0で停止、負の値を指定すると逆再生となります。

Set Loop Count / Get Loop Count

アニメーションのループ回数の設定と取得です。

取得出来る値は、再生時に設定した値ではなく、現在の残りループ回数です。

Set Round Trip / Is Round Trip

往復再生状態の設定と取得です。

Set Flip H / Set Flip V / Get Flip H / Get Flip V

上下反転，左右反転それぞれの、設定と取得です。

Get Num Anim Packs / Get Num Animations

SsPlayerに設定されたSSPJアセットに含まれるアニメーションの数を取得します。

Update Player

通常は呼び出す必要はありません。

コンポーネントの Auto Update を OFF にした場合は、この関数を呼び出してアニメーションを更新します。

Add Texture Replacement / Add Texture Replacement by Name

インデックスか名前のどちらかでパーツを指定して、描画に使用されるテクスチャの差し替えを登録します。

Remove Texture Replacement / Remove Texture Replacement by Name / Remove Texture Replacement All

テクスチャ差し替え登録を解除します。

Allでは全てのパーツに対して実行されます。

Add Attach Component / Add Attach Component by Name

指定したパーツに対して、指定したコンポーネントをアタッチします。

アタッチされたコンポーネントは、指定されたパーツの変換に追従するようになります。

この機能を使用する場合、SsPlayerコンポーネントとアタッチ先コンポーネントは兄弟にし、それぞれのTransformはデフォルトの状態にして下さい。

オフセット付きでのアタッチを行いたい場合は、Sceneコンポーネントをアタッチ先とし、そのSceneコンポーネントの子として目的のコンポーネントを登録して下さい。

Attach Components

アタッチされたコンポーネントへの参照はArray型でBlueprintに公開されています。

アタッチを解除する場合は、直接このArrayを操作して下さい。

Get Part Transform in Auto Draw Mesh

通常は使用しません。アタッチ機能で内部的に使用している関数を公開しています。

指定したパーツの、Actorローカル座標系での変換を取得します。

OnSsEndPlay

再生終了時に呼び出されるイベントです。

OnSsUserData

SpriteStudioのアニメーションデータのUserDataキーが再生された際に呼び出されるイベントです。

UserData構造体をBreakすることで、個別のデータにアクセス出来ます。