GutTrackedError

Inherits: RefCounted

This contains all the information provided by Godot about an error. This is also used to represent a GUT error. See Logger for additional information about properties. Some properties are not populated for GUT errors.

Properties

Variant	backtrace	[]
Variant	code	"NONE"
Variant	rationale	"NONE"
Variant	error_type	-1
Variant	editor_notify	false
Variant	file	"NONE"
Variant	function	"NONE"
Variant	line	-1
Variant	handled	false

Methods

Variant	contains_text(text)
Variant	get_error_type_name()
Variant	is_engine_error()
Variant	is_gut_error()
Variant	is_push_error()
Variant	is_push_warning()
String	to_s()

---

Property Descriptions

Variant backtrace = [] 🔗

This will be an Array[ScriptBacktrace] for engine/push errors. This will the result of get_stack for GUT errors.

---

Variant code = "NONE" 🔗

Usually the description

---

Variant rationale = "NONE" 🔗

No description

---

Variant error_type = -1 🔗

Logger.ErrorType value or, for GUT errors, this will be GutUtils.GUT_ERROR_TYPE.

---

Variant editor_notify = false 🔗

No description

---

Variant file = "NONE" 🔗

The full path to the file where the error occurred.

---

Variant function = "NONE" 🔗

The function name in file where the error occurred.

---

Variant line = -1 🔗

The line number in file

---

Variant handled = false 🔗

Used by GUT to flag errors as being handled. This is set by various asserts or can be set in a test. When set to true GUT will ignore it when determining if an unexpected error occurred during the execution of the test. Setting this value prior to performing any of the error related asserts may have unexpected results. It is recommended you either set this manually or use the error asserts.

---

Method Descriptions

String to_s() 🔗

_to_string that is not _to_string.

---

Variant is_push_error() 🔗

Returns true if the error is a push_error.

---

Variant is_engine_error() 🔗

Returns true if the error is an engine error. This includes all errors that pass through the Logger that do not originate from the push_error function.

---

Variant is_push_warning() 🔗

No description

---

Variant is_gut_error() 🔗

Returns true if the error is a GUT error. Some fields may not be populated for GUT errors.

---

Variant contains_text(text) 🔗

No description

---

Variant get_error_type_name() 🔗

For display purposes only, the actual value returned may change over time. This returns a name for the error_type as far as this class is concerned. Use the various is_ methods to check if an error is a certain type.