/
DebugSettings.yaml
173 lines (173 loc) · 4.4 KB
/
DebugSettings.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
name: DebugSettings
type: class
category: Settings
memory_category: Instances
summary: |
Collection of various developer-facing diagnostics information.
description: |
The DebugSettings allows you to view diagnostics information regarding Roblox.
It is labeled as **Diagnostics** in the Roblox Studio Settings menu.
code_samples:
inherits:
- Instance
tags:
- NotCreatable
- Settings
- NotBrowsable
deprecation_message: ''
properties:
- name: DebugSettings.DataModel
summary: |
Describes whether a `Class.DataModel` is actively in memory, as an integer
(where 1 = true, and 0 = false).
description: |
Describes whether a `Class.DataModel` is actively in memory, as an integer
(where 1 = true, and 0 = false).
code_samples:
type: int
tags:
- ReadOnly
- NotReplicated
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Performance
serialization:
can_load: false
can_save: true
- name: DebugSettings.InstanceCount
summary: |
The number of instances active in the simulation.
description: |
The number of instances active in the simulation.
code_samples:
type: int
tags:
- ReadOnly
- NotReplicated
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Performance
serialization:
can_load: false
can_save: true
- name: DebugSettings.IsScriptStackTracingEnabled
summary: |
Whether or not a stacktrace is displayed in the output for an error.
description: |
Whether or not a stacktrace is displayed in the output for an error.
code_samples:
type: bool
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Errors
serialization:
can_load: true
can_save: true
- name: DebugSettings.JobCount
summary: |
Returns the number of internal DataModel jobs actively being processed.
description: |
Returns the number of internal DataModel jobs actively being processed.
code_samples:
type: int
tags:
- ReadOnly
- NotReplicated
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Performance
serialization:
can_load: false
can_save: true
- name: DebugSettings.PlayerCount
summary: |
The number of players currently in the active game-instance.
description: |
The number of players currently in the active game-instance.
code_samples:
type: int
tags:
- ReadOnly
- NotReplicated
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Performance
serialization:
can_load: false
can_save: true
- name: DebugSettings.ReportSoundWarnings
summary: |
Whether or not sound warnings should be reported.
description: |
Whether or not sound warnings should be reported.
code_samples:
type: bool
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Errors
serialization:
can_load: true
can_save: true
- name: DebugSettings.RobloxVersion
summary: |
The current client version of Roblox. Can also be retrieved by using the
version() function.
description: |
The current client version of Roblox. Can also be retrieved by using the
version() function.
code_samples:
type: string
tags:
- ReadOnly
- NotReplicated
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Profile
serialization:
can_load: false
can_save: true
- name: DebugSettings.TickCountPreciseOverride
summary: |
Sets the internal sampling method used to measure elapsed time with
consistency across platforms.
description: |
Sets the internal sampling method used to measure elapsed time with
consistency across platforms.
code_samples:
type: TickCountSampleMethod
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Benchmarking
serialization:
can_load: true
can_save: true
methods: []
events: []
callbacks: []