Skip to content

Commit dbe92b8

Browse files
update Open Source Docs from Roblox internal teams
1 parent 683faca commit dbe92b8

19 files changed

+429
-54
lines changed

content/common/navigation/engine/reference.yaml

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -260,6 +260,11 @@ navigation:
260260
type: engineapi
261261
source: /reference/engine/classes/AudioFlanger.yaml
262262
ignoreTranslation: true
263+
- title: AudioGate
264+
path: /reference/engine/classes/AudioGate
265+
type: engineapi
266+
source: /reference/engine/classes/AudioGate.yaml
267+
ignoreTranslation: true
263268
- title: AudioLimiter
264269
path: /reference/engine/classes/AudioLimiter
265270
type: engineapi
@@ -558,11 +563,6 @@ navigation:
558563
type: engineapi
559564
source: /reference/engine/classes/CollectionService.yaml
560565
ignoreTranslation: true
561-
- title: CommandService
562-
path: /reference/engine/classes/CommandService
563-
type: engineapi
564-
source: /reference/engine/classes/CommandService.yaml
565-
ignoreTranslation: true
566566
- title: CommerceService
567567
path: /reference/engine/classes/CommerceService
568568
type: engineapi
@@ -4209,6 +4209,11 @@ navigation:
42094209
type: engineapi
42104210
source: /reference/engine/enums/DialogTone.yaml
42114211
ignoreTranslation: true
4212+
- title: DisplaySize
4213+
path: /reference/engine/enums/DisplaySize
4214+
type: engineapi
4215+
source: /reference/engine/enums/DisplaySize.yaml
4216+
ignoreTranslation: true
42124217
- title: DominantAxis
42134218
path: /reference/engine/enums/DominantAxis
42144219
type: engineapi
@@ -5039,6 +5044,11 @@ navigation:
50395044
type: engineapi
50405045
source: /reference/engine/enums/PromptCreateAvatarResult.yaml
50415046
ignoreTranslation: true
5047+
- title: PromptLinkSharingResult
5048+
path: /reference/engine/enums/PromptLinkSharingResult
5049+
type: engineapi
5050+
source: /reference/engine/enums/PromptLinkSharingResult.yaml
5051+
ignoreTranslation: true
50425052
- title: PromptPublishAssetResult
50435053
path: /reference/engine/enums/PromptPublishAssetResult
50445054
type: engineapi

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

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,24 @@ methods:
5656
thread_safety: Unsafe
5757
capabilities: []
5858
writeCapabilities: []
59+
- name: AdService:UnregisterAdOpportunity
60+
summary: ''
61+
description: ''
62+
code_samples: []
63+
parameters:
64+
- name: instance
65+
type: Instance
66+
default: ''
67+
summary: ''
68+
returns:
69+
- type: ()
70+
summary: ''
71+
tags: []
72+
deprecation_message: ''
73+
security: None
74+
thread_safety: Unsafe
75+
capabilities: []
76+
writeCapabilities: []
5977
- name: AdService:GetAdAvailabilityNowAsync
6078
summary: ''
6179
description: ''
@@ -75,6 +93,29 @@ methods:
7593
thread_safety: Unsafe
7694
capabilities: []
7795
writeCapabilities: []
96+
- name: AdService:RegisterAdOpportunityAsync
97+
summary: ''
98+
description: ''
99+
code_samples: []
100+
parameters:
101+
- name: instance
102+
type: Instance
103+
default: ''
104+
summary: ''
105+
- name: placementId
106+
type: int64?
107+
default: ''
108+
summary: ''
109+
returns:
110+
- type: ()
111+
summary: ''
112+
tags:
113+
- Yields
114+
deprecation_message: ''
115+
security: None
116+
thread_safety: Unsafe
117+
capabilities: []
118+
writeCapabilities: []
78119
- name: AdService:ShowRewardedVideoAdAsync
79120
summary: ''
80121
description: ''

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ properties:
2626
tags:
2727
- ReadOnly
2828
- NotReplicated
29-
- NotBrowsable
3029
deprecation_message: ''
3130
security:
3231
read: None
Lines changed: 163 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
name: AudioGate
2+
type: class
3+
memory_category: Internal
4+
summary: ''
5+
description: ''
6+
code_samples: []
7+
inherits:
8+
- Instance
9+
tags:
10+
- NotBrowsable
11+
deprecation_message: ''
12+
properties:
13+
- name: AudioGate.Attack
14+
summary: ''
15+
description: ''
16+
code_samples: []
17+
type: float
18+
tags: []
19+
deprecation_message: ''
20+
security:
21+
read: None
22+
write: None
23+
thread_safety: ReadSafe
24+
category: State
25+
serialization:
26+
can_load: true
27+
can_save: true
28+
capabilities:
29+
- Audio
30+
writeCapabilities: []
31+
- name: AudioGate.Bypass
32+
summary: ''
33+
description: ''
34+
code_samples: []
35+
type: boolean
36+
tags: []
37+
deprecation_message: ''
38+
security:
39+
read: None
40+
write: None
41+
thread_safety: ReadSafe
42+
category: State
43+
serialization:
44+
can_load: true
45+
can_save: true
46+
capabilities:
47+
- Audio
48+
writeCapabilities: []
49+
- name: AudioGate.Release
50+
summary: ''
51+
description: ''
52+
code_samples: []
53+
type: float
54+
tags: []
55+
deprecation_message: ''
56+
security:
57+
read: None
58+
write: None
59+
thread_safety: ReadSafe
60+
category: State
61+
serialization:
62+
can_load: true
63+
can_save: true
64+
capabilities:
65+
- Audio
66+
writeCapabilities: []
67+
- name: AudioGate.Threshold
68+
summary: ''
69+
description: ''
70+
code_samples: []
71+
type: NumberRange
72+
tags: []
73+
deprecation_message: ''
74+
security:
75+
read: None
76+
write: None
77+
thread_safety: ReadSafe
78+
category: State
79+
serialization:
80+
can_load: true
81+
can_save: true
82+
capabilities:
83+
- Audio
84+
writeCapabilities: []
85+
methods:
86+
- name: AudioGate:GetConnectedWires
87+
summary: ''
88+
description: ''
89+
code_samples: []
90+
parameters:
91+
- name: pin
92+
type: string
93+
default: ''
94+
summary: ''
95+
returns:
96+
- type: Instances
97+
summary: ''
98+
tags: []
99+
deprecation_message: ''
100+
security: None
101+
thread_safety: Unsafe
102+
capabilities:
103+
- Audio
104+
writeCapabilities: []
105+
- name: AudioGate:GetInputPins
106+
summary: ''
107+
description: ''
108+
code_samples: []
109+
parameters: []
110+
returns:
111+
- type: Array
112+
summary: ''
113+
tags: []
114+
deprecation_message: ''
115+
security: None
116+
thread_safety: Unsafe
117+
capabilities:
118+
- Audio
119+
writeCapabilities: []
120+
- name: AudioGate:GetOutputPins
121+
summary: ''
122+
description: ''
123+
code_samples: []
124+
parameters: []
125+
returns:
126+
- type: Array
127+
summary: ''
128+
tags: []
129+
deprecation_message: ''
130+
security: None
131+
thread_safety: Unsafe
132+
capabilities:
133+
- Audio
134+
writeCapabilities: []
135+
events:
136+
- name: AudioGate.WiringChanged
137+
summary: ''
138+
description: ''
139+
code_samples: []
140+
parameters:
141+
- name: connected
142+
type: boolean
143+
default: ''
144+
summary: ''
145+
- name: pin
146+
type: string
147+
default: ''
148+
summary: ''
149+
- name: wire
150+
type: Wire
151+
default: ''
152+
summary: ''
153+
- name: instance
154+
type: Instance
155+
default: ''
156+
summary: ''
157+
tags: []
158+
deprecation_message: ''
159+
security: None
160+
capabilities:
161+
- Audio
162+
writeCapabilities: []
163+
callbacks: []

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

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,17 @@ description: |
88
single **Output** pin which can be connected to other pins via
99
`Class.Wire|Wires`.
1010
11-
Roblox uses the following formula to throttle requests for this API based on the number of players in your experience:
11+
Roblox uses the following formula to throttle requests for this API based on
12+
the number of players in your experience:
1213
`max requests per second per experience = 1 + (0.05 * per_thousand_concurrent_users)`
1314
1415
For a more in-depth look, see
1516
[Text-to-speech](../../../audio/objects.md#text-to-speech).
16-
1717
code_samples:
1818
- audio-wiring---text-to-speech
1919
inherits:
2020
- Instance
21-
tags:
22-
- NotBrowsable
21+
tags: []
2322
deprecation_message: ''
2423
properties:
2524
- name: AudioTextToSpeech.IsLoaded
@@ -165,8 +164,8 @@ properties:
165164
summary: |
166165
The text to be converted into speech audio by `Class.AudioTextToSpeech`.
167166
description: |
168-
The text to be converted into speech audio by `Class.AudioTextToSpeech`. The text has a
169-
maximum length of 300 characters.
167+
The text to be converted into speech audio by `Class.AudioTextToSpeech`.
168+
The text has a maximum length of 300 characters.
170169
code_samples: []
171170
type: string
172171
tags: []
@@ -230,9 +229,9 @@ properties:
230229
summary: |
231230
The voice style to be used by `Class.AudioTextToSpeech`.
232231
description: |
233-
The voice style to be used by`Class.AudioTextToSpeech`.
234-
A list of available voices and their corresponding VoiceIds
235-
can be found in the [text-to-speech guide](../../../audio/objects.md#text-to-speech).
232+
The voice style to be used by`Class.AudioTextToSpeech`. A list of
233+
available voices and their corresponding VoiceIds can be found in the
234+
[text-to-speech guide](../../../audio/objects.md#text-to-speech).
236235
code_samples: []
237236
type: string
238237
tags: []
@@ -408,8 +407,8 @@ events:
408407
`Class.AudioTextToSpeech:GetPropertyChangedSignal()` on the
409408
`Class.AudioTextToSpeech.IsPlaying|IsPlaying` property.
410409
411-
This event may be used to destroy an `Class.AudioTextToSpeech` object
412-
when it has completed playback.
410+
This event may be used to destroy an `Class.AudioTextToSpeech` object when
411+
it has completed playback.
413412
code_samples: []
414413
parameters: []
415414
tags: []

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

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,29 @@ methods:
169169
thread_safety: Unsafe
170170
capabilities: []
171171
writeCapabilities: []
172+
- name: AvatarCreationService:AutoSetupAvatarAsync
173+
summary: ''
174+
description: ''
175+
code_samples: []
176+
parameters:
177+
- name: player
178+
type: Player
179+
default: ''
180+
summary: ''
181+
- name: model
182+
type: Model
183+
default: ''
184+
summary: ''
185+
returns:
186+
- type: string
187+
summary: ''
188+
tags:
189+
- Yields
190+
deprecation_message: ''
191+
security: None
192+
thread_safety: Unsafe
193+
capabilities: []
194+
writeCapabilities: []
172195
- name: AvatarCreationService:GetBatchTokenDetailsAsync
173196
summary: |
174197
Gets the avatar creation token details for a list of avatar creation
@@ -213,6 +236,25 @@ methods:
213236
thread_safety: Unsafe
214237
capabilities: []
215238
writeCapabilities: []
239+
- name: AvatarCreationService:LoadGeneratedAvatarAsync
240+
summary: ''
241+
description: ''
242+
code_samples: []
243+
parameters:
244+
- name: generationId
245+
type: string
246+
default: ''
247+
summary: ''
248+
returns:
249+
- type: HumanoidDescription
250+
summary: ''
251+
tags:
252+
- Yields
253+
deprecation_message: ''
254+
security: None
255+
thread_safety: Unsafe
256+
capabilities: []
257+
writeCapabilities: []
216258
- name: AvatarCreationService:PrepareAvatarForPreviewAsync
217259
summary: |
218260
Prepares in-experience avatar for preview.

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2591,7 +2591,8 @@ methods:
25912591
summary: |
25922592
The base part of an assembly (a collection of parts connected
25932593
together).
2594-
tags: []
2594+
tags:
2595+
- Deprecated
25952596
deprecation_message: ''
25962597
security: None
25972598
thread_safety: Safe

0 commit comments

Comments
 (0)