Skip to content

Commit 88298e8

Browse files
update Open Source Docs from Roblox internal teams
1 parent 24e3868 commit 88298e8

28 files changed

+388
-811
lines changed

content/common/navigation/engine/reference.yaml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2009,6 +2009,11 @@ navigation:
20092009
type: engineapi
20102010
source: /reference/engine/classes/BanHistoryPages.yaml
20112011
ignoreTranslation: true
2012+
- title: CapturesPages
2013+
path: /reference/engine/classes/CapturesPages
2014+
type: engineapi
2015+
source: /reference/engine/classes/CapturesPages.yaml
2016+
ignoreTranslation: true
20122017
- title: CatalogPages
20132018
path: /reference/engine/classes/CatalogPages
20142019
type: engineapi
@@ -2363,11 +2368,6 @@ navigation:
23632368
type: engineapi
23642369
source: /reference/engine/classes/ReflectionMetadataYieldFunctions.yaml
23652370
ignoreTranslation: true
2366-
- title: ReflectionService
2367-
path: /reference/engine/classes/ReflectionService
2368-
type: engineapi
2369-
source: /reference/engine/classes/ReflectionService.yaml
2370-
ignoreTranslation: true
23712371
- title: RemoteDebuggerServer
23722372
path: /reference/engine/classes/RemoteDebuggerServer
23732373
type: engineapi

content/en-us/performance-optimization/identify.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Roblox has a number of tools for identifying performance issues, some of which a
3232
<td>Live sessions, Studio testing</td>
3333
</tr>
3434
<tr>
35-
<td>Performance Stats Bar</td>
35+
<td>Performance Stats bar</td>
3636
<td>A toolbar with basic performance statistics, including memory consumption, CPU, GPU, network data sent and received, and ping time.</td>
3737
<td>In-experience</td>
3838
<td><kbd>Ctrl</kbd><kbd>Alt</kbd><kbd>F7</kbd> (<kbd>⌘</kbd><kbd>⌥</kbd><kbd>F7</kbd>)</td>
@@ -115,7 +115,7 @@ High memory usage is not necessarily indicative of a problem, but some indicatio
115115
- A significant percentage of client crashes showing in the **Performance Dashboard**, particularly a sudden uptick that coincides with an update. Some number of crashes are expected, but you should investigate if your crash rates increase above 2-3%.
116116
- A crash occurs while testing on a device that you want your experience to support.
117117

118-
A significant portion of an experience's memory consumption on the client are from assets, such as images, meshes, and audio files, loaded into memory. In the **Developer Console**, check the following labels under **PlaceMemory**:
118+
A significant portion of an experience's memory consumption on the client are from assets, such as images, meshes, and audio files, loaded into memory. In the Developer Console, check the following labels under **PlaceMemory**:
119119

120120
- **GraphicsMeshParts** - Graphics memory consumed by meshes.
121121
- **GraphicsTexture** - Graphics memory consumed by textures.
@@ -137,3 +137,19 @@ end)
137137
```
138138

139139
For additional insight, enable **Print Join Size Breakdown** from the **Network** tab of [Studio Settings](../studio/setup.md#customization) to print the top 20 instances by size and a percentage breakdown by instance type when you start the experience in Studio.
140+
141+
## Ping
142+
143+
The two primary measurements of ping (latency) are **network ping** and **data ping**.
144+
145+
Network ping is the round-trip time measured from when the client sends a network data packet to when it receives the server's echo reply. It is similar to what would be reported as `time` by the general purpose ping network utility.
146+
147+
Network ping is visible in the **Performance Stats** bar. It is mostly affected by the length of the network path between the client and server and is outside your control.
148+
149+
Data ping is the round-trip time measured from when the client sends data reliably through the replication system to when it receives an echo reply from the server's replication system. It includes time spent in both the client's and server's replication queues, along with TCP-like retransmissions of lost or corrupted packets.
150+
151+
Data ping is similar to sending a reliable remote event from the client, receiving it on the server, and then sending a reliable remote event from the server to the client in response. Because data ping also includes time spent on the network between the client and server, it is greater than or equal to network ping.
152+
153+
Average data ping for all players connected to a server is visible in the **Server Stats** tab of the Developer Console. Data ping for an individual client is visible using <kbd>Shift</kbd><kbd>F3</kbd> to display network debug stats.
154+
155+
Data ping is affected by both the network path and by replication queueing delays. When the server generates replication data faster than the network can send it (or faster than the client can process it), data must wait in replication queues. Some difference between data ping and network ping is normal due to both network retransmissions and the way network data is processed by the Roblox app. However, if data ping is significantly higher than network ping, use the [MicroProfiler](./microprofiler/network.md) to view network traffic. For optimization suggestions, see [Networking and replication](./improve.md#networking-and-replication).
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
0.698.1.6980943
2-
version-260f9e4fe1c74bfb
1+
0.699.0.6990877
2+
version-874602c66c70451a

content/en-us/reference/engine/classes/AdGui.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,3 +115,4 @@ callbacks:
115115
thread_safety: Unsafe
116116
capabilities:
117117
- UI
118+
writeCapabilities: []

content/en-us/reference/engine/classes/BindableFunction.yaml

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ description: |
2727
As stated, `Class.BindableFunction|BindableFunctions` do not allow for
2828
communication between the server and clients. If you are looking for this
2929
functionality, use a `Class.RemoteFunction` as outlined in
30-
[Remote Events and Callbacks](../../../scripting/events/remote.md).
30+
[Remote events and callbacks](../../../scripting/events/remote.md).
3131
32-
See [Custom Events and Callbacks](../../../scripting/events/custom.md) for
32+
See [Bindable events and callbacks](../../../scripting/events/bindable.md) for
3333
code samples and further details on `Class.BindableFunction`.
3434
3535
#### Parameter Limitations
@@ -38,7 +38,7 @@ description: |
3838
others can be passed as a parameter when a `Class.BindableFunction` is
3939
invoked, as well as Luau types such as numbers, strings, and booleans,
4040
although you should carefully explore the
41-
[limitations](../../../scripting/events/custom.md#argument-limitations).
41+
[limitations](../../../scripting/events/bindable.md#argument-limitations).
4242
code_samples: []
4343
inherits:
4444
- Instance
@@ -63,14 +63,14 @@ methods:
6363
others can be passed as a parameter to
6464
`Class.BindableFunction:Invoke()|Invoke()`, as well as Luau types such as
6565
numbers, strings, and booleans, although you should carefully explore the
66-
[limitations](../../../scripting/events/custom.md#argument-limitations).
66+
[limitations](../../../scripting/events/bindable.md#argument-limitations).
6767
6868
Only one function can be bound to
6969
`Class.BindableFunction:Invoke()|Invoke()` at a time. If you assign
7070
multiple functions, only the last one assigned will be used.
7171
72-
See [Custom Events and Callbacks](../../../scripting/events/custom.md) for
73-
code samples and further details on
72+
See [Bindable events and callbacks](../../../scripting/events/bindable.md)
73+
for code samples and further details on
7474
`Class.BindableFunction:Invoke()|Invoke()`.
7575
code_samples: []
7676
parameters:
@@ -104,8 +104,8 @@ callbacks:
104104
is found and, if it is never set, the script that invoked it will not
105105
resume execution.
106106
107-
See [Custom Events and Callbacks](../../../scripting/events/custom.md) for
108-
code samples and further details on
107+
See [Bindable events and callbacks](../../../scripting/events/bindable.md)
108+
for code samples and further details on
109109
`Class.BindableFunction.OnInvoke|OnInvoke`.
110110
code_samples: []
111111
parameters:
@@ -124,3 +124,4 @@ callbacks:
124124
security: None
125125
thread_safety: Unsafe
126126
capabilities: []
127+
writeCapabilities: []

content/en-us/reference/engine/classes/CaptureService.yaml

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -292,11 +292,16 @@ methods:
292292
description: |
293293
This client-side function uploads a capture, like one retrieved from
294294
`ReadCapturesFromGalleryAsync`, to the asset system. It returns a tuple of
295-
the result and the asset ID. For video capture types, there is an upload
296-
limit of 20 videos per day per user.
295+
the result and the asset ID.
297296
298-
Note: This function can take up to several minutes to finish executing,
299-
and the user will need to remain in the experience.
297+
Notes:
298+
299+
- This function will only work properly if the Maturity and Compliance
300+
questionnaire has been filled out for the experience.
301+
- For video capture types, there is an upload limit of 20 videos per day
302+
per user.
303+
- This function can take up to several minutes to finish executing, and
304+
the user will need to remain in the experience.
300305
code_samples:
301306
- UploadCaptureAsync-example
302307
parameters:

content/en-us/reference/engine/classes/DataModel.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1017,3 +1017,4 @@ callbacks:
10171017
security: None
10181018
thread_safety: Unsafe
10191019
capabilities: []
1020+
writeCapabilities: []

content/en-us/reference/engine/classes/GameSettings.yaml

Lines changed: 1 addition & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -19,42 +19,7 @@ tags:
1919
- NotReplicated
2020
- NotBrowsable
2121
deprecation_message: ''
22-
properties:
23-
- name: GameSettings.VideoCaptureEnabled
24-
summary: |
25-
Toggles whether or not video capture is enabled.
26-
description: |
27-
Toggles whether or not video capture is enabled.
28-
code_samples: []
29-
type: boolean
30-
tags: []
31-
deprecation_message: ''
32-
security:
33-
read: None
34-
write: None
35-
thread_safety: ReadSafe
36-
category: Video
37-
serialization:
38-
can_load: true
39-
can_save: true
40-
capabilities: []
41-
- name: GameSettings.VideoRecording
42-
summary: ''
43-
description: ''
44-
code_samples: []
45-
type: boolean
46-
tags:
47-
- NotReplicated
48-
deprecation_message: ''
49-
security:
50-
read: RobloxScriptSecurity
51-
write: RobloxEngineSecurity
52-
thread_safety: ReadSafe
53-
category: Video
54-
serialization:
55-
can_load: true
56-
can_save: false
57-
capabilities: []
22+
properties: []
5823
methods: []
5924
events: []
6025
callbacks: []

content/en-us/reference/engine/classes/Instance.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,6 @@ descendants:
236236
- ProximityPrompt
237237
- ProximityPromptService
238238
- PublishService
239-
- ReflectionService
240239
- RemoteDebuggerServer
241240
- RemoteFunction
242241
- RenderingTest

content/en-us/reference/engine/classes/MarketplaceService.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1558,3 +1558,4 @@ callbacks:
15581558
security: None
15591559
thread_safety: Unsafe
15601560
capabilities: []
1561+
writeCapabilities: []

0 commit comments

Comments
 (0)