【Unity】Unityで学ぶデザインパターン14: Command パターン【デザパタ】

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

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

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

デザインパターンを学ぶ理由としては
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)


# Command　パターンについて
Commandパターンとはその名の通り、コマンド（命令・処理）をObjectとしてカプセル化するための方法です。
Commandパターンを用いることで処理の遅延実行や、敵AIの行動制御など様々なことが実装可能です。

# ゲームにおける Commandパターン

オンラインの格闘ゲームはキー・ボタン入力が大事になるため、キー入力自体を同期することが多いですが、他のゲーム、例えばRTSではゲーム内の指示であるコマンドを入力する方法で実装されていたりします。

https://www.4gamer.net/games/105/G010549/20100905002/

ここのコマンドは例えば `味方ユニットを生成する` とか `指定座標に新しく建築物の建築を開始する` といったものです。
当然パラメータも必要になるため、このCommandパターンは `指示コマンド(関数ポインタ or コマンドID)` と `コマンドに必要なパラメータ` をセットで管理します。

以下に、ユニットの生成・移動のサンプルコマンドを記載しておきます。

```CommandSample.cs


public interface ICommand
{
    bool Do();
    bool Undo();
}

public abstract class BaseCommand : ICommand
{
    protected abstract bool OnDoCommand();
    protected abstract bool OnRedoCommand();
    #region ===== ICommand =====

    bool ICommand.Do() { return OnDoCommand();}
    bool ICommand.Undo(){ return OnRedoCommand();}
    
    #endregion //) ===== ICommand =====
}


public class CreateUnitCommand : BaseCommand
{
    private GameObject m_target = null;
    private Vector3 m_pos;
    private GameObject m_instance = null;
    public CreateUnitCommand(GameObject target, Vector3 position)
    {
        m_target = target;
        m_pos = position;
    }

    protected override bool OnDoCommand()
    {
        if (m_target == null) return false;
        m_instance = (GameObject)Object.Instantiate(m_target, m_pos, Quaternion.identity); 
        return true;
    }

    protected override bool OnRedoCommand()
    {
        if (m_instance == null) return true;
        Object.Destroy(m_instance);
        return true;
    }
}

public class MoveUnitCommand : BaseCommand
{
    private GameObject m_target = null;
    private Vector3 m_prevPosition;
    private Vector3 m_nextPosition;
    public MoveUnitCommand(GameObject target, Vector3 position)
    {
        m_target = target;
        m_nextPosition = position;
    }

    protected override bool OnDoCommand()
    {
        if (m_target == null) return false;
        m_prevPosition = m_target.transform.position;
        m_target.transform.position = m_nextPosition;
        return true;
    }

    protected override bool OnRedoCommand()
    {
        if (m_target == null) return false;
        m_target.transform.position = m_prevPosition;
        return true;
    }
}
```

このように組んでおけば、敵AIの行動などは
```EnemyBrain.cs

public class EnemyBrain : MonoBehaviour
{
    private Queue<ICommand> commands = new Queue<ICommand>();

    void Update()
    {
        if(commands.Count > 0)
        {
            var cmd = command.Dequeue();
            cmd.Do();
        }
    }
}
```

のように書けば、毎フレームコマンドを実行してくれるようになります。


# まとめ
Commandパターンは行動とパラメータをまとめて管理します。
これにより入力の抽象化や他プレイヤーやAIの代理実行などで非常に役に立ちます。