【Unity】Unityでシングルトンを使う用途

2023年10月15日

シングルトンは、特定のオブジェクトがアプリケーション内で一意であることを確保し、コードの整理や効率的なリソース管理に役立ちます。Unityにはシングルトンを実装するためのいくつかの方法があり、C#で独自の実装を行うこともできます

Unityでシングルトンを使う主な用途は以下のようになります

1. 主な用途
2. Unityでシングルトンを使用する際の一般的なデメリット
3. Unityでシングルトンを使用するメリット
4. サンプルコードの使い方

主な用途

ゲームマネージャー

ゲーム内の進行状況やリソース管理など、ゲーム全体を管理するためのシングルトンを使用します

サンプルコード

using UnityEngine;

public class GameManager : MonoBehaviour
{
    private static GameManager instance;

    // 他のスクリプトからGameManagerへのアクセスを提供するプロパティ
    public static GameManager Instance => instance;

    // このクラスからのインスタンスができないようにしている
    private GameManager() {}

    private void Awake()
    {
        if (instance == null)
        {
            instance = this;
            DontDestroyOnLoad(this.gameObject);
        }
        else
        {
            Destroy(gameObject);
        }
    }

    // ここにゲームマネージャの機能や変数を追加
    public int score = 0;

    public void IncrementScore(int amount)
    {
        score += amount;
    }

    // その他のゲームマネージャの機能やゲームロジックを実装
}

このコードでは、GameManagerクラスをシングルトンとして実装しています。GameManagerは他のスクリプトからアクセス可能で、ゲーム内の進行状況を管理するための基本的な機能を提供しています。SceneManagerでシーンが切り替わってもGameManagerは破棄されないようにDontDestroyOnLoadメソッドを使用しています

使い方

プレイヤーキャラクター

ゲーム内に唯一のプレイヤーキャラクターがいる場合、そのキャラクターをシングルトンとして実装することがあります

サンプルコード

using UnityEngine;

public class PlayerCharacter : MonoBehaviour
{
    private static PlayerCharacter instance;

    // 他のスクリプトからPlayerCharacterへのアクセスを提供するプロパティ
    public static PlayerCharacter Instance => instance;

    // このクラスからのインスタンスができないようにしている
    private PlayerCharacter() {}

    private void Awake()
    {
        if (instance == null)
        {
            instance = this;
            DontDestroyOnLoad(this.gameObject);
        }
        else
        {
            Destroy(gameObject);
        }
    }

    // ここにプレイヤーキャラクターの機能や変数を追加
    public int health = 100;
    public int score = 0;

    public void TakeDamage(int damage)
    {
        health -= damage;
        if (health <= 0)
        {
            // プレイヤーキャラクターの死亡処理を実行
        }
    }

    public void IncreaseScore(int amount)
    {
        score += amount;
    }

    // その他のプレイヤーキャラクターの機能やゲームロジックを実装
}

このコードでは、PlayerCharacterクラスをプレイヤーキャラクターとしてのシングルトンとして実装しています。プレイヤーキャラクターは他のスクリプトからアクセス可能で、プレイヤーの健康状態やスコアなどを管理するための基本的な機能を提供しています。同様に、SceneManagerでシーンが切り替わってもプレイヤーキャラクターは破棄されないようにしています

アセットマネージャー

ゲーム内のアセット（テクスチャ、サウンド、モデルなど）を管理するためのシングルトンを作成し、リソースの読み込みや解放を制御します

サンプルコード

using UnityEngine;

public class AssetManager : MonoBehaviour
{
    private static AssetManager instance;

    // 他のスクリプトからAssetManagerへのアクセスを提供するプロパティ
    public static AssetManager Instance => instance;

    // このクラスからのインスタンスができないようにしている
    private AssetManager() {}

    private void Awake()
    {
        if (instance == null)
        {
            instance = this;
            DontDestroyOnLoad(this.gameObject);
        }
        else
        {
            Destroy(gameObject);
        }
    }

    // その他のアセット管理の機能やリソースロード処理を実装
    public Sprite GetSprite(string spriteName)
    {
        // 指定した名前のスプライトを返す処理を実装
        return Array.Find(sprites, s => s.name == spriteName);
    }

    public AudioClip GetAudioClip(string audioName)
    {
        // 指定した名前のオーディオクリップを返す処理を実装
        return Array.Find(audioClips, a => a.name == audioName);
    }
}

このコードでは、AssetManagerクラスをアセット管理のためのシングルトンとして実装しています。AssetManagerは他のスクリプトからアクセス可能で、ゲーム内のスプライトやオーディオクリップなどのアセットを管理するための基本的な機能を提供しています。SceneManagerでシーンが切り替わってもAssetManagerは破棄されないようにしています。アセットのロードや提供などの具体的な処理は、必要に応じて追加で実装してください

イベントマネージャー

イベントやメッセージの送受信を管理するために、シングルトンを使用してゲーム内のコンポーネント間の通信を簡素化します

サンプルコード

using System;
using UnityEngine;

public class EventManager : MonoBehaviour
{
    private static EventManager instance;

    // 他のスクリプトからEventManagerへのアクセスを提供するプロパティ
    public static EventManager Instance => instance;

    // このクラスからのインスタンスができないようにしている
    private EventManager() {}

    private void Awake()
    {
        if (instance == null)
        {
            instance = this;
            DontDestroyOnLoad(this.gameObject);
        }
        else
        {
            Destroy(gameObject);
        }
    }
    // イベントを呼び出すメソッド
    public void TriggerMyEvent()
    {
        OnMyEvent?.Invoke(); // イベントが登録されていれば呼び出す
    }
}

このコードでは、EventManagerクラスをイベント管理のためのシングルトンとして実装しています。EventManagerは他のスクリプトからアクセス可能で、ゲーム内のイベントを管理するための基本的な機能を提供しています。イベントの呼び出しはTriggerMyEventメソッドを使用して行われ、イベントに登録されているメソッドが呼び出されます。また、SceneManagerでシーンが切り替わってもEventManagerは破棄されないようにしています

UIコントローラー

ゲーム内のユーザーインターフェースを制御するために、シングルトンを使用し、UI要素の表示や非表示を管理します

サンプルコード

public class UIController : MonoBehaviour
{
    private static UIController instance;

    // 他のスクリプトからUIControllerへのアクセスを提供するプロパティ
    public static UIController Instance => instance;

    // このクラスからのインスタンスができないようにしている
    private UIController() {}

    private void Awake()
    {
        if (instance == null)
        {
            instance = this;
            DontDestroyOnLoad(this.gameObject);
        }
        else
        {
            Destroy(gameObject);
        }
    }
    // ここにUIコントローラーの機能や変数を追加
    public Text scoreText;
    public GameObject gameOverPanel;

    private void Awake()
    {
        // UIControllerが既に存在する場合、新しいインスタンスを破棄
        if (instance != null && instance != this)
        {
            Destroy(this.gameObject);
            return;
        }

        instance = this;
        DontDestroyOnLoad(this.gameObject); // シーン切り替え時に破棄されないように設定
    }

    // スコアの更新
    public void UpdateScore(int score)
    {
        scoreText.text = "Score: " + score;
    }

    // ゲームオーバー画面の表示
    public void ShowGameOverPanel()
    {
        gameOverPanel.SetActive(true);
    }
    
    // ゲームオーバー画面の非表示
    public void HideGameOverPanel()
    {
        gameOverPanel.SetActive(false);
    }

    // その他のUIコントローラーの機能やUI操作処理を実装
}

このコードでは、UIControllerクラスをUIコントローラーとしてのシングルトンとして実装しています。UIControllerは他のスクリプトからアクセス可能で、ゲーム内のスコア表示やゲームオーバー画面の表示/非表示などのUI関連の基本的な機能を提供しています。SceneManagerでシーンが切り替わってもUIControllerは破棄されないようにしています。具体的なUI操作や処理は、必要に応じて追加で実装してください

グローバルデータ

ゲーム内で共有する設定、プレイヤーのスコア、難易度設定などのデータを保存・アクセスするためにシングルトンを利用します

サンプルコード

using UnityEngine;

public class GlobalData : MonoBehaviour
{
    private static GlobalData instance;

    // 他のスクリプトからGlobalDataへのアクセスを提供するプロパティ
    public static GlobalData Instance => instance;

    // このクラスからのインスタンスができないようにしている
    private GlobalData() {}

    private void Awake()
    {
        if (instance == null)
        {
            instance = this;
            DontDestroyOnLoad(this.gameObject);
        }
        else
        {
            Destroy(gameObject);
        }
    }

    // ここにグローバルデータの変数を追加
    public int playerScore = 0;
    public string playerName = "Player1";

    private void Awake()
    {
        // GlobalDataが既に存在する場合、新しいインスタンスを破棄
        if (instance != null && instance != this)
        {
            Destroy(this.gameObject);
            return;
        }

        instance = this;
        DontDestroyOnLoad(this.gameObject); // シーン切り替え時に破棄されないように設定
    }

    // その他のグローバルデータの操作や設定を実装
    public void SetPlayerName(string name)
    {
        playerName = name;
    }

    public void IncreasePlayerScore(int amount)
    {
        playerScore += amount;
    }
}

このコードでは、GlobalDataクラスをグローバルデータを管理するためのシングルトンとして実装しています。GlobalDataは他のスクリプトからアクセス可能で、ゲーム内のプレイヤーのスコアや名前などのグローバルデータを管理するための基本的な機能を提供しています。SceneManagerでシーンが切り替わってもGlobalDataは破棄されないようにしています。具体的なデータの操作や設定は、必要に応じて追加で実装してください

Unityでシングルトンを使用する際の一般的なデメリット

グローバルな状態: シングルトンはグローバルなアクセスポイントを提供しますが、これはアプリケーション内で状態を共有することを容易にします。しかし、適切に管理しないと、状態が不整合を引き起こす可能性があります。
複雑性の増加: シングルトンを過度に使用すると、コードベースが複雑になり、デバッグや保守が難しくなる可能性があります。
テストの難しさ: シングルトンはモックやユニットテストにおいてテストを難しくする可能性があります。依存関係の注入（Dependency Injection）などのテスト可能なデザインパターンと競合することがあります。
依存関係: シングルトンは他のコンポーネントに依存する可能性が高く、これによりコードの疎結合性が低下する可能性があります。
シングルトンの不正な使用: シングルトンは過度に使用され、非常に多くのオブジェクトが依存する場合、その設計は効果的でなくなります。特に大規模なプロジェクトでは問題が増幅されることがあります。
メモリ管理: シングルトンはシーンをまたいで生存し続けるため、メモリ管理に気をつける必要があります。不要になったシングルトンを正しく破棄しない場合、メモリリークの原因となります。
並列処理の問題: シングルトンがスレッドセーフでない場合、マルチスレッド環境で問題が発生する可能性があります。

これらのデメリットは、シングルトンの適切な使用と設計が重要であることを示しています。シングルトンは特定の状況で非常に有用ですが、過度に使用すると問題を引き起こす可能性があるため、慎重に選択する必要があります。必要に応じて、依存関係の注入などの代替手法を検討することが重要です。

Unityでシングルトンを使用するメリット

グローバルなアクセス: シングルトンはアプリケーション内のどの場所からでもアクセス可能で、共有データや機能に簡単にアクセスできます。
一貫性の維持: シングルトンは特定のオブジェクトがアプリケーション内で一意であることを保証し、データの整合性を維持します。
シンプルな管理: シングルトンを使用することで、複数のインスタンスを管理する必要がなくなり、コードの管理がシンプルになります。
リソース管理: アセットマネージャやリソースマネージャとしてのシングルトンを使用することで、リソースの読み込みと解放を一元的に管理できます。
イベント通知: イベントマネージャとしてのシングルトンを使用することで、異なる部分のコード間でイベント通知を効率的に行うことができます。
シーン間のデータ共有: シングルトンはシーン間でデータを共有でき、ゲームの進行状況を維持するのに役立ちます。
シーン遷移時のデータ保持: シーン遷移時にオブジェクトが破棄されないため、シーン間のデータの保持が容易です。
簡潔なコード: シングルトンはコード内の冗長なパラメータの渡し合いを減少させ、コードをより簡潔にします。

これらのメリットは、シングルトンが特定の状況で非常に有用であることを示しています。ただし、適切な使用と設計が必要で、過度に使用すると問題を引き起こす可能性があることにも注意が必要です。

サンプルコードの使い方

Unityでゲームマネージャーとしてのシングルトンを使用するサンプルの使い方を説明します。

前提条件

Unityプロジェクトを開いていること。
GameManagerという名前のスクリプトファイルを作成し、上記のサンプルコードをコピーして貼り付けていること。

サンプルコードでは、GameManagerシングルトンはゲーム内の進行状況を管理し、プレイヤーのスコアをインクリメントする機能を提供します。

使い方

GameManagerオブジェクトの作成

UnityのHierarchyウィンドウで、右クリックして「Create Empty」を選択し、新しいGameObjectを作成します。

このGameObjectの名前を「GameManager」に変更します。

GameManagerコンポーネントのアタッチ

HierarchyウィンドウのGameManager GameObjectを選択します。

Inspectorウィンドウで、GameManagerコンポーネントがアタッチされていることを確認します。アタッチされていない場合、GameManagerスクリプトをGameManager GameObjectにドラッグ＆ドロップしてアタッチします。

ゲームスクリプトからGameManagerにアクセス

他のゲームオブジェクトやスクリプトからGameManagerにアクセスするには、GameManager.Instanceプロパティを使用します。たとえば、スコアをインクリメントするには以下のようにします。

他のスクリプトでGameManagerにアクセスする例

GameManager.Instance.IncrementScore(10);

テスト

ゲーム内の別のスクリプトからGameManagerを使用して、スコアを増加させてみてください。

また、GameManagerを使って他のゲーム関連のデータを管理することもできます

GameManagerはゲームの進行を管理する中心的な要素として役立ち、シーン間でデータを簡単に共有できるようになります

Unity,デザインパターン

Posted by hidepon

VisualStudioCodeスニペット

インベントリシステム（持ち物）サンプルのリファクタリングいろいろ

コメント一覧

まだ、コメントがありません

コメントをどうぞコメントをキャンセル

このサイトはスパムを低減するために Akismet を使っています。コメントデータの処理方法の詳細はこちらをご覧ください。