【Unity】「参照していない別のゲームオブジェクトの処理」を実行できる超便利な方法

Unityでゲームを作っていると、結構な頻度で

参照していない別のゲームオブジェクトの処理を実行させたい

という場面に出くわすときがあります。これは例えばゲームオブジェクトA・Bがあり、A→Bへの参照がないにも関わらずBが持つ処理をAから実行したい…というような場合ですね。

普通に考えるとこのような場面では、処理を指示する側のゲームオブジェクトに、指示される側のゲームオブジェクトの処理への参照を持たせないといけないと思うことでしょう。しかし

ScriptableObject
UnityEvent

の2つを駆使すると、なんと参照がないにもかかわらず他方のゲームオブジェクトを操作することができるのです。一体どうやるのか気になりませんか？

そこでここでは、上記の2つの機能を駆使して全く関係のないゲームオブジェクト同士を連携させる方法をご紹介しますね。

参照のないゲームオブジェクトの処理を実行するためのC#スクリプト
1. GameEvent（ScriptableObject）
2. GameEventListener
上記のC＃スクリプトの使い方
おわりに

参照のないゲームオブジェクトの処理を実行するためのC#スクリプト

では早速ですが、参照していないゲームオブジェクトの処理を実行するためのC#スクリプトを掲載します。この連携システムは次の2つのC#スクリプトで構成されます。

GameEvent：イベントを発火させるためのScriptableObject
GameEventListener：イベント発火時に実行する操作を登録するためのクラス

GameEvent（ScriptableObject）

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

namespace KurokumaSoft
{

    [CreateAssetMenu(fileName = "New GameEvent", menuName = "GameEvent")]
    public class GameEvent : ScriptableObject
    {
        [NonSerialized]
        private List<GameEventListener> listeners = new List<GameEventListener>();

        public void Raise()
        {
            for (int i = listeners.Count - 1; i >= 0; i--)
            {
                listeners[i].OnEventRaised();
            }
        }

        public void RegisterListener(GameEventListener listener)
        {
            listeners.Add(listener);
        }

        public void UnregisterListener(GameEventListener listener)
        {
            listeners.Remove(listener);
        }

        public void ClearAllListeners()
        {
            listeners.Clear();
        }

    }

}

まず、これはイベントを発火させるためのScriptableObjectです。任意のタイミングでこのScriptableObjectのRaise関数を呼び出すと、後述するGameEventListenerに登録したイベントが一斉に呼び出されるという仕組みになっています。

この仕組みにScriptableObjectを使っている理由は、ScriptableObjectはシーンに依存しないためどこからでもこのScriptableObjectへの参照を登録できるからです。もしこれがシーンに依存した形になると結局特定のゲームオブジェクトへの参照が必要になるため、「参照のないゲームオブジェクト同士を連携させる」という目的を達成できなくなってしまいます。

なお「ScriptableObjectって何？」という方は下記の記事も併せてご覧頂くと理解が深まると思います。

【Unity】ScriptableObjectの作り方・使い方

Unityでゲームを作っていると、特にRPGなどで大量のデータを扱う必要が出てきて「データの管理が大変だからデータベース的なものが欲しいなぁ」と思うことがあります。そんなときに便利なのがUnity標準の「ScriptableObject」...

GameEventListener

using UnityEngine;
using UnityEngine.Events;

namespace KurokumaSoft
{

    public class GameEventListener : MonoBehaviour
    {

        [SerializeField]
        GameEvent gameEvent = null;

        public UnityEvent response = new UnityEvent();

        void OnEnable()
        {
            gameEvent.RegisterListener(this);
        }

        void OnDisable()
        {
            gameEvent.UnregisterListener(this);
        }

        public void OnEventRaised()
        {
            response.Invoke();
        }
    }

}

次にこちらは、UnityEventを使ってGameEvent発火時に実行する操作を登録するだけのシンプルなクラスです。先ほどのGameEventクラスのRaise関数が実行されたタイミングで何かをさせたいゲームオブジェクトにアタッチし、処理を登録する形になります。