■Component/Widgetプロパティリファレンス

このページは、SsPlayerコンポーネント及びウィジェットのプロパティ一覧です。

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

 

Detailsウィンドウ上で、カテゴリが３つに分かれていますので注意して下さい。

Sprite Studio Asset

Ss Project

再生するSsProjectアセットを設定します。

まず最初に、必ずココを設定しましょう。

 

Sprite Studio Play Settings

Auto update

自動的にアニメーションを更新します。通常はONのまま変更する必要はありません。

特殊な用途で、更新タイミングを完全に制御したい場合はOFFにして下さい。

Auto Play

自動的にアニメーションを再生開始します。通常はONのまま変更する必要はありません。

OFFにした場合は、自分で再生開始関数を呼び出す必要があります。

Auto Play Anim Pack Name / Auto Play Animation Name

自動再生する際のアニメーション名です。

インデックスと連動しているので、どちらから指定しても構いません。

Auto Play Anim Pack Index / Auto Play Animation Index

自動再生する際のアニメーションインデックスです。

アニメーション名と連動しているので、どちらから指定しても構いません。

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

描画モードを設定します。ウィジェットでは選択出来ず、専用のオフスクリーンレンダリングに固定されます。

Default (SsPlayerComponentのみ)

デフォルトの描画モードです。通常はこのモードを使用して下さい。

パーツ毎のポリゴンを、3D空間上に直接描画します。最も高速で、機能制限もありません。

OffScreenPlane (SsPlayerComponentのみ)

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

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

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

OffScreenOnly (SsPlayerComponentのみ)

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

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

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

Canvas (SsPlayerComponentのみ)

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

UMG_Default (SsPlayerWidgetのみ)

UMGで使用する際のデフォルトの描画モードです。

アルファブレンドモードはMixのみとなります。

UMG_OffScreen (SsPlayerWidgetのみ)

UMGで使用する際のオフスクリーンレンダリング用の描画モードです。

機能制限は、OffScreenPlane/OffScreenOnlyと同様です。

 

Base Material

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

デフォルトではプラグイン内で用意されたマテリアルが設定されていますが、これを変更することで特殊なエフェクトを実装出来ます。

Off Screen Render Resolution

描画モードが OffScreenPlane もしくは OffScreenOnly の場合に確保される、レンダーターゲットの解像度を指定します。

UU Per Pixel (SsPlayerComponentのみ)

UnrealUnit / Pixel

アニメーションのキャンバスサイズに対する、3D空間上のサイズを決める係数です。

1.0 のとき、1024×1024 のアニメーションが 1024[UU] = 1024[cm] で描画される、ということになります。

Ss Bounds Scale (SsPlayerComponentのみ)

描画モードが Default の際のカリング範囲のスケールです。

アニメーションのキャンバスサイズの範囲を超えるパーツが存在する場合、それを覆えるサイズに設定しておく必要があります。

Ignore Clip Rect (SsPlayerWidgetのみ)

ONにすると、描画基準枠外のパーツも描画します。

Ignore Child Clip Rect (SsPlayerWidgetのみ)

ONにすると、描画基準枠外にアタッチされた子ウィジェットをクリップしません。

 

---

目次

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

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

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

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