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

関連記事

AnacondaとTensorFlowをインストールしてVi...

Pythonのソースコードに特化した検索エンジン『Nulle...

WordPressの表示を高速化する

オープンソースの物理ベースレンダラ『Mitsuba』をMay...

libigl:軽量なジオメトリ処理ライブラリ

Swark:コードからアーキテクチャ図を作成できるVSCod...

3DCG Meetup #4に行ってきた

Kubric:機械学習用アノテーション付き動画生成パイプライ...

Kornia:微分可能なコンピュータービジョンライブラリ

WordPressのテーマを自作する

OpenMVS:Multi-View Stereoによる3次...

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

OpenCVでカメラ画像から自己位置認識 (Visual O...

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

OpenCV 3.1とopencv_contribモジュール...

Point Cloud Utils:Pythonで3D点群・...

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

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

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

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

プログラミングスキルとは何か?

UnityのAR FoundationでARKit 3

Google Chromecast

BlenderProc:Blenderで機械学習用の画像デー...

Amazon Web ServicesでWordPress

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

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

Webサイトのワイヤーフレームが作成できるオンラインツール

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

MythTV:Linuxでテレビの視聴・録画ができるオープン...

bpy-renderer:レンダリング用Pythonパッケー...

畳み込みニューラルネットワーク (CNN: Convolut...

PGGAN:段階的に解像度を上げて学習を進めるGAN

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

C++の抽象クラス

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

DCGAN (Deep Convolutional GAN)...

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

WordPress on Windows Azure

3Dスキャンしたテクスチャから照明を除去するUnityツール...

trimesh:PythonでポリゴンMeshを扱うライブラ...

openMVGをWindows10 Visual Studi...

コメント