EngineDebugger handles the communication between the editor and the running game. It is active in the running game. Messages can be sent/received through it. It also manages the profilers.
Clears all breakpoints.
Starts a debug break in script execution, optionally specifying whether the program can continue based on can_continue
and whether the break was due to a breakpoint.
Experimental: This method may be changed or removed in future versions.
Returns the current debug depth.
Experimental: This method may be changed or removed in future versions.
Returns the number of lines that remain.
Returns true
if a capture with the given name is present otherwise false
.
Returns true
if a profiler with the given name is present otherwise false
.
Inserts a new breakpoint with the given source
and line
.
Returns true
if the debugger is active otherwise false
.
Returns true
if the given source
and line
represent an existing breakpoint.
Returns true
if a profiler with the given name is present and active otherwise false
.
Returns true
if the debugger is skipping breakpoints otherwise false
.
Forces a processing loop of debugger events. The purpose of this method is just processing events every now and then when the script might get too busy, so that bugs like infinite loops can be caught.
Calls the add
callable of the profiler with given name
and data
.
Calls the toggle
callable of the profiler with given name
and arguments
. Enables/Disables the same profiler depending on enable
argument.
Registers a message capture with given name
. If name
is "my_message" then messages starting with "my_message:" will be called with the given callable.
The callable must accept a message string and a data array as argument. The callable should return true
if the message is recognized.
Note: The callable will receive the message with the prefix stripped, unlike EditorDebuggerPlugin._capture(). See the EditorDebuggerPlugin description for an example.
Registers a profiler with the given name
. See EngineProfiler for more information.
Removes a breakpoint with the given source
and line
.
Starts a debug break in script execution, optionally specifying whether the program can continue based on can_continue
and whether the break was due to a breakpoint.
Sends a message with given message
and data
array.
Experimental: This method may be changed or removed in future versions.
Sets the current debugging depth.
Experimental: This method may be changed or removed in future versions.
Sets the current debugging lines that remain.
Unregisters the message capture with given name
.
Unregisters a profiler with given name
.