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に適した設計方法ってのをのんびり模索していきたい。上手く長所を活かせる方法が見つかるといいなぁ。

関連記事

UnityプロジェクトをGitHubで管理する

uvでWindows11のPython環境を管理する

定数

openMVGをWindows10 Visual Studio 2015環境でビルドする

BlenderのPython環境にPyTorchをインストールする

Python for Unity:UnityEditorでPythonを使えるパッケージ

Maya LTのQuick Rigを試す

Unity ARKitプラグインサンプルのチュートリアルを読む

JavaScriptとかWebGLとかCanvasとか

FreeMoCap Project:オープンソースのマーカーレスモーションキャプチャ

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

OpenSfM:PythonのStructure from Motionライブラリ

WebGL開発に関する情報が充実してきている

python-twitterで自分のお気に入りを取得する

OpenCV 3.1のsfmモジュールのビルド再び

オープンソースの物理ベースレンダラ『Mitsuba』をMayaで使う

HD画質の無駄遣い

Accord.NET Framework:C#で使える機械学習ライブラリ

Boost オープンソースライブラリ

UnityのGameObjectの向きをScriptで制御する

UnityでARKit2.0

ポリゴンジオメトリ処理ライブラリ『pmp-library (Polygon Mesh Process...

Python拡張モジュールのWindows用インストーラー配布サイト

ブログの復旧が難航してた話

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

オープンソースの顔認識フレームワーク『OpenBR』

Rerun:マルチモーダルデータの可視化アプリとSDK

オープンソースの顔の動作解析ツールキット『OpenFace』

Cartographer:オープンソースのSLAMライブラリ

OpenCV 3.1から追加されたSfMモジュール

Gource:バージョン管理の履歴を可視化するツール

Kaolin:3Dディープラーニング用のPyTorchライブラリ

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

書籍『OpenCV 3 プログラミングブック』を購入

網元AMIで作ったWordpressサイトのインスタンスをt1microからt2microへ移行した

ZBrushのZScript入門

Google XML Sitemap Generatorプラグインを3.4.1へダウングレード

CGレンダラ研究開発のためのフレームワーク『Lightmetrica (ライトメトリカ)』

Zibra Liquids:Unity向け流体シミュレーションプラグイン

書籍『ゼロから作るDeep Learning』で自分なりに学ぶ

続・ディープラーニングの資料

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

コメント