Reference API Roblox

Engine API

Website

Related

Reference API Roblox

DebugSettings

Collection of various developer-facing diagnostics information.

This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a settings container. It contains settings that affect the behavior of the peer.
This class is not browsable. It is not visible in Studio's object browser.
Tags: [NotCreatable, Settings, NotBrowsable]

Member index 8

HistoryMember
553DataModel: int
553InstanceCount: int
553IsScriptStackTracingEnabled: bool
553JobCount: int
553PlayerCount: int
553ReportSoundWarnings: bool
553RobloxVersion: string
553TickCountPreciseOverride: TickCountSampleMethod
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Removed member index 50

HistoryMember
271AltCdnFailureCount: int
271AltCdnSuccessCount: int
271AvailablePhysicalMemory: int
271BlockMeshSize: int
271CPU: string
271CdnFailureCount: int
271CdnResponceTime: double
271CdnSuccessCount: int
271CpuCount: int
271CpuSpeed: int
271ElapsedTime: double
214EnforceInstanceCountLimit: bool
407ErrorReporting: ErrorReporting
407GfxCard: string
214InstanceCountLimit: int
431IsFmodProfilingEnabled: bool
270IsProfilingEnabled: bool
271LastCdnFailureTimeSpan: double
401LuaRamLimit: int
278NameDatabaseBytes: int
278NameDatabaseSize: int
407OsIs64Bit: bool
407OsPlatform: string
407OsPlatformId: int
407OsVer: string
271PageFaultsPerSecond: int
271PageFileBytes: int
271PixelShaderModel: float
271PrivateBytes: int
271PrivateWorkingSetBytes: int
271ProcessCores: double
271ProcessorTime: int
270ProfilingWindow: double
271RAM: int
271ReportExtendedMachineConfiguration: bool
271Resolution: string
271RobloxFailureCount: int
407RobloxProductName: string
271RobloxRespoceTime: double
271RobloxSuccessCount: int
407SIMD: string
407SystemProductName: string
271TotalPhysicalMemory: int
271TotalProcessorTime: int
271VertexShaderModel: float
407VideoMemory: int
271VirtualBytes: int
311LegacyScriptMode(): void
271ResetCdnFailureCounts(): Tuple
311SetBlockingRemove(value: bool): void

Description

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

History 140

Members 8

DataModel

TypeDefault
int

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

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 4

Tags: [ReadOnly, NotReplicated]

InstanceCount

TypeDefault
int

The number of instances active in the simulation.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 4

Tags: [ReadOnly, NotReplicated]

IsScriptStackTracingEnabled

TypeDefault
bool

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

History 4

JobCount

TypeDefault
int

Returns the number of internal DataModel jobs actively being processed.

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 4

Tags: [ReadOnly, NotReplicated]

PlayerCount

TypeDefault
int

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

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 4

Tags: [ReadOnly, NotReplicated]

ReportSoundWarnings

TypeDefault
bool

Whether or not sound warnings should be reported.

History 4

RobloxVersion

TypeDefault
string

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

This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 4

Tags: [ReadOnly, NotReplicated]

TickCountPreciseOverride

TypeDefault
TickCountSampleMethod

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

History 4

Removed members 50

AltCdnFailureCount

TypeDefault
int
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly]

AltCdnSuccessCount

TypeDefault
int
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly]

AvailablePhysicalMemory

TypeDefault
int
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly]

BlockMeshSize

TypeDefault
int
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly]

CPU

TypeDefault
string
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly]

CdnFailureCount

TypeDefault
int
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly]

CdnResponceTime

TypeDefault
double
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly]

CdnSuccessCount

TypeDefault
int
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly]

CpuCount

TypeDefault
int
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly]

CpuSpeed

TypeDefault
int
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly]

ElapsedTime

TypeDefault
double
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly]

EnforceInstanceCountLimit

TypeDefault
bool

History 2

ErrorReporting

TypeDefault
ErrorReporting

History 2

GfxCard

TypeDefault
string
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly, NotReplicated]

InstanceCountLimit

TypeDefault
int

History 2

IsFmodProfilingEnabled

TypeDefault
bool

History 4

IsProfilingEnabled

TypeDefault
bool

History 2

LastCdnFailureTimeSpan

TypeDefault
double
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly]

LegacyScriptMode

Parameters (0)
No parameters.
Returns (1)
void
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 3

Tags: [Deprecated]

LuaRamLimit

TypeDefault
int

History 2

NameDatabaseBytes

TypeDefault
int
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly]

NameDatabaseSize

TypeDefault
int
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly]

OsIs64Bit

TypeDefault
bool
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly, NotReplicated]

OsPlatform

TypeDefault
string
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly, NotReplicated]

OsPlatformId

TypeDefault
int
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly, NotReplicated]

OsVer

TypeDefault
string
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly, NotReplicated]

PageFaultsPerSecond

TypeDefault
int
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly]

PageFileBytes

TypeDefault
int
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly]

PixelShaderModel

TypeDefault
float
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly]

PrivateBytes

TypeDefault
int
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly]

PrivateWorkingSetBytes

TypeDefault
int
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly]

ProcessCores

TypeDefault
double
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly]

ProcessorTime

TypeDefault
int
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly]

ProfilingWindow

TypeDefault
double

History 2

RAM

TypeDefault
int
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly]

ReportExtendedMachineConfiguration

TypeDefault
bool

History 2

ResetCdnFailureCounts

Parameters (0)
No parameters.
Returns (1)
Tuple

History 2

Resolution

TypeDefault
string
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly]

RobloxFailureCount

TypeDefault
int
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly]

RobloxProductName

TypeDefault
string
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 4

Tags: [ReadOnly, NotReplicated]

RobloxRespoceTime

TypeDefault
double
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly]

RobloxSuccessCount

TypeDefault
int
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly]

SIMD

TypeDefault
string
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly, NotReplicated]

SetBlockingRemove

Parameters (1)
valuebool
Returns (1)
void

History 2

SystemProductName

TypeDefault
string
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly, NotReplicated]

TotalPhysicalMemory

TypeDefault
int
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly]

TotalProcessorTime

TypeDefault
int
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly]

VertexShaderModel

TypeDefault
float
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly]

VideoMemory

TypeDefault
int
This property is not replicated. Its interface does not cross the network boundary.
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly, NotReplicated]

VirtualBytes

TypeDefault
int
This property is read-only. Its value can be read, but it cannot be modified.

History 2

Tags: [ReadOnly]

Settings