追加された行はこの色です。
削除された行はこの色です。
複数回の手順に分けて、ログ表示機能の実装を学習します。
なお、C# と Unity の基礎知識＋アルファの学習(中級者クラス)が必要になります。
----
前回までの続きです。制作した UI を利用し、アイテム獲得時のログ表示機能の実装を行います。
事前の準備が必要になりますが、C# と Unity の基礎知識＋アルファの学習(中級者クラス)が必要になります。
この教材の手順を見ても実装が難しい方はまず
=|PERL|
��C# の機能の学習(クラスの継承、インターフェースなどを活用した抽象化の学習）
�▲妊競ぅ鵐僖拭璽鵑粒惱�(オブジェクトプール、オブザーバーパターン、シングルトンパターン)
��Unity の機能の学習(オブジェクトプール、スクリプタブル・オブジェクト)
||=
などを学習してから実装にチャレンジしてください。
----
*データベースの準備
サーバー、あるいはスクリプタブル・オブジェクトなどでアイテムのデータを用意し、ゲーム内取得できるように準備を行って下さい。
下記の教材を参考にしていただいても問題ありません。
=> ''%%%[[アイテムの情報をスクリプタブル・オブジェクトに登録して利用する>アイテムの情報をスクリプタブル・オブジェクトに登録して利用する]]%%%''
----
*オブジェクトプールの準備
オブジェクトプールの準備を行ってください。
下記の教材を参考にしていただいても問題ありません。
=> ''%%%[[スクリプタブル・オブジェクトとオブジェクトプールを活用したエフェクト複数種管理��>スクリプタブル・オブジェクトとオブジェクトプールを活用したエフェクト複数種管理��]]%%%''
=> ''%%%[[スクリプタブル・オブジェクトとオブジェクトプールを活用したエフェクト複数種管理��>スクリプタブル・オブジェクトとオブジェクトプールを活用したエフェクト複数種管理��]]%%%''
=> ''%%%[[スクリプタブル・オブジェクトとオブジェクトプールを活用したエフェクト複数種管理��>スクリプタブル・オブジェクトとオブジェクトプールを活用したエフェクト複数種管理��]]%%%''
----
*ToastSlot クラス
オブジェクトプールを利用してこのオブジェクトを再利用する設計です。
PoolBase クラスを継承し、オブジェクトプールに対応できるようにしています。
Text コンポーネント部分は適宜 TextMeshPro などに変更してください。
''ToastSlot.cs''
[+] <= クリックすると開きます
=|BOX|
using UnityEngine;
using UnityEngine.UI;
using DG.Tweening;
using UnityEngine.Events;
public class ToastSlot : PoolBase {
[SerializeField] private Image imgIcon;
[SerializeField] private Text txtItemName;
[SerializeField] private float moveDuration = 0.5f;
[SerializeField] private CanvasGroup canvasGroup;
private float interval = 1.0f;
private float endPosX;
/// <summary>
/// トーストの設定
/// </summary>
/// <param name="rewardType"></param>
/// <param name="itemIndex"></param>
/// <param name="getCount"></param>
public void SetToastSlot(int itemIndex, int getCount) {
// 最終的な移動位置を保持(画面外)
endPosX = transform.position.x;
// TODO アイテムデータの取得。プロジェクトに応じて実装
ItemMasterData itemData = [アイテムデータの取得処理を書いてください]
// TODO 画像の取得。プロジェクトに応じて実装
imgIcon.sprite = [アイテムデータを元に画像の取得処理を書いてください]
// TODO アイテム名表示。プロジェクトに応じて実装
txtItemName.text = $"{ itemData.itemName } x {getCount}";
}
/// <summary>
/// トーストの移動
/// </summary>
/// <param name="targetTran"></param>
/// <param name="contentTran"></param>
/// <param name="canvasTran"></param>
/// <param name="endAction">ToastManager の RemoveList が入っている</param>
public void MoveSlot(Transform targetTran, Transform contentTran, Transform canvasTran, UnityAction<ToastSlot> endAction) {
transform.localPosition = Vector3.zero;
RectTransform rectTransform = transform as RectTransform;
// 画面左端からスライドインし、再度左端にスライドアウトしていくアニメ処理
Sequence sequence = DOTween.Sequence();
// スライドイン
sequence.Append(rectTransform.DOAnchorPosX(targetTran.localPosition.x, moveDuration)
.SetEase(Ease.InQuart)
.OnComplete(() => transform.SetParent(contentTran))); // 画面外から画面内に移動後、ScrollView の Content の子オブジェクトにして整列させます
// 一時停止
sequence.AppendInterval(interval).OnComplete(() => transform.SetParent(canvasTran)); // 一定時間待機後、Canvas の子オブジェクトにして、Content の影響を受けない状態にします
// スライドアウト
sequence.Append(rectTransform.DOAnchorPosX(endPosX, moveDuration).SetEase(Ease.InCubic))
.OnComplete(() => ReleaseSlot(endAction));
}
/// <summary>
/// 見えないトーストの設定
/// </summary>
/// <param name="contentTran"></param>
public void HideSlot(Transform contentTran) {
canvasGroup.alpha = 0.0f;
transform.SetParent(contentTran);
Sequence sequence = DOTween.Sequence();
sequence.AppendInterval(moveDuration).OnComplete(() => ReleaseSlot());
}
/// <summary>
/// トーストを初期化し、オブジェクトプールへ戻す
/// </summary>
/// <param name="endAction">ToastManager の RemoveList メソッドを実行</param>
private void ReleaseSlot(UnityAction<ToastSlot> endAction = null) {
// ヒエラルキーにトーストがアクティブ状態で残っている場合のみ
if (gameObject.activeInHierarchy) {
// List から削除
endAction?.Invoke(this);
// オブジェクトプールで再利用するため初期化
transform.SetParent(null); // Canvas の子オブジェクトや、Generator の子オブジェクトにしておいても問題ありません
canvasGroup.alpha = 1.0f;
ObjectPool.Release(this);
}
}
}
||=
[END]
----
*ISetup インターフェース
初期化用のメソッドを実装強要するためのインターフェースです。
=|BOX|
using UnityEngine;
/// <summary>
/// 初期設定共通化用のインターフェース
/// </summary>
public interface ISetup {
void SetUp(GameObject entityObject = null);
}
||=
----
*ToastSlotGenerator クラス
オブジェクトプールの機能を活用するために作成済の GeneratorBase クラスを継承し、ISetup インターフェースを実装します。
Debug.Log メソッドはコメントアウトしていますが、実際に挙動を確認してからコメントアウトするようにした方がいいでしょう。
オブジェクトプールとして生成する機能については GeneratorBase クラスのメソッドをそのまま利用しますので、このクラスではオーバーロードしていません。
''ToastSlotGenerator.cs''
[+] <= クリックすると開きます
=|BOX|
using UnityEngine;
public class ToastSlotGenerator : GeneratorBase, ISetup
{
/// <summary>
/// インターフェースの実装
/// 初期設定
/// </summary>
/// <param name="entityObject"></param>
public void SetUp(GameObject entityObject = null) {
// ObjectPool の初期化
InitObjectPool();
//Debug.Log($"{this} Setup 完了");
}
}
||=
[END]
----
*AbstractSingleton クラス
シングルトンクラスを作成するための親クラスです。
継承することにより、指定したクラスをシングルトンクラスとして機能させます。
今回は次に作成するクラスにて利用しますが、ほかのプロジェクトにも有用な親クラスです。
''AbstractSingleton.cs''
[+] <= クリックすると開きます
=|BOX|
using UnityEngine;
/// <summary>
/// 派生クラスに対するシングルトンの基本機能を提供する抽象クラス
/// </summary>
/// <typeparam name="T">シングルトンにしたいインスタンスの型</typeparam>
public abstract class AbstractSingleton<T> : MonoBehaviour where T : Component {
public static T instance;
protected virtual void Awake() {
if (instance == null) {
instance = this as T;
DontDestroyOnLoad(gameObject);
} else {
Destroy(gameObject);
}
}
}
||=
[END]
----
*ToastManager クラス
AbstractSingleton クラスを継承し、シングルトンクラスとして機能させます。
理由はアイテム獲得のタイミングが様々な状況で発生しえるため、それに対応できる設計とするためです。
また Setup メソッドを利用して初期設定を行えるように ISetup インターフェースを実装して処理の共通化を図っています。
''ToastManager.cs''
[+] <= クリックすると開きます
=|BOX|
using System.Collections.Generic;
using UnityEngine;
public class ToastManager : AbstractSingleton<ToastManager>, ISetup
{
[SerializeField] private Transform generateToastTran;
[SerializeField] private Transform targetTran;
[SerializeField] private Transform contentTran;
[SerializeField] private Transform canvasTran;
[SerializeField] private ToastSlotGenerator toastSlotGenerator; // オブジェクトプール用
private List<ToastSlot> toastSlotList = new();
// デバッグ用
void Start() {
SetUp();
}
/// <summary>
/// インターフェースの実装
/// 実際に外部クラスから実行する予定
/// </summary>
public void SetUp(GameObject entityObject = null) {
toastSlotGenerator.SetUp();
}
/// <summary>
/// トーストの生成()
/// </summary>
/// <param name="rewardType"></param>
/// <param name="index"></param>
/// <param name="getCount"></param>
public void GenerateToastSlot(int index, int getCount = 1) {
// トーストスロットをオブジェクトプールから取り出す
ToastSlot toastSlot = (ToastSlot)toastSlotGenerator.GetObjectFromPool(generateToastTran);
toastSlot.gameObject.SetActive(true);
// トーストの設定と移動
toastSlot.SetToastSlot(index, getCount);
toastSlot.MoveSlot(targetTran, contentTran, canvasTran, RemoveList);
// すでに表示されているトーストがある場合
if (toastSlotList.Count > 0) {
// Content の一番下を１つ分空けるため、見えないトーストを配置
ToastSlot nullSlot = (ToastSlot)toastSlotGenerator.GetObjectFromPool(targetTran);
nullSlot.HideSlot(contentTran);
}
toastSlotList.Add(toastNotificationSlot);
}
private void RemoveList(ToastSlot toastNotificationSlot) {
toastSlotList.Remove(toastNotificationSlot);
}
}
||=
[END]
----
*テストコードの作成
実際のプロジェクトにつなぎこむ前に、テストコードを作成して、動作確認を行いましょう。
テストコードは、実際のプロジェクトのコードをテストするために使用される補助的なコードであり、
通常は本番コードとは分離された独立したファイルやクラスとして作成されます。
テストコードは、本番コードの機能が正しく機能し、期待どおりに動作することを確認するために使用されます。
これには、ユニットテスト、統合テスト、機能テストなど、さまざまな種類のテストが含まれます。
テストコードは通常、期待される出力や動作と実際の出力や動作を比較し、問題を特定するためにアサーションを使用します。
今回作成する TestGenerateToast クラスは、ToastManager の GenerateToastSlot メソッドをテストするためのテストコードとして機能します。
このクラスは、GenerateToastSlot メソッドがマウスクリックのタイミングで正しく動作するかどうかを確認するために使用されます。
''TestGenerateToast.cs''
[+] <= クリックすると開きます
=|BOX|
using UnityEngine;
using UniRx;
using UniRx.Triggers;
public class TestGenerateToast : MonoBehaviour
{
[SerializeField] private int index = 0;
[SerializeField] private int getCount = 1;
void Start()
{
// マウスがクリックされたらGenerateToastSlotメソッドを呼び出す
this.UpdateAsObservable()
.Where(_ => Input.GetMouseButtonDown(0))
.Subscribe(_ => GenerateToast());
}
private void GenerateToast()
{
// シングルトンのToastManagerのインスタンスを取得し、GenerateToastSlotメソッドを呼び出す
ToastManager.instance.GenerateToastSlot(index, getCount);
}
}
||=
[END]
----
スクリプトを作成したら、Create Empty で新規オブジェクトを作成し、アタッチします。
既存のオブジェクトにアタッチしても問題ありません。
&ref(https://image02.seesaawiki.jp/i/o/i-school-memo/gqTuXOjZRg.png, 35%)
----
ゲームを実行し、動作確認を行ってください。
&ref(https://image02.seesaawiki.jp/i/o/i-school-memo/TE9W9jnRn0.gif, 35%)
問題ないことが確認できたら、実際に自分のプロジェクトに採用するため、処理のつなぎこみを行いましょう。
以上になります。
なお、C# と Unity の基礎知識＋アルファの学習(中級者クラス)が必要になります。
----
前回までの続きです。制作した UI を利用し、アイテム獲得時のログ表示機能の実装を行います。
事前の準備が必要になりますが、C# と Unity の基礎知識＋アルファの学習(中級者クラス)が必要になります。
この教材の手順を見ても実装が難しい方はまず
=|PERL|
��C# の機能の学習(クラスの継承、インターフェースなどを活用した抽象化の学習）
�▲妊競ぅ鵐僖拭璽鵑粒惱�(オブジェクトプール、オブザーバーパターン、シングルトンパターン)
��Unity の機能の学習(オブジェクトプール、スクリプタブル・オブジェクト)
||=
などを学習してから実装にチャレンジしてください。
----
*データベースの準備
サーバー、あるいはスクリプタブル・オブジェクトなどでアイテムのデータを用意し、ゲーム内取得できるように準備を行って下さい。
下記の教材を参考にしていただいても問題ありません。
=> ''%%%[[アイテムの情報をスクリプタブル・オブジェクトに登録して利用する>アイテムの情報をスクリプタブル・オブジェクトに登録して利用する]]%%%''
----
*オブジェクトプールの準備
オブジェクトプールの準備を行ってください。
下記の教材を参考にしていただいても問題ありません。
=> ''%%%[[スクリプタブル・オブジェクトとオブジェクトプールを活用したエフェクト複数種管理��>スクリプタブル・オブジェクトとオブジェクトプールを活用したエフェクト複数種管理��]]%%%''
=> ''%%%[[スクリプタブル・オブジェクトとオブジェクトプールを活用したエフェクト複数種管理��>スクリプタブル・オブジェクトとオブジェクトプールを活用したエフェクト複数種管理��]]%%%''
=> ''%%%[[スクリプタブル・オブジェクトとオブジェクトプールを活用したエフェクト複数種管理��>スクリプタブル・オブジェクトとオブジェクトプールを活用したエフェクト複数種管理��]]%%%''
----
*ToastSlot クラス
オブジェクトプールを利用してこのオブジェクトを再利用する設計です。
PoolBase クラスを継承し、オブジェクトプールに対応できるようにしています。
Text コンポーネント部分は適宜 TextMeshPro などに変更してください。
''ToastSlot.cs''
[+] <= クリックすると開きます
=|BOX|
using UnityEngine;
using UnityEngine.UI;
using DG.Tweening;
using UnityEngine.Events;
public class ToastSlot : PoolBase {
[SerializeField] private Image imgIcon;
[SerializeField] private Text txtItemName;
[SerializeField] private float moveDuration = 0.5f;
[SerializeField] private CanvasGroup canvasGroup;
private float interval = 1.0f;
private float endPosX;
/// <summary>
/// トーストの設定
/// </summary>
/// <param name="rewardType"></param>
/// <param name="itemIndex"></param>
/// <param name="getCount"></param>
public void SetToastSlot(int itemIndex, int getCount) {
// 最終的な移動位置を保持(画面外)
endPosX = transform.position.x;
// TODO アイテムデータの取得。プロジェクトに応じて実装
ItemMasterData itemData = [アイテムデータの取得処理を書いてください]
// TODO 画像の取得。プロジェクトに応じて実装
imgIcon.sprite = [アイテムデータを元に画像の取得処理を書いてください]
// TODO アイテム名表示。プロジェクトに応じて実装
txtItemName.text = $"{ itemData.itemName } x {getCount}";
}
/// <summary>
/// トーストの移動
/// </summary>
/// <param name="targetTran"></param>
/// <param name="contentTran"></param>
/// <param name="canvasTran"></param>
/// <param name="endAction">ToastManager の RemoveList が入っている</param>
public void MoveSlot(Transform targetTran, Transform contentTran, Transform canvasTran, UnityAction<ToastSlot> endAction) {
transform.localPosition = Vector3.zero;
RectTransform rectTransform = transform as RectTransform;
// 画面左端からスライドインし、再度左端にスライドアウトしていくアニメ処理
Sequence sequence = DOTween.Sequence();
// スライドイン
sequence.Append(rectTransform.DOAnchorPosX(targetTran.localPosition.x, moveDuration)
.SetEase(Ease.InQuart)
.OnComplete(() => transform.SetParent(contentTran))); // 画面外から画面内に移動後、ScrollView の Content の子オブジェクトにして整列させます
// 一時停止
sequence.AppendInterval(interval).OnComplete(() => transform.SetParent(canvasTran)); // 一定時間待機後、Canvas の子オブジェクトにして、Content の影響を受けない状態にします
// スライドアウト
sequence.Append(rectTransform.DOAnchorPosX(endPosX, moveDuration).SetEase(Ease.InCubic))
.OnComplete(() => ReleaseSlot(endAction));
}
/// <summary>
/// 見えないトーストの設定
/// </summary>
/// <param name="contentTran"></param>
public void HideSlot(Transform contentTran) {
canvasGroup.alpha = 0.0f;
transform.SetParent(contentTran);
Sequence sequence = DOTween.Sequence();
sequence.AppendInterval(moveDuration).OnComplete(() => ReleaseSlot());
}
/// <summary>
/// トーストを初期化し、オブジェクトプールへ戻す
/// </summary>
/// <param name="endAction">ToastManager の RemoveList メソッドを実行</param>
private void ReleaseSlot(UnityAction<ToastSlot> endAction = null) {
// ヒエラルキーにトーストがアクティブ状態で残っている場合のみ
if (gameObject.activeInHierarchy) {
// List から削除
endAction?.Invoke(this);
// オブジェクトプールで再利用するため初期化
transform.SetParent(null); // Canvas の子オブジェクトや、Generator の子オブジェクトにしておいても問題ありません
canvasGroup.alpha = 1.0f;
ObjectPool.Release(this);
}
}
}
||=
[END]
----
*ISetup インターフェース
初期化用のメソッドを実装強要するためのインターフェースです。
=|BOX|
using UnityEngine;
/// <summary>
/// 初期設定共通化用のインターフェース
/// </summary>
public interface ISetup {
void SetUp(GameObject entityObject = null);
}
||=
----
*ToastSlotGenerator クラス
オブジェクトプールの機能を活用するために作成済の GeneratorBase クラスを継承し、ISetup インターフェースを実装します。
Debug.Log メソッドはコメントアウトしていますが、実際に挙動を確認してからコメントアウトするようにした方がいいでしょう。
オブジェクトプールとして生成する機能については GeneratorBase クラスのメソッドをそのまま利用しますので、このクラスではオーバーロードしていません。
''ToastSlotGenerator.cs''
[+] <= クリックすると開きます
=|BOX|
using UnityEngine;
public class ToastSlotGenerator : GeneratorBase, ISetup
{
/// <summary>
/// インターフェースの実装
/// 初期設定
/// </summary>
/// <param name="entityObject"></param>
public void SetUp(GameObject entityObject = null) {
// ObjectPool の初期化
InitObjectPool();
//Debug.Log($"{this} Setup 完了");
}
}
||=
[END]
----
*AbstractSingleton クラス
シングルトンクラスを作成するための親クラスです。
継承することにより、指定したクラスをシングルトンクラスとして機能させます。
今回は次に作成するクラスにて利用しますが、ほかのプロジェクトにも有用な親クラスです。
''AbstractSingleton.cs''
[+] <= クリックすると開きます
=|BOX|
using UnityEngine;
/// <summary>
/// 派生クラスに対するシングルトンの基本機能を提供する抽象クラス
/// </summary>
/// <typeparam name="T">シングルトンにしたいインスタンスの型</typeparam>
public abstract class AbstractSingleton<T> : MonoBehaviour where T : Component {
public static T instance;
protected virtual void Awake() {
if (instance == null) {
instance = this as T;
DontDestroyOnLoad(gameObject);
} else {
Destroy(gameObject);
}
}
}
||=
[END]
----
*ToastManager クラス
AbstractSingleton クラスを継承し、シングルトンクラスとして機能させます。
理由はアイテム獲得のタイミングが様々な状況で発生しえるため、それに対応できる設計とするためです。
また Setup メソッドを利用して初期設定を行えるように ISetup インターフェースを実装して処理の共通化を図っています。
''ToastManager.cs''
[+] <= クリックすると開きます
=|BOX|
using System.Collections.Generic;
using UnityEngine;
public class ToastManager : AbstractSingleton<ToastManager>, ISetup
{
[SerializeField] private Transform generateToastTran;
[SerializeField] private Transform targetTran;
[SerializeField] private Transform contentTran;
[SerializeField] private Transform canvasTran;
[SerializeField] private ToastSlotGenerator toastSlotGenerator; // オブジェクトプール用
private List<ToastSlot> toastSlotList = new();
// デバッグ用
void Start() {
SetUp();
}
/// <summary>
/// インターフェースの実装
/// 実際に外部クラスから実行する予定
/// </summary>
public void SetUp(GameObject entityObject = null) {
toastSlotGenerator.SetUp();
}
/// <summary>
/// トーストの生成()
/// </summary>
/// <param name="rewardType"></param>
/// <param name="index"></param>
/// <param name="getCount"></param>
public void GenerateToastSlot(int index, int getCount = 1) {
// トーストスロットをオブジェクトプールから取り出す
ToastSlot toastSlot = (ToastSlot)toastSlotGenerator.GetObjectFromPool(generateToastTran);
toastSlot.gameObject.SetActive(true);
// トーストの設定と移動
toastSlot.SetToastSlot(index, getCount);
toastSlot.MoveSlot(targetTran, contentTran, canvasTran, RemoveList);
// すでに表示されているトーストがある場合
if (toastSlotList.Count > 0) {
// Content の一番下を１つ分空けるため、見えないトーストを配置
ToastSlot nullSlot = (ToastSlot)toastSlotGenerator.GetObjectFromPool(targetTran);
nullSlot.HideSlot(contentTran);
}
toastSlotList.Add(toastNotificationSlot);
}
private void RemoveList(ToastSlot toastNotificationSlot) {
toastSlotList.Remove(toastNotificationSlot);
}
}
||=
[END]
----
*テストコードの作成
実際のプロジェクトにつなぎこむ前に、テストコードを作成して、動作確認を行いましょう。
テストコードは、実際のプロジェクトのコードをテストするために使用される補助的なコードであり、
通常は本番コードとは分離された独立したファイルやクラスとして作成されます。
テストコードは、本番コードの機能が正しく機能し、期待どおりに動作することを確認するために使用されます。
これには、ユニットテスト、統合テスト、機能テストなど、さまざまな種類のテストが含まれます。
テストコードは通常、期待される出力や動作と実際の出力や動作を比較し、問題を特定するためにアサーションを使用します。
今回作成する TestGenerateToast クラスは、ToastManager の GenerateToastSlot メソッドをテストするためのテストコードとして機能します。
このクラスは、GenerateToastSlot メソッドがマウスクリックのタイミングで正しく動作するかどうかを確認するために使用されます。
''TestGenerateToast.cs''
[+] <= クリックすると開きます
=|BOX|
using UnityEngine;
using UniRx;
using UniRx.Triggers;
public class TestGenerateToast : MonoBehaviour
{
[SerializeField] private int index = 0;
[SerializeField] private int getCount = 1;
void Start()
{
// マウスがクリックされたらGenerateToastSlotメソッドを呼び出す
this.UpdateAsObservable()
.Where(_ => Input.GetMouseButtonDown(0))
.Subscribe(_ => GenerateToast());
}
private void GenerateToast()
{
// シングルトンのToastManagerのインスタンスを取得し、GenerateToastSlotメソッドを呼び出す
ToastManager.instance.GenerateToastSlot(index, getCount);
}
}
||=
[END]
----
スクリプトを作成したら、Create Empty で新規オブジェクトを作成し、アタッチします。
既存のオブジェクトにアタッチしても問題ありません。
&ref(https://image02.seesaawiki.jp/i/o/i-school-memo/gqTuXOjZRg.png, 35%)
----
ゲームを実行し、動作確認を行ってください。
&ref(https://image02.seesaawiki.jp/i/o/i-school-memo/TE9W9jnRn0.gif, 35%)
問題ないことが確認できたら、実際に自分のプロジェクトに採用するため、処理のつなぎこみを行いましょう。
以上になります。