CRIWARE Unity Plugin Manual  Last Updated: 2024-07-12
CriWareErrorHandler Class Reference

CRIWARE error handling object More...

Inherits CriMonoBehaviour.

Public Member Functions

delegate void Callback (string message)
 Error callback delegate More...
 

Public Attributes

bool enableDebugPrintOnTerminal = false
 Whether to enable Coroutine debug output More...
 
bool enableForceCrashOnError = false
 Force crash flag (for debugging only) More...
 
bool dontDestroyOnLoad = true
 
uint messageBufferCounts = 8
 

Static Public Attributes

static readonly string logPrefix = "[CRIWARE]"
 Log message prefix More...
 
static Callback callback = null
 Error callback More...
 

Properties

static string errorMessage [get, set]
 
static Callback OnCallback
 Error callback event More...
 

Detailed Description

CRIWARE error handling object

Description:
This component obtains and outputs error messages generated by the CRIWARE library.

Member Function Documentation

delegate void Callback ( string  message)

Error callback delegate

Description:
A callback delegate that will be called when an error occurs in the CRIWARE native library.
The argument string contains the message in the format "Error ID: Error details".

Member Data Documentation

bool enableDebugPrintOnTerminal = false

Whether to enable Coroutine debug output

Deprecated:
削除予定の非推奨APIです。本値は使用されていません。
Note:
Whether to enable console debug output along with Unity debug window output [deprecated] It will only output to the Unity debug window on PC.
bool enableForceCrashOnError = false

Force crash flag (for debugging only)

Description:
When set to true, it will force a crash when an error occurs.
Only valid when there is an event registered in OnCallback .
bool dontDestroyOnLoad = true

Whether to remove the error handler at scene change

readonly string logPrefix = "[CRIWARE]"
static

Log message prefix

Description:
Prefix indicating log messages from CRIWARE.
Callback callback = null
static

Error callback

Deprecated:
削除予定の非推奨APIです。 CriWareErrorHandler.OnCallback event の使用を検討してください。
Description:
A callback that will be called when an error occurs in the CRIWARE native library.
If not set, the default log output function defined in this class will be called.
If a user defined process based on the error message is preferred, register a delegate and perform the process inside the callback function.
Set the callback to null to unregister.
Note:
The registered callback may be called at any time while CriWareErrorHandler is active.
Therefore, be careful not to release the instance of the callback before CriWareErrorHandler .
uint messageBufferCounts = 8
Deprecated:
This is a deprecated API that will be removed. This value is not referenced since error messages can now be queued regardless of this value.

Property Documentation

string errorMessage
staticgetset
Deprecated:
This is a deprecated API that will be removed. The value is not used.
Callback OnCallback
staticaddremove

Error callback event

Description:
The callback event to be called when an error occurs within the CRIWARE native library.
If not set, the default log output function defined in this class will be called instead.
If you need to write custom error handling based on the error message,
register a delegate and handle the error inside the callback function.
This event is always called from the main thread.
Note:
The registered callback may be called at any time while CriWareErrorHandler is active.

Be aware not to release the instance of the called function before CriWareErrorHandler .


The documentation for this class was generated from the following file: