FlipbookAnimation Component

Textureをタイルとして分割し、コマを切り替えて描画します。

設定する手順

1. 行数と各列の定義を設定し、表示間隔とループを選びます。
2. SceneViewまたはGameViewで結果を確認します。
3. 編集中のSceneまたはPrefabを保存します。

項目の説明

項目	C#名	型	操作	定義時の初期値	意味
有効	Enabled	bool	読取・変更	true	このComponentの処理を有効にします。GameObject全体のアクティブ状態とは別です。
ループ再生	Loop	bool	読取・変更	true	末尾に到達したら先頭へ戻って再生します。
ループ間隔	LoopInterval	float	読取・変更	0.0f	繰り返すまでの待ち時間です。単位は秒です。
再生終了後に非表示	EndAnimUnDisplay	bool	読取・変更	false	最後まで再生したら描画を隠します。
分割Y	TilesY	int	読取・変更	1	Textureを縦方向に分割するタイル数です。
再生時間	Duration	float	読取・変更	1.0f	処理や遷移の継続時間です。時間設定の単位は秒です。
イージング	EasingType	EasingType	読取・変更	EasingType::EaseInSine	始点から終点へ変化する補間曲線です。

Inspectorの設定と使い方

「Editor / C#」は両方から変更できる設定、「Editorのみ」は公開C# APIのない編集操作です。「Editor表示のみ」は計算結果や統計などの確認欄です。「C#のみ」は、このInspectorに編集欄のない操作です。

設定・操作	編集場所	C#の入口	意味・使い方
再生時間・ループ・間隔・終了後非表示	Editor / C#	Enabled / Duration / Loop / LoopInterval / EndAnimUnDisplay / EasingType	1枚の画像内のコマを順番に表示します。Durationはアニメーション全体の時間です。LoopIntervalは次の周回までの間隔、終了後非表示は単発の演出を残さない指定です。
分割Y・分割Xの列	Editor / C#	TilesY / tileColumns	縦の分割数と各列の分割情報を画像の配置へ合わせます。C#ではtileColumnsのBuffer要素を編集します。
編集中も再生	Editorのみ	—	Play前にコマ送りの見た目を確認する設定です。現在の公開C# APIに対応する切り替えプロパティはありません。

初期値はEngineのComponent定義時の値で、C++表記を含みます。C#へ貼り付ける実行例ではありません。既存Sceneの保存値や既定Assetがある場合はそちらが優先されます。数値の編集範囲はInspectorで制限される場合があります。

C#から使う

操作型はFlipbookAnimationです。 GameObjectから取得する基本操作はGameObjectの操作を参照してください。以下には基本プロパティだけでなく、公開関数・追加の設定API・継承した共通操作も掲載します。

選択値（Enum）

型・各値の詳説	使える値
EasingType	27件。型のページで全候補を確認できます。

FlipbookAnimation

宣言・詳説	種類・操作	役割
public float Duration	プロパティ（読取・変更）	処理や遷移の継続時間です。時間設定の単位は秒です。
public EasingType EasingType	プロパティ（読取・変更）	始点から終点へ変化する補間曲線です。
public bool Enabled	プロパティ（読取・変更）	このComponentの処理を有効にします。GameObject全体のアクティブ状態とは別です。
public bool EndAnimUnDisplay	プロパティ（読取・変更）	最後まで再生したら描画を隠します。
public static FlipbookAnimation FromEntity(GameObject gameObject)	関数	既にComponentを持つGameObjectから操作用の参照を作ります。Componentを追加する操作ではありません。
public bool Loop	プロパティ（読取・変更）	末尾に到達したら先頭へ戻って再生します。
public float LoopInterval	プロパティ（読取・変更）	繰り返すまでの待ち時間です。単位は秒です。
public int TilesY	プロパティ（読取・変更）	Textureを縦方向に分割するタイル数です。
public static int componentTypeID	プロパティ（読取専用）	組み込みComponentの接続識別子です。通常のゲームコードではGetComponentで取得します。
public DynamicBuffer<FlipbookTileColumn> tileColumns	プロパティ（読取専用）	Flipbookの列ごとのタイル設定です。

継承する共通操作：Component

宣言・詳説	種類・操作	役割
public T AddComponent<T>() where T : Component	関数	ComponentまたはScriptを追加し、操作する参照を返します。
public T? GetComponent<T>() where T : class	関数	component access(owner GameObjectへの委譲)
public T? GetComponentInChildren<T>(bool includeInactive = false) where T : class	関数	子階層から指定型のComponentを探します。
public T? GetComponentInParent<T>(bool includeInactive = false) where T : class	関数	親階層から指定型のComponentを探します。
public T[] GetComponents<T>() where T : class	関数	同じGameObjectにある指定型のComponentをすべて取得します。
public void GetComponents<T>(List<T> results) where T : class	関数	同じGameObjectにある指定型のComponentをすべて取得します。
public T[] GetComponentsInChildren<T>(bool includeInactive = false) where T : class	関数	子階層にある指定型のComponentを収集します。
public void GetComponentsInChildren<T>(bool includeInactive, List<T> results) where T : class	関数	子階層にある指定型のComponentを収集します。
public void GetComponentsInChildren<T>(List<T> results) where T : class	関数	子階層にある指定型のComponentを収集します。
public T[] GetComponentsInParent<T>(bool includeInactive = false) where T : class	関数	親階層にある指定型のComponentを収集します。
public void GetComponentsInParent<T>(bool includeInactive, List<T> results) where T : class	関数	親階層にある指定型のComponentを収集します。
public override int GetHashCode()	関数	同じ値を検索Keyに使うためのHashを返します。
public bool HasComponent<T>() where T : class	関数	指定型のComponentを持つかを調べます。
public void RemoveComponent<T>() where T : Component	関数	指定型のComponentを取り除きます。
public bool TryGetComponent<T>(out T component) where T : class	関数	Componentを検索し、見つかったかをbool、結果をout引数で返します。
public GameObject gameObject	プロパティ（読取専用）	このComponentを所有するGameObjectです。
public Transform transform	プロパティ（読取専用）	所有GameObjectのTransformです。

継承する共通操作：Object

宣言・詳説	種類・操作	役割
public static void Destroy(Object? target)	関数	参照先の個体だけを安全地点で破棄する
public override bool Equals(object? obj)	関数	2つの値が等しいかを調べます。
public override int GetHashCode()	関数	同じ値を検索Keyに使うためのHashを返します。
public static GameObject Instantiate(Prefab original)	関数	Prefabまたは指定したGameObject・Componentを複製して参照を返します。生成できない場合は例外です。nullを返す前提で処理しないでください。
public static GameObject Instantiate(Prefab original, GameObject? parent)	関数	Prefabまたは指定したGameObject・Componentを複製して参照を返します。生成できない場合は例外です。nullを返す前提で処理しないでください。
public static GameObject Instantiate(Prefab original, Vector3 position, Quaternion rotation)	関数	Prefabまたは指定したGameObject・Componentを複製して参照を返します。生成できない場合は例外です。nullを返す前提で処理しないでください。
public static GameObject Instantiate(Prefab original, Vector3 position, Quaternion rotation, GameObject? parent)	関数	Prefabまたは指定したGameObject・Componentを複製して参照を返します。生成できない場合は例外です。nullを返す前提で処理しないでください。
public static T Instantiate<T>(T original) where T : Object	関数	Prefabまたは指定したGameObject・Componentを複製して参照を返します。生成できない場合は例外です。nullを返す前提で処理しないでください。
public static T Instantiate<T>(T original, GameObject? parent) where T : Object	関数	Prefabまたは指定したGameObject・Componentを複製して参照を返します。生成できない場合は例外です。nullを返す前提で処理しないでください。
public static T Instantiate<T>(T original, Vector3 position, Quaternion rotation) where T : Object	関数	Prefabまたは指定したGameObject・Componentを複製して参照を返します。生成できない場合は例外です。nullを返す前提で処理しないでください。
public static T Instantiate<T>(T original, Vector3 position, Quaternion rotation, GameObject? parent) where T : Object	関数	Prefabまたは指定したGameObject・Componentを複製して参照を返します。生成できない場合は例外です。nullを返す前提で処理しないでください。
public static bool operator ==(Object? lhs, Object? rhs)	関数	等値比較を行います。引数型と戻り値型で、成分ごとの演算か対象参照の比較かを確認してください。
public static implicit operator bool(Object? value)	関数	暗黙の型変換を行います。引数型と戻り値型で、成分ごとの演算か対象参照の比較かを確認してください。
public static bool operator !=(Object? lhs, Object? rhs)	関数	不等値比較を行います。引数型と戻り値型で、成分ごとの演算か対象参照の比較かを確認してください。

使用時の注意

MaterialやRendererがUVを使用する必要があります。ParticleのFlipbook Moduleとは別のComponentです。

Play中の変更は実行用Worldへ反映します。Scene編集のUndoと実行中の値の変更は別です。保存方法は編集と実行時変更を参照してください。

関連項目

• 機能の使い方
• Component一覧
• C# API一覧