Skip to content

Commit 565db3f

Browse files
update Open Source Docs from Roblox internal teams
1 parent 044809a commit 565db3f

26 files changed

+2543
-28
lines changed

content/common/navigation/engine/reference.yaml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -265,6 +265,11 @@ navigation:
265265
type: engineapi
266266
source: /reference/engine/classes/AudioSearchParams.yaml
267267
ignoreTranslation: true
268+
- title: AudioTextToSpeech
269+
path: /reference/engine/classes/AudioTextToSpeech
270+
type: engineapi
271+
source: /reference/engine/classes/AudioTextToSpeech.yaml
272+
ignoreTranslation: true
268273
- title: AvatarCreationService
269274
path: /reference/engine/classes/AvatarCreationService
270275
type: engineapi
@@ -470,6 +475,11 @@ navigation:
470475
type: engineapi
471476
source: /reference/engine/classes/CanvasGroup.yaml
472477
ignoreTranslation: true
478+
- title: Capture
479+
path: /reference/engine/classes/Capture
480+
type: engineapi
481+
source: /reference/engine/classes/Capture.yaml
482+
ignoreTranslation: true
473483
- title: CaptureService
474484
path: /reference/engine/classes/CaptureService
475485
type: engineapi
@@ -1235,6 +1245,11 @@ navigation:
12351245
type: engineapi
12361246
source: /reference/engine/classes/HumanoidDescription.yaml
12371247
ignoreTranslation: true
1248+
- title: HumanoidRigDescription
1249+
path: /reference/engine/classes/HumanoidRigDescription
1250+
type: engineapi
1251+
source: /reference/engine/classes/HumanoidRigDescription.yaml
1252+
ignoreTranslation: true
12381253
- title: IKControl
12391254
path: /reference/engine/classes/IKControl
12401255
type: engineapi
@@ -2110,6 +2125,11 @@ navigation:
21102125
type: engineapi
21112126
source: /reference/engine/classes/ScreenGui.yaml
21122127
ignoreTranslation: true
2128+
- title: ScreenshotCapture
2129+
path: /reference/engine/classes/ScreenshotCapture
2130+
type: engineapi
2131+
source: /reference/engine/classes/ScreenshotCapture.yaml
2132+
ignoreTranslation: true
21132133
- title: ScreenshotHud
21142134
path: /reference/engine/classes/ScreenshotHud
21152135
type: engineapi
@@ -3603,6 +3623,11 @@ navigation:
36033623
type: engineapi
36043624
source: /reference/engine/enums/CameraType.yaml
36053625
ignoreTranslation: true
3626+
- title: CaptureUIHideMode
3627+
path: /reference/engine/enums/CaptureUIHideMode
3628+
type: engineapi
3629+
source: /reference/engine/enums/CaptureUIHideMode.yaml
3630+
ignoreTranslation: true
36063631
- title: CatalogCategoryFilter
36073632
path: /reference/engine/enums/CatalogCategoryFilter
36083633
type: engineapi
@@ -4373,6 +4398,11 @@ navigation:
43734398
type: engineapi
43744399
source: /reference/engine/enums/MarkupKind.yaml
43754400
ignoreTranslation: true
4401+
- title: MatchmakingType
4402+
path: /reference/engine/enums/MatchmakingType
4403+
type: engineapi
4404+
source: /reference/engine/enums/MatchmakingType.yaml
4405+
ignoreTranslation: true
43764406
- title: Material
43774407
path: /reference/engine/enums/Material
43784408
type: engineapi

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -606,16 +606,16 @@ methods:
606606
Stops the `Class.AnimationTrack`. Once called, the weight of the animation
607607
will move towards zero over a length of time specified by the optional
608608
`fadeTime` parameter. For example, if `Stop()` is called with a `fadeTime`
609-
of `2`, it will take two seconds for the weight of the track to reach
610-
zero and its effects completely end. Please note this will be the case
609+
of `2`, it will take two seconds for the weight of the track to reach zero
610+
and its effects completely end. Please note this will be the case
611611
regardless of the initial weight of the animation.
612612
613613
It is not recommended to use a `fadeTime` of `0` in an attempt to override
614614
this effect and end the animation immediately for `Class.Motor6D|Motor6Ds`
615-
that have their `Class.Motor.MaxVelocity` set to zero, as this causes
616-
the joints to freeze in place. If it must end immediately, ensure the
617-
`Class.Motor.MaxVelocity` of `Class.Motor6D|Motor6Ds` in your rig are
618-
high enough for them to snap properly.
615+
that have their `Class.Motor.MaxVelocity` set to zero, as this causes the
616+
joints to freeze in place. If it must end immediately, ensure the
617+
`Class.Motor.MaxVelocity` of `Class.Motor6D|Motor6Ds` in your rig are high
618+
enough for them to snap properly.
619619
code_samples:
620620
- AnimationTrack-Stop
621621
parameters:

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

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,20 @@ inherits:
1010
tags: []
1111
deprecation_message: ''
1212
properties: []
13-
methods: []
13+
methods:
14+
- name: Annotation:IsThreadParent
15+
summary: ''
16+
description: ''
17+
code_samples: []
18+
parameters: []
19+
returns:
20+
- type: bool
21+
summary: ''
22+
tags: []
23+
deprecation_message: ''
24+
security: RobloxScriptSecurity
25+
thread_safety: Unsafe
26+
capabilities: []
27+
writeCapabilities: []
1428
events: []
1529
callbacks: []

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

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,34 @@ methods:
4848
thread_safety: Unsafe
4949
capabilities: []
5050
writeCapabilities: []
51+
- name: AudioChannelMixer:GetInputPins
52+
summary: ''
53+
description: ''
54+
code_samples: []
55+
parameters: []
56+
returns:
57+
- type: Array
58+
summary: ''
59+
tags: []
60+
deprecation_message: ''
61+
security: None
62+
thread_safety: Unsafe
63+
capabilities: []
64+
writeCapabilities: []
65+
- name: AudioChannelMixer:GetOutputPins
66+
summary: ''
67+
description: ''
68+
code_samples: []
69+
parameters: []
70+
returns:
71+
- type: Array
72+
summary: ''
73+
tags: []
74+
deprecation_message: ''
75+
security: None
76+
thread_safety: Unsafe
77+
capabilities: []
78+
writeCapabilities: []
5179
events:
5280
- name: AudioChannelMixer.WiringChanged
5381
summary: ''

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

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,34 @@ methods:
4848
thread_safety: Unsafe
4949
capabilities: []
5050
writeCapabilities: []
51+
- name: AudioChannelSplitter:GetInputPins
52+
summary: ''
53+
description: ''
54+
code_samples: []
55+
parameters: []
56+
returns:
57+
- type: Array
58+
summary: ''
59+
tags: []
60+
deprecation_message: ''
61+
security: None
62+
thread_safety: Unsafe
63+
capabilities: []
64+
writeCapabilities: []
65+
- name: AudioChannelSplitter:GetOutputPins
66+
summary: ''
67+
description: ''
68+
code_samples: []
69+
parameters: []
70+
returns:
71+
- type: Array
72+
summary: ''
73+
tags: []
74+
deprecation_message: ''
75+
security: None
76+
thread_safety: Unsafe
77+
capabilities: []
78+
writeCapabilities: []
5179
events:
5280
- name: AudioChannelSplitter.WiringChanged
5381
summary: ''
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: AudioTextToSpeech
2+
type: class
3+
category:
4+
memory_category: Internal
5+
summary: ''
6+
description: ''
7+
code_samples: []
8+
inherits:
9+
- Instance
10+
tags: []
11+
deprecation_message: ''
12+
properties: []
13+
methods: []
14+
events: []
15+
callbacks: []
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Capture
2+
type: class
3+
category:
4+
memory_category: Instances
5+
summary: ''
6+
description: ''
7+
code_samples: []
8+
inherits:
9+
- Object
10+
tags:
11+
- NotCreatable
12+
- NotReplicated
13+
deprecation_message: ''
14+
properties: []
15+
methods: []
16+
events: []
17+
callbacks: []

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

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -67,11 +67,10 @@ methods:
6767
experience's main menu.
6868
code_samples: []
6969
parameters:
70-
- name: contentIds
70+
- name: captures
7171
type: Array
7272
default:
73-
summary: |
74-
An array of `contentId` strings identifying the screenshots to save.
73+
summary: ''
7574
- name: resultCallback
7675
type: Function
7776
default:
@@ -107,11 +106,10 @@ methods:
107106
`IsContentSharingAllowed` is true in the returned dictionary.
108107
code_samples: []
109108
parameters:
110-
- name: contentId
111-
type: ContentId
109+
- name: captureContent
110+
type: Content
112111
default:
113-
summary: |
114-
The `contentId` identifying the screenshot to share.
112+
summary: ''
115113
- name: launchData
116114
type: string
117115
default:
@@ -136,6 +134,28 @@ methods:
136134
thread_safety: Unsafe
137135
capabilities: []
138136
writeCapabilities: []
137+
- name: CaptureService:TakeCapture
138+
summary: ''
139+
description: ''
140+
code_samples: []
141+
parameters:
142+
- name: onCaptureReady
143+
type: Function
144+
default:
145+
summary: ''
146+
- name: captureParams
147+
type: Dictionary
148+
default: nil
149+
summary: ''
150+
returns:
151+
- type: void
152+
summary: ''
153+
tags: []
154+
deprecation_message: ''
155+
security: None
156+
thread_safety: Unsafe
157+
capabilities: []
158+
writeCapabilities: []
139159
events:
140160
- name: CaptureService.CaptureBegan
141161
summary: |

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

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,25 @@ properties:
206206
can_save: false
207207
capabilities: []
208208
writeCapabilities: []
209+
- name: DataModel.MatchmakingType
210+
summary: ''
211+
description: ''
212+
code_samples: []
213+
type: MatchmakingType
214+
tags:
215+
- ReadOnly
216+
- NotReplicated
217+
deprecation_message: ''
218+
security:
219+
read: None
220+
write: None
221+
thread_safety: ReadSafe
222+
category: Data
223+
serialization:
224+
can_load: false
225+
can_save: true
226+
capabilities: []
227+
writeCapabilities: []
209228
- name: DataModel.PlaceId
210229
summary: |
211230
Describes the ID of the place running on the server.

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

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,37 @@ methods:
4444
thread_safety: Unsafe
4545
capabilities: []
4646
writeCapabilities: []
47+
- name: GenerationService:InternalGenerateMeshAsync
48+
summary: ''
49+
description: ''
50+
code_samples: []
51+
parameters:
52+
- name: inputs
53+
type: Dictionary
54+
default:
55+
summary: ''
56+
- name: userId
57+
type: int64
58+
default:
59+
summary: ''
60+
- name: options
61+
type: Dictionary
62+
default:
63+
summary: ''
64+
- name: intermediateResultCallback
65+
type: Function?
66+
default:
67+
summary: ''
68+
returns:
69+
- type: Tuple
70+
summary: ''
71+
tags:
72+
- Yields
73+
deprecation_message: ''
74+
security: RobloxScriptSecurity
75+
thread_safety: Unsafe
76+
capabilities: []
77+
writeCapabilities: []
4778
- name: GenerationService:LoadGeneratedMeshAsync
4879
summary: ''
4980
description: ''

0 commit comments

Comments
 (0)