reckfellENGINE

EngineDebugger

Exposes the internal debugger.

On this page
class EngineDebuggerReckfellSharp

Exposes the internal debugger.

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.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Properties1

SingletonProperty
# Singleton
C#
public static EngineDebuggerInstance Singleton { get; }

Methods23

ClearBreakpointsvoid
# ClearBreakpoints
C#
public static void ClearBreakpoints();

Clears all breakpoints.

Debugvoid
# Debug
C#
public static void Debug(bool canContinue = true, bool isErrorBreakpoint = false);

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.

Parameters
NameTypeDefault
canContinuebooltrue
isErrorBreakpointboolfalse
GetDepthint
# GetDepth
C#
public static int GetDepth();

Returns the current debug depth.

Returns int
GetLinesLeftint
# GetLinesLeft
C#
public static int GetLinesLeft();

Returns the number of lines that remain.

Returns int
HasCapturebool
# HasCapture
C#
public static bool HasCapture(StringName name);

Returns true if a capture with the given name is present otherwise false.

Parameters
NameTypeDefault
nameStringName—
Returns bool
HasProfilerbool
# HasProfiler
C#
public static bool HasProfiler(StringName name);

Returns true if a profiler with the given name is present otherwise false.

Parameters
NameTypeDefault
nameStringName—
Returns bool
InsertBreakpointvoid
# InsertBreakpoint
C#
public static void InsertBreakpoint(int line, StringName source);

Inserts a new breakpoint with the given source and line.

Parameters
NameTypeDefault
lineint—
sourceStringName—
IsActivebool
# IsActive
C#
public static bool IsActive();

Returns true if the debugger is active otherwise false.

Returns bool
IsBreakpointbool
# IsBreakpoint
C#
public static bool IsBreakpoint(int line, StringName source);

Returns true if the given source and line represent an existing breakpoint.

Parameters
NameTypeDefault
lineint—
sourceStringName—
Returns bool
IsProfilingbool
# IsProfiling
C#
public static bool IsProfiling(StringName name);

Returns true if a profiler with the given name is present and active otherwise false.

Parameters
NameTypeDefault
nameStringName—
Returns bool
IsSkippingBreakpointsbool
# IsSkippingBreakpoints
C#
public static bool IsSkippingBreakpoints();

Returns true if the debugger is skipping breakpoints otherwise false.

Returns bool
LinePollvoid
# LinePoll
C#
public static void LinePoll();

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.

ProfilerAddFrameDatavoid
# ProfilerAddFrameData
C#
public static void ProfilerAddFrameData(StringName name, Reckfell.Collections.Array data);

Calls the add callable of the profiler with given name and data.

Parameters
NameTypeDefault
nameStringName—
dataReckfell.Collections.Array—
ProfilerEnablevoid
# ProfilerEnable
C#
public static void ProfilerEnable(StringName name, bool enable, Reckfell.Collections.Array arguments = null);

Calls the toggle callable of the profiler with given name and arguments. Enables/Disables the same profiler depending on enable argument.

Parameters
NameTypeDefault
nameStringName—
enablebool—
argumentsReckfell.Collections.Arraynull
RegisterMessageCapturevoid
# RegisterMessageCapture
C#
public static void RegisterMessageCapture(StringName name, Callable callable);

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.

Parameters
NameTypeDefault
nameStringName—
callableCallable—
RegisterProfilervoid
# RegisterProfiler
C#
public static void RegisterProfiler(StringName name, EngineProfiler profiler);

Registers a profiler with the given name. See EngineProfiler for more information.

Parameters
NameTypeDefault
nameStringName—
profilerEngineProfiler—
RemoveBreakpointvoid
# RemoveBreakpoint
C#
public static void RemoveBreakpoint(int line, StringName source);

Removes a breakpoint with the given source and line.

Parameters
NameTypeDefault
lineint—
sourceStringName—
ScriptDebugvoid
# ScriptDebug
C#
public static void ScriptDebug(ScriptLanguage language, bool canContinue = true, bool isErrorBreakpoint = false);

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.

Parameters
NameTypeDefault
languageScriptLanguage—
canContinuebooltrue
isErrorBreakpointboolfalse
SendMessagevoid
# SendMessage
C#
public static void SendMessage(string message, Reckfell.Collections.Array data);

Sends a message with given message and data array.

Parameters
NameTypeDefault
messagestring—
dataReckfell.Collections.Array—
SetDepthvoid
# SetDepth
C#
public static void SetDepth(int depth);

Sets the current debugging depth.

Parameters
NameTypeDefault
depthint—
SetLinesLeftvoid
# SetLinesLeft
C#
public static void SetLinesLeft(int lines);

Sets the current debugging lines that remain.

Parameters
NameTypeDefault
linesint—
UnregisterMessageCapturevoid
# UnregisterMessageCapture
C#
public static void UnregisterMessageCapture(StringName name);

Unregisters the message capture with given name.

Parameters
NameTypeDefault
nameStringName—
UnregisterProfilervoid
# UnregisterProfiler
C#
public static void UnregisterProfiler(StringName name);

Unregisters a profiler with given name.

Parameters
NameTypeDefault
nameStringName—
Reckfell Engine documentationBack to top ↑
QUICK LINKSGetting startedEntity hierarchyC# & .NET 10Scenes and prefabs
Reckfell guides and full API K
reckfellENGINE
RECKFELL ACCOUNT

Sign in

Sign in to your Reckfell account.

One account for the entire Reckfell platform.