■BluePrintリファレンス

このページは、SsPlayerコンポーネント/ウィジェットの、BluePrint関数リファレンスです。

SpriteStudioプラグインについてはコチラ、SpriteStudio本体についてはコチラをご覧下さい。

 

Play / Play by Index

アニメーションの再生を行います。

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

この引数で設定した各項目は、再生開始後にも変更が可能です。

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

 

Get Playing Animation Name / Get Playing Animation Index

現在再生中の アニメーション名 / インデックス を取得します。

 

Pause / Resume

各種設定を維持したまま、アニメーションを 一時停止/再開 します。

 

Is Playing

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

 

Get Num Anim Packs / Get Num Animations / Get Num Animations by Index

セットされているSsProjectアセットに含まれているアニメーション数を取得します。

 

Get Play Frame / Set Play Frame

現在のフレームを 取得 / 設定 します。

 

Get Loop Count / Set Loop Count

残りループ数を 取得 / 設定 します。

０以下の値では無限ループとなります。

 

Is Round Trip / Set Round Trip

往復再生するかどうかを 取得 / 設定 します。

往復再生中のループ回数は、片道で１回とカウントされます。

 

Get Play Rate / Set Play Rate

再生速度を 取得 / 設定 します。

1.0 で通常再生です。マイナスの値で逆再生になります。

 

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

水平/垂直反転状態を 取得 / 設定 します。

Hが水平、Vが垂直です。

 

Add Texture Replacement / Add Texture Replacement by Index

特定のパーツに対して、テクスチャの入れ替え登録を行います。

 

Remove Texture Replacement / Remove Texture Replacement by Index /

Remove Texture Replacement All

パーツに対するテクスチャ入れ替え登録を解除します。

 

Update Player

１フレーム分のアニメーションの更新を行います。

プロパティの「Auto Update」をOFFにした場合に使用します。

 

Get Render Target

描画モードが OffScreenPlane か OffScreenOnly の場合に、レンダーターゲットテクスチャを取得します。

 

Get Part Color Label / Get Part Color Label by Index

指定したパーツのカラーラベルを取得します。
※ カラーラベルはSpriteStudio5.6.0で追加された機能です。
※ この機能は「v1.1.0_UE4.10_SS5.6.0」以降で使用可能です。

 

On Ss End Play

アニメーションの再生終了時に呼び出されるイベントです。

 

On Ss User Data

アニメーションに設定されたユーザーデータのキーフレームが再生された際に呼び出されるイベントです。

User Data 構造体を Break すると、個々の要素にアクセス出来ます。

 

SpawnSsPlayerAtLocation / SpawnSsPlayerAtLocationByIndex

指定したアニメーションをセットしたSsPlayerActorを生成し、アニメーションを単発再生します。主にエフェクト等の用途での使用を想定しています。

static関数のため、LevelBluePrint等からの呼び出しが可能です。

AutoDestroyをOFFにした場合は、使用者側でActorの寿命を管理する必要があります。

戻り値はSsPlayerActorへの参照です。再生開始後に直接操作することも可能です。

 

---

目次

■チュートリアル　：本プラグインを新規に導入される方は、まずはこちらのチュートリアル記事をご覧下さい
・自分のプロジェクトへの導入方法
・SSPJファイルのインポート方法
・BluePrintからの使用方法
　・HUDでの使用方法 UMG / Canvas

■機能リファレンス　：BluePrintの機能リファレンスは、下記のページをご覧下さい
・プロパティリファレンス
・BluePrintリファレンス

■TIPSなど
・TIPS & 制限事項
・パッケージ作成手順

■SpriteStudio本体について
ウェブテクノロジ様の公式ページをご参照ください
http://www.webtech.co.jp/spritestudio/