API:Class/ScriptDebugger

Filtered-inheritance mode: While this class technically inherits all Instance class members, some (if not all) have been hidden because they serve no purpose for this object.
Uncreatable: This object cannot be created with Instance.new.

ExplorerImageIndex76.pngScriptDebugger : Object Icon.pngInstance

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

Properties

Properties [toggle]

intCurrentLine [readonly]

The current line that the script is on.

|RMD member="API:Class/ScriptDebugger/CurrentLine"|The current line that the script is on.|/RMD|
boolIsDebugging [readonly]

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

|RMD member="API:Class/ScriptDebugger/IsDebugging"|Describes if this ScriptDebugger is actually debugging the script attached to it.|/RMD|
boolIsPaused [readonly]

Describes if this ScriptDebugger is paused.

|RMD member="API:Class/ScriptDebugger/IsPaused"|Describes if this ScriptDebugger is paused.|/RMD|
Ref<LuaSourceContainer>Script [readonly]

The script object this debugger is linked to.

|RMD member="API:Class/ScriptDebugger/Script"|The script object this debugger is linked to.|/RMD|
CurrentLine [readonly]
The current line that the script is on.
IsDebugging [readonly]
Describes if this ScriptDebugger is actually debugging the script attached to it.
IsPaused [readonly]
Describes if this ScriptDebugger is paused.
Script [readonly]
The script object this debugger is linked to.

Functions

FunctionsmemberhiddenFunctions [toggle]

DebuggerWatchAddWatch ( string expression )

Adds a watch with the given expression.

|RMD member="API:Class/ScriptDebugger/AddWatch"|Adds a watch with the given expression.|/RMD|
array<DebuggerBreakpoint>GetBreakpoints ( )

Returns a list of BreakpointIcon.pngDebuggerBreakpoints present in the script.

|RMD member="API:Class/ScriptDebugger/GetBreakpoints"|Returns a list of BreakpointIcon.pngDebuggerBreakpoints present in the script.|/RMD|
dictionary<Variant>GetGlobals ( )

Returns a dictionary of all variables that are visible to the script's global stack, where the keys are the names of the variables, and the values are the actual values of the variables.

|RMD member="API:Class/ScriptDebugger/GetGlobals"|Returns a dictionary of all variables that are visible to the script's global stack, where the keys are the names of the variables, and the values are the actual values of the variables.|/RMD|
dictionary<Variant>GetLocals ( int stackFrame = 0 )

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

|RMD member="API:Class/ScriptDebugger/GetLocals"|Returns a dictionary of all local variables in the specified stack, where the keys are the names of the variables, and the values are the actual values of the variables.|/RMD|
array<dictionary<Variant>>GetStack ( )

Returns an array of all active call stacks in the script.

|RMD member="API:Class/ScriptDebugger/GetStack"|Returns an array of all active call stacks in the script.|/RMD|
dictionary<Variant>GetUpvalues ( int stackFrame = 0 )

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

|RMD member="API:Class/ScriptDebugger/GetUpvalues"|Returns a dictionary of all upvalues present in the stack specified.|/RMD|
VariantGetWatchValue ( DebuggerWatch watch )

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

|RMD member="API:Class/ScriptDebugger/GetWatchValue"|Returns the current value of a variable being watched by a DebuggerWatch.pngDebuggerWatch.|/RMD|
array<DebuggerWatch>GetWatches ( )

Returns a list with all the watches for this debugger.

|RMD member="API:Class/ScriptDebugger/GetWatches"|Returns a list with all the watches for this debugger.|/RMD|
DebuggerBreakpointSetBreakpoint ( int line )

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

|RMD member="API:Class/ScriptDebugger/SetBreakpoint"|Sets the specified line of the script as a breakpoint. Returns a BreakpointIcon.pngDebuggerBreakpoint that you can use to manage the breakpoint.|/RMD|
voidSetGlobal ( string name, Variant value )

Sets the value of the variable name as value in the script's main stack.

|RMD member="API:Class/ScriptDebugger/SetGlobal"|Sets the value of the variable name as value in the script's main stack.|/RMD|
voidSetLocal ( string name, Variant value, int stackFrame = 0 )

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

|RMD member="API:Class/ScriptDebugger/SetLocal"|Sets the value of the variable name as value in the stack specified.|/RMD|
voidSetUpvalue ( string name, Variant value, int stackFrame = 0 )

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

|RMD member="API:Class/ScriptDebugger/SetUpvalue"|Sets the value of the upvalue name as value in the stack specified.|/RMD|
voidResume ( ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/ScriptDebugger/Resume"|Deprecated. Do not use.|/RMD|
voidStepIn ( ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/ScriptDebugger/StepIn"|Deprecated. Do not use.|/RMD|
voidStepOut ( ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/ScriptDebugger/StepOut"|Deprecated. Do not use.|/RMD|
voidStepOver ( ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/ScriptDebugger/StepOver"|Deprecated. Do not use.|/RMD|
AddWatch ( string expression )
Adds a watch with the given expression.
Returns a list of BreakpointIcon.pngDebuggerBreakpoints present in the script.
Returns a dictionary of all variables that are visible to the script's global stack, where the keys are the names of the variables, and the values are the actual values of the variables.
GetLocals ( int stackFrame = 0 )
Returns a dictionary of all local variables in the specified stack, where the keys are the names of the variables, and the values are the actual values of the variables.
Returns an array of all active call stacks in the script.
GetUpvalues ( int stackFrame = 0 )
Returns a dictionary of all upvalues present in the stack specified.
Returns the current value of a variable being watched by a DebuggerWatch.pngDebuggerWatch.
Returns a list with all the watches for this debugger.
Sets the specified line of the script as a breakpoint. Returns a BreakpointIcon.pngDebuggerBreakpoint that you can use to manage the breakpoint.
SetGlobal ( string name, Variant value )
Sets the value of the variable name as value in the script's main stack.
SetLocal ( string name, Variant value, int stackFrame = 0 )
Sets the value of the variable name as value in the stack specified.
SetUpvalue ( string name, Variant value, int stackFrame = 0 )
Sets the value of the upvalue name as value in the stack specified.
Resume ( ) [deprecated]
Deprecated. Do not use.
StepIn ( ) [deprecated]
Deprecated. Do not use.
StepOut ( ) [deprecated]
Deprecated. Do not use.
StepOver ( ) [deprecated]
Deprecated. Do not use.
Inherited from Object Icon.pngInstance:
voidDestroy ( )

Sets the Parent property to nil, locks the Parent property, disconnects all connections and calls Destroy() on all children.

|RMD member="API:Class/Instance/Destroy"|Sets the Parent property to nil, locks the Parent property, disconnects all connections and calls Destroy() on all children.|/RMD|
Sets the Parent property to nil, locks the Parent property, disconnects all connections and calls Destroy() on all children.


Events

Events [toggle]

BreakpointAdded ( DebuggerBreakpoint breakpoint )

Fired when a breakpoint is added to the script.

|RMD member="API:Class/ScriptDebugger/BreakpointAdded"|Fired when a breakpoint is added to the script.|/RMD|
BreakpointRemoved ( DebuggerBreakpoint breakpoint )

Fired when a breakpoint is removed from the script.

|RMD member="API:Class/ScriptDebugger/BreakpointRemoved"|Fired when a breakpoint is removed from the script.|/RMD|
EncounteredBreak ( int line )

Fired when a breakpoint is encountered by the script.

|RMD member="API:Class/ScriptDebugger/EncounteredBreak"|Fired when a breakpoint is encountered by the script.|/RMD|
Resuming ( )

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

|RMD member="API:Class/ScriptDebugger/Resuming"|Fired when the game is resumed after being paused by a breakpoint.|/RMD|
WatchAdded ( DebuggerWatch watch )

Fired when an expression watch is added to this script debugger.

|RMD member="API:Class/ScriptDebugger/WatchAdded"|Fired when an expression watch is added to this script debugger.|/RMD|
WatchRemoved ( DebuggerWatch watch )

Fired when an expression watch is removed from this script debugger.

|RMD member="API:Class/ScriptDebugger/WatchRemoved"|Fired when an expression watch is removed from this script debugger.|/RMD|
Fired when a breakpoint is added to the script.
Fired when a breakpoint is removed from the script.
Fired when a breakpoint is encountered by the script.
Fired when the game is resumed after being paused by a breakpoint.
Fired when an expression watch is added to this script debugger.
Fired when an expression watch is removed from this script debugger.

|RMD member="API:Class/ScriptDebugger"|A ScriptDebugger is used to handle the debugging of a specific script. It can be retrieved from the DebuggerManager.pngDebuggerManager. |/RMD|