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

関連記事

3Dモデルを立体視で確認できるVRアプリを作っている

UnityのuGUIチュートリアル

Google Colaboratoryで遊ぶ準備

PeopleSansPeople:機械学習用の人物データをUnityで生成する

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

Unite 2017 Tokyoに行ってきた

PyMC:Pythonのベイズ統計ライブラリ

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

OpenGVの用語

TeleSculptor:空撮動画からPhotogrammetryするツール

WordPressの表示を高速化する

フォトンの放射から格納までを可視化した動画

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

組み込み向けのWindows OS 『Windows Embedded』

WordPressのサーバ引っ越し方法を考える

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

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

Alice Vision:オープンソースのPhotogrammetryフレームワーク

Russian3DScannerのトポロジー転送ツール『WrapX』

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

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

AMIMOTO(PVM版)で作成したインスタンスをAMIMOTO (HVM版)へ移行する

OpenVDB:3Dボリュームデータ処理ライブラリ

UnityでTweenアニメーションを実装できる3種類の無料Asset

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

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

HD画質の無駄遣い

チャットツール用bot開発フレームワーク『Hubot』

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

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

KelpNet:C#で使える可読性重視のディープラーニングライブラリ

Math Inspector:科学計算向けビジュアルプログラミングツール

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

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

オープンソースの取引プラットフォーム

Unreal Engineの薄い本

OpenCVで動画の手ぶれ補正

Google Chromecast

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

Google製オープンソース機械学習ライブラリ『TensorFlow』のWindows版が公開された

Google App EngineでWordPress

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

コメント