【デザインパターン】ObserverパターンについてUnityで学んでみよー

■はじめに

Observer知らんので、記事にしながら学んでみようと思います。(※正確性保証しません)

今回もUnityでの利用を例とします。

■説明

●Observerパターンとは

• 対象のオブジェクトの変更を、その他の色々なオブジェクトに通知するっていう設計
  • 通知対象のオブジェクト：Subject
  • 通知を受け取るオブジェクト：Observer

●種類

1. Observerをリストで管理する

• SubjectがObserverをリストで管理して、リスト内のObserverに通知する方法
• SubjectがObserverを参照する

2. Eventを利用する

• SubjectにEventを持たせて、Observerがそのイベントに変更されたときの登録する
• ObserverがSubjectを参照する
• C#ではこちらのほうが簡単に実装できる

• Unityで利用する場合、よっぽどのことがなければ、2のイベントでObserverを利用したほうが楽でいいかもです

• これは、ほかのデザインパターンであるMVPパターンにも利用されています

■サンプルプロジェクト

公式のサンプルプロジェクトを見てみましょう

こちらのサンプルプロジェクトでは、イベント駆動型でのObserverパターンを利用しています

• ボタンを押すと、いろんなアクションが起こります
  • ボタンのアニメーション
  • 右のスピーカーオブジェクトからパーティクル出てくる
  • ボタンクリック音の後に、謎の効果音が再生される

また、サンプルプロジェクトでのSubject、Observerはこんな感じです

• Subject：ボタン
• Observer：ボタンアニメーション再生スクリプト、パーティクル再生スクリプト、音声再生スクリプト

■コード

そんなに複雑じゃないです

●ButtonSubject

• ObserverパターンのSubject担当です

ButtonSubject.cs

public class ButtonSubject: MonoBehaviour
{
    public event Action Clicked;

    private Collider collider;

    void Start()
    {
        collider = GetComponent<Collider>();
    }

    public void ClickButton()
    {
        Clicked?.Invoke();
    }

    void Update()
    {
        CheckCollider();
    }

    private void CheckCollider()
    {
        if (Input.GetMouseButtonDown(0))
        {
            Ray ray = Camera.main.ScreenPointToRay(Input.mousePosition);
            RaycastHit hitInfo;

            if (Physics.Raycast(ray, out hitInfo, 100f))
            {
                if (hitInfo.collider == this.collider)
                {
                    ClickButton();
                }
            }
        }
    }
}

• わざわざクリック用のレイを飛ばして当たり判定をとって押されたか判定しています
• クリックされたら、Clickedイベントを実行します

今回は分かりやすさのためにわざと自作でレイで押されたか判定してますが、UnityではButtonコンポーネントにOnClicked()イベントがすでに用意されています。

これもObserverパターンのひとつだったんですね～

●ParticleSystemObserver

• ObserverパターンのObserver担当です
• こいつのほかにも、AudioObserverとかAnimObserverなどがありますが、ほとんど同じなので省略します

ParticleSystemObserver.cs

public class ParticleSystemObserver : MonoBehaviour
{
    [SerializeField] ButtonSubject subjectToObserve;
    [SerializeField] ParticleSystem particleSystem;

    private void Awake()
    {
        if (subjectToObserve != null)
        {
            subjectToObserve.Clicked += OnThingHappened;
        }
    }

    private void OnThingHappened()
    {
        if (particleSystem != null)
        {
            particleSystem.Stop();
            particleSystem.Play();
        }
    }

    private void OnDestroy()
    {
        // unsubscribe/deregister from the event if we destroy the object
        if (subjectToObserve != null)
        {
            subjectToObserve.Clicked -= OnThingHappened;
        }
    }

}

• インスペクターからSubjectを参照しています
• Awake()内で、SubjectのイベントにOnThingHappend()メソッドを追加しています
• OnThingHappend()メソッドでは、パーティクルを再生するようにしています
• OnDestroy()で、イベントからOnThingHappend()メソッドを除いています

このサンプルプロジェクトでのObserverは、基底クラスがMonoBehaviorですが、Observer用の基底クラスを継承させたほうが便利かもです

■さいごに

UniRxってのでObserverが便利に使いやすくなってるっぽい。
使ってみようかな～

●参考サイト