イベント駆動設計の仕組みと実装方法

2024年9月26日

ゲーム開発において、コードの拡張性や保守性を高めるためには、イベント駆動設計（Event-Driven Design）が非常に有効です。ここでは、あなたが提示した設計を基に、イベントの基本的な仕組みとその実装方法を初心者向けに解説します。

1. 1. イベント駆動設計とは？
2. 2. イベントの基本構造
3. 3. アイテムがイベントを発行する仕組み
4. 4. GameDirectorがイベントを受け取る仕組み
5. 5. アイテム生成時にイベントを登録する
6. 6. イベント駆動設計の利点
7. 7. メモリリーク防止のためのイベント解除
8. 8. まとめ

1. イベント駆動設計とは？

イベント駆動設計とは、プログラムの動作を「イベント」に基づいて制御する設計手法です。イベントとは、ユーザーの操作やシステムの状態変化など、特定の出来事を指します。イベント駆動設計を採用することで、各コンポーネント間の依存関係を減らし、柔軟で拡張しやすいコードを書くことができます。

2. イベントの基本構造

C#におけるイベントは、デリゲートと呼ばれる特殊な型を用いて定義されます。以下に基本的なイベントの構造を示します。

// イベントに渡すデータを定義するクラス
public class ScoreEventArgs : EventArgs
{
    public int ScoreChange { get; private set; }

    public ScoreEventArgs(int scoreChange)
    {
        ScoreChange = scoreChange;
    }
}

// イベントを定義するインターフェース
public interface ICollectible
{
    void Collect(); // アイテム収集時の処理
    event EventHandler<ScoreEventArgs> OnCollected; // スコア変更イベント
}

ScoreEventArgs: イベントが発生した際に渡されるデータを定義しています。この場合、スコアの変動量を保持します。
ICollectible: 収集可能なアイテムに共通するインターフェースです。CollectメソッドとOnCollectedというイベントを定義しています。

3. アイテムがイベントを発行する仕組み

各アイテム（リンゴ、爆弾、ゴールドアップルなど）はItemControllerクラスを継承し、Collectメソッドを実装します。アイテムが収集された際に、OnCollectedイベントを発行してスコアの変動を通知します。

public class ItemController : MonoBehaviour, ICollectible
{
    public int scoreChange = 0; // 各アイテムが持つポイント

    public event EventHandler<ScoreEventArgs> OnCollected;

    public virtual void Collect()
    {
        // スコア変更イベントを発行
        OnCollected?.Invoke(this, new ScoreEventArgs(scoreChange));

        Destroy(gameObject);
    }
}

OnCollected?.Invoke: OnCollectedイベントに登録されているすべてのリスナー（処理）を呼び出します。scoreChangeの値をScoreEventArgsとして渡します。
Destroy(gameObject): アイテムを削除します。

各具体的なアイテムクラスでは、scoreChangeの値を設定します。

public class BombController : ItemController
{
    void Start()
    {
        this.scoreChange = -50; // 爆弾はスコアを減少させる
    }
}

public class GoldAppleController : ItemController
{
    void Start()
    {
        this.scoreChange = 500; // ゴールドアップルはスコアを大幅に増加させる
    }
}

4. GameDirectorがイベントを受け取る仕組み

GameDirectorはスコアを管理する中心的な役割を担います。アイテムが収集された際に発行されるOnCollectedイベントを受け取り、スコアを更新します。

public class GameDirector : MonoBehaviour
{
    public int point = 0;
    GameObject pointText;

    void Start()
    {
        this.pointText = GameObject.Find("Point");
    }

    // スコア変更イベントハンドラ
    public void HandleScoreChange(object sender, ScoreEventArgs e)
    {
        this.point += e.ScoreChange;
        UpdateScoreUI();
    }

    // スコアUIの更新
    private void UpdateScoreUI()
    {
        this.pointText.GetComponent<TextMeshProUGUI>().text = this.point.ToString() + " point";
    }
}

HandleScoreChange: イベントハンドラとして、スコアの変動を受け取り、pointを更新します。
UpdateScoreUI: UI上のスコア表示を更新します。

5. アイテム生成時にイベントを登録する

ItemGeneratorは新しいアイテムを生成する際に、GameDirectorのHandleScoreChangeメソッドをイベントに登録します。これにより、アイテムが収集された際にGameDirectorが通知を受け取ることができます。

public class ItemGenerator : MonoBehaviour
{
    public GameObject applePrefab;
    public GameObject bombPrefab;
    public GameObject goldApplePrefab;
    float span = 1.0f;
    float delta = 0;
    int ratio = 2;
    float speed = -0.03f;

    void Update()
    {
        this.delta += Time.deltaTime;
        if (this.delta > this.span)
        {
            this.delta = 0;
            GameObject item;
            int dice = Random.Range(1, 11);
            if (dice <= this.ratio)
            {
                item = Instantiate(bombPrefab);
            }
            else if (dice == this.ratio + 1)
            {
                item = Instantiate(goldApplePrefab);
            }
            else
            {
                item = Instantiate(applePrefab);
            }
            float x = Random.Range(-1, 2);
            float z = Random.Range(-1, 2);
            item.transform.position = new Vector3(x, 4, z);

            // GameDirectorのインスタンスを取得し、イベントハンドラを登録
            GameDirector director = GameObject.Find("GameDirector").GetComponent<GameDirector>();
            ICollectible collectible = item.GetComponent<ICollectible>();
            if (collectible != null)
            {
                collectible.OnCollected += director.HandleScoreChange;
            }
        }
    }
}

collectible.OnCollected += director.HandleScoreChange: アイテムが収集された際にGameDirectorのHandleScoreChangeメソッドが呼び出されるように登録します。

6. イベント駆動設計の利点

疎結合: GameDirectorは具体的なアイテムの種類を知る必要がなく、汎用的にスコアを管理できます。新しいアイテムを追加する際もGameDirectorを変更する必要がありません。
拡張性: 新しいアイテムを追加する際に、既存のコードに影響を与えずに拡張できます。
保守性: コードが整理され、各コンポーネントが明確な役割を持つため、バグの発見や修正が容易になります。

7. メモリリーク防止のためのイベント解除

イベントにリスナーを登録した後、不要になった際には必ず解除することが重要です。これを怠ると、メモリリークの原因となります。例えば、アイテムが破棄される際にイベントハンドラを解除します。

public class ItemController : MonoBehaviour, ICollectible
{
    // 既存のコード...

    void OnDestroy()
    {
        // GameDirectorが存在する場合のみ解除
        if (OnCollected != null)
        {
            OnCollected = null;
        }
    }
}

または、ItemGeneratorでアイテムを生成する際に、イベント解除を管理する方法も考えられます。