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

関連記事

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

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

iPhoneアプリ開発 Xcode 5のお作法

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

OpenCVでPhotoshopのプラグイン開発

ブログが1日ダウンしてました

COLMAP:オープンソースのSfM・MVSツール

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

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

IronPythonを使ってUnity上でPythonのコードを実行する

ドットインストールのWordPress入門レッスン

ブログのデザイン変えました

UnityのuGUIチュートリアル

OpenCV バージョン4がリリースされた!

Raspberry Pi 2のGPIOピン配置

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

TensorFlowでCGを微分できる『TensorFlow Graphics』

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

Twitter APIのPythonラッパー『python-twitter』

1枚の画像からマテリアルを作成できる無料ツール『Materialize』

SONYの自律型エンタテインメントロボット『aibo』

Google App Engine上のWordPressでFlickrの画像を貼る

UnityでPoint Cloudを表示する方法

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

Mean Stack開発の最初の一歩

オープンソースのロボットアプリケーションフレームワーク『ROS (Robot Operating S...

オープンソースの物理ベースGIレンダラ『appleseed』

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

OpenGVの用語

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

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

OANDAのfxTrade API

JavaScriptとかWebGLとかCanvasとか

cvui:OpenCVのための軽量GUIライブラリ

UnityでARKit2.0

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

OpenMVSのサンプルを動かしてみる

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

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

OpenCVのfindEssentialMat関数を使ったサンプルを読んでみる

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

タマムシっぽい質感

コメント