NoaConsoleLog
このクラスを介して、ConsoleLog機能が保持しているログを取得できます。
API一覧
Static Methods
API | 説明 |
---|---|
Add(LogType, message, stackTrace) | ConsoleLogツールに出力するログを追加します。 stackTraceの指定がない場合、自動的にスタックトレースを取得します。 |
Clear() | 保持しているログ情報を一括削除します。 |
Static Properties
API | 説明 |
---|---|
LogList | 保持しているログ情報の一覧を返します。 |
OnError | エラー検出時に実行するイベントです。 |
OnFilterErrorNotification | エラー検出時に通知を表示するかを判定するデリゲートです。trueを返すと通知を表示します。 具体的な使用方法はサンプルコードを参照してください。 |
OnLogCopied | ログをクリップボードにコピーした時に実行するイベントです。 |
OnLogDownload | ログをダウンロードする時に実行するイベントです。 イベントハンドラが true を返すとダウンロードを許可し、false を返すとダウンロードを拒否します。 ※このイベント登録時に OnLogDownloadWithLogEntries のイベント登録を解除します。 |
OnLogDownloadWithLogEntries | ログをダウンロードする時に実行するイベントです。 イベントハンドラが true を返すとダウンロードを許可し、false を返すとダウンロードを拒否します。 ※このイベント登録時に OnLogDownload のイベント登録を解除します。 |
OnLogSend | ログを送信する際に実行するイベントです。 ConsoleLogツールの[ |
サンプルコード
using System.Collections.Generic;
using UnityEngine;
#if NOA_DEBUGGER
using NoaDebugger;
#endif
public class Example
{
void ExampleMethod()
{
#if NOA_DEBUGGER
// ConsoleLog機能が保持しているログ情報の一覧を取得
LinkedList<ConsoleLogEntry> consoleLogList = NoaConsoleLog.LogList;
// ConsoleLog機能にログを追加
NoaConsoleLog.Add(UnityEngine.LogType.Error, "log_message", "log_stacktrace");
// ConsoleLog機能にログを追加(スタックトレースを指定しない場合)
NoaConsoleLog.Add(UnityEngine.LogType.Error, "log_message");
// エラー検出時に実行するイベントを設定
NoaConsoleLog.OnError += (ConsoleLogEntry log) => Debug.Log("Error detected.");
// エラー検出時に通知を表示するかを判定するデリゲートを設定
NoaConsoleLog.OnFilterErrorNotification += (ConsoleLogEntry log) => log.LogString.StartsWith("Log to notify an error.");
// ログをクリップボードにコピーした時に実行するイベントを設定
NoaConsoleLog.OnLogCopied += (ConsoleLogEntry log, string clipboardText) => Debug.Log($"Log copied. Clipboard: {clipboardText}");
// ログをダウンロードする時に実行するイベントを設定
NoaConsoleLog.OnLogDownload += (string filename, string jsonData) =>
{
Debug.Log($"Logs download. Filename: {filename}");
// ローカルにダウンロードを許可する場合はtrueを返す
// ローカルにダウンロードを拒否する場合はfalseを返す
return true;
};
// ログをダウンロードする時に実行するイベントを設定(ログ情報を取得する場合)
NoaConsoleLog.OnLogDownloadWithLogEntries += (string filename, List<ConsoleLogEntry> logList) =>
{
Debug.Log($"Logs download. Filename: {filename}");
// ローカルにダウンロードを許可する場合はtrueを返す
// ローカルにダウンロードを拒否する場合はfalseを返す
return true;
};
// ログを送信する際に実行するイベントを設定
NoaConsoleLog.OnLogSend += (List<ConsoleLogEntry> logList) => Debug.Log("Log sent.");
// ログを一括削除します
NoaConsoleLog.Clear();
#endif
}
}