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

DebugSettings

Deprecated

DebugSettings

Deprecated

The DebugSettings allows you to view diagnostics information regarding Roblox. It is labeled as Diagnostics in the Roblox Studio Settings menu.


Properties

int

DataModel

[ReadOnly] [NotReplicated]

Describes whether a DataModel is actively in memory, as an integer (where 1 = true, and 0 = false).

ErrorReporting

ErrorReporting

The action Roblox should take when reporting an error.

string

GfxCard

[ReadOnly] [NotReplicated]

The GfxCard currently installed into your machine.

int

InstanceCount

[ReadOnly] [NotReplicated]

The number of instances active in the simulation.

bool

IsFmodProfilingEnabled

Toggles whether or not profiling of the Fmod library (which is responsible for sounds) is enabled.

bool

IsScriptStackTracingEnabled

Whether or not a stacktrace is displayed in the output for an error.

int

JobCount

[ReadOnly] [NotReplicated]

Returns the number of internal DataModel jobs actively being processed.

int

LuaRamLimit

Sets a RAM limit in bytes for Lua if greater than 0.

bool

OsIs64Bit

[ReadOnly] [NotReplicated]

Whether your OS is a 64 bit OS or a 32 bit one.

string

OsPlatform

[ReadOnly] [NotReplicated]

A string representing the type of Operating System Platform your machine is on.

int

OsPlatformId

[ReadOnly] [NotReplicated]

The PlatformId of your Operating System.

string

OsVer

[ReadOnly] [NotReplicated]

The current version of your Operating System.

int

PlayerCount

[ReadOnly] [NotReplicated]

The number of players currently in the active game-instance.

bool

ReportSoundWarnings

Whether or not sound warnings should be reported.

string

RobloxProductName

[ReadOnly] [NotReplicated]

The purpose of this property is unknown.
Its value is always “?”.

string

RobloxVersion

[ReadOnly] [NotReplicated]

The current client version of Roblox. Can also be retrieved by using the version() function.

string

SIMD

[ReadOnly] [NotReplicated]

The type of SIMD instruction set used by your machine.

string

SystemProductName

[ReadOnly] [NotReplicated]

The name of your System’s Model.

TickCountSampleMethod

TickCountPreciseOverride

Sets the internal sampling method used to measure elapsed time with consistency across platforms.

int

VideoMemory

[ReadOnly] [NotReplicated]

The total amount of video memory on your machine, in bytes as a negative integer.

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

Inherited from Instance: Show Hide

Array

GetDescendants ( )

[CustomLuaState]
Returns an array containing all of the `Instance`'s descendants.
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

FindFirstChildWhichIsA ( string className , bool recursive )

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

FindFirstChildOfClass ( string className )

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

FindFirstChild ( string name , bool recursive )

Returns the first child of the `Instance` found with the given name.
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.
RBXScriptSignal

GetPropertyChangedSignal ( string property )

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

GetFullName ( )

Returns a string showing the `Instance`'s ancestry.
string

GetDebugId ( int scopeLength )

[NotBrowsable]
Returns a coded string of the `Instance`s DebugId used internally by Roblox.
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.
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

Inherited from Instance: Show Hide

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

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the `Instance` is removed.
RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.