DebugSettings
Collection of various developer-facing diagnostics information.
Memory category | Instances |
---|
Member index 8
Removed member index 50
Description
The DebugSettings allows you to view diagnostics information regarding Roblox. It is labeled as Diagnostics in the Roblox Studio Settings menu.
History 140
- 553 Change Default of TickCountPreciseOverride from to
- 553 Change Default of RobloxVersion from to
- 553 Change Default of ReportSoundWarnings from to
- 553 Change Default of PlayerCount from to
- 553 Change Default of JobCount from to
- 553 Change Default of IsScriptStackTracingEnabled from to
- 553 Change Default of InstanceCount from to
- 553 Change Default of DataModel from to
- 486 Change ThreadSafety of TickCountPreciseOverride from ReadOnly to ReadSafe
- 486 Change ThreadSafety of RobloxVersion from ReadOnly to ReadSafe
- 486 Change ThreadSafety of ReportSoundWarnings from ReadOnly to ReadSafe
- 486 Change ThreadSafety of PlayerCount from ReadOnly to ReadSafe
- 486 Change ThreadSafety of JobCount from ReadOnly to ReadSafe
- 486 Change ThreadSafety of IsScriptStackTracingEnabled from ReadOnly to ReadSafe
- 486 Change ThreadSafety of InstanceCount from ReadOnly to ReadSafe
- 486 Change ThreadSafety of DataModel from ReadOnly to ReadSafe
- 462 Change ThreadSafety of TickCountPreciseOverride from to ReadOnly
- 462 Change ThreadSafety of RobloxVersion from to ReadOnly
- 462 Change ThreadSafety of ReportSoundWarnings from to ReadOnly
- 462 Change ThreadSafety of PlayerCount from to ReadOnly
- 462 Change ThreadSafety of JobCount from to ReadOnly
- 462 Change ThreadSafety of IsScriptStackTracingEnabled from to ReadOnly
- 462 Change ThreadSafety of InstanceCount from to ReadOnly
- 462 Change ThreadSafety of DataModel from to ReadOnly
- 431 Remove IsFmodProfilingEnabled
- 429 Add IsFmodProfilingEnabled
- 430 Remove IsFmodProfilingEnabled
- 413 Change Tags of DebugSettings from [Settings, NotBrowsable] to [NotCreatable, Settings, NotBrowsable]
- 407 Remove VideoMemory
- 407 Remove SystemProductName
- 407 Remove SIMD
- 407 Remove RobloxProductName
- 407 Remove OsVer
- 407 Remove OsPlatformId
- 407 Remove OsPlatform
- 407 Remove OsIs64Bit
- 407 Remove GfxCard
- 407 Remove ErrorReporting
- 401 Remove LuaRamLimit
- 350 Change Tags of DebugSettings from [Service, NotBrowsable] to [Settings, NotBrowsable]
- 311 Remove SetBlockingRemove
- 311 Remove LegacyScriptMode
- 278 Remove NameDatabaseSize
- 278 Remove NameDatabaseBytes
- 271 Remove ResetCdnFailureCounts
- 271 Remove VirtualBytes
- 271 Remove VertexShaderModel
- 271 Remove TotalProcessorTime
- 271 Remove TotalPhysicalMemory
- 271 Remove RobloxSuccessCount
- 271 Remove RobloxRespoceTime
- 271 Remove RobloxFailureCount
- 271 Remove Resolution
- 271 Remove ReportExtendedMachineConfiguration
- 271 Remove RAM
- 271 Remove ProcessorTime
- 271 Remove ProcessCores
- 271 Remove PrivateWorkingSetBytes
- 271 Remove PrivateBytes
- 271 Remove PixelShaderModel
- 271 Remove PageFileBytes
- 271 Remove PageFaultsPerSecond
- 271 Remove LastCdnFailureTimeSpan
- 271 Remove ElapsedTime
- 271 Remove CpuSpeed
- 271 Remove CpuCount
- 271 Remove CdnSuccessCount
- 271 Remove CdnResponceTime
- 271 Remove CdnFailureCount
- 271 Remove CPU
- 271 Remove BlockMeshSize
- 271 Remove AvailablePhysicalMemory
- 271 Remove AltCdnSuccessCount
- 271 Remove AltCdnFailureCount
- 270 Remove ProfilingWindow
- 270 Remove IsProfilingEnabled
- 214 Remove InstanceCountLimit
- 214 Remove EnforceInstanceCountLimit
- 97 Add SIMD
- 79 Add RobloxProductName
- 78 Remove RobloxProductName
- 79 Add RobloxProductName
- 69 Add OsIs64Bit
- 68 Change Tags of LegacyScriptMode from [] to [Deprecated]
- 47 Add SetBlockingRemove
- 47 Add ResetCdnFailureCounts
- 47 Add LegacyScriptMode
- 47 Add VirtualBytes
- 47 Add VideoMemory
- 47 Add VertexShaderModel
- 47 Add TotalProcessorTime
- 47 Add TotalPhysicalMemory
- 47 Add TickCountPreciseOverride
- 47 Add SystemProductName
- 47 Add RobloxVersion
- 47 Add RobloxSuccessCount
- 47 Add RobloxRespoceTime
- 47 Add RobloxFailureCount
- 47 Add Resolution
- 47 Add ReportSoundWarnings
- 47 Add ReportExtendedMachineConfiguration
- 47 Add RAM
- 47 Add ProfilingWindow
- 47 Add ProcessorTime
- 47 Add ProcessCores
- 47 Add PrivateWorkingSetBytes
- 47 Add PrivateBytes
- 47 Add PlayerCount
- 47 Add PixelShaderModel
- 47 Add PageFileBytes
- 47 Add PageFaultsPerSecond
- 47 Add OsVer
- 47 Add OsPlatformId
- 47 Add OsPlatform
- 47 Add NameDatabaseSize
- 47 Add NameDatabaseBytes
- 47 Add LuaRamLimit
- 47 Add LastCdnFailureTimeSpan
- 47 Add JobCount
- 47 Add IsScriptStackTracingEnabled
- 47 Add IsProfilingEnabled
- 47 Add IsFmodProfilingEnabled
- 47 Add InstanceCountLimit
- 47 Add InstanceCount
- 47 Add GfxCard
- 47 Add ErrorReporting
- 47 Add EnforceInstanceCountLimit
- 47 Add ElapsedTime
- 47 Add DataModel
- 47 Add CpuSpeed
- 47 Add CpuCount
- 47 Add CdnSuccessCount
- 47 Add CdnResponceTime
- 47 Add CdnFailureCount
- 47 Add CPU
- 47 Add BlockMeshSize
- 47 Add AvailablePhysicalMemory
- 47 Add AltCdnSuccessCount
- 47 Add AltCdnFailureCount
- 47 Add DebugSettings
Members 8
DataModel
Type | Default | |
---|---|---|
int |
Describes whether a DataModel is actively in memory, as an integer (where 1 = true, and 0 = false).
Thread safety | ReadSafe |
---|---|
Category | Performance |
Loaded/Saved | false/true |
InstanceCount
Type | Default | |
---|---|---|
int |
The number of instances active in the simulation.
Thread safety | ReadSafe |
---|---|
Category | Performance |
Loaded/Saved | false/true |
History 4
- 553 Change Default of InstanceCount from to
- 486 Change ThreadSafety of InstanceCount from ReadOnly to ReadSafe
- 462 Change ThreadSafety of InstanceCount from to ReadOnly
- 47 Add InstanceCount
IsScriptStackTracingEnabled
Type | Default | |
---|---|---|
bool |
Whether or not a stacktrace is displayed in the output for an error.
Thread safety | ReadSafe |
---|---|
Category | Errors |
Loaded/Saved | true |
History 4
- 553 Change Default of IsScriptStackTracingEnabled from to
- 486 Change ThreadSafety of IsScriptStackTracingEnabled from ReadOnly to ReadSafe
- 462 Change ThreadSafety of IsScriptStackTracingEnabled from to ReadOnly
- 47 Add IsScriptStackTracingEnabled
JobCount
Type | Default | |
---|---|---|
int |
Returns the number of internal DataModel jobs actively being processed.
Thread safety | ReadSafe |
---|---|
Category | Performance |
Loaded/Saved | false/true |
PlayerCount
Type | Default | |
---|---|---|
int |
The number of players currently in the active game-instance.
Thread safety | ReadSafe |
---|---|
Category | Performance |
Loaded/Saved | false/true |
History 4
- 553 Change Default of PlayerCount from to
- 486 Change ThreadSafety of PlayerCount from ReadOnly to ReadSafe
- 462 Change ThreadSafety of PlayerCount from to ReadOnly
- 47 Add PlayerCount
ReportSoundWarnings
Type | Default | |
---|---|---|
bool |
Whether or not sound warnings should be reported.
Thread safety | ReadSafe |
---|---|
Category | Errors |
Loaded/Saved | true |
History 4
- 553 Change Default of ReportSoundWarnings from to
- 486 Change ThreadSafety of ReportSoundWarnings from ReadOnly to ReadSafe
- 462 Change ThreadSafety of ReportSoundWarnings from to ReadOnly
- 47 Add ReportSoundWarnings
RobloxVersion
Type | Default | |
---|---|---|
string |
The current client version of Roblox. Can also be retrieved by using the version() function.
Thread safety | ReadSafe |
---|---|
Category | Profile |
Loaded/Saved | false/true |
History 4
- 553 Change Default of RobloxVersion from to
- 486 Change ThreadSafety of RobloxVersion from ReadOnly to ReadSafe
- 462 Change ThreadSafety of RobloxVersion from to ReadOnly
- 47 Add RobloxVersion
TickCountPreciseOverride
Type | Default | |
---|---|---|
TickCountSampleMethod |
Sets the internal sampling method used to measure elapsed time with consistency across platforms.
Thread safety | ReadSafe |
---|---|
Category | Benchmarking |
Loaded/Saved | true |
History 4
- 553 Change Default of TickCountPreciseOverride from to
- 486 Change ThreadSafety of TickCountPreciseOverride from ReadOnly to ReadSafe
- 462 Change ThreadSafety of TickCountPreciseOverride from to ReadOnly
- 47 Add TickCountPreciseOverride
Removed members 50
AltCdnFailureCount
Type | Default | |
---|---|---|
int |
Category | |
---|---|
Loaded/Saved | false |
History 2
- 271 Remove AltCdnFailureCount
- 47 Add AltCdnFailureCount
AltCdnSuccessCount
Type | Default | |
---|---|---|
int |
Category | |
---|---|
Loaded/Saved | false |
History 2
- 271 Remove AltCdnSuccessCount
- 47 Add AltCdnSuccessCount
AvailablePhysicalMemory
Type | Default | |
---|---|---|
int |
Category | |
---|---|
Loaded/Saved | false |
History 2
- 271 Remove AvailablePhysicalMemory
- 47 Add AvailablePhysicalMemory
BlockMeshSize
Type | Default | |
---|---|---|
int |
Category | |
---|---|
Loaded/Saved | false |
History 2
- 271 Remove BlockMeshSize
- 47 Add BlockMeshSize
CPU
Type | Default | |
---|---|---|
string |
Category | |
---|---|
Loaded/Saved | false |
CdnFailureCount
Type | Default | |
---|---|---|
int |
Category | |
---|---|
Loaded/Saved | false |
History 2
- 271 Remove CdnFailureCount
- 47 Add CdnFailureCount
CdnResponceTime
Type | Default | |
---|---|---|
double |
Category | |
---|---|
Loaded/Saved | false |
History 2
- 271 Remove CdnResponceTime
- 47 Add CdnResponceTime
CdnSuccessCount
Type | Default | |
---|---|---|
int |
Category | |
---|---|
Loaded/Saved | false |
History 2
- 271 Remove CdnSuccessCount
- 47 Add CdnSuccessCount
CpuCount
Type | Default | |
---|---|---|
int |
Category | |
---|---|
Loaded/Saved | false |
CpuSpeed
Type | Default | |
---|---|---|
int |
Category | |
---|---|
Loaded/Saved | false |
ElapsedTime
Type | Default | |
---|---|---|
double |
Category | |
---|---|
Loaded/Saved | false |
History 2
- 271 Remove ElapsedTime
- 47 Add ElapsedTime
EnforceInstanceCountLimit
Type | Default | |
---|---|---|
bool |
Category | |
---|---|
Loaded/Saved | false |
History 2
ErrorReporting
Type | Default | |
---|---|---|
ErrorReporting |
Category | Errors |
---|---|
Loaded/Saved | true |
History 2
- 407 Remove ErrorReporting
- 47 Add ErrorReporting
GfxCard
Type | Default | |
---|---|---|
string |
Category | Profile |
---|---|
Loaded/Saved | false/true |
InstanceCountLimit
Type | Default | |
---|---|---|
int |
Category | |
---|---|
Loaded/Saved | false |
History 2
- 214 Remove InstanceCountLimit
- 47 Add InstanceCountLimit
IsFmodProfilingEnabled
Type | Default | |
---|---|---|
bool |
Category | Benchmarking |
---|---|
Loaded/Saved | true |
History 4
- 431 Remove IsFmodProfilingEnabled
- 429 Add IsFmodProfilingEnabled
- 430 Remove IsFmodProfilingEnabled
- 47 Add IsFmodProfilingEnabled
IsProfilingEnabled
Type | Default | |
---|---|---|
bool |
Category | |
---|---|
Loaded/Saved | false |
History 2
- 270 Remove IsProfilingEnabled
- 47 Add IsProfilingEnabled
LastCdnFailureTimeSpan
Type | Default | |
---|---|---|
double |
Category | |
---|---|
Loaded/Saved | false |
History 2
- 271 Remove LastCdnFailureTimeSpan
- 47 Add LastCdnFailureTimeSpan
LegacyScriptMode
Parameters (0) | ||
---|---|---|
No parameters. | ||
Returns (1) | ||
void |
Security | LocalUserSecurity |
---|
History 3
- 311 Remove LegacyScriptMode
- 68 Change Tags of LegacyScriptMode from [] to [Deprecated]
- 47 Add LegacyScriptMode
LuaRamLimit
Type | Default | |
---|---|---|
int |
Category | Limits |
---|---|
Loaded/Saved | true |
History 2
- 401 Remove LuaRamLimit
- 47 Add LuaRamLimit
NameDatabaseBytes
Type | Default | |
---|---|---|
int |
Category | |
---|---|
Loaded/Saved | false |
History 2
- 278 Remove NameDatabaseBytes
- 47 Add NameDatabaseBytes
NameDatabaseSize
Type | Default | |
---|---|---|
int |
Category | |
---|---|
Loaded/Saved | false |
History 2
- 278 Remove NameDatabaseSize
- 47 Add NameDatabaseSize
OsIs64Bit
Type | Default | |
---|---|---|
bool |
Category | Profile |
---|---|
Loaded/Saved | false/true |
OsPlatform
Type | Default | |
---|---|---|
string |
Category | Profile |
---|---|
Loaded/Saved | false/true |
History 2
- 407 Remove OsPlatform
- 47 Add OsPlatform
OsPlatformId
Type | Default | |
---|---|---|
int |
Category | Profile |
---|---|
Loaded/Saved | false/true |
History 2
- 407 Remove OsPlatformId
- 47 Add OsPlatformId
OsVer
Type | Default | |
---|---|---|
string |
Category | Profile |
---|---|
Loaded/Saved | false/true |
PageFaultsPerSecond
Type | Default | |
---|---|---|
int |
Category | |
---|---|
Loaded/Saved | false |
History 2
- 271 Remove PageFaultsPerSecond
- 47 Add PageFaultsPerSecond
PageFileBytes
Type | Default | |
---|---|---|
int |
Category | |
---|---|
Loaded/Saved | false |
History 2
- 271 Remove PageFileBytes
- 47 Add PageFileBytes
PixelShaderModel
Type | Default | |
---|---|---|
float |
Category | |
---|---|
Loaded/Saved | false |
History 2
- 271 Remove PixelShaderModel
- 47 Add PixelShaderModel
PrivateBytes
Type | Default | |
---|---|---|
int |
Category | |
---|---|
Loaded/Saved | false |
History 2
- 271 Remove PrivateBytes
- 47 Add PrivateBytes
PrivateWorkingSetBytes
Type | Default | |
---|---|---|
int |
Category | |
---|---|
Loaded/Saved | false |
History 2
- 271 Remove PrivateWorkingSetBytes
- 47 Add PrivateWorkingSetBytes
ProcessCores
Type | Default | |
---|---|---|
double |
Category | |
---|---|
Loaded/Saved | false |
History 2
- 271 Remove ProcessCores
- 47 Add ProcessCores
ProcessorTime
Type | Default | |
---|---|---|
int |
Category | |
---|---|
Loaded/Saved | false |
History 2
- 271 Remove ProcessorTime
- 47 Add ProcessorTime
ProfilingWindow
Type | Default | |
---|---|---|
double |
Category | |
---|---|
Loaded/Saved | false |
History 2
- 270 Remove ProfilingWindow
- 47 Add ProfilingWindow
RAM
Type | Default | |
---|---|---|
int |
Category | |
---|---|
Loaded/Saved | false |
ReportExtendedMachineConfiguration
Type | Default | |
---|---|---|
bool |
Category | |
---|---|
Loaded/Saved | false |
History 2
ResetCdnFailureCounts
Parameters (0) | ||
---|---|---|
No parameters. | ||
Returns (1) | ||
Tuple |
Security | LocalUserSecurity |
---|
History 2
- 271 Remove ResetCdnFailureCounts
- 47 Add ResetCdnFailureCounts
Resolution
Type | Default | |
---|---|---|
string |
Category | |
---|---|
Loaded/Saved | false |
History 2
- 271 Remove Resolution
- 47 Add Resolution
RobloxFailureCount
Type | Default | |
---|---|---|
int |
Category | |
---|---|
Loaded/Saved | false |
History 2
- 271 Remove RobloxFailureCount
- 47 Add RobloxFailureCount
RobloxProductName
Type | Default | |
---|---|---|
string |
Category | Profile |
---|---|
Loaded/Saved | false/true |
History 4
- 407 Remove RobloxProductName
- 79 Add RobloxProductName
- 78 Remove RobloxProductName
- 79 Add RobloxProductName
RobloxRespoceTime
Type | Default | |
---|---|---|
double |
Category | |
---|---|
Loaded/Saved | false |
History 2
- 271 Remove RobloxRespoceTime
- 47 Add RobloxRespoceTime
RobloxSuccessCount
Type | Default | |
---|---|---|
int |
Category | |
---|---|
Loaded/Saved | false |
History 2
- 271 Remove RobloxSuccessCount
- 47 Add RobloxSuccessCount
SIMD
Type | Default | |
---|---|---|
string |
Category | Profile |
---|---|
Loaded/Saved | false/true |
SetBlockingRemove
Parameters (1) | ||
---|---|---|
value | bool | |
Returns (1) | ||
void |
Security | LocalUserSecurity |
---|
History 2
- 311 Remove SetBlockingRemove
- 47 Add SetBlockingRemove
SystemProductName
Type | Default | |
---|---|---|
string |
Category | Profile |
---|---|
Loaded/Saved | false/true |
History 2
- 407 Remove SystemProductName
- 47 Add SystemProductName
TotalPhysicalMemory
Type | Default | |
---|---|---|
int |
Category | |
---|---|
Loaded/Saved | false |
History 2
- 271 Remove TotalPhysicalMemory
- 47 Add TotalPhysicalMemory
TotalProcessorTime
Type | Default | |
---|---|---|
int |
Category | |
---|---|
Loaded/Saved | false |
History 2
- 271 Remove TotalProcessorTime
- 47 Add TotalProcessorTime
VertexShaderModel
Type | Default | |
---|---|---|
float |
Category | |
---|---|
Loaded/Saved | false |
History 2
- 271 Remove VertexShaderModel
- 47 Add VertexShaderModel
VideoMemory
Type | Default | |
---|---|---|
int |
Category | Profile |
---|---|
Loaded/Saved | false/true |
History 2
- 407 Remove VideoMemory
- 47 Add VideoMemory
VirtualBytes
Type | Default | |
---|---|---|
int |
Category | |
---|---|
Loaded/Saved | false |
History 2
- 271 Remove VirtualBytes
- 47 Add VirtualBytes