ステートパターンを使った状態遷移の実装方法

初めに

2Dアクションゲームを初めて作ってみた際に、各アクションの遷移についてこれをそのまま実装するとなると、 if 文や switch 文で実装をしていました。

if (!GameManager.instance.IsGameState()) return false;
if (stateManager.CurrentState is RopeState) return false;
if (stateManager.CurrentState is CannonState) return false;
if (isOnRail) return false; 
return true;

ステートパターンとは

プレイヤーなどの状態管理の処理を追いやすくするために使用する記述方法です。アクションごとにその状態に移行したとき、その状態であるとき、その状態から抜けたときの処理を記述して、そのなかで具体的に「どの処理からどの処理へはどういう条件で状態を切り替えるのか」が追いやすくなります。

ステートパターンの実装方法

インターフェース

ステートパターンは先ほどの通り Enter, Update, Exit のように状態ごとに処理があるため、こちらはインターフェースを用いて抽象的に記述ができます。
Enterはそのステートに入った時の処理。Updateはその状態で毎フレーム実行する処理、または次のステートに行くための条件などを入れる。最後にExitはその状態を抜けた場合に実行する処理を記述します。

// 記事に載せる
public interface IActionState
{
void Enter(); // 状態開始時
void Update(); // 毎フレーム
void Exit(); // 状態終了時
}

// IdleState と WalkState のみ全文掲載
public class IdleState : IActionState
{
    private readonly CharacterHandler handler;
    
    public IdleState(CharacterHandler handler)
    {
        this.handler = handler;
    }

    public void Enter()
    {
        Debug.Log("Idle開始");
　　　　
        handler.Movement.Stop();  //例)移動を止める処理
    }

    public void Update() { }
    
    public void Exit()
    {
        Debug.Log("Idle終了");
    }
}

public class WalkState : IActionState
{
    // 同様の構造
}

// 例：入力処理での状態遷移
if (Input.GetButtonDown("Jump") && isGrounded)
{
ChangeAction(new JumpState(this));
}

// CharacterHandler から抜粋
public class CharacterHandler : MonoBehaviour
{
    private IActionState currentAction;

    // 状態切り替えの部分
    public void ChangeAction(IActionState newAction)
    {
        currentAction?.Exit();
        currentAction = newAction;
        currentAction.Enter();
    }

    void Update()
    {
        //現在のステートのUpdate()の処理を実行
        currentAction?.Update();
    }
}

処理の流れ

以上のコードは断片的なので処理の順番は以下の通りになります。

1. 入力を受け取る
   Update 内で入力をチェックし、ChangeAction(new JumpState(this)) を呼び出します。
2. 現在のステートを終了する
currentAction?.Exit(); によって現在のステートを終了します。
   例：IdleState なら Debug.Log("Idle終了") が呼ばれる。
3. 新しいステートに切り替える
currentAction = newAction; によって新しいステートを代入します。
   直後に currentAction.Enter(); が呼ばれ、ジャンプ開始処理が実行されます。
4. 毎フレーム処理
   void Update() { currentAction?.Update(); } によって、現在のステートの Update() が毎フレーム呼ばれます。
   その後、条件を満たせばまた別のステートへ遷移します。

クラス図の参考例ですが以下の通りです。

追記

ステートパターンを自分なりに紹介してみたのですが、実際に独自のアクション要素をいくつも追加していくと、どうしてもコードが見づらくなったり、処理の流れが分かりにくく感じる場面が多くなりました。
もちろん、これは人によって向き・不向きがあるので、最終的には自分が理解しやすく、開発しやすい設計を選ぶのが一番だと思います。

まとめ