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

関連記事

Live CV:インタラクティブにComputer Visi...

手を動かしながら学ぶデータマイニング

Google App EngineでWordPress

Windows10でPyTorchをインストールしてVSCo...

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

UnityでARKit2.0

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

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

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

UnityのTransformクラスについて調べてみた

『手を動かしながら学ぶエンジニアのためのデータサイエンス』ハ...

R-CNN (Regions with CNN featur...

PythonでMayaのShapeノードプラグインを作る

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

PythonのHTML・XMLパーサー『BeautifulS...

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

UnityユーザーがUnreal Engineの使い方を学ぶ...

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

JavaScriptとかWebGLとかCanvasとか

ManuelBastioniLAB:人体モデリングできるBl...

3D復元技術の情報リンク集

Managing Software Requirements...

hloc:SuperGlueで精度を向上させたSfM・Vis...

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

Mean Stack開発の最初の一歩

ArUco:OpenCVベースのコンパクトなARライブラリ

OpenCVの超解像(SuperResolution)モジュ...

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

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

iOSデバイスと接続して連携するガジェットの開発方法

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

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

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

Iterator

Model View Controller

Human Generator:Blenderの人体生成アド...

まだ続くブログの不調

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

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

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

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

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

コメント