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

関連記事

C#で使える遺伝的アルゴリズムライブラリ『GeneticSharp』

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

Manim:Pythonで使える数学アニメーションライブラリ

OpenCV 3.3.0-RCでsfmモジュールをビルド

UnityのGlobal Illumination

OpenCVで動画の手ぶれ補正

MPFB2:Blenderの人体モデリングアドオン

ROSの薄い本

geometry3Sharp:Unity C#で使えるポリゴン操作ライブラリ

Pythonの自然言語処理ライブラリ『NLTK(Natural Language Toolkit)』

3分の動画でプログラミングを学習できるサイト『ドットインストール』

Google App Engineのデプロイ失敗

Amazon EC2ログイン用の秘密鍵を無くした場合の対処方法

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

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

Structure from Motion (多視点画像からの3次元形状復元)

pythonもかじってみようかと

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

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

Polyscope:3Dデータ操作用GUIライブラリ

Javaで作られたオープンソースの3DCGレンダラ『Sunflow』

WinSCP

C++始めようと思うんだ

Mean Stack開発の最初の一歩

BGSLibrary:OpenCVベースの背景差分ライブラリ

konashiのサンプルコードを動かしてみた

MVStudio:オープンソースのPhotogrammetryツール

ManimML:機械学習の概念を視覚的に説明するためのライブラリ

スクラッチで既存のキャラクターを立体化したい

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

機械学習で遊ぶ

ドラマ『ファーストクラス』のモーショングラフィックス

株式会社ヘキサドライブの研究室ページ

動的なメモリの扱い

ブログをGoogle App EngineからAmazon EC2へ移行

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

映像ビジネスの未来

SVM (Support Vector Machine)

ROMOハッカソンに行ってきた

Unity MonoBehaviourクラスのオーバーライド関数が呼び出される順番

CycleGAN:ドメイン関係を学習した画像変換

サンプルコードにも間違いはある?

コメント