Logger

自定义日志记录器，能够从内部错误/警告流接收消息。

描述

自定义日志记录器，能够从内部错误/警告流接收消息。日志记录器通过 OS.add_logger() 注册。

方法

void	_log_error(function: String, file: String, line: int, code: String, rationale: String, editor_notify: bool, error_type: int, script_backtraces: Array[ScriptBacktrace]) virtual
void	_log_message(message: String, error: bool) virtual

枚举

enum ErrorType: 🔗

ErrorType ERROR_TYPE_ERROR = 0

接收到的消息是错误。

ErrorType ERROR_TYPE_WARNING = 1

接收到的消息是警告。

ErrorType ERROR_TYPE_SCRIPT = 2

接收到的消息是脚本错误。

ErrorType ERROR_TYPE_SHADER = 3

接收到的消息是着色器错误。

方法说明

void _log_error(function: String, file: String, line: int, code: String, rationale: String, editor_notify: bool, error_type: int, script_backtraces: Array[ScriptBacktrace]) virtual 🔗

Called when an error is logged. The error provides the function, file, and line that it originated from, as well as either the code that generated the error or a rationale.

The type of error provided by error_type is described in the ErrorType enumeration.

Additionally, script_backtraces provides backtraces for each of the script languages. These will only contain stack frames in editor builds and debug builds by default. To enable them for release builds as well, you need to enable ProjectSettings.debug/settings/gdscript/always_track_call_stacks.

Warning: This method will be called from threads other than the main thread, possibly at the same time, so you will need to have some kind of thread-safety in your implementation of it, like a Mutex.

Note: script_backtraces will not contain any captured variables, due to its prohibitively high cost. To get those you will need to capture the backtraces yourself, from within the Logger virtual methods, using Engine.capture_script_backtraces().

Note: Logging errors from this method using functions like @GlobalScope.push_error() or @GlobalScope.push_warning() is not supported, as it could cause infinite recursion. These errors will only show up in the console output.

void _log_message(message: String, error: bool) virtual 🔗

Called when a message is logged. If error is true, then this message was meant to be sent to stderr.

Warning: This method will be called from threads other than the main thread, possibly at the same time, so you will need to have some kind of thread-safety in your implementation of it, like a Mutex.

Note: Logging another message from this method using functions like @GlobalScope.print() is not supported, as it could cause infinite recursion. These messages will only show up in the console output.