CRIWARE Unity Plugin Manual  Last Updated: 2024-04-24
CriWareErrorHandler クラス

CRIWAREエラーオブジェクト [詳解]

CriMonoBehaviourを継承しています。

公開メンバ関数

delegate void Callback (string message)
 エラーコールバックデリゲート [詳解]
 

公開変数類

bool enableDebugPrintOnTerminal = false
 コンソールデバッグ出力を有効にするかどうか [詳解]
 
bool enableForceCrashOnError = false
 デバッグ向け強制クラッシュフラグ [詳解]
 
bool dontDestroyOnLoad = true
 
uint messageBufferCounts = 8
 

静的公開変数類

static readonly string logPrefix = "[CRIWARE]"
 ログメッセージプレフィックス [詳解]
 
static Callback callback = null
 エラーコールバック [詳解]
 

プロパティ

static string errorMessage [get, set]
 
static Callback OnCallback
 エラーコールバックイベント [詳解]
 

詳解

CRIWAREエラーオブジェクト

説明:
CRIWAREライブラリのエラーメッセージを取得し出力するコンポーネントです。

関数詳解

delegate void Callback ( string  message)

エラーコールバックデリゲート

説明:
CRIWAREネイティブライブラリ内でエラーが発生した際に呼び出されるコール バックデリゲートです。
引数の文字列には、"エラーID:エラー内容"のフォーマットでメッセージが 記載されています。

メンバ詳解

bool enableDebugPrintOnTerminal = false

コンソールデバッグ出力を有効にするかどうか

非推奨:
削除予定の非推奨APIです。本値は使用されていません。
注意:
Unityデバッグウィンドウだけでなく、コンソールデバッグ出力を有効にするかどうか [deprecated] PCの場合はデバッグウィンドウに出力されます。
bool enableForceCrashOnError = false

デバッグ向け強制クラッシュフラグ

説明:
trueの場合、エラー発生時に強制的にクラッシュさせます。
OnCallback にイベントが登録されている場合のみ作用します。
bool dontDestroyOnLoad = true

シーンチェンジ時にエラーハンドラを削除するかどうか

readonly string logPrefix = "[CRIWARE]"
static

ログメッセージプレフィックス

説明:
CRIWAREによるログメッセージを示すプレフィックスです。
Callback callback = null
static

エラーコールバック

非推奨:
削除予定の非推奨APIです。 CriWareErrorHandler.OnCallback event の使用を検討してください。
説明:
CRIWAREネイティブライブラリ内でエラーが発生した際に呼び出されるコール バックです。
未設定時には、本クラス内に定義されているデフォルトのログ出力関数が 呼び出されます。
エラーメッセージを元に独自の処理を記述したい場合、デリゲートを登録して コールバック関数内で処理を行ってください。
登録を解除する場合は null を設定してください。
注意:
登録したコールバックは、CriWareErrorHandlerが生存中は常に呼び出される 可能性があります。
呼び出し先関数の実体が、CriWareErrorHandlerよりも先に解放されないように ご注意ください。
uint messageBufferCounts = 8
非推奨:
削除予定の非推奨APIです。 本値によらずエラーメッセージがキューイングできるようになったため、本値は参照されません。

プロパティ詳解

string errorMessage
staticgetset
非推奨:
削除予定の非推奨APIです。本値は使用されていません。
Callback OnCallback
staticaddremove

エラーコールバックイベント

説明:
CRIWAREネイティブライブラリ内でエラーが発生した際に呼び出されるコール
バックイベントです。
未設定時には、本クラス内に定義されているデフォルトのログ出力関数が
呼び出されます。
エラーメッセージを元に独自の処理を記述したい場合、デリゲートを登録して
コールバック関数内で処理を行ってください。
本イベントは必ずメインスレッドから呼び出されます。
注意:
登録したコールバックは、CriWareErrorHandlerが生存中は常に呼び出される
可能性があります。
呼び出し先関数の実体が、CriWareErrorHandlerよりも先に解放されないように
ご注意ください。

このクラス詳解は次のファイルから抽出されました: