イベント駆動型処理の作成例① - i-school

イベント駆動型処理

　イベント駆動型プログラミング、イベントドリブンともよばれる、プログラミング手法の１つです。

参考サイト

e-words 様
イベントドリブン【event-driven】イベント駆動型

　例えば、「スイッチを押したら　→　扉が開く」、「ボタンを押したら　→　ジャンプする」という形で
「なにかをしたら(イベント)　→　どうなるのか(イベントハンドラ)」という形式のサイクルを
イベント単位で処理が完結するように記述する方式のことをいいます。

　イベント処理自体は event キーワードや delegate キーワード(UnityAction)を活用しても作成できますが、
UniRx の機能とオブザーバーパターンを利用することでも、イベント駆動型処理を実装することができます。

　ただし、ゲーム内のすべての処理がこの処理に適しているという訳でありません。
そのため、実装する際にはどういった処理を作りたいのかを考えて、その上でどの機能(UniRx なのか、UnityAciton なのか、UnityEvent なのか)を採用するか検討する必要があります。

　基本的には、先ほどのようなボタンやクリックなどのイベントには、UniRx とオブザーバーパターンを利用すると実装しやすいです。

サンプル

　「ボタンを押す　→　乱数を１つ決める」というイベントとイベントハンドラを駆動させるケースのサンプルです。

Example.cs

<= クリックすると開きます。

using UnityEngine;
using UnityEngine.UI;
using UniRx;

public class Example : MonoBehaviour
{
    public Button button;
    public ReactiveProperty<int> variable = new ReactiveProperty<int>();

    private void Start()
    {
        // ReactivePropertyの変更を監視する
        variable.Subscribe(x =>
        {
            // 変数によって処理の振る舞いを変える
            if (x > 5)
            {
                Debug.Log("変数が5より大きい場合の処理");
            }
            else
            {
                Debug.Log("変数が5以下の場合の処理");
            }
        })
        .AddTo(this);

        // ボタンのクリックを監視する
        button.OnClickAsObservable()
            .Subscribe(_ =>
            {
                // 変数を確定させる
                variable.Value = Random.Range(0, 11);
            })
            .AddTo(this);
    }
}

　この例では、変数の値の変更をReactivePropertyを使って監視しています。
ReactivePropertyは、値の変更があった場合に自動的に通知してくれる仕組みを持っています。

　Subscribe()メソッドで変数の変更を監視し、値が変わった際に実行する処理を記述しています。

　また、ボタンのクリックを監視し、ボタンが押された際に変数を確定させるようにしています。
variable.ValueでReactivePropertyの値を取得・設定することができます。

　UnityとUniRxを使った場合、SubscribeしたObservableのライフサイクルを管理する必要があります。
これは、Observableがアクティブな間、メモリリークを避けるためです。

　そのため、SubscribeしたObservableのライフサイクルを自動的に管理するために、通常AddToメソッドを使用します。
AddToメソッドは、Observableが終了したときに、自動的にDisposeすることができるため、メモリリークを防止することができます。

　このケースにおいても、どちらのSubscribe には AddTo メソッドを使用し、Observableのライフサイクルを自動的に管理しています。

サイコロを振るイベント

　先ほどの例を元に、「ボタンを押す　→　サイコロを振って出目を決める」というイベント処理の実装例です。

DiceRoller.cs

<= クリックすると開きます。

using UnityEngine;
using UnityEngine.UI;
using UniRx;

public class DiceRoller : MonoBehaviour
{
    public Button rollButton;
    public ReactiveProperty<int> diceResult = new ReactiveProperty<int>();


    private void Start()
    {
        // サイコロの結果を監視する
        diceResult.Subscribe(x =>
        {
            Debug.Log($"サイコロの結果：{x}");
        })
        .AddTo(this);

        // ボタンを押したら
        rollButton.OnClickAsObservable()
            .Subscribe(_ =>
            {
                 // サイコロを振る(サイコロの結果を乱数から設定する)
                 diceResult.Value = Random.Range(1, 7);
            })
            .AddTo(this);
    }
}

　Random.Range()メソッドを使用して、サイコロの目やカードの種類をランダムに決定しています。
また、それぞれの結果をReactivePropertyで保持しています。
Subscribe()メソッドで変更を監視しているので、diceResultが変更されるたびに、デバッグログに結果を出力するようにしています。

カードを１枚引くイベント

　同じように、今度は「ボタンを押す　→　カードを１枚引く」というイベント処理の実装例です。
こちらにはボタン連打防止の処理も追加しています。

CardDealer.cs

<= クリックすると開きます。

using UnityEngine;
using UnityEngine.UI;
using UniRx;

public class CardDealer : MonoBehaviour
{
    public Button drawCardButton;
    public ReactiveProperty<string> cardResult = new ReactiveProperty<string>();

    // カードの結果を設定する
    private string[] cardList = { "カードA", "カードB", "カードC", "カードD", "カードE" };


    private void Start()
    {
        // カードの結果を監視する
        cardResult.Subscribe(x =>
        {
            Debug.Log($"カードの結果：{x}");
        })
        .AddTo(this);

        // ボタンを押したら
        drawCardButton.OnClickAsObservable()
 
            // 一度ボタンが押されたら、1000ミリ秒(1秒)は次にボタンを押しても無視する
            .ThrottleFirst(System.TimeSpan.FromMilliseconds(1000))
            .Subscribe(_ =>
            {
                // ランダムなカードを引く
                int index = Random.Range(0, cardList.Length);
                cardResult.Value = cardList[index];
            })
            .AddTo(this);
    }
}

　Random.Range()メソッドを使用して、カードの種類をランダムに決定しています。
また、それぞれの結果をReactivePropertyで保持しています。Subscribe()メソッドで変更を監視しているので、
cardResultが変更されるたびに、デバッグログに結果を出力するようにしています。

　ThrottleFirst オペレータを利用することで、ボタンの連打防止を行っています。

役割に合わせてクラスを分割する①

　DiceRoller クラスを役割に合わせてクラスを分割した例です。

DiceRollerInput.cs

<= クリックすると開きます。

using UnityEngine;
using UnityEngine.UI;
using UniRx;

public class DiceRollerInput : MonoBehaviour
{
    public Button rollButton;
    public ReactiveProperty<int> diceResult = new ReactiveProperty<int>();

    private void Start()
    {
        rollButton.OnClickAsObservable()
　　　　　　.Subscribe(_ =>
        　　{
            　　// サイコロの結果を設定する
            　　diceResult.Value = Random.Range(1, 7);
        　　})
　　　　　　.AddTo(this);
    }
}

DiceRollerObserver.cs

<= クリックすると開きます。

using UnityEngine;
using UnityEngine.UI;
using UniRx;

public class DiceRollerObserver : MonoBehaviour
{
    private DiceRollerInput diceRollerInput;


    private void Start()
    {
        // サイコロの結果を監視する
        diceRollerInput.diceResult
            .Subscribe(x =>
            {
                Debug.Log($"サイコロの結果：{x}");

                // TODO 結果をうけて、処理をする。例えば、マスを進む、効果が変わる、など

            })
            .AddTo(this);
    }
}

　DiceRollerInputクラスはサイコロを振る入力を担当し、DiceRollerObserverクラスはサイコロの結果を監視する処理を担当しています。
これらのクラスは共通の diceResult 変数を使用しています。

　DiceRollerInputクラスでイベントを受け取り、diceResult変数に結果を設定して、
DiceRollerObserverクラスでは、その diceResult 変数を監視することで、
分割されたクラスでもサイコロを振る処理が正常に動作します。

　このようにクラスを分割することで、入力と監視処理を明確に区別し、コードの可読性や保守性が向上します。

役割に合わせてクラスを分割する②

　
　先ほどの DiceRoller クラスを見ながら、CardDealer クラスを、役割に合わせて複数のクラスに分割してみてください。

　それが出来たら、応用編として、カードの枚数を増やすため、string 型ではなく int 型で52枚のカード(トランプを模して)を管理して、利用してみてください。
そしてカードを引くたびにその番号のカードを抜いていき、同じ番号は引かないようにしてみましょう。

　この方法を実装すると、重複しない番号のカードが1枚ずつ山札から減っていき、最後は引くカードがなくなってデッキの残り枚数が 0 になる機能が実装できます。

　＜応用編　回答例＞

　以上になります。

　次は イベント駆動型処理の作成例② です。

参考サイト

Qiita @toRisouP 様
2022年現在におけるUniRxの使いみち

Zenn Rinia 様
神経質が設計にこだわりすぎた失敗談①　細分化しすぎ

note REALITY 株式会社様
Now in REALITY Tech #34 転生したらAndroidエンジニアだった件 - 元Unityエンジニアの思うゲームとアプリの技術類似点

slideshare Koji Morikawa 様
RPGにおけるイベント駆動型の設計と実装