SingletonMonoBehaviour<T>
abstract
名前空間：SilCilSystem.Singletons
継承：UnityEngine.MonoBehaviour
Assembly：SilCilSystem.Packages
ゲーム内に1つしか存在しないコンポーネントの作成に使用する抽象クラスです。
メンバ一覧
メソッド
| member | description |
|---|---|
| protected void OnAwake() | Awakeで呼ばれます。基底クラスのAwakeをvirtualにするとbase.Awakeの呼び出し忘れが起こるのでこういう形にしています。 |
| protected void OnDestroyCallback() | OnDestroyで呼ばれます。 |
使用例
シングルトンを作成する場合はこのクラスを継承したコンポーネントを作成します。
例えば、文字列をDebug.Logで表示するためのシングルトンは以下のようになります。
using UnityEngine;
using SilCilSystem.Singletons;
public class SingletonExample : SingletonMonoBehaviour<SigletonExample>
{
protected override void OnAwake()
{
// Awake時に呼ばれます。
}
protected override void OnDestroyCallback()
{
// OnDestroy時に呼ばれます。
}
public void Write(string text)
{
Debug.Log(text);
}
}
呼び出しはInstanceにアクセスします。
using UnityEngine;
public class TestSingletonExample : MonoBehaviour
{
private void Start()
{
SingletonExample.Instance.Write("Test");
}
}
シングルトンの自動生成
作成したシングルトンは自動で生成されるようにしたほうが便利です。
ゲーム開始時に自動で生成されるようなエディタ拡張を用意しており、
Resources/InitialPrefabsフォルダ下に置かれている全てのプレハブが生成されるようになっています。
例えば、SceneLoaderやAudioPlayerはSilCilSystemフォルダ下にこのフォルダを作成しており、
自動で生成されるようになっています。
※生成処理はPrefabGeneratorOnLoad.csに記述してあります。
実装
Awake内で重複がないかをチェックしています。
すでに存在する場合には削除し、存在しない場合はDontDestoryOnLoadを用いてゲームオブジェクトが破棄されないように設定します。
private void Awake()
{
if(Instance == null)
{
Instance = this as T;
DontDestroyOnLoad(this.gameObject);
OnAwake();
}
else
{
Destroy(gameObject);
}
}
明示的に削除した場合にはInstanceにはnullが代入されます。
これはOnDestroyで処理しています。
private void OnDestroy()
{
Instance = (Instance == this) ? null : Instance;
OnDestroyCallback();
}