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

関連記事

機械学習手法『Random Forest』

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

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

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

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

Google Chromecast

iPhone・iPod touchで動作する知育ロボット『ROMO』

UnityでARKit2.0

html5のcanvasの可能性

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

UnityからROSを利用できる『ROS#』

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

Google App Engine上のWordPressでAmazonJSを利用する

書籍『3次元コンピュータビジョン計算ハンドブック』を購入

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

WordPressプラグインによるサイトマップの自動生成

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

Mask R-CNN:ディープラーニングによる一般物体検出・Instance Segmentatio...

Unityで360度ステレオVR動画を作る

AnacondaとTensorFlowをインストールしてVisual Studio 2015で使う

『手を動かしながら学ぶエンジニアのためのデータサイエンス』ハンズオンセミナーに行ってきた

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

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

Open3D:3Dデータ処理ライブラリ

UnityでShaderの入力パラメータとして行列を渡す

WordPress on Google App Engineを1週間運用してみて

オープンソースの人体モデリングツール『MakeHuman』のAPI開発プロジェクトがスタート

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

このブログのデザインに飽きてきた

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

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

Math.NET Numerics:Unityで使える数値計算ライブラリ

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

Theia:オープンソースのStructure from Motionライブラリ

Windows10でPyTorchをインストールしてVSCodeで使う

FCN (Fully Convolutional Network):ディープラーニングによるSema...

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

Konashiを買った

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

Unityからkonashiをコントロールする

ブラウザ操作自動化ツール『Selenium』を試す

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

コメント