Unityでのシングルトンの使い方を知りたい

Question

前提・実現したいこと

先輩からシングルトンのスクリプトを教えてもらい、早速使ってみようと思いましたが、ネットの記事とかで紹介されてるような動きをしないです。　継承を使ったことがないので使い方があってるかどうかも教えて欲しいです。
教えてもらった先輩にはしばらく会えないため質問しました。

発生している問題・エラーメッセージ

シーンを移動してから同じシーンに戻るとオブジェクトが増えている。
シングルトンの役割を果たしていない

該当のソースコード

public class SceneController : SingletonMonoBehaviour<SceneController>
{
	private void Awake()
	{
		DontDestroyOnLoad(this.gameObject);
	}
	public void GoTitle(){
		SceneManager.LoadScene("TitleScene");
	}

	public void GoStageSelect(){
		SceneManager.LoadScene("StageSelectScene");
	}

	public void StageLoad(string scenename){
		SceneManager.LoadScene(scenename);
	}
}

貰ったシングルトンのコード

public class SingletonMonoBehaviour<T> :MonoBehaviour where T: MonoBehaviour {
    private static T _instance;

    public static T Instance
    {
        get
        {
            if(_instance == null)
            {
                //シーン上から取得する
                _instance = FindObjectOfType<T>();
				
            }

            //FindObjectOfType<T>();が失敗していないか
            if (_instance == null)
            {
                Debug.LogError(typeof(T) + "is nothing");
            }
            return _instance;
        }
    }

	protected virtual void Awake()
	{
		CheckInstance();
	}
	
	bool CheckInstance(){

	//this →　SingletonMonoBehaviour.cs自身
	//→　Singletonから呼び出されている。
	//→最初に作られたSingleton == 取得してきたSingleton
	if(this == Instance){ return true; }

		//今作られたものと最初に作られたのもが違った場合
		//今作られた物を削除する。
		Destroy(gameObject);//←thisにするとスクリプトだけ消える
		return false;
	}

	
}

補足情報（FW/ツールのバージョンなど）

Unity 2019.2.4f1

Comments

[退会済みユーザー]

・>ネットの記事とかで紹介されてるような動き とはなにか
・質問者さん自身は、このスクリプトをどう使っているのか
があると回答が来やすくなるかと思います。
今のままでは、使い方だけ聞いている丸投げの質問とみなされる可能性があります。

[kkk]

ご指摘ありがとうございます。
○○マネージャーとしてシーン間をまたいでシングルトンのスクリプトがついたゲームオブジェクトを残しているのを見て真似してみました。
上記のコードを空のオブジェクトに付けて使っていますが上記の問題通りです。
シングルトンを継承してDontDestroyしている記事が無かったので自分なりにやってみたのですが、そもそも自分の使い方で合っているのかが聞きたかったです。

[hermit19901127]

少し気になる所があります…

＞シーンを移動してから同じシーンに戻るとオブジェクトが増えている。
＞シングルトンの役割を果たしていない

この「オブジェクト」ですが、この「シングルトン」が生成したものでしょうか…？

それが事実であれば、シングルトン側で生成したオブジェクトは
「シングルトン」に結びつきます…。
いくらゲームシーンが変化しようと、「シングルトン」に結びついてオブジェクトが生成されてるため、消失致しません…。

シングルトンは基本的に「ゲームが生きている」限り、ずっと存在し続けます…。
シングルトン側で生成したオブジェクトは「シングルトン」が処理する必要があります…。

たとえば、Scene終了時に自動的にゲーム中にシングルトンを使って発行したオブジェクトがあるなら
Scene終了時に走らせる（ゲーム中に生成したオブジェクトの明示的破棄）処理を、Stage終了処理時に自動的に走るイベントに噛ませる必要があると思う次第です…。

[hermit19901127]

（忘れてください）

[hermit19901127]

＞シーンを移動してから同じシーンに戻るとオブジェクトが増えている。
＞シングルトンの役割を果たしていない

ただ、これに関する回答とすると、Singletonでオブジェクトと作ってる故・・・・。
Singletonは全シーン共通のオブジェクト故、シーンが変わってもその情報を保持致します…。

簡単なソリューションとしては、Ｓｉｎｇｌｅｔｏｎ側に紐づいた生成物を
Ｓｃｅｎｅ変更時に走る処理があると存じますので…その時にＳｉｎｇｌｅtonの適切な初期化処理を走らせるのはどうでしょうか…

Answer 1

Unityは分からないのと、SingletonMonoBehaviourがGenericクラスを使っているので外しているかもですが、少なくともC#のプログラムとしてみた場合に疑問が生じたので回答させていただきます。

基底クラスSingletonMonoBehaviourのメソッドAwakeはvirtualなメソッドですが、

protected virtual void Awake()
{
    CheckInstance();
}

それを継承したSceneControllerのAwakeメソッドでは効果を無効にするような書き方です。

public class SceneController : SingletonMonoBehaviour<SceneController>
{
    private void Awake()
    {
        DontDestroyOnLoad(this.gameObject);
    }
...

意図としては基底クラスのSingletonMonoBehaviour.Awakeメソッドの中でCheckInstanceメソッドが呼ばれることで、シングルトンとして使用するSceneControllerクラスのインスタンスが生成されることを期待しているように思いますが、違いますでしょうか。

あくまでSceneControllerクラスでAwakeメソッドの機能を膨らませて使いたいのであれば、メソッドをoverrideして、更にその中で基底クラスのメソッドを呼び出す必要があると思います。

    // private void Awake()
    protected override void Awake()
    {
        base.Awake();
        DontDestroyOnLoad(this.gameObject);
    }

コンソールアプリとしてUnity特有な部分とGeneric部分を外したサンプルコードです。virtualなAwake2メソッドを新たに設け、それをoverrideすることでサンプル動作を示したつもりのものです。

using System;

namespace ConApp1
{
    public class Program
    {
        static void Main(string[] args)
        {
            var monoBehavior = new SceneController();
            monoBehavior.AwakeAll();
        }
    }

    public class SceneController : SingletonMonoBehaviour
    {
        // 警告が出る
        // warning CS0114: 'SceneController.Awake()' は継承されたメンバー 'SingletonMonoBehaviour.Awake()' を非表示にします。現在のメンバーでその実装をオーバーライドするには、override キーワードを追加してください。オーバーライドしない場合は、new キーワードを追加してください。
        private void Awake()
        {
            Console.WriteLine("SceneController.Awake()");
        }

        protected override void Awake2()
        {
            Console.WriteLine("SceneController.Awake2()");
            // 基底クラスのメソッドを呼び出す
            base.Awake2();
        }

        public void AwakeAll()
        {
            Awake();
            Awake2();
        }
    }

    public class SingletonMonoBehaviour
    {
        private static SingletonMonoBehaviour _instance;

        public static SingletonMonoBehaviour Instance
        {
            get
            {
                if (_instance == null)
                {
                    _instance = new SingletonMonoBehaviour();

                }

                return _instance;
            }
        }

        protected virtual void Awake()
        {
            Console.WriteLine("SingletonMonoBehaviour.Awake()");
            CheckInstance();
        }

        protected virtual void Awake2()
        {
            Console.WriteLine("SingletonMonoBehaviour.Awake2()");
            CheckInstance();
        }

        bool CheckInstance()
        {
            //this →　SingletonMonoBehaviour.cs自身
            //→　Singletonから呼び出されている。
            //→最初に作られたSingleton == 取得してきたSingleton
            if (this == Instance)
            {
                return true;
            }

            //今作られたものと最初に作られたのもが違った場合
            //今作られた物を削除する。
            //Destroy(gameObject);//←thisにするとスクリプトだけ消える
            return false;
        }
    }
}

これをWindowsのコマンドプロンプト上で実行すると、以下のような結果となります。

C:>ConApp1.exe
SceneController.Awake()
SceneController.Awake2()
SingletonMonoBehaviour.Awake2()

Comments

[kkk]

ありがとうございます！
無事動きました。継承が理解できてなかったので分かりやすかったです。

[dodox86]

当たっていましたか。無事解決してよかったです。