【Unity】ScriptableObjectの活用方法についてまとめる

マイケル

みなさんこんにちは！
マイケルです！

エレキベア

こんにちクマ〜〜

マイケル

今日は、Unity開発で使用すると便利な
ScriptableObjectについて使い方を紹介しようと思うよ！

エレキベア

名前は聞いたことあるクマが何なのクマ？

マイケル

ScriptableObjectは基本的には共有データの管理をするのに使用されるよ！
特徴としては下記のようなものがあります。

スクリプトインスタンスから独立している
共有データを保存できメモリの節約になる
Inspecter上でのデータ編集が可能
エディターセッション中にデータの保存が可能

ScriptableObject – Unityマニュアル

ScriptableObject を使用してゲームを構築する 3 つの方法

エレキベア

なるほどクマ
データ管理に適したオブジェクトなのクマね

マイケル

文字だけだと分かりにくいと思うから、
実際にコードを書いて触ってみよう！

ScriptableObjectの活用方法
おわりに

ScriptableObjectの活用方法

マイケル

今回は
・データの管理
・シーン間のデータ共有
・イベント管理
の３つの使用方法について解説します。
なおUnityのバージョンは下記を使用していて、
サンプルはGitHubにもあげていますので、こちらもご自由にご参照ください！

[使用したUnityバージョン]
2021.3.1f1

[GitHub]
GitHub – masarito617/unity-scriptable-object-sample

エレキベア

楽しみクマ〜〜〜

データの管理

マイケル

まずは最も基本的なデータ管理の方法について見ていきます！

データを表示する

マイケル

下記のようなシーンを用意し、ゲーム実行時に
ScriptableObjectからデータを設定する処理を作ってみましょう。

マイケル

ScriptableObjectは下記のように継承して定義することができます。

using UnityEngine;

[CreateAssetMenu(fileName = "MonsterData", menuName = "SampleGame/MonsterData")]
public class MonsterData : ScriptableObject
{
    /// <summary>
    /// 名前
    /// </summary>
    public string monsterName;

    /// <summary>
    /// HP
    /// </summary>
    public int hp;

    /// <summary>
    /// 死亡しているか？
    /// </summary>
    public bool isDead;
}

↑ScriptableObjectを継承して作成

エレキベア

ScriptableObjectを継承して作成するのクマね

マイケル

CreateAssetMenuは、Assetsフォルダ内で右クリックした際に開く
メニューに表示する名称になります。

マイケル

アセットを作成して、今回は下記のように設定しました。

エレキベア

名前を使われたクマ・・・

マイケル

あとは下記のように管理クラスにアタッチして
設定処理を記述すれば完了です！

using UnityEngine;
using UnityEngine.UI;

public class ShowOnlySceneManager : MonoBehaviour
{
    /// <summary>
    /// UI
    /// </summary>
    [SerializeField] private Text nameText;
    [SerializeField] private Text hpText;
    [SerializeField] private Text isDeadText;

    /// <summary>
    /// ScriptableObject
    /// </summary>
    [SerializeField] private MonsterData monsterData;

    private void Awake()
    {
        // ScriptableObjectからデータを設定
        nameText.text = monsterData.monsterName;
        hpText.text = monsterData.hp.ToString();
        isDeadText.text = monsterData.isDead.ToString();
    }
}

↑UIへのデータ設定処理

エレキベア

簡単に表示できたクマ〜〜

マイケル

MonoBehaviourやJSONファイル等で定義するのと比べてどうなの？
という方は、下記記事がまとまっていて分かりやすいのでご参照ください！

・他のデータ形式との比較
【Unity】ScriptableObjectにマスタデータを持たせるメリットについて

マイケル

基本的にはサーバ通信はJSON、それ以外はScriptableObject
を使用するのがよさそうですね！

マイケル

あとはInspecter上で編集できてゲーム実行中でも編集できるので、
エンジニア以外の方と共同で作業する場合やパラメータを調整する際には重宝しそうですね。

エレキベア

簡単に使えるし便利クマね

複数レコードを管理する

マイケル

それでは下記のように複数データを表示する場合はどのようにすればよいでしょうか？

マイケル

先ほど作成したデータをInstantiateして複製して設定することも可能ではありますが、
ScriptableObjectのメリットを活かすには下記のようにデータをリストとして定義した方がよさそうです。

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

[CreateAssetMenu(fileName = "MonstersData", menuName = "SampleGame/MonstersData")]
public class MonstersData : ScriptableObject
{
    public List<MonsterData> dataList;

    [Serializable]
    public class MonsterData
    {
        /// <summary>
        /// 名前
        /// </summary>
        public string monsterName;

        /// <summary>
        /// HP
        /// </summary>
        public int hp;

        /// <summary>
        /// 死亡しているか？
        /// </summary>
        public bool isDead;
    }
}

↑複数データを定義できるようにする

マイケル

Inspecter上では下記のように設定することができます。

エレキベア

マスタデータのように使えるクマね

マイケル

データの設定を効率化したい場合には、
後ほど紹介するExcelファイルから設定する拡張機能について参照ください！

エレキベア

データ入力をExcelに出来たら効率化出来そうクマね

シーン間のデータ共有

マイケル

次はシーン間でデータ共有をする方法についてです。
こちらは「スクリプトインスタンスから独立している」といった特徴を活かした方法になっています。

マイケル

今回は下記のようにデータを入力するシーンと、
それを表示するシーンの２つを用意しました。
これらのシーン間でデータを共有できるようにしてみましょう！

エレキベア

よくある構造クマね

マイケル

ゲーム実行中に入力データをそのまま設定してしまうと実行終了後にも上書きした値が残ってしまうため、
・初期化用の変数
・ランタイムで使用する変数
の２つを用意しておくことで解決することができます。

using System;
using UnityEngine;

[CreateAssetMenu(fileName = "MonsterSceneData", menuName = "SampleGame/MonsterSceneData")]
public class MonsterSceneData : ScriptableObject, ISerializationCallbackReceiver
{
    /// <summary>
    /// 名前
    /// </summary>
    [SerializeField] private string initMonsterName;
    [NonSerialized] public string MonsterName;

    /// <summary>
    /// HP
    /// </summary>
    [SerializeField] private int initHp;
    [NonSerialized] public int Hp;

    /// <summary>
    /// 死亡しているか？
    /// </summary>
    [SerializeField] private bool initIsDead;
    [NonSerialized] public bool IsDead;

    public void OnBeforeSerialize() { }
    public void OnAfterDeserialize()
    {
        // ランタイムでの書き込み用に値をコピーする
        MonsterName = initMonsterName;
        Hp = initHp;
        IsDead = initIsDead;
    }
}

↑初期化用の変数とランタイムで使用する変数を分ける

マイケル

ISerializationCallbackReceiverを継承してOnAfterDeserializeのタイミングで設定 することで、Awake処理の前に設定することができます。

※呼び出しタイミングに関しては下記記事が分かりやすいです。
【Unity】ISerializationCallbackReceiverを使ってみたんだ

エレキベア

Inspecter上でいじるのはあくまで初期化用の値、
ということにするわけクマね

マイケル

あとは各シーンの管理クラスにそれぞれアタッチして使用するだけです！

using UnityEngine;
using UnityEngine.SceneManagement;
using UnityEngine.UI;

public class InputSceneManager : MonoBehaviour
{
    /// <summary>
    /// UI
    /// </summary>
    [SerializeField] private InputField nameInputField;
    [SerializeField] private InputField hpInputField;
    [SerializeField] private Toggle isDeadToggle;
    [SerializeField] private Button nextButton;

    /// <summary>
    /// ScriptableObject
    /// </summary>
    [SerializeField] private MonsterSceneData monsterData;

    private void Awake()
    {
        // ScriptableObjectからデータを設定
        nameInputField.text = monsterData.MonsterName;
        hpInputField.text = monsterData.Hp.ToString();
        isDeadToggle.isOn = monsterData.IsDead;

        // ボタン押下処理
        nextButton.onClick.AddListener(() =>
        {
            // 入力データをScriptableObjectに設定
            monsterData.MonsterName = nameInputField.text;
            monsterData.Hp = int.Parse(hpInputField.text);
            monsterData.IsDead = isDeadToggle.isOn;

            // シーン遷移
            SceneManager.LoadScene("ShowScene");
        });
    }
}

↑入力シーンの処理

using UnityEngine;
using UnityEngine.SceneManagement;
using UnityEngine.UI;

public class ShowSceneManager : MonoBehaviour
{
    /// <summary>
    /// UI
    /// </summary>
    [SerializeField] private Text nameText;
    [SerializeField] private Text hpText;
    [SerializeField] private Text isDeadText;
    [SerializeField] private Button backButton;

    /// <summary>
    /// ScriptableObject
    /// </summary>
    [SerializeField] private MonsterSceneData monsterData;

    private void Awake()
    {
        // ScriptableObjectからデータを設定
        nameText.text = monsterData.MonsterName;
        hpText.text = monsterData.Hp.ToString();
        isDeadText.text = monsterData.IsDead.ToString();

        // ボタン押下処理
        backButton.onClick.AddListener(() =>
        {
            // 元のシーンに戻る
            SceneManager.LoadScene("InputScene");
        });
    }
}

↑表示シーンの処理

エレキベア

いい感じに共有できているクマね

マイケル

一点注意点としては、ScriptableObjectを参照していないシーンに遷移するとデータが一度破棄されるようなので、ランタイムで使用する場合にはその点に注意しましょう。

エレキベア

これはうっかりがありそうクマね・・・

イベント管理

マイケル

最後にScriptableObjectを使用したイベント管理の方法について紹介します！
これは公式でも紹介されていて、こんな方法もあるのかと面白かったので試してみました。

ScriptableObject を使用してゲームを構築する 3 つの方法

マイケル

今回は、仲間のモンスターが死亡した通知を受けたらメッセージを出力する処理を実装してみます。

エレキベア

かわいそうクマ・・・

マイケル

まずはScriptableObjectで作成したGameEventクラスと、
イベント通知を受け取るGameEventListenerクラスを下記のように作成します。

using System.Collections.Generic;
using UnityEngine;

[CreateAssetMenu(fileName = "GameEvent", menuName = "SampleGame/GameEvent")]
public class GameEvent : ScriptableObject
{
    private readonly List<GameEventListener> _listeners = new List<GameEventListener>();

    public void Raise()
    {
        foreach (var listener in _listeners)
        {
            listener.OnEventRaised();
        }
    }

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

    public void UnRegisterListener(GameEventListener listener)
    {
        _listeners.Remove(listener);
    }
}

↑イベントクラス。Raiseを呼び出すとListenerに通知する

using UnityEngine;
using UnityEngine.Events;

public class GameEventListener : MonoBehaviour
{
    [SerializeField] private GameEvent gameEvent;
    [SerializeField] private UnityEvent unityEvent;

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

    private void OnDisable()
    {
        gameEvent.UnRegisterListener(this);
    }

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

↑イベント通知を受け取る側。OnEventRaisedが呼ばれると設定した処理を実行する

エレキベア

Listenerの方にはScriptableObjectで作成したイベントと、
イベント通知で実行したい処理を設定しておくクマね

マイケル

今回は下記のようにMonsterクラスを作成して、
・死亡する処理
・仲間の死亡通知を受ける処理
を定義しておきます。

using UnityEngine;

public class Monster : MonoBehaviour
{
    [SerializeField] private string deadMessage;
    [SerializeField] private string shockMessage;
    [SerializeField] private GameEvent deadEvent;

    private bool _isDead = false;

    /// <summary>
    /// 死亡する
    /// </summary>
    public void Dead()
    {
        if (_isDead) return;

        // 雄叫びをあげながら死亡
        _isDead = true;
        Debug.Log($"<color=red>{gameObject.name}: {deadMessage}</color>");

        // 死亡イベントを発行する
        deadEvent.Raise();
    }

    /// <summary>
    /// 仲間の死亡通知を受ける
    /// </summary>
    public void NotifyFriendDead()
    {
        if (_isDead) return;

        // ショックを受ける
        Debug.Log($"<color=cyan>{gameObject.name}: {shockMessage}</color>");
    }
}

マイケル

ScriptableObjectは下記のように死亡した際に呼ばれる
EnemyDeadEventという名前で作成します。

マイケル

作成したらこれらを各Monsterオブジェクトにアタッチして
値を設定しましょう。

マイケル

分かりやすいように各モンスターの通知を受けた際の
メッセージ内容は変えておきます。

↑Monster3の設定内容

エレキベア

これで準備は完了クマね

マイケル

あとは下記のように各MonsterクラスのDead処理を呼び出すボタンを用意
して実行してみましょう！

using UnityEngine;
using UnityEngine.UI;

public class EventSceneManager : MonoBehaviour
{
    [SerializeField] private Button deadMonster1Button;
    [SerializeField] private Button deadMonster2Button;
    [SerializeField] private Button deadMonster3Button;
    [SerializeField] private Monster monster1;
    [SerializeField] private Monster monster2;
    [SerializeField] private Monster monster3;

    private void Awake()
    {
        // ボタンに応じたモンスターを死亡させる
        deadMonster1Button.onClick.AddListener(() => monster1.Dead());
        deadMonster2Button.onClick.AddListener(() => monster2.Dead());
        deadMonster3Button.onClick.AddListener(() => monster3.Dead());
    }
}

マイケル

こちらで順番に死亡させてみた結果は下記のようになります。