SS6Player for UE4 – Component / Widget プロパティリファレンス

SS6Player for UE4のコンポーネント及びウィジェットのプロパティ一覧です。
Detailsウィンドウ上で、カテゴリが３つに分かれていますので注意して下さい。

SS6Player for UE4の使い方などは下記ページをご覧ください。

プロパティリファレンス

SsPlayerComponent

Sprite Studio Asset

Ss Project プロジェクトにインポートされている中から
再生するSsProjectアセットを設定します。

Sprite Studio Play Settings

Auto update 自動的にアニメーションを更新します。通常はONのまま変更する必要はありません。
特殊な用途で、更新タイミングを完全に制御したい場合はOFFにして下さい。
Auto Play 自動的にアニメーションを再生開始します。通常はONのまま変更する必要はありません。
OFFにした場合は、自分で再生開始関数を呼び出す必要があります。
Auto Play Anim Pack Name 自動再生する際のアニメパック名です。ssaeの名称で指定します。
Auto Play Anim Pack Index と連動しているので、どちらから指定しても構いません。
Auto Play Animation Name 自動再生する際のアニメーション名です。アニメーションデータ名で指定します。
Auto Play Animation Indexと連動しているので、どちらから指定しても構いません。
Auto Play Anim Pack Index 自動再生する際のアニメパックインデックスです。
Auto Play Anim Pack Name と連動しているので、どちらから指定しても構いません。
Auto Play Animation Index 自動再生する際のアニメーションインデックスです。
Auto Play Animation Name と連動しているので、どちらから指定しても構いません。
Auto Play Start Frame 自動再生する際のアニメーションの開始フレームです。
Auto Play Rate 自動再生する際のアニメーションの再生速度です。
マイナスの値を設定すると、逆再生します。
Auto Play Loop Count 自動再生する際のアニメーションのループ回数です。
0を指定すると無限ループになります。
Auto Play Round Trip ONにすると、自動再生の際に往復再生となります。
Auto Play Flip H ONにすると、自動再生の際に水平方向に反転します。
Auto Play Flip V ONにすると、自動再生の際に垂直方向に反転します。

Sprite Studio Render Settings

Render Mode

描画モードを設定します。

Render Mode

Default

デフォルトの描画モードです。通常はこのモードを使用して下さい。
パーツ毎のポリゴンを、3D空間上に直接描画します。最も高速で、機能制限もありません。

OffScreenPlane

一旦オフスクリーンレンダリングし、そのレンダーターゲットを板ポリに貼り付けて描画します。

オフスクリーンレンダリングを行うため、アルファブレンドモードの Mul/Add/Sub には対応していません。全て Mix として描画されます。

制限があるうえにDefaultに比べて処理が重くなってしまいますが、板ポリに貼り付ける際のマテリアルをカスタムすることが出来るため、UE4のマテリアルを利用した特殊なエフェクトを実装することが出来ます。

OffScreenOnly

レンダーターゲットに対するオフスクリーンレンダリングだけを行います。そのため、これ単独では画面には何も描画されません。

GetRenderTarget関数で、レンダーターゲットテクスチャを取得出来ます。

MaterialInstanceDynamicを利用して独自のモデルに貼り付けるなど、特殊な用途に利用するための描画モードです。

Canvas

HUDのCanvasにレンダリングするための描画モードです。
3D空間上には何も描画されません。SsHUD を継承したHUDクラスでの描画にのみ使用されます。
アルファ値はテクスチャのアルファのみ反映されます。
アルファブレンドモード/カラーブレンドモードは反映されません。
Base Material

描画モードが OffScreenPlane の際に、板ポリに貼り付ける際に使用されるマテリアルです。

デフォルトではプラグイン内で用意されたマテリアルが設定されていますが、これを変更することで特殊なエフェクトを実装出来ます。
Off Screen Render Resolution 描画モードが OffScreenPlane もしくは OffScreenOnly の場合に確保される、レンダーターゲットの解像度を指定します。
UU Per Pixel  UnrealUnit / Pixel
アニメーションのキャンバスサイズに対する、3D空間上のサイズを決める係数です。
1.0 のとき、1024×1024 のアニメーションが 1024[UU] = 1024[cm] で描画される、ということになります。
Ss Bounds Scale  描画モードが Default の際のカリング範囲のスケールです。
アニメーションのキャンバスサイズの範囲を超えるパーツが存在する場合、それを覆えるサイズに設定しておく必要があります。

SsPlayerWidget

Sprite Studio Asset

Ss Project プロジェクトにインポートされている中から
再生するSsProjectアセットを設定します。

Sprite Studio Play Settings

Auto update 自動的にアニメーションを更新します。通常はONのまま変更する必要はありません。
特殊な用途で、更新タイミングを完全に制御したい場合はOFFにして下さい。
Auto Play 自動的にアニメーションを再生開始します。通常はONのまま変更する必要はありません。
OFFにした場合は、自分で再生開始関数を呼び出す必要があります。
Auto Play Anim Pack Name 自動再生する際のアニメパック名です。ssaeの名称で指定します。
Auto Play Anim Pack Index と連動しているので、どちらから指定しても構いません。
Auto Play Animation Name 自動再生する際のアニメーション名です。アニメーションデータ名で指定します。
Auto Play Animation Indexと連動しているので、どちらから指定しても構いません。
Auto Play Anim Pack Index 自動再生する際のアニメパックインデックスです。
Auto Play Anim Pack Name と連動しているので、どちらから指定しても構いません。
Auto Play Animation Index 自動再生する際のアニメーションインデックスです。
Auto Play Animation Name と連動しているので、どちらから指定しても構いません。
Auto Play Start Frame 自動再生する際のアニメーションの開始フレームです。
Auto Play Rate 自動再生する際のアニメーションの再生速度です。
マイナスの値を設定すると、逆再生します。
Auto Play Loop Count 自動再生する際のアニメーションのループ回数です。
0を指定すると無限ループになります。
Auto Play Round Trip ONにすると、自動再生の際に往復再生となります。
Dont Update if Hidden ウィジェットが非表示のときはアニメーションを再生しない
Tickable when Paused Pause中でもTickする

Sprite Studio Render Settings

Render Mode

描画モードを設定します。

Render Mode

UMG_Default

UMGで使用する際のデフォルトの描画モードです。
アルファブレンドモードはMixのみとなります。

UMG_OffScreen

UMGで使用する際のオフスクリーンレンダリング用の描画モードです。
機能制限は、OffScreenPlane/OffScreenOnlyと同様です。
Base Material

描画モードが UMG_OffScreen の際に、板ポリに貼り付ける際に使用されるマテリアルです。

デフォルトではプラグイン内で用意されたマテリアルが設定されていますが、これを変更することで特殊なエフェクトを実装出来ます。
Off Screen Render Resolution 描画モードが UMG_OffScreen の場合に確保される、レンダーターゲットの解像度を指定します。
Reflect Parent Alpha 親Widgetのアルファ値を反映するかを選択します。

関連ページ

SS6Player For UnrealEngine4
最新版、質問・要望は GitHubへ

Published : Edit : OPTPiX User Support