PcoWSkbVqDnWTu_dm2ix
We use cookies on this site to enhance your user experience
Collapse Sidebar

ScriptDebugger

Show deprecated

ScriptDebugger

Show deprecated

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


Properties

int

CurrentLine

[ReadOnly] [NotReplicated]

The current line that the script is on.

bool

IsDebugging

[ReadOnly] [NotReplicated]

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

bool

IsPaused

[ReadOnly] [NotReplicated]

Describes if this ScriptDebugger is paused.

Instance

Script

[ReadOnly] [NotReplicated]

The script object this debugger is linked to.

Inherited from Instance: Show Hide

int

DataCost

[ReadOnly] [NotReplicated]

The cost of saving the instance using data persistence.

Instance

Parent

Determines the hierarchical parent of the Instance.

bool

RobloxLocked

If true, the Instance and its descendants cannot be indexed or edited by a Script or LocalScript and will throw an error if it is attempted.

string

ClassName

[ReadOnly] [NotReplicated]

A read-only string representing the class this Instance belongs to.

string

Name

A non-unique identifier of the Instance.

bool

Archivable

Determines if an Instance can be cloned using /Instance/Clone or saved to file.

Functions

Instance

AddWatch ( string expression )

Adds a watch with the given expression.

Objects

GetBreakpoints ( )

Returns a list of DebuggerBreakpoint present in the script.

Map

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.

Map

GetLocals ( int stackFrame )

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.

Array

GetStack ( )

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

Map

GetUpvalues ( int stackFrame )

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

Variant

GetWatchValue ( Instance watch )

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

Objects

GetWatches ( )

Returns a list with all the watches for this debugger

Instance

SetBreakpoint ( int line )

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

void

SetGlobal ( string name , Variant value )

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

void

SetLocal ( string name , Variant value , int stackFrame )

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

void

SetUpvalue ( string name , Variant value , int stackFrame )

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

Inherited from Instance: Show Hide

Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the Instance found with the given name.

Array

GetDescendants ( )

[CustomLuaState]

Returns an array containing all of the descendants of the instance

Objects

GetChildren ( )

Returns an array containing all of the Instance's children.

void

Destroy ( )

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

RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.

string

GetFullName ( )

Returns a string describing the Instance's ancestry.

Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the Instance for whom Instance/IsA returns true for the given className.

bool

IsAncestorOf ( Instance descendant )

Returns true if an Instance is an ancestor of the given descendant.

bool

IsDescendantOf ( Instance ancestor )

Returns true if an Instance is a descendant of the given ancestor.

Instance

FindFirstChildOfClass ( string className )

Returns the first child of the Instance whose Instance/ClassName|ClassName is equal to the given className.

Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the Instance for whom Instance/IsA returns true for the given className.

Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the Instance whose Instance/ClassName is equal to the given className.

Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the Instance whose Instance/Name is equal to the given name.

bool

IsA ( string className )

Returns true if an Instance's class matches or inherits from a given class

Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]

Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does.

string

GetDebugId ( int scopeLength )

[NotBrowsable]

Returns a coded string of the Instances DebugId used internally by Roblox.

Instance

Clone ( )

Create a deep copy of a Roblox instance and descendants where Archivable = true.

void

ClearAllChildren ( )

This function destroys all of an Instance's children.

Events

RBXScriptSignal

BreakpointAdded ( Instance breakpoint )

Fired when a breakpoint is added to the script.

RBXScriptSignal

BreakpointRemoved ( Instance breakpoint )

Fired when a breakpoint is removed from the script.

RBXScriptSignal

EncounteredBreak ( int line )

Fired when a breakpoint is encountered by the script.

RBXScriptSignal

Resuming ( )

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

RBXScriptSignal

WatchAdded ( Instance watch )

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

RBXScriptSignal

WatchRemoved ( Instance watch )

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

Inherited from Instance: Show Hide

RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the Instance is removed.

RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the Instance/Parent property of the object or one of its ancestors is changed.

RBXScriptSignal

ChildAdded ( Instance child )

Fires when an object is parented to this Instance.

RBXScriptSignal

ChildRemoved ( Instance child )

Fires when a child is removed from this Instance.

RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires when a descendant is added to the Instance.

RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.