Skip to content

Commit 55ece99

Browse files
update Open Source Docs from Roblox internal teams
1 parent a72e0db commit 55ece99

31 files changed

+395
-267
lines changed

content/common/navigation/engine/guides.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -337,6 +337,16 @@ navigation:
337337
path: /audio/objects
338338
- title: Effects
339339
path: /audio/effects
340+
- title: Legacy
341+
section:
342+
- title: Sound
343+
path: /sound/index
344+
- title: Objects
345+
path: /sound/objects
346+
- title: Groups
347+
path: /sound/groups
348+
- title: Dynamic Effects
349+
path: /sound/dynamic-effects
340350
- title: User interface
341351
path: /ui/
342352
section:

content/common/navigation/engine/reference.yaml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1108,11 +1108,6 @@ navigation:
11081108
type: engineapi
11091109
source: /reference/engine/classes/Glue.yaml
11101110
ignoreTranslation: true
1111-
- title: GoogleAnalyticsConfiguration
1112-
path: /reference/engine/classes/GoogleAnalyticsConfiguration
1113-
type: engineapi
1114-
source: /reference/engine/classes/GoogleAnalyticsConfiguration.yaml
1115-
ignoreTranslation: true
11161111
- title: GroundController
11171112
path: /reference/engine/classes/GroundController
11181113
type: engineapi
@@ -3751,6 +3746,11 @@ navigation:
37513746
type: engineapi
37523747
source: /reference/engine/enums/CameraType.yaml
37533748
ignoreTranslation: true
3749+
- title: CaptureType
3750+
path: /reference/engine/enums/CaptureType
3751+
type: engineapi
3752+
source: /reference/engine/enums/CaptureType.yaml
3753+
ignoreTranslation: true
37543754
- title: CatalogCategoryFilter
37553755
path: /reference/engine/enums/CatalogCategoryFilter
37563756
type: engineapi

content/en-us/audio/objects.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Audio objects
3-
description: An overview of audio object on Roblox.
3+
description: An overview of modular audio objects on Roblox.
44
---
55

66
Roblox's modular audio objects allow you to have dynamic control over sound and voice chat in your experiences. Almost every audio object corresponds to a real-world audio device, and they all function together to capture and play audio like their physical counterparts.
@@ -15,7 +15,7 @@ For example, every audio object conceptually falls into the following categories
1515
As you read through this guide and learn about how all of these audio objects work together to emit sound, you will learn how to accurately capture and feed music, sound effects, and the human voice from the experience to the player and vice-versa.
1616

1717
<Alert severity = 'info'>
18-
`Class.Sound`, `Class.SoundGroup`, and `Class.SoundEffect` objects are now deprecated in favor of the more robust functionality of audio objects.
18+
`Class.Sound`, `Class.SoundGroup`, and `Class.SoundEffect` objects are now discouraged in favor of the more robust functionality of audio objects.
1919
</Alert>
2020

2121
## Play audio

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

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -72,24 +72,6 @@ methods:
7272
thread_safety: Unsafe
7373
capabilities: []
7474
writeCapabilities: []
75-
- name: AssetService:CreateSurfaceAppearance
76-
summary: ''
77-
description: ''
78-
code_samples: []
79-
parameters:
80-
- name: content
81-
type: Dictionary
82-
default: ''
83-
summary: ''
84-
returns:
85-
- type: SurfaceAppearance
86-
summary: ''
87-
tags: []
88-
deprecation_message: ''
89-
security: None
90-
thread_safety: Unsafe
91-
capabilities: []
92-
writeCapabilities: []
9375
- name: AssetService:CreateAssetAsync
9476
summary: |
9577
Uploads a new asset to Roblox from the given object.

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ code_samples:
1616
- audio-wiring---splitting-mixing
1717
inherits:
1818
- Instance
19-
tags: []
19+
tags:
20+
- NotBrowsable
2021
deprecation_message: ''
2122
properties:
2223
- name: AudioChannelMixer.Layout

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ code_samples:
1818
- audio-wiring---splitting-mixing
1919
inherits:
2020
- Instance
21-
tags: []
21+
tags:
22+
- NotBrowsable
2223
deprecation_message: ''
2324
properties:
2425
- name: AudioChannelSplitter.Layout

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

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,13 @@ memory_category: Internal
44
summary: |
55
Records audio streams in-experience.
66
description: |
7-
`AudioRecorder` records audio streams in-experience with a fixed time limit of 60 seconds. The
8-
results can be loaded into an `Class.AudioPlayer` for playback.
7+
`AudioRecorder` records audio streams in-experience with a fixed time limit of
8+
60 seconds. The results can be loaded into an `Class.AudioPlayer` for
9+
playback.
910
1011
At this time, `Class.AudioDeviceInput` cannot be recorded. The
11-
`Class.AudioRecorder.GetUnrecordableInstancesAsync()|GetUnrecordableInstancesAsync()` method
12-
can be used to check specifically which instances aren't recordable.
12+
`Class.AudioRecorder.GetUnrecordableInstancesAsync()|GetUnrecordableInstancesAsync()`
13+
method can be used to check specifically which instances aren't recordable.
1314
code_samples: []
1415
inherits:
1516
- Instance
@@ -127,7 +128,8 @@ methods:
127128
summary: ''
128129
description: |
129130
Returns recorded content that can be played back with `Class.AudioPlayer`.
130-
The content retrieved from this method is only valid in the current session.
131+
The content retrieved from this method is only valid in the current
132+
session.
131133
code_samples: []
132134
parameters: []
133135
returns:
@@ -159,8 +161,9 @@ methods:
159161
- name: AudioRecorder:CanRecordAsync
160162
summary: ''
161163
description: |
162-
Returns whether the `AudioRecorder` can currently record. For instance, this will return `false`
163-
if the current recording data has reached the recording time limit. To clear the recording, use
164+
Returns whether the `AudioRecorder` can currently record. For instance,
165+
this will return `false` if the current recording data has reached the
166+
recording time limit. To clear the recording, use
164167
`Class.AudioRecorder:Clear()|Clear()`.
165168
code_samples: []
166169
parameters: []
@@ -178,8 +181,9 @@ methods:
178181
- name: AudioRecorder:GetUnrecordableInstancesAsync
179182
summary: ''
180183
description: |
181-
Traverses the audio graph, starting from this recorder's inputs, to find unrecordable instances.
182-
Currently, `Class.AudioDeviceInput` is not recordable.
184+
Traverses the audio graph, starting from this recorder's inputs, to find
185+
unrecordable instances. Currently, `Class.AudioDeviceInput` is not
186+
recordable.
183187
code_samples: []
184188
parameters: []
185189
returns:
@@ -196,8 +200,9 @@ methods:
196200
- name: AudioRecorder:RecordAsync
197201
summary: ''
198202
description: |
199-
If `Class.AudioRecorder:CanRecordAsync()|CanRecordAsync()` returns `true`, recording begins.
200-
If recording cannot begin, this method produces an error.
203+
If `Class.AudioRecorder:CanRecordAsync()|CanRecordAsync()` returns `true`,
204+
recording begins. If recording cannot begin, this method produces an
205+
error.
201206
code_samples: []
202207
parameters: []
203208
returns:

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

Lines changed: 0 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -169,25 +169,6 @@ methods:
169169
thread_safety: Unsafe
170170
capabilities: []
171171
writeCapabilities: []
172-
- name: AvatarCreationService:GenerateAvatar2DPreviewAsync
173-
summary: ''
174-
description: ''
175-
code_samples: []
176-
parameters:
177-
- name: avatarGeneration2dPreviewParams
178-
type: Dictionary
179-
default: ''
180-
summary: ''
181-
returns:
182-
- type: string
183-
summary: ''
184-
tags:
185-
- Yields
186-
deprecation_message: ''
187-
security: None
188-
thread_safety: Unsafe
189-
capabilities: []
190-
writeCapabilities: []
191172
- name: AvatarCreationService:GetBatchTokenDetailsAsync
192173
summary: |
193174
Gets the avatar creation token details for a list of avatar creation
@@ -232,44 +213,6 @@ methods:
232213
thread_safety: Unsafe
233214
capabilities: []
234215
writeCapabilities: []
235-
- name: AvatarCreationService:LoadAvatar2DPreviewAsync
236-
summary: ''
237-
description: ''
238-
code_samples: []
239-
parameters:
240-
- name: previewId
241-
type: string
242-
default: ''
243-
summary: ''
244-
returns:
245-
- type: EditableImage
246-
summary: ''
247-
tags:
248-
- Yields
249-
deprecation_message: ''
250-
security: None
251-
thread_safety: Unsafe
252-
capabilities: []
253-
writeCapabilities: []
254-
- name: AvatarCreationService:LoadGeneratedAvatarAsync
255-
summary: ''
256-
description: ''
257-
code_samples: []
258-
parameters:
259-
- name: generationId
260-
type: string
261-
default: ''
262-
summary: ''
263-
returns:
264-
- type: HumanoidDescription
265-
summary: ''
266-
tags:
267-
- Yields
268-
deprecation_message: ''
269-
security: None
270-
thread_safety: Unsafe
271-
capabilities: []
272-
writeCapabilities: []
273216
- name: AvatarCreationService:PrepareAvatarForPreviewAsync
274217
summary: ''
275218
description: ''

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

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,11 @@ events:
201201
used to customize the capture experience, for example by hiding certain
202202
GUI elements.
203203
code_samples: []
204-
parameters: []
204+
parameters:
205+
- name: captureType
206+
type: CaptureType
207+
default: ''
208+
summary: ''
205209
tags: []
206210
deprecation_message: ''
207211
security: None
@@ -215,7 +219,11 @@ events:
215219
to restore any changes made when the
216220
`Class.CaptureService.CaptureBegan|CaptureBegan` event fired.
217221
code_samples: []
218-
parameters: []
222+
parameters:
223+
- name: captureType
224+
type: CaptureType
225+
default: ''
226+
summary: ''
219227
tags: []
220228
deprecation_message: ''
221229
security: None

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

Lines changed: 43 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
11
name: CommerceService
22
type: class
33
memory_category: Instances
4-
summary: 'Supports real-world purchases that you can bundle with digital benefits.'
5-
description: '`Class.CommerceService` is a service that supports real-world purchases that you can bundle with virtual items. For information on eligibility and implementation, see [Commerce products](../../../production/monetization/commerce-products.md).'
4+
summary: |
5+
Supports real-world purchases that you can bundle with digital benefits.
6+
description: |
7+
`Class.CommerceService` is a service that supports real-world purchases that
8+
you can bundle with virtual items. For information on eligibility and
9+
implementation, see
10+
[Commerce products](../../../production/monetization/commerce-products.md).
611
code_samples: []
712
inherits:
813
- Instance
@@ -13,8 +18,14 @@ deprecation_message: ''
1318
properties: []
1419
methods:
1520
- name: CommerceService:PromptCommerceProductPurchase
16-
summary: 'Prompts a user to purchase a commerce product using the provided `commerceProductId`. Opens a webview that guides the user through the purchasing flow.'
17-
description: 'Prompts a user to purchase a commerce product using the provided `commerceProductId`. Opens a webview that guides the user through the purchasing flow.'
21+
summary: |
22+
Prompts a user to purchase a commerce product using the provided
23+
`commerceProductId`. Opens a webview that guides the user through the
24+
purchasing flow.
25+
description: |
26+
Prompts a user to purchase a commerce product using the provided
27+
`commerceProductId`. Opens a webview that guides the user through the
28+
purchasing flow.
1829
code_samples: []
1930
parameters:
2031
- name: user
@@ -36,7 +47,12 @@ methods:
3647
writeCapabilities: []
3748
- name: CommerceService:PromptRealWorldCommerceBrowser
3849
summary: ''
39-
description: 'This is a legacy endpoint that is not meant for use. To open the webview to the purchasing flow for real world commerce, see `Class.CommerceService:PromptCommerceProductPurchase`. For more information, see [Commerce products](../../../production/monetization/commerce-products.md)'
50+
description: |
51+
This is a legacy endpoint that is not meant for use. To open the webview
52+
to the purchasing flow for real world commerce, see
53+
`Class.CommerceService:PromptCommerceProductPurchase`. For more
54+
information, see
55+
[Commerce products](../../../production/monetization/commerce-products.md)
4056
code_samples: []
4157
parameters:
4258
- name: player
@@ -57,9 +73,13 @@ methods:
5773
capabilities: []
5874
writeCapabilities: []
5975
- name: CommerceService:GetCommerceProductInfoAsync
60-
summary: 'Retrieves information about the commerce products you are selling in experience.'
76+
summary: |
77+
Retrieves information about the commerce products you are selling in
78+
experience.
6179
description: |
62-
Retrieves information about the products that you are selling and surface them within your experience. How you surface products to your users is entirely up to you.
80+
Retrieves information about the products that you are selling and surface
81+
them within your experience. How you surface products to your users is
82+
entirely up to you.
6383
6484
<table><thead>
6585
<tr>
@@ -90,7 +110,6 @@ methods:
90110
</tr>
91111
</tbody>
92112
</table>
93-
94113
code_samples: []
95114
parameters:
96115
- name: commerceProductId
@@ -109,7 +128,12 @@ methods:
109128
writeCapabilities: []
110129
- name: CommerceService:UserEligibleForRealWorldCommerceAsync
111130
summary: ''
112-
description: 'This is a legacy endpoint that is not meant for use. To check if a user is eligible for real world commerce, see `Class.PolicyService.IsEligibleToPurchaseCommerceProduct`. For more information, see [Commerce products](../../../production/monetization/commerce-products.md)'
131+
description: |
132+
This is a legacy endpoint that is not meant for use. To check if a user is
133+
eligible for real world commerce, see
134+
`Class.PolicyService.IsEligibleToPurchaseCommerceProduct`. For more
135+
information, see
136+
[Commerce products](../../../production/monetization/commerce-products.md)
113137
code_samples: []
114138
parameters: []
115139
returns:
@@ -124,12 +148,18 @@ methods:
124148
writeCapabilities: []
125149
events:
126150
- name: CommerceService.PromptCommerceProductPurchaseFinished
127-
summary: 'Fires when commerce purchase webview has closed - not an indicator that a purchase was successful.'
151+
summary: |
152+
Fires when commerce purchase webview has closed - not an indicator that a
153+
purchase was successful.
128154
description: |
129-
Use this signal to detect when a user has completed the purchasing flow and the webview has closed to resume gameplay within the experience. **This signal does not indicate a successful purchase**, so do not grant virtual items solely from this signal.
130-
131-
While optional, it is recommended to use this signal to reorient your users on Android, as the commerce purchasing flow will have forced them into portrait mode.
155+
Use this signal to detect when a user has completed the purchasing flow
156+
and the webview has closed to resume gameplay within the experience.
157+
**This signal does not indicate a successful purchase**, so do not grant
158+
virtual items solely from this signal.
132159
160+
While optional, it is recommended to use this signal to reorient your
161+
users on Android, as the commerce purchasing flow will have forced them
162+
into portrait mode.
133163
code_samples: []
134164
parameters:
135165
- name: user

0 commit comments

Comments
 (0)