UniTask を活用した場合の、イベント処理用の子クラスについてまとめます。
新しいイベント用の子クラスの作成 
分岐処理内で作成していたイベント処理を、子クラスにしてイベント化します。
ここでは今までのコルーチンの処理も残した上で、比較が出来る状態で UniTask での実装例を提示します。
１．御朱印用のオブジェクトの獲得イベント用(シーンでオブジェクトから取得するイベント)
シーン内に設置されている御朱印を獲得した際のイベントです。
イベントの中で取得する方法ではなく、オブジェクトとして取得するタイプのイベント用のクラスです。
<= クリックすると開きます。
using System.Collections;
using System.Threading;
using UnityEngine;
using Cysharp.Threading.Tasks;
public class GameEventGoshuinBox : GameEventBase
{
[SerializeField]
private GoshuinName goshuinName; //御朱印の有無
public void SetUpGoshuin()
{
// DataBaseManager に登録してあるスクリプタブル・オブジェクトを検索し、指定した通し番号の EventData を NPC 用の EventData として取得して代入
//Debug.Log("SetUpGoshuin" + gosSeachEventNo);
//goshuinData = DataBaseManager.instance.GetGoshuinDataFromGoshuinNo(gosSeachEventNo);
//CheckPossesion();
//this.gameObject.SetActive(true);
}
/// <summary>
/// 所持しているかどうかの判定
/// </summary>
public void CheckPossesion()
{
for (int i = 0; i < DataBaseManager.instance.goshuinDataSO.goshuinDatasList.Count; i++)
{
if (DataBaseManager.instance.goshuinDataSO.goshuinDatasList[i].goshuinName == goshuinName)
{
Debug.Log("左：" + DataBaseManager.instance.goshuinDataSO.goshuinDatasList[i].goshuinName);
Debug.Log("右：" + goshuinName);
this.gameObject.SetActive(false);
}
else
{
Debug.Log(goshuinName + "：その御朱印は持っていないから消さないよ");
this.gameObject.SetActive(true);
}
}
}
/// <summary>
/// コルーチンによる非同期
/// </summary>
/// <returns></returns>
public override IEnumerator ExecuteEventCoroutine() {
// 御朱印がNoData出なければ、御朱印を追加する
if (!GameData.instance.goshuinInventryDatasList.Exists(x => x.goshuinName == goshuinName)) {
yield return StartCoroutine(GetGenerator.instance.ActivatePlacementGetStampPopUp2(DataBaseManager.instance.GetGoshuinDataFromName(goshuinName)));
GameData.instance.AddGoshuinInventryData(goshuinName);
yield return true;
gameObject.SetActive(false); // 先に return しておかないと Current で取得できない
yield break;
}
yield return false;
gameObject.SetActive(false);
}
/// <summary>
/// 非同期
/// </summary>
/// <param name="token"></param>
public override async UniTask<bool> ExecuteEventAsync(CancellationToken token) {
// 御朱印がNoData出なければ、御朱印を追加する
if (!GameData.instance.goshuinInventryDatasList.Exists(x => x.goshuinName == goshuinName)) {
await GetGenerator.instance.ActivatePlacementGetStampPopUpAsync(DataBaseManager.instance.GetGoshuinDataFromName(goshuinName), token);
GameData.instance.AddGoshuinInventryData(goshuinName);
Destroy(gameObject);
return true;
}
Destroy(gameObject);
return false;
}
}
２．御朱印の取得イベント用
オブジェクト以外からの御朱印の取得イベント用です。
会話イベントなどと組み合わて使うことを想定しています。
ここからはコメントの補記を省略しています。
いままでの子クラス内部の処理を見直し、自分でコメントを補記してみてください。
<= クリックすると開きます。
using System.Collections;
using System.Threading;
using Cysharp.Threading.Tasks;
using UnityEngine;
public class GameEventGetGoshuin : GameEventBase
{
[SerializeField]
private GoshuinName goshuinName; //御朱印の有無
/// <summary>
/// コルーチンによる非同期
/// </summary>
/// <returns></returns>
public override IEnumerator ExecuteEventCoroutine() {
// 今回終了した会話イベント後に紐づいたイベントがあるか確認
if (!AdvEngineController.instance.AdvEngine.Param.GetParameterBoolean(utageParamBoolName.ToString())) {
Debug.Log("対象のイベントではない");
yield return false;
yield break;
}
// 御朱印がNoData出なければ、御朱印を追加する
if (!GameData.instance.goshuinInventryDatasList.Exists(x => x.goshuinName == goshuinName)) {
yield return StartCoroutine(GetGenerator.instance.ActivatePlacementGetStampPopUp2(DataBaseManager.instance.GetGoshuinDataFromName(goshuinName)));
GameData.instance.AddGoshuinInventryData(goshuinName);
yield return true;
}
}
/// <summary>
/// 非同期
/// </summary>
public override async UniTask<bool> ExecuteEventAsync(CancellationToken token) {
// 今回終了した会話イベント後に紐づいたイベントがあるか確認
if (!AdvEngineController.instance.AdvEngine.Param.GetParameterBoolean(utageParamBoolName.ToString())) {
Debug.Log("対象のイベントではない");
return false;
}
// 御朱印がNoData出なければ、御朱印を追加する
if (!GameData.instance.goshuinInventryDatasList.Exists(x => x.goshuinName == goshuinName)) {
await GetGenerator.instance.ActivatePlacementGetStampPopUpAsync(DataBaseManager.instance.GetGoshuinDataFromName(goshuinName), token);
GameData.instance.AddGoshuinInventryData(goshuinName);
return true;
}
return false;
}
}
３．自動移動イベント用
オブジェクトの自動移動イベント用のクラスです。
単独でもよいですし、他のイベントと組わ合わせても利用できます。
DOTween はコルーチン内部で実行する場合、yield return 付で命令することが出来ます。
その場合、WaitForCompletion() メソッドをチェーンすることで待機処理として実行されます。
<= クリックすると開きます。
using UnityEngine;
using Cysharp.Threading.Tasks;
using DG.Tweening;
using System.Linq;
using System.Threading;
public class GameEventAutoMove : GameEventBase, IGameEvent
{
private BoxCollider2D boxCollider2D;
private Animator anim;
private Vector3[] paths;
[SerializeField, Header("移動経路の情報")]
private PathData pathData;
[SerializeField, Header("移動速度")]
private float moveSpeed = 30.0f;
public override IEnumerator ExecuteEventCoroutine() {
// UTAGE のフラグ確認が必要？
// 今回終了した会話イベント後に紐づいたイベントがあるか確認
// if (!AdvEngineController.instance.AdvEngine.Param.GetParameterBoolean(utageParamBoolName.ToString())) {
// Debug.Log("対象のイベントではない");
// return;
// }
if (!TryGetComponent(out boxCollider2D)) {
Debug.Log("Box Collider 取得できないため、処理を終了します");
yield return false;
yield break;
}
// isTriggerをOnにする。
boxCollider2D.isTrigger = true;
paths = pathData.pathTranArray.Select(x => x.position).ToArray();
// 移動
yield return transform.DOPath(paths, moveSpeed)
.SetEase(Ease.Linear)
.OnWaypointChange(ChangeAnimeDirection)
.WaitForCompletion();
boxCollider2D.isTrigger = false;
yield return false;
}
/// <summary>
/// 非同期処理
/// </summary>
public override async UniTask<bool> ExecuteEventAsync(CancellationToken token) {
// UTAGE のフラグ確認が必要？
// 今回終了した会話イベント後に紐づいたイベントがあるか確認
// if (!AdvEngineController.instance.AdvEngine.Param.GetParameterBoolean(utageParamBoolName.ToString())) {
// Debug.Log("対象のイベントではない");
// return;
// }
if (!TryGetComponent(out boxCollider2D)) {
Debug.Log("Box Collider 取得できないため、処理を終了します");
return false;
}
// isTriggerをOnにする。
boxCollider2D.isTrigger = true;
paths = pathData.pathTranArray.Select(x => x.position).ToArray();
// 移動
await transform.DOPath(paths, moveSpeed)
.SetEase(Ease.Linear)
.OnWaypointChange(ChangeAnimeDirection);
boxCollider2D.isTrigger = false;
return false;
}
/// <summary>
/// キャラの向き変更
/// </summary>
/// <param name="index"></param>
private void ChangeAnimeDirection(int index)
{
Debug.Log(index);
// 次の移動先の地点がない場合には、ここで処理を終了する
if (index >= paths.Length)
{
return;
}
if (!TryGetComponent(out anim)) {
Debug.Log("Animator 取得できないため、処理を終了します");
return;
}
if (transform.position.x > paths[index].x)
{
anim.SetFloat("Y", 0f);
anim.SetFloat("X", -1.0f);
Debug.Log("左方向");
}
if (transform.position.y < paths[index].y)
{
anim.SetFloat("Y", 1.0f);
anim.SetFloat("X", 0f);
Debug.Log("上方向");
}
if (transform.position.y > paths[index].y)
{
anim.SetFloat("Y", -1.0f);
anim.SetFloat("X", 0f);
Debug.Log("下方向");
}
else
{
anim.SetFloat("Y", 0f);
anim.SetFloat("X", 1.0f);
Debug.Log("右方向");
}
}
}
４．オブジェクトの自動生成イベント用
オブジェクトの自動生成イベント用のクラスです。
今回は NonPlayerCharacter 型で生成していますが、これも抽象化を利用すれば他のゲームオブジェクトも生成対象に出来ます。
<= クリックすると開きます。
using System.Collections;
using System.Threading;
using Cysharp.Threading.Tasks;
using UnityEngine;
using UnityEngine.UI;
public class GameEventGenerateChara : GameEventBase, IGameEvent
{
[SerializeField]
private NonPlayerCharacter nonPlayerCharacterPrefab;
[SerializeField]
private Transform generateTran;
[SerializeField]
private bool isOnlyEvent; // 一度生成したら終わりにする
/// <summary>
/// コルーチンによる非同期
/// </summary>
/// <returns></returns>
public override IEnumerator ExecuteEventCoroutine() {
if (isOnlyEvent) {
Debug.Log("オブジェクト生成済");
yield return false;
yield break;
}
// 今回終了した会話イベント後に紐づいたイベントがあるか確認
if (!AdvEngineController.instance.AdvEngine.Param.GetParameterBoolean(utageParamBoolName.ToString())) {
Debug.Log("対象のイベントではない");
yield return false;
yield break;
}
if (!generateTran) {
// 生成位置の登録がない場合、エラーになるのを防ぐため、このクラスのゲームオブジェクトの情報を代入
generateTran = transform;
}
// 生成
NonPlayerCharacter npc = Instantiate(nonPlayerCharacterPrefab, generateTran.position, Quaternion.identity);
npc.SetUpNPC();
isOnlyEvent = true;
yield return false;
}
/// <summary>
/// 非同期
/// </summary>
/// <param name="token"></param>
public override async UniTask<bool> ExecuteEventAsync(CancellationToken token) {
if (isOnlyEvent) {
Debug.Log("オブジェクト生成済");
return false;
}
// 今回終了した会話イベント後に紐づいたイベントがあるか確認
if (!AdvEngineController.instance.AdvEngine.Param.GetParameterBoolean(utageParamBoolName.ToString())) {
Debug.Log("対象のイベントではない");
return false;
}
if (!generateTran) {
// 生成位置の登録がない場合、エラーになるのを防ぐため、このクラスのゲームオブジェクトの情報を代入
generateTran = transform;
}
// 生成
NonPlayerCharacter npc = Instantiate(nonPlayerCharacterPrefab, generateTran.position, Quaternion.identity);
npc.SetUpNPC();
isOnlyEvent = true;
await UniTask.Yield(token);
return false;
}
}
５．宝箱のイベント
作成済の宝箱のイベントにメソッドを追加しています。
<= クリックすると開きます。
using System.Collections;
using System.Threading;
using Cysharp.Threading.Tasks;
using UnityEngine;
public class GameEventTreasureBox : GameEventBase
{
[Header("探索イベント判定用")]
public bool isOpen; // true の場合は会話イベント中であるように扱う
[SerializeField]
private int itemNo;
private ItemData itemData;
[SerializeField, Header("空いた時の画像")]
private Sprite openSprite;
// - アイコンの設定 -
[SerializeField, Header("アイコン")]
private PlacementIconPopUp placementIconPopUpPrefab;
private PlacementIconPopUp placementIconPopUp;
[SerializeField]
private Transform canvasTran;
private SpriteRenderer spriteRenderer;
/// <summary>
/// デバッグ用
/// </summary>
public void Start()
{
SetUpTresureBox();
}
public void SetUpTresureBox()
{
isOpen = false;
TryGetComponent(out spriteRenderer);
//spriteRenderer = GetComponent<SpriteRenderer>();
// 対象物 の EventData を取得
itemData = DataBaseManager.instance.GetItemDataFromItemNo(itemNo);
// 所持しているかどうかの判定
CheckPossesion();
//アイコン の 設定
CreatePlacementIconPopUp();
}
/// <summary>
/// 所持しているかどうかの判定
/// </summary>
public void CheckPossesion()
{
Debug.Log("アイテムの保有数：" + GameData.instance.itemInventryDatasList.Count);
for (int i = 0; i < GameData.instance.itemInventryDatasList.Count; i++)
{
if (GameData.instance.itemInventryDatasList[i].itemName == itemData.itemName)
{
Debug.Log(itemData.itemName + "：そのアイテムは持っているから消すよ");
Destroy(this.gameObject);
}
else
{
Debug.Log(itemData.itemName + "：そのアイテムは持っていないから消さないよ");
}
}
}
/// <summary>
/// 配置キャラ選択用ポップアップ生成
/// </summary>
/// <returns></returns>
public void CreatePlacementIconPopUp()
{
// placementIconPopUpのポップアップを生成
placementIconPopUp = Instantiate(placementIconPopUpPrefab, canvasTran, false);
// placementIconPopUpのポップアップを非表示にする
placementIconPopUp.gameObject.SetActive(false);
}
/// <summary>
/// Iconの表示
/// </summary>
/// <param name="collision"></param>
private void OnCollisionEnter2D(Collision2D collision)
{
if (isOpen) {
return;
}
if (collision.gameObject.tag == "Player")
{
placementIconPopUp.gameObject.SetActive(true);
}
}
/// <summary>
/// Iconの非表示
/// </summary>
/// <param name="collision"></param>
private void OnCollisionExit2D(Collision2D collision)
{
if (collision.gameObject.tag == "Player")
{
placementIconPopUp.gameObject.SetActive(false);
}
}
/// <summary>
/// イベント処理
/// </summary>
/// <returns></returns>
public override IEnumerator ExecuteEventCoroutine() {
yield return StartCoroutine(AdvEngineController.instance.JumpScenarioAsync(itemData.itemScenario, null));
bool isSaveEvent = SwitchStateTresureBox();
yield return isSaveEvent;
}
/// <summary>
/// 非同期
/// </summary>
/// <param name="token"></param>
public override async UniTask<bool> ExecuteEventAsync(CancellationToken token) {
await AdvEngineController.instance.JumpScenarioAsync(itemData.itemScenario, token);
return SwitchStateTresureBox();
}
/// <summary>
/// 探索状態の切り替え
/// </summary>
private bool SwitchStateTresureBox() {
// 既にisOpenがtrueの時ならば何もしない（returnで返す）。
if (isOpen) {
return false;
}
// isOpenがfalseの時に限り、以下の処理を行う。
isOpen = true;
spriteRenderer.sprite = openSprite;
placementIconPopUp.gameObject.SetActive(false);
GameData.instance.AddItemInventryData(itemData.itemName);
return true;
}
}
６．宝箱以外からのアイテムの取得用
宝箱を通さずにアイテムを入手するようなケースのイベント処理です。
そのためこれは会話イベントなどと組み合わせて使うことを想定しています。
GameEventGetItem.cs
<= クリックすると開きます。
using System.Collections;
using UnityEngine;
using UnityEngine.UI;
public class GameEventGetItem : GameEventBase
{
[SerializeField]
private ItemName itemName;
/// <summary>
/// コルーチンによる非同期
/// </summary>
/// <returns></returns>
public override IEnumerator ExecuteEventCoroutine() { // ← 親クラスのメソッドをオーバーライド
// すでに所持しているアイテムの場合、セーブ処理の対象にはせず、獲得処理もしない
if (GameData.instance.itemInventryDatasList.Exists(x => x.itemName == itemName)) {
// 戻り値を false (セーブなし)で保持
yield return false;
// ここで処理終了(↓の処理にはいかない)
yield break;
}
// 今回終了した会話イベント後に紐づいたイベントがあるか確認
if (AdvEngineController.instance.AdvEngine.Param.GetParameterBoolean(utageParamBoolName.ToString())) {
GameData.instance.AddItemInventryData(itemName);
// 戻り値を true (セーブ有)で保持
yield return true;
// ここで処理終了(↓の処理にはいかない)
yield break;
}
// 戻り値を false (セーブなし)で保持
yield return false;
}
/// <summary>
/// 非同期
/// </summary>
/// <param name="token"></param>
public override async UniTask<bool> ExecuteEventAsync(CancellationToken token) {
// すでに所持しているアイテムの場合、セーブ処理はせず、獲得処理もしない
if (GameData.instance.itemInventryDatasList.Exists(x => x.itemName == itemName)) {
return false;
}
// 今回終了した会話イベント後に紐づいたイベントがあるか確認
if (AdvEngineController.instance.AdvEngine.Param.GetParameterBoolean(utageParamBoolName.ToString())) {
GameData.instance.AddItemInventryData(itemName);
return true;
}
await UniTask.Yield(token);
return false;
}
}
イベントの作成方法
作成方法は前回までと同じです。
GameEventHandler クラスをイベントを発火させたいゲームオブジェクトにアタッチし、
合わせて、そのゲームオブジェクトに実際に発火するイベントのクラスをアタッチします。
アタッチする順番は順不同です。アサインの順番だけイベント順に並べてください。
ただし、GameEventHandler に登録する情報が GameEventBase 型ではなく IGameEvent 型になっており、
親クラスではなく、インターフェースが実装されているクラスであれば登録できますので、より、抽象度が増しています。
(アサインできる型が GameEventBase 型ではなく、object 型になっています。)
インスペクター画像
御朱印の場合
Scene ビュー画像
インスペクター画像
会話＋御朱印＋移動など複数のイベントの組み合わせの場合
Scene ビュー画像
インスペクター画像
ゲームを実行して動作を確認する
作成したイベントをまとめて試す前に、まずは、１つずつのイベントが正常に実行されるか確認してください。
いきなりまとめて試してしまうと、万が一バグが発生した場合、どの部分に問題があるのか分からないためです。
こういった機能をまとめて試す前に、１つずつイベントが動作することを確認してから
複数のイベントが実行されることを確認していくことが鉄則です。
コメントをかく