スクリプトリファレンス（[RootEffect]アニメーション）

SS6Player for Unity（以降「SS6PU」）のエフェクト制御用クラス（Script_SpriteStudio6_RootEffect）のアニメーション管理関係の機能群のスクリプトリファレンスです。

---

アニメーション再生の開始

関数（動的）

bool AnimationPlay(
        int timesPlay=-1,
        float rateTime=float.NaN,
        int framePerSecond=0
    )

引数

• timesPlay : 再生回数
• rateTime : 再生速度
• framePerSecond : 再生FPS（※常に本引数は省略してください）

返値

true ... 成功
false ... 失敗（エラー）

解説

エフェクトのアニメーションを再生開始します。
引数の省略記載設定値（引数の後ろに=で書かれている値）は「直前に再生した時の設定のまま」を意味します。

timesPlayは「再生回数」で、1を指定するとループしない・0を指定すると無限ループ指定となります。
指定された再生回数を再生終了すると、再生終了時のコールバックが行われます。

rateTimeは再生速度の係数（倍率）で、2.0fなら倍速、0.5fなら半分速になります。 また、本値に負数を設定すると逆再生を行います。

framePerSecondは再生時の基準FPSを設定できますが、常に省略してください（主に親アニメーションからエフェクトパーツで呼び出す際の内部制御のために設置されている引数です。この引数は予告なく削除される可能性があります）。

本関数は再生できないようなパラメータを与えられた場合にエラーを返します。

---

アニメーション再生の停止

関数（動的）

void AnimationStop(bool flagJumpEnd = false)

引数

• flagJumpEnd : 停止後のマスタトラックフレームの扱い

返値

（なし）

解説

エフェクトのアニメーション再生を停止します。

flagJumpEndは、「true時はフレームを終端にジャンプさせる」「false時は停止時点フレームのまま」の動作となります。

本値の指定でフレームを終端にジャンプさせた場合、再生完了のコールバックは行われません。

本関数で再生を停止した場合、停止した状態から再度再生復帰することはできません（そのような停止の場合、原則としてAnimationPauseを使用してください）。

---

アニメーション再生の一時停止

関数（動的）

bool AnimationPause(bool flagSwitch)

引数

• flagSwitch : 一時停止状態

返値

true ... 成功
false ... 失敗（エラー）

解説

エフェクトのアニメーション再生を一時停止します。

flagSwitchは、「true時は一時停止」「false時は一時停止解除」の動作となります。