[UNITY]2DRPG開発日誌 #83 『Extended Debug Logs』ドキュメント日本語訳

このページは、UNITYのアセット『Extended Debug Logs』に同梱されているPDFファイルをDeepL翻訳したものです。

1. Get started quickly

新しいロギングを使用したいコード内の任意の場所で、まず "DTT.ExtendedDebugLogs" 名前空間をインポートしてください。

これにより、より良いロギングを可能にする様々なメソッドを含むDebugEx静的クラスを利用することができます。

これは、標準のUnity「Debug」が含むすべてのものを含んでいます。

推奨されるメソッドは、「LogArray」、「LogDictionary」または「LogObject」です。

すべての可能性については、APIセクションを参照してください。

すべてのログは、ログを「タグ付け」することができるように追加の引数を取ることができるようになりました、セットアップセクションでこれについての詳細を参照してください。

2. はじめに

Extended Debug Logsは、開発者がデバッグログを次のレベルに引き上げるためのアセットです。

ログを分類し、タグ付けすることができます。

これらの分類により、対象となるログのロギングを有効または無効にすることができます。

この主な利点は、ログを所定の場所に保管できるようになり、ログを無効にすることができるため、ログを掃除する必要がないことです。

そして、将来、何かが期待通りに動作しなくなったときに、ログを有効にして、問題の原因がどこにあるのかを効果的に特定することができます。

3. Set-Up

タグ

パッケージをインポートすると、画面上部の「Tools/DTT/Extended Debug Logs/Tag Window」に新しいメニュー項目が表示されます。

このメニューを選択すると、デバッグに使用するタグに関連するすべての設定を確認できるウィンドウが表示されます。

このウィンドウでは、まず、プロジェクトのタグコンテナを作成することができます。

これはスクリプト可能なオブジェクトで、プロジェクトに関連するタグの全データが格納されます。

名前は自由につけることができ、「+」アイコンを押して作成します。

これでタグコンテナができたので、カテゴリーの追加を開始することができます。

どのカテゴリーにもタグを入れることができます。

つまり、この階層を利用して、カテゴリーを整理することができるのです。

内部的には、カテゴリはクラスとして作成され、タグはそのクラスのメンバーとして作成されるので、名前を付けるときはその点に注意してください。

タグとカテゴリーを有効または無効にすることができ、これにより、そのタグでタグ付けされたログは記録されなくなります。

カラーフィールドは、タグがコンソールに表示されるときに、そのタグにパーソナライズされた色を与えるために使用することができます。

これは、成功や失敗を示す特定のログを素早く認識するのに非常に便利です。

カテゴリやタグを右クリックすると、名前の変更と削除ができます。

タグに修正を加えた場合、右上の再生ボタンを押すことで、すべての変更が適用されます。

タグの名前を変更したり削除したりすると、もう存在しないタグを参照することになるため、コンパイルエラーが発生することがありますので、ご注意ください。

4. API

DebugEx

メソッド名引数説明
LogArrayT[] array

object message

Tag tag (optional)

Object context (optional)
指定された配列を1つのデバッグメッセージとしてログに記録します。
LogDictionaryDictionary dictionary

object message

Tag tag (optional)

Object context (optional)
提供された辞書を、すべてのキーと値のペアを持つ単一のデバッグメッセージに記録します。
LogEnumerableIEnumerable
enumerable

object message

Tag tag (optional)

Object context (optional)
IEnumerable インターフェースを実装したオブジェクトをログに記録します。ほとんどのコレクションはこのインターフェイスを実装しているので、おそらくあなたが出会ったどんなコレクションでもログを記録することができるだろうことに注意してください。
LogListList list

object message

Tag tag (optional)

Object context (optional)
提供されたリストを1つのデバッグメッセージとしてログに記録します。
LogObjectT object

object message

Tag tag (optional)

Object context (optional)
与えられたオブジェクトのすべてのフィールド(パブリックおよびプライベート)をログに記録します。注意:これはリフレクションを利用しているため、パフォーマンスに影響を与える可能性があります。

DebugExtensions

メソッド名引数説明
LogExthis T obj

object message

Tag tag (optional)

Object context (optional)
提供されたオブジェクトを1つのデバッグメッセージに記録する。これは拡張メソッドであるため、このメソッドは
オブジェクトそのものになります。

5. 既知の制限事項

メッセージが記録された後にタグを無効化しても、メッセージは非表示になりません。

6. Support and feedback

(省略)