Engine
GuidesReferenceResourcesArtDesign

ScriptDebugger

Show Deprecated
Not Creatable

A ScriptDebugger is used to handle the debugging of a specific script. It can be retrieved from the DebuggerManager.

Summary

Properties

CurrentLine: number

The current line that the script is on.

READ ONLY
NOT REPLICATED
IsDebugging: boolean

Describes if this ScriptDebugger is actually debugging the script attached to it.

READ ONLY
NOT REPLICATED
IsPaused: boolean

Describes if this ScriptDebugger is paused.

READ ONLY
NOT REPLICATED
Script: Instance

The script object this debugger is linked to.

READ ONLY
NOT REPLICATED

Methods

AddWatch(expression: string): Instance  

Adds a DebuggerWatch with the given expression.

GetBreakpoints(): Objects  

Returns a list of DebuggerBreakpoint present in the script.

GetGlobals(stackFrame: number): table  

Returns a dictionary of all variables that are present in the global environment of the stack frame.

GetLocals(stackFrame: number): table  

Returns a dictionary of all local variables in the specified stack frame.

GetStack(): Array  

Returns an array of all active call stack frames in the script.

GetUpvalues(stackFrame: number): table  

Returns a dictionary of all upvalues present in the specified stack frame.

GetWatchValue(watch: Instance): Variant  

Returns the current value of a variable being watched by a DebuggerWatch.

GetWatches(): Objects  

Returns a list with all the DebuggerWatch instances for this debugger.

SetBreakpoint(line: number, isContextDependentBreakpoint: boolean): Instance  

Sets the specified line of the script as a breakpoint. Returns a DebuggerBreakpoint that you can use to manage the breakpoint.

SetGlobal(name: string, value: Variant, stackFrame: number): void  

Sets the value of the variable name as value in the global environment of the specified stack frame.

SetLocal(name: string, value: Variant, stackFrame: number): void  

Sets the value of the variable name as value in the specified stack frame.

SetUpvalue(name: string, value: Variant, stackFrame: number): void  

Sets the value of the upvalue name as value in the specified stack frame.

Events

BreakpointAdded(breakpoint: Instance): RBXScriptSignal  

Fires when a DebuggerBreakpoint is added to the script.

BreakpointRemoved(breakpoint: Instance): RBXScriptSignal  

Fires when a DebuggerBreakpoint is removed from the script.

EncounteredBreak(line: number, breakReason: BreakReason): RBXScriptSignal  

Fires when a DebuggerBreakpoint is encountered by the script.

Resuming(): RBXScriptSignal  

Fires when the game is resumed after being paused by a breakpoint.

WatchAdded(watch: Instance): RBXScriptSignal  

Fires when a DebuggerWatch is added to this script debugger.

WatchRemoved(watch: Instance): RBXScriptSignal  

Fires when a DebuggerWatch is removed from this script debugger.

Properties

CurrentLine

number
Read Only
Not Replicated
Read Parallel

The current line that the script is on.

IsDebugging

boolean
Read Only
Not Replicated
Read Parallel

Describes if this ScriptDebugger is actually debugging the script attached to it.

IsPaused

boolean
Read Only
Not Replicated
Read Parallel

Describes if this ScriptDebugger is paused.

Script

Instance
Read Only
Not Replicated
Read Parallel

The script object this debugger is linked to.

Methods

AddWatch

Instance

Adds a DebuggerWatch with the given expression.

Parameters

expression: string

Returns

Instance

GetBreakpoints

Objects

Returns a list of DebuggerBreakpoint present in the script.


Returns

Objects

GetGlobals

table

Returns a dictionary of all variables that are present in the global environment of the stack frame, where the keys are the names of the variables, and the values are the actual values of the variables.
Each stack frame might see different global variables if function environments are different.

Parameters

stackFrame: number
Default Value: 0

Returns

table

GetLocals

table

Returns a dictionary of all local variables in the specified stack frame, where the keys are the names of the variables, and the values are the actual values of the variables.

Parameters

stackFrame: number
Default Value: 0

Returns

table

GetStack

Array

Returns an array of all active call stack frames in the script.


Returns

Array

GetUpvalues

table

Returns a dictionary of all upvalues present in the specified stack frame, where the keys are the names of the upvalues, and the values are the actual values of the upvalues.

Parameters

stackFrame: number
Default Value: 0

Returns

table

GetWatchValue

Variant

Returns the current value of a variable being watched by a DebuggerWatch.

Parameters

watch: Instance

Returns

Variant

GetWatches

Objects

Returns a list with all the DebuggerWatch instances for this debugger.


Returns

Objects

SetBreakpoint

Instance

Sets the specified line of the script as a breakpoint. Returns a DebuggerBreakpoint that you can use to manage the breakpoint.

Parameters

line: number
isContextDependentBreakpoint: boolean

Whether the breakpoint is unique for a single script instance or not.


Returns

Instance

SetGlobal

void

Sets the value of the variable name as value in the global environment of the specified stack frame.

Parameters

name: string
value: Variant
stackFrame: number

Returns

void

SetLocal

void

Sets the value of the variable name as value in the specified stack frame.

Parameters

name: string
value: Variant
stackFrame: number
Default Value: 0

Returns

void

SetUpvalue

void

Sets the value of the upvalue name as value in the specified stack frame.

Parameters

name: string
value: Variant
stackFrame: number
Default Value: 0

Returns

void

Events

BreakpointAdded

Fires when a DebuggerBreakpoint is added to the script.

Parameters

breakpoint: Instance

BreakpointRemoved

Fires when a DebuggerBreakpoint is removed from the script.

Parameters

breakpoint: Instance

EncounteredBreak

Fires when a DebuggerBreakpoint is encountered by the script.

Parameters

line: number
breakReason: BreakReason

Resuming

Fires when the game is resumed after being paused by a breakpoint.


WatchAdded

Fires when a DebuggerWatch is added to this script debugger.

Parameters

watch: Instance

WatchRemoved

Fires when a DebuggerWatch is removed from this script debugger.

Parameters

watch: Instance