Skip to content

Commit 28ddb9b

Browse files
update Open Source Docs from Roblox internal teams
1 parent 6d4ea24 commit 28ddb9b

21 files changed

+539
-51
lines changed

content/common/navigation/engine/reference.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5461,6 +5461,11 @@ navigation:
54615461
type: engineapi
54625462
source: /reference/engine/enums/VirtualInputMode.yaml
54635463
ignoreTranslation: true
5464+
- title: VoiceChatDistanceAttenuationType
5465+
path: /reference/engine/enums/VoiceChatDistanceAttenuationType
5466+
type: engineapi
5467+
source: /reference/engine/enums/VoiceChatDistanceAttenuationType.yaml
5468+
ignoreTranslation: true
54645469
- title: VoiceChatState
54655470
path: /reference/engine/enums/VoiceChatState
54665471
type: engineapi

content/en-us/art/characters/specifications.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ In the [3D importer](../../art/modeling/3d-importer.md#avatar-general), use **Ri
8585
</tr>
8686
<tr>
8787
<td>Torso</td>
88-
<td>.8</td>
88+
<td>.85</td>
8989
<td>1.7</td>
9090
<td>.7</td>
9191
</tr>

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ methods:
3838
- `Size` – A `Datatype.Vector2` that specifies the image's desired
3939
width and height.
4040
returns:
41-
- type: Object
41+
- type: EditableImage
4242
summary: ''
4343
tags: []
4444
deprecation_message: ''
@@ -65,7 +65,7 @@ methods:
6565
`Class.EditableMesh.FixedSize|FixedSize` will always be `false` for
6666
empty editable meshes.
6767
returns:
68-
- type: Object
68+
- type: EditableMesh
6969
summary: ''
7070
tags: []
7171
deprecation_message: ''
@@ -244,7 +244,7 @@ methods:
244244
Currently no options are available since resizing via
245245
`Class.EditableImage.Size|Size` is not supported.
246246
returns:
247-
- type: Object
247+
- type: EditableImage
248248
summary: |
249249
A new `Class.EditableImage` containing the provided image.
250250
tags:
@@ -292,7 +292,7 @@ methods:
292292
only modify their values. Set to `false` if the ability to change
293293
the mesh topology is required, at the expense of using more memory.
294294
returns:
295-
- type: Object
295+
- type: EditableMesh
296296
summary: |
297297
The new `Class.EditableMesh` instance.
298298
tags:

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@ code_samples:
1717
- audio-wiring---splitting-mixing
1818
inherits:
1919
- Instance
20-
tags:
21-
- NotBrowsable
20+
tags: []
2221
deprecation_message: ''
2322
properties:
2423
- name: AudioChannelMixer.Layout

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,7 @@ code_samples:
1919
- audio-wiring---splitting-mixing
2020
inherits:
2121
- Instance
22-
tags:
23-
- NotBrowsable
22+
tags: []
2423
deprecation_message: ''
2524
properties:
2625
- name: AudioChannelSplitter.Layout

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ methods:
243243
default:
244244
summary: ''
245245
returns:
246-
- type: Object
246+
- type: EditableImage
247247
summary: ''
248248
tags:
249249
- Yields

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ description: |
3333
information on how to adjust and customize the camera's behavior.
3434
code_samples:
3535
inherits:
36-
- Instance
36+
- PVInstance
3737
tags:
3838
- NotReplicated
3939
deprecation_message: ''

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ methods:
2020
code_samples: []
2121
parameters: []
2222
returns:
23-
- type: Object
23+
- type: ConfigSnapshot
2424
summary: ''
2525
tags:
2626
- Yields
@@ -39,7 +39,7 @@ methods:
3939
default:
4040
summary: ''
4141
returns:
42-
- type: Object
42+
- type: ConfigSnapshot
4343
summary: ''
4444
tags:
4545
- Yields

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,9 +100,12 @@ methods:
100100
summary: |
101101
Returns the default data store.
102102
description: |
103-
This function returns the default `Class.GlobalDataStore`. If you want to
104-
access a specific **named** data store instead, you should use the
103+
This function returns the default `Class.GlobalDataStore`.
104+
If you want to access a specific **named** data store instead, you should use the
105105
`Class.DataStoreService:GetDataStore()|GetDataStore()` function.
106+
107+
Note that the `Class.DataStore` returned by this function always uses the scope `u`.
108+
See [Data stores](../../../cloud-services/data-stores/index.md) for details on scope.
106109
code_samples:
107110
- get-a-globaldatastore-instance
108111
parameters: []

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ methods:
170170
Position at which the top-left corner of the added image will be
171171
drawn.
172172
- name: image
173-
type: Object
173+
type: EditableImage
174174
default:
175175
summary: |
176176
The `Class.EditableImage` to draw into this `Class.EditableImage`.
@@ -200,7 +200,7 @@ methods:
200200
code_samples: []
201201
parameters:
202202
- name: mesh
203-
type: Object
203+
type: EditableMesh
204204
default:
205205
summary: |
206206
The `Class.EditableMesh` used to project into.
@@ -275,7 +275,7 @@ methods:
275275
The rotation angle in degrees, applied around the pivot point of the
276276
source image.
277277
- name: image
278-
type: Object
278+
type: EditableImage
279279
default:
280280
summary: |
281281
The source `Class.EditableImage` to be drawn into this image.
@@ -396,8 +396,8 @@ methods:
396396
Reads a rectangular region of pixels into a buffer.
397397
description: |
398398
Reads a rectangular region of pixels from an `Class.EditableImage` and
399-
returns it as a buffer. Each number in the buffer is a single byte, with pixels
400-
stored in a sequence of four bytes (red, green, blue, and alpha).
399+
returns it as a buffer. Each number in the buffer is a single byte, with
400+
pixels stored in a sequence of four bytes (red, green, blue, and alpha).
401401
402402
Note that this method uses alpha instead of transparency, unlike the
403403
`Class.EditableImage` drawing methods.
@@ -432,8 +432,8 @@ methods:
432432
Writes a rectangular region of pixels into the image.
433433
description: |
434434
Writes a rectangular region of pixels to an `Class.EditableImage` from a
435-
buffer. Each number in the buffer is a single byte, with pixels stored in a
436-
sequence of four bytes (red, green, blue, and alpha).
435+
buffer. Each number in the buffer is a single byte, with pixels stored in
436+
a sequence of four bytes (red, green, blue, and alpha).
437437
438438
Note that this method uses alpha instead of transparency, unlike the
439439
`Class.EditableImage` drawing methods.

0 commit comments

Comments
 (0)