UnityのMonoBehaviourクラスをシングルトン化する

何を隠そう、ここ2年ほど仕事でUnityを使っているオイラです。

UnityでC#のScriptを作成しようとすると、デフォルトでMonoBehaviourクラスを継承したクラスが作成される。このMonoBehaviourクラスはUnityとやり取りするための様々な機能がすでに実装されていてとても便利。ただ、個々のGameObjectが独立して動作させるような時には自由度が高くて良いんだけど、この自由度が逆に管理しづらいこともあるのです。

例えば、ゲーム全体を一元管理する情報を扱うような場合、あるいは外部のアプリケーションやKinectみたいなセンサーとやり取りするインターフェイスを作る場合、そのクラスのインスタンスは唯一にしておきたい。知らないうちに複数出来ちゃったら大混乱だ。

ということで、MonoBehaviourクラスの便利さを保ったままシングルトンにする方法を探したら、良い方法を見つけた。

Unity Technologies Japanの元エバンジェリスト伊藤さんが翻訳したこの記事↓
http://warapuri.tumblr.com/post/28972633000/unity-50-tips

29、シングルトンは便利だ

こんな感じで自動的にシングルトンが作られるようにしておくといい。

public class Singleton<T> : MonoBehaviour where T : MonoBehaviour
{
   protected static T instance;
 
   /**
      Returns the instance of this singleton.
   */
   public static T Instance
   {
      get
      {
         if(instance == null)
         {
            instance = (T) FindObjectOfType(typeof(T));
 
            if (instance == null)
            {
               Debug.LogError("An instance of " + typeof(T) + 
                  " is needed in the scene, but there is none.");
            }
         }
 
         return instance;
      }
   }
}

シングルトンはParticleManager とか AudioManager とか GUIManager.とかマネージャーに役に立つ。

  • マネージャーではない固有インスタンス(プレイヤーとか)にシングルトンを使うのは止めよう。(以下略)
  • クラスの外側から利用されるために、staticなプロパティと関数を定義しておこう。こうしておくと、GameManager.Playerと書けるようになる(GameManager.Instance.playerという書き方ではなく)

あとはこれを継承して任意のクラスを作るだけ。例えばこんな感じ。

using UnityEngine;
 
public class GameManager : SingletonMonoBehaviour<GameManager> {
     
    public void Awake(){
        if(this != Instance){
            Destroy(this);
            return;
        }
 
        DontDestroyOnLoad(this.gameObject);//シーン遷移しても破棄されない設定
    }    
     
}

そして、同じような要件でシーン遷移後もMonoBehaviourクラスを破棄せずに存続させたい場合は、上記のようにAwake()メソッドでの初期化時に

 DontDestroyOnLoad(this.gameObject);

という記述を加えれば、Script(MonoBehaviourクラス)の親となるGameObjectがシーン遷移後も存続するようになる。

Unityは、ささっと動く物を作るには本当に便利だけど、ややカチッとしたものを作ろうとするとMonoBehaviourクラスの特殊さが壁になっちゃったりもする。
システム開発してた人間からすると、MVCにならない時点で頭を抱えちゃうんだけど、Unityに適した設計方法ってのをのんびり模索していきたい。上手く長所を活かせる方法が見つかるといいなぁ。

関連記事

hloc:SuperGlueで精度を向上させたSfM・Vis...

Seleniumを使ったFXや株の自動取引

LuxCoreRender:オープンソースの物理ベースレンダ...

Unityで強化学習できる『Unity ML-Agents』

RSSフィードを読込んで表示するWordpressプラグイン...

動的なメモリの扱い

PythonでMayaのShapeノードプラグインを作る

ディープラーニング

NumSharp:C#で使えるNumPyライクな数値計算ライ...

CGALDotNet:計算幾何学ライブラリ CGALのC#ラ...

iPhoneアプリ開発 Xcode 5のお作法

Faster R-CNN:ディープラーニングによる一般物体検...

Deep Learningとその他の機械学習手法の性能比較

OpenCV3.3.0でsfmモジュールのビルドに成功!

Python.NET:Pythonと.NETを連携させるパッ...

ROSの薄い本

Caffe:読みやすくて高速なディープラーニングのフレームワ...

TensorSpace.js:ニューラルネットワークの構造を...

Oculus Goを購入!

Iterator

Unityの各コンポーネント間でのやり取り

PyDataTokyo主催のDeep Learning勉強会

OpenGVの用語

OpenGVのライブラリ構成

ManuelBastioniLAB:人体モデリングできるBl...

OpenGV:画像からカメラの3次元位置・姿勢を推定するライ...

科学技術計算向けスクリプト言語『Julia』

FreeMoCap Project:オープンソースのマーカー...

geometry3Sharp:Unity C#で使えるポリゴ...

Mitsuba 2:オープンソースの物理ベースレンダラ

組み込み向けのWindows OS 『Windows Emb...

1枚の画像からマテリアルを作成できる無料ツール『Materi...

2D→3D復元技術で使われる用語まとめ

Maya LTのQuick Rigを試す

第1回 3D勉強会@関東『SLAMチュートリアル大会』

Deep Fluids:流体シミュレーションをディープラーニ...

OpenCVでiPhone6sのカメラをキャリブレーションす...

uGUI:Unityの新しいGUI作成システム

Google App Engineのデプロイ失敗

ブログをGoogle App EngineからAmazon ...

Unity ARKitプラグインサンプルのドキュメントを読む

Raspberry Pi 2のGPIOピン配置

コメント