Skip to content

Commit 49f87f5

Browse files
rbx-open-source-docs[bot]rbx-open-source-docs[bot]
committed
update Open Source Docs from Roblox internal teams
1 parent 1763144 commit 49f87f5

31 files changed

+831
-64
lines changed

‎content/common/navigation/engine/reference.yaml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,16 @@ navigation:
165165
type: engineapi
166166
source: /reference/engine/classes/AudioAnalyzer.yaml
167167
ignoreTranslation: true
168+
- title: AudioChannelMixer
169+
path: /reference/engine/classes/AudioChannelMixer
170+
type: engineapi
171+
source: /reference/engine/classes/AudioChannelMixer.yaml
172+
ignoreTranslation: true
173+
- title: AudioChannelSplitter
174+
path: /reference/engine/classes/AudioChannelSplitter
175+
type: engineapi
176+
source: /reference/engine/classes/AudioChannelSplitter.yaml
177+
ignoreTranslation: true
168178
- title: AudioChorus
169179
path: /reference/engine/classes/AudioChorus
170180
type: engineapi
@@ -3408,6 +3418,11 @@ navigation:
34083418
type: engineapi
34093419
source: /reference/engine/enums/AudioApiRollout.yaml
34103420
ignoreTranslation: true
3421+
- title: AudioChannelLayout
3422+
path: /reference/engine/enums/AudioChannelLayout
3423+
type: engineapi
3424+
source: /reference/engine/enums/AudioChannelLayout.yaml
3425+
ignoreTranslation: true
34113426
- title: AudioFilterType
34123427
path: /reference/engine/enums/AudioFilterType
34133428
type: engineapi

‎content/en-us/art/modeling/avatar-setup.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Roblox intends to continue releasing updated versions of the auto-setup ML model
6262

6363
### Valid inputs
6464

65-
The auto-setup feature supports various mesh inputs, as long as the base mesh meets the [body model requirements](#body-model-requirements).
65+
If the base mesh meets the [body model requirements](#body-model-requirements), auto-setup supports the following inputs:
6666

6767
<table><thead>
6868
<tr>
@@ -171,8 +171,8 @@ The full requirements for the input body model are as follows:
171171
1. Bodies with I-pose may yield lower quality results.
172172
2. Ensure that no limbs obscure or overlap each other from the front view.
173173
7. **Negative Z Axis** — The body front should face the negative Z axis.
174-
8. **Symmetrical** — The body should be left and right symmetrical.
175-
1. Asymmetrical bodies may still work on a case-to-case basis. Position the center of the body with the Y-axis to improve the accuracy of the result.
174+
8. **Symmetrical** — Asymmetrical bodies may work on a case-to-case basis. Position the center of the body with the Y-axis to improve the accuracy of the result.
175+
1. If your asymmetrical model experiences setup issues, try using a more symmetrical version.
176176
9. **Watertight** — Ensure the model is watertight in all regions with the exception of the eyes and mouth. Watertight means that there are no holes in the mesh and no back faces are exposed.
177177
10. **No accessories** — Do not include accessories, including face accessories, like hair, eyebrows, beards, and eyelashes.
178178
11. **Distinct neck area** — Keep the neck distinct and not merged with the shoulders or upper torso.
@@ -207,12 +207,12 @@ The following are common examples of models that may not yield expected results
207207
<tbody>
208208
<tr>
209209
<td>
210-
<center><figure><img src="../../assets/avatar/avatar-setup/Assymetry.png" alt=""/><figcaption>**Asymmetry** &mdash; setup tool expects symmetry with limbs.</figcaption></figure></center>
210+
<center><figure><img src="../../assets/avatar/avatar-setup/Assymetry.png" alt=""/><figcaption>**Extreme asymmetry** &mdash; If you are having issues with an asymmetrical model, try using a more symmetrical version and make minor adjustments.</figcaption></figure></center>
211211
</td>
212212
</tr>
213213
<tr>
214214
<td>
215-
<center><figure><img src="../../assets/avatar/avatar-setup/I-pose.png" alt=""/><figcaption>**I-pose** &mdash; setup tool expects A-Pose.</figcaption></figure></center>
215+
<center><figure><img src="../../assets/avatar/avatar-setup/I-pose.png" alt=""/><figcaption>**I-pose** &mdash; If you are experiencing issues with your model in an I-pose, try resubmitting with A-pose or T-pose.</figcaption></figure></center>
216216
</td>
217217
</tr>
218218
<tr>

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

Lines changed: 9 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -210,8 +210,9 @@ methods:
210210
type: Content
211211
default:
212212
summary: |
213-
Reference to asset content stored externally or as an object within the place, wrapping a single value
214-
of one of the supported `Enum.ContentSourceType` values.
213+
Reference to asset content stored externally or as an object within
214+
the place, wrapping a single value of one of the supported
215+
`Enum.ContentSourceType` values.
215216
- name: editableImageOptions
216217
type: Dictionary?
217218
default:
@@ -253,8 +254,9 @@ methods:
253254
type: Content
254255
default:
255256
summary: |
256-
Reference to asset content stored externally or as an object within the place, wrapping a single value
257-
of one of the supported `Enum.ContentSourceType` values.
257+
Reference to asset content stored externally or as an object within
258+
the place, wrapping a single value of one of the supported
259+
`Enum.ContentSourceType` values.
258260
- name: editableMeshOptions
259261
type: Dictionary?
260262
default:
@@ -276,36 +278,6 @@ methods:
276278
thread_safety: Unsafe
277279
capabilities: []
278280
writeCapabilities: []
279-
- name: AssetService:CreateEditableMeshFromPartAsync
280-
summary: |
281-
Returns a new `Class.EditableMesh` instance created from an existing
282-
`Class.MeshPart`.
283-
description: |
284-
Returns a new `Class.EditableMesh` instance created from the
285-
`Class.MeshPart.MeshId|MeshId` of an existing `Class.MeshPart`.
286-
code_samples: []
287-
parameters:
288-
- name: meshPart
289-
type: Instance
290-
default:
291-
summary: |
292-
The `Class.MeshPart` from which to create an `Class.EditableMesh`
293-
instance. The part must have a valid `Class.MeshPart.MeshId|MeshId`
294-
for this method to operate.
295-
returns:
296-
- type: Object
297-
summary: |
298-
The new `Class.EditableMesh` instance.
299-
tags:
300-
- Yields
301-
- Deprecated
302-
deprecation_message: |
303-
This function has been deprecated - use
304-
`Class.AssetService:CreateEditableMeshAsync()`.
305-
security: None
306-
thread_safety: Unsafe
307-
capabilities: []
308-
writeCapabilities: []
309281
- name: AssetService:CreateMeshPartAsync
310282
summary: |
311283
Creates a new `Class.MeshPart` with a specified mesh ID and an optional
@@ -324,8 +296,9 @@ methods:
324296
type: Content
325297
default:
326298
summary: |
327-
Reference to asset content stored externally or as an object within the place, wrapping a single value
328-
of one of the supported `Enum.ContentSourceType` values.
299+
Reference to asset content stored externally or as an object within
300+
the place, wrapping a single value of one of the supported
301+
`Enum.ContentSourceType` values.
329302
- name: options
330303
type: Dictionary
331304
default: nil

‎content/en-us/reference/engine/classes/AudioAnalyzer.yaml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,34 @@ methods:
133133
thread_safety: Unsafe
134134
capabilities: []
135135
writeCapabilities: []
136+
- name: AudioAnalyzer:GetInputPins
137+
summary: ''
138+
description: ''
139+
code_samples: []
140+
parameters: []
141+
returns:
142+
- type: Array
143+
summary: ''
144+
tags: []
145+
deprecation_message: ''
146+
security: None
147+
thread_safety: Unsafe
148+
capabilities: []
149+
writeCapabilities: []
150+
- name: AudioAnalyzer:GetOutputPins
151+
summary: ''
152+
description: ''
153+
code_samples: []
154+
parameters: []
155+
returns:
156+
- type: Array
157+
summary: ''
158+
tags: []
159+
deprecation_message: ''
160+
security: None
161+
thread_safety: Unsafe
162+
capabilities: []
163+
writeCapabilities: []
136164
- name: AudioAnalyzer:GetSpectrum
137165
summary: |
138166
Returns the frequency spectrum of the last audio buffer.

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

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
name: AudioChannelMixer
2+
type: class
3+
category:
4+
memory_category: Internal
5+
summary: ''
6+
description: ''
7+
code_samples: []
8+
inherits:
9+
- Instance
10+
tags:
11+
- NotBrowsable
12+
deprecation_message: ''
13+
properties:
14+
- name: AudioChannelMixer.Layout
15+
summary: ''
16+
description: ''
17+
code_samples: []
18+
type: AudioChannelLayout
19+
tags: []
20+
deprecation_message: ''
21+
security:
22+
read: None
23+
write: None
24+
thread_safety: ReadSafe
25+
category: State
26+
serialization:
27+
can_load: true
28+
can_save: true
29+
capabilities:
30+
- Audio
31+
writeCapabilities: []
32+
methods:
33+
- name: AudioChannelMixer:GetConnectedWires
34+
summary: ''
35+
description: ''
36+
code_samples: []
37+
parameters:
38+
- name: pin
39+
type: string
40+
default:
41+
summary: ''
42+
returns:
43+
- type: Instances
44+
summary: ''
45+
tags: []
46+
deprecation_message: ''
47+
security: None
48+
thread_safety: Unsafe
49+
capabilities: []
50+
writeCapabilities: []
51+
events:
52+
- name: AudioChannelMixer.WiringChanged
53+
summary: ''
54+
description: ''
55+
code_samples: []
56+
parameters:
57+
- name: connected
58+
type: bool
59+
default:
60+
summary: ''
61+
- name: pin
62+
type: string
63+
default:
64+
summary: ''
65+
- name: wire
66+
type: Wire
67+
default:
68+
summary: ''
69+
- name: instance
70+
type: Instance
71+
default:
72+
summary: ''
73+
tags: []
74+
deprecation_message: ''
75+
security: None
76+
thread_safety: Unsafe
77+
capabilities: []
78+
writeCapabilities: []
79+
callbacks: []

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

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
name: AudioChannelSplitter
2+
type: class
3+
category:
4+
memory_category: Internal
5+
summary: ''
6+
description: ''
7+
code_samples: []
8+
inherits:
9+
- Instance
10+
tags:
11+
- NotBrowsable
12+
deprecation_message: ''
13+
properties:
14+
- name: AudioChannelSplitter.Layout
15+
summary: ''
16+
description: ''
17+
code_samples: []
18+
type: AudioChannelLayout
19+
tags: []
20+
deprecation_message: ''
21+
security:
22+
read: None
23+
write: None
24+
thread_safety: ReadSafe
25+
category: State
26+
serialization:
27+
can_load: true
28+
can_save: true
29+
capabilities:
30+
- Audio
31+
writeCapabilities: []
32+
methods:
33+
- name: AudioChannelSplitter:GetConnectedWires
34+
summary: ''
35+
description: ''
36+
code_samples: []
37+
parameters:
38+
- name: pin
39+
type: string
40+
default:
41+
summary: ''
42+
returns:
43+
- type: Instances
44+
summary: ''
45+
tags: []
46+
deprecation_message: ''
47+
security: None
48+
thread_safety: Unsafe
49+
capabilities: []
50+
writeCapabilities: []
51+
events:
52+
- name: AudioChannelSplitter.WiringChanged
53+
summary: ''
54+
description: ''
55+
code_samples: []
56+
parameters:
57+
- name: connected
58+
type: bool
59+
default:
60+
summary: ''
61+
- name: pin
62+
type: string
63+
default:
64+
summary: ''
65+
- name: wire
66+
type: Wire
67+
default:
68+
summary: ''
69+
- name: instance
70+
type: Instance
71+
default:
72+
summary: ''
73+
tags: []
74+
deprecation_message: ''
75+
security: None
76+
thread_safety: Unsafe
77+
capabilities: []
78+
writeCapabilities: []
79+
callbacks: []

‎content/en-us/reference/engine/classes/AudioChorus.yaml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,34 @@ methods:
128128
thread_safety: Unsafe
129129
capabilities: []
130130
writeCapabilities: []
131+
- name: AudioChorus:GetInputPins
132+
summary: ''
133+
description: ''
134+
code_samples: []
135+
parameters: []
136+
returns:
137+
- type: Array
138+
summary: ''
139+
tags: []
140+
deprecation_message: ''
141+
security: None
142+
thread_safety: Unsafe
143+
capabilities: []
144+
writeCapabilities: []
145+
- name: AudioChorus:GetOutputPins
146+
summary: ''
147+
description: ''
148+
code_samples: []
149+
parameters: []
150+
returns:
151+
- type: Array
152+
summary: ''
153+
tags: []
154+
deprecation_message: ''
155+
security: None
156+
thread_safety: Unsafe
157+
capabilities: []
158+
writeCapabilities: []
131159
events:
132160
- name: AudioChorus.WiringChanged
133161
summary: |

0 commit comments

Comments
 (0)