【Unity】Unityで学ぶデザインパターン20: State パターン【デザパタ】

# はじめに
様々な言語で「デザインパターン」の本が世の中にありますが、筆者個人の経験では
`いまいちピンとこない例` `いまいちピンとこないコード` で説明されてることが多く、
`結局これっていつ使うの？` という疑問に答えるには仕事仲間等との議論をしないと
辿り着けないことが多々ありました。

そこで特に「ゲーム開発ではどう使うか？」にフォーカスを当てて、実践的な例を交えて
デザインパターンの説明の需要があると思い記事を作りました。

## デザインパターンを学ぶ理由

デザインパターンを学ぶ理由としては
1. 車輪の再発明の防止
1. 長文で読みにくいコード（可読性の低いコード）を減らす
1. コードを疎結合にして変更に強くなる(変更時のコスト・変更箇所を減らす)
1. モジュールとして使いまわせるように、コードの再利用性を高める
といった効果を期待できます。

## 対象読者
Unity 全くの初心者(インストールしただけで触ったことがないような方)はお断りです。
最低限以下のことは理解・経験を積んでおくことが必須になります。

- MonoBehaviour 継承クラスでコードを書いたことがある
- C# のピュアクラスを用いた自作クラスを作ったことがある
- クラスの継承という概念は知っている

そのため、`脱・初心者` `中級者へのステップアップ` として `デザインパターンを学ぶ` のが良いと思います。


# デザパタ記事リンク
## 生成系
1. [AbstractFactory パターン](https://qiita.com/Cova8bitdot/items/e863cecf48c0529ba05a)
1. [Builder パターン](https://qiita.com/Cova8bitdot/items/9dcdfeb0641bc774b1f8)
1. [FactoryMethod パターン](https://qiita.com/Cova8bitdot/items/61a38fd51735f321e564)
1. [Prototype パターン](https://qiita.com/Cova8bitdot/items/0bc251bc36201985c204)
1. [Singleton パターン](https://qiita.com/Cova8bitdot/items/29b7064c7472a6f34972)

## 構造系
1. [Adapter パターン](https://qiita.com/Cova8bitdot/items/f09776957073cf64902b)
1. [Bridge パターン](https://qiita.com/Cova8bitdot/private/5b528216952c74436045)
1. [Composite パターン](https://qiita.com/Cova8bitdot/items/1c57d856027a33e99eb0)
1. [Decorator パターン](https://qiita.com/Cova8bitdot/items/e1373a756b3dfd86c920)
1. [Facade パターン](https://qiita.com/Cova8bitdot/items/bdf0976bdfa83e57f121)
1. [Flyweight パターン](https://qiita.com/Cova8bitdot/items/7f1f1f04b46ebaf43c5e)
1. [Proxy パターン](https://qiita.com/Cova8bitdot/items/77bef2e721f0be0804d2)

## 様態・ふるまい系
1. [Chain of Responsibility パターン](https://qiita.com/Cova8bitdot/items/66c62dd96adffda7e72e) 
1. [Command パターン](https://qiita.com/Cova8bitdot/items/9a88f7fc0782c729f97c)
1. [Interpreter パターン](https://qiita.com/Cova8bitdot/items/a871c1de813d14049934)
1. [Iterator パターン](https://qiita.com/Cova8bitdot/items/302f19863cc3b2235625)
1. [Mediator パターン](https://qiita.com/Cova8bitdot/items/be33b97f35c84e814df7)
1. [Memento パターン](https://qiita.com/Cova8bitdot/items/ae7e6f5d2da7b07d379b)
1. [Observer パターン](https://qiita.com/Cova8bitdot/items/632782ad5264baf6a366)
1. [State パターン](https://qiita.com/Cova8bitdot/items/ab9fc16ac3a6657fdce0)（本記事）
1. [Strategy パターン](https://qiita.com/Cova8bitdot/items/28dd773075cf6e9fefee)
1. [TemplateMethod パターン](https://qiita.com/Cova8bitdot/items/f0bed164ef6563b489d0)
1. [Visitor パターン](https://qiita.com/Cova8bitdot/items/15c56d40435adf63891d)

# State　パターンについて
Stateパターンは名前の通り `状態変化` を扱うことに適したデザインパターンです。
`状態` だけをintやEnumで管理するだけでは、`その状態になった時` だったり `その状態中どうするか?` などの振る舞いは管理できません。
そこで、この状態と振る舞いをまとめてクラスに(=カプセル化)してしまうことで処理を含めた共通化ができるようになります。

ざっくりとしたStateクラスのインターフェースを定義するなら以下のように作るのが良いでしょう。

```mermaid
classDiagram
    class StateType{
        <<Enumeration>>
        UNDEFINED,
        IDLE,
    }

    class IState{
        <<interface>>

        StateType GetCurrentState();
        bool ChangeState(StateType nextState );

        void OnStateChanged();
        void OnStateBegin();
        void OnStateEnd();
        void Update(float dt);

        void SetNextState(StateType nextState );
        StateType GetNextState();
    }

    direction RL
    IState -- StateType
```

Enum でStateが定義できるなら管理が楽なのでEnumを使うことを推奨しますが、言語的だったり、Stateの変更をしやすさでいえば、const int で管理して先のインターフェースのEnum部分をint に変えたものを使うと良いでしょう。

# ゲームにおける State パターン
ゲームは状態遷移のオンパレードです。
`敵/味方AIの行動制御`, `インタラクティブミュージック`, `マルチプレイのネットワーク接続管理`, `ステージ(Level)遷移・切り替え`, `ノードベースエディタの実行状況表示` といった具合に、特定の分野で利用されているのではなく、ほとんど全ての分野で使われます。
そのためゲーム開発において、「俺AI制御やらないから」とか「サウンドは関係ない」と言った言い訳は基本的には通用しないためしっかり学んでおきましょう。


ここからは、先ほどあげたような実例を用いてもう少し詳しく説明していきます。

## 行動制御とStateパターン

まずは単純な例として、敵AIの行動制御のためのStateパターンを考えてみます。
敵の状態としては `待機中(Idle)`, `移動中(Move)`, `攻撃(Attack)`, `防御(Defense)`, `死亡(Dead)` の5パターンがあるとしましょう。

そうするとクラス図的には先ほどのものに加えると以下のようになります。


```mermaid
classDiagram
    class StateType{
        <<Enumeration>>
        UNDEFINED,
        IDLE,
        MOVE,
        ATTACK,
        DEFENSE,
        DEAD,
    }

    class IState{
        <<interface>>

        StateType GetCurrentState();
        bool ChangeState(StateType nextState );

        void OnStateChanged();
        void OnStateBegin();
        void OnStateEnd();
        void Update(float dt);

        void SetNextState(StateType nextState );
        StateType GetNextState();
    }

    direction RL
    IState -- StateType

    direction TB
    class IdleState{
    }
    IState <|-- IdleState

    class MoveState{
    }
    IState <|-- MoveState

    class AttackState{
    }
    IState <|-- AttackState

    class DefenseState{
    }
    IState <|-- DefenseState

    class DeadState{
    }
    IState <|-- DeadState

```

これらを踏まえてサンプルのコードを書くなら以下のようになります。

```DummyStatePattern.cs

using System;
using System.Collections;
using System.Collections.Generic;
using UnityEngine;

namespace Dummy.StatePattern
{
    public enum StateType
    {
        UNDEFINED,
        IDLE,
        MOVE,
        ATTACK,
        DEFENSE,
        DEAD,
    }

    public interface IState
    {
        StateType GetCurrentState { get; }
        bool ChangeState(IState nextState);

        void OnStateChanged();
        void OnStateBegin();
        void OnStateEnd();

        void Update(float deltaTime);
        void SetNextState(IState nextState);
        IState GetNextState();
    }

    public class IdleState : IState
    {
        private IState m_nextState =null;
        public bool IsEndState { get; protected set; } = false;
        #region ===== IState =====

        StateType IState.GetCurrentState { get; } = StateType.IDLE;

        bool IState.ChangeState(IState nextState)
        {
            IState state = this;
            state.OnStateEnd();
            if (nextState == null) return false;
            
            nextState.OnStateChanged();
            nextState.OnStateBegin();
            return true;
        }

        void IState.OnStateChanged()
        {
            // Initialize
        }

        void IState.OnStateBegin()
        {
            IsEndState = false;
        }

        void IState.OnStateEnd()
        {
            IsEndState = true;
        }

        void IState.Update(float deltaTime)
        {
            if (IsEndState) return;
            if (m_nextState != null)
            {
                (this as IState).ChangeState(m_nextState);
                return;
            }
        }

        void IState.SetNextState(IState nextState) { m_nextState = nextState;}
        IState IState.GetNextState() { return m_nextState; }

        #endregion //) ===== IState =====
    }
    
    public class MoveState : IState
    {
        protected Transform m_moveTarget = null;
        protected Vector3 m_moveDestination = Vector3.zero;
        protected float m_moveSpeed = 0.0f;
        private IState m_nextState =null;
        public bool IsEndState { get; protected set; } = false;
        #region ===== IState =====

        StateType IState.GetCurrentState { get; } = StateType.MOVE;

        bool IState.ChangeState(IState nextState)
        {
            IState state = this;
            state.OnStateEnd();
            if (nextState == null) return false;
            
            nextState.OnStateChanged();
            nextState.OnStateBegin();
            return true;
        }

        void IState.OnStateChanged()
        {
            // Initialize
        }

        void IState.OnStateBegin()
        {
            IsEndState = false;
        }

        void IState.OnStateEnd()
        {
            IsEndState = true;
        }

        void IState.Update(float deltaTime)
        {
            if (IsEndState) return;
            if (m_nextState != null)
            {
                (this as IState).ChangeState(m_nextState);
                return;
            }

            if (m_moveTarget == null) return;
            Vector3 currentPosition = m_moveTarget.position;
            Vector3 moveVec = (m_moveDestination - currentPosition).normalized;
            m_moveTarget.position = currentPosition + moveVec * (m_moveSpeed * deltaTime);
        }

        void IState.SetNextState(IState nextState) { m_nextState = nextState;}
        IState IState.GetNextState() { return m_nextState; }

        #endregion //) ===== IState =====

        public void SetTarget(Transform target, Vector3 destination, float speedPerSec)
        {
            m_moveTarget = target;
            m_moveDestination = destination;
            m_moveSpeed = speedPerSec;
        }
    }


    public class StateController : MonoBehaviour
    {
        private IState currentState = new IdleState();


        private void Update()
        {
            currentState.Update(Time.deltaTime);
        }
    }
}


```

C#のピュアクラスでは毎フレームの更新ができないため、 IState.Update(float deltaTime) をMonoBehaviour継承クラスのどこかから読んでもらう必要はあります。

また、Stateの切り替えロジックについては今回は割愛しますが、ここでいえば、StateControllerのcurrentState に対してSetNextStateをコールすることで切り替わりが実現できます。


## ノードベースエディタでのStateパターン


Unity のノードベースエディタといえば、StateMachineである [Mecanim](https://docs.unity3d.com/ja/2022.3/Manual/AnimationOverview.html) (Animator ウィンドウで制御するあれ)や、[ShaderGraph](https://unity.com/ja/features/shader-graph), [VisualScript](https://unity.com/ja/features/unity-visual-scripting)があります。

これらに共通する機能としてはEditor再生中に現在どのNodeが実行されているのか？を可視化しています。
大抵は枠で囲われたり、点滅を繰り返す等で表現されますが、この `どのノードが実行されているのか?` はStateパターンによって管理されてない限り実現は出来ません。
一応連結リストによる表現も可能といえば可能ですが、分岐するような表現は苦手であるため、柔軟性を持たせるにはStateパターンを利用して管理し、今回でいえば `if(currentState == this) Node枠を表示する()` のような処理を行うことでノードベースエディタの表現が可能です。

# まとめ
ゲーム開発においては切っても切れないほど頻繁に出てくるのが状態遷移。
その状態遷移を表現するためのデザインパターンとしてStateパターンがあります。

おそらくゲームほど複雑で多数の状態が定義されている開発はなかなかないと思うので、ゲーム開発を行う人はたとえ、ゲーム外ツールであっても必要になる場面が必ず出てくるので覚えておくとよいでしょう。