Skip to content

Commit a0b933f

Browse files
update Open Source Docs from Roblox internal teams
1 parent 951966a commit a0b933f

File tree

84 files changed

+604
-408
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

84 files changed

+604
-408
lines changed

content/common/navigation/engine/reference.yaml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4238,6 +4238,11 @@ navigation:
42384238
type: engineapi
42394239
source: /reference/engine/enums/ListDisplayMode.yaml
42404240
ignoreTranslation: true
4241+
- title: ListenerLocation
4242+
path: /reference/engine/enums/ListenerLocation
4243+
type: engineapi
4244+
source: /reference/engine/enums/ListenerLocation.yaml
4245+
ignoreTranslation: true
42414246
- title: ListenerType
42424247
path: /reference/engine/enums/ListenerType
42434248
type: engineapi
@@ -5188,6 +5193,11 @@ navigation:
51885193
type: engineapi
51895194
source: /reference/engine/enums/UIDragDetectorResponseStyle.yaml
51905195
ignoreTranslation: true
5196+
- title: UIDragSpeedAxisMapping
5197+
path: /reference/engine/enums/UIDragSpeedAxisMapping
5198+
type: engineapi
5199+
source: /reference/engine/enums/UIDragSpeedAxisMapping.yaml
5200+
ignoreTranslation: true
51915201
- title: UIFlexAlignment
51925202
path: /reference/engine/enums/UIFlexAlignment
51935203
type: engineapi
@@ -5348,6 +5358,11 @@ navigation:
53485358
type: engineapi
53495359
source: /reference/engine/enums/WeldConstraintPreserve.yaml
53505360
ignoreTranslation: true
5361+
- title: WhisperChatPrivacyMode
5362+
path: /reference/engine/enums/WhisperChatPrivacyMode
5363+
type: engineapi
5364+
source: /reference/engine/enums/WhisperChatPrivacyMode.yaml
5365+
ignoreTranslation: true
53515366
- title: WrapLayerAutoSkin
53525367
path: /reference/engine/enums/WrapLayerAutoSkin
53535368
type: engineapi

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ properties:
4646
summary: ''
4747
description: ''
4848
code_samples: []
49-
type: Content
49+
type: ContentId
5050
tags: []
5151
deprecation_message: ''
5252
security:

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ properties:
5151
Note that the animation will need to be loaded onto an
5252
`Class.AnimationTrack` in order to play it.
5353
code_samples:
54-
type: Content
54+
type: ContentId
5555
tags: []
5656
deprecation_message: ''
5757
security:

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ methods:
3838
code_samples: []
3939
parameters:
4040
- name: assetId
41-
type: Content
41+
type: ContentId
4242
default:
4343
summary: |
4444
The content ID of the animation.
@@ -108,7 +108,7 @@ methods:
108108
summary: |
109109
The `Class.AnimationClip` to be used.
110110
returns:
111-
- type: Content
111+
- type: ContentId
112112
summary: |
113113
A temporary asset ID generated for localized animation playback.
114114
tags: []
@@ -141,7 +141,7 @@ methods:
141141
summary: |
142142
The `Class.AnimationClip` to be used.
143143
returns:
144-
- type: Content
144+
- type: ContentId
145145
summary: |
146146
A temporary asset ID generated for localized animation playback.
147147
tags: []
@@ -160,7 +160,7 @@ methods:
160160
code_samples: []
161161
parameters:
162162
- name: assetId
163-
type: Content
163+
type: ContentId
164164
default:
165165
summary: |
166166
The content ID of the animation.
@@ -205,7 +205,7 @@ methods:
205205
code_samples: []
206206
parameters:
207207
- name: assetId
208-
type: Content
208+
type: ContentId
209209
default:
210210
summary: ''
211211
returns:

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ methods:
2929
code_samples: []
3030
parameters:
3131
- name: textureId
32-
type: Content
32+
type: ContentId
3333
default:
3434
summary: |
3535
Texture ID of the image to populate the `Class.EditableImage`.
@@ -52,7 +52,7 @@ methods:
5252
code_samples: []
5353
parameters:
5454
- name: meshId
55-
type: Content
55+
type: ContentId
5656
default:
5757
summary: |
5858
Content ID of the mesh from which to create an `Class.EditableMesh`
@@ -106,7 +106,7 @@ methods:
106106
code_samples: []
107107
parameters:
108108
- name: meshId
109-
type: Content
109+
type: ContentId
110110
default:
111111
summary: ''
112112
- name: options

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

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -58,13 +58,14 @@ properties:
5858
can_load: false
5959
can_save: true
6060
- name: AudioAnalyzer.SpectrumEnabled
61-
summary: 'Enables usage of `Class.AudioAnalyzer:GetSpectrum|GetSpectrum`.'
61+
summary: |
62+
Enables usage of `Class.AudioAnalyzer:GetSpectrum|GetSpectrum`.
6263
description: |
63-
Enables usage of `Class.AudioAnalyzer:GetSpectrum|GetSpectrum`.
64-
If false, `Class.AudioAnalyzer:GetSpectrum|GetSpectrum` returns an empty array,
65-
but the CPU overhead of the `Class.AudioAnalyzer` is dramatically reduced.
66-
This means that if you are only analyzing the **volume** of an audio stream,
67-
you can disable this property to improve performance.
64+
Enables usage of `Class.AudioAnalyzer:GetSpectrum|GetSpectrum()`. If `false`,
65+
`Class.AudioAnalyzer:GetSpectrum|GetSpectrum()` returns an empty array, but
66+
the CPU overhead of the `Class.AudioAnalyzer` is dramatically reduced.
67+
This means that if you are only analyzing the **volume** of an audio
68+
stream, you can disable this property to improve performance.
6869
code_samples: []
6970
type: bool
7071
tags: []
@@ -79,10 +80,12 @@ properties:
7980
can_save: true
8081
methods:
8182
- name: AudioAnalyzer:GetConnectedWires
82-
summary: 'Returns an array of `Class.Wire|Wires` that are connected to the specified pin.'
83+
summary: |
84+
Returns an array of `Class.Wire|Wires` that are connected to the specified
85+
pin.
8386
description: |
84-
Returns an array of `Class.Wire|Wires` that are connected to the specified pin.
85-
`Class.AudioAnalyzer` has one "Input" pin.
87+
Returns an array of `Class.Wire|Wires` that are connected to the specified
88+
pin. `Class.AudioAnalyzer` has one "Input" pin.
8689
code_samples: []
8790
parameters:
8891
- name: pin

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

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,10 @@ tags: []
2121
deprecation_message: ''
2222
properties:
2323
- name: AudioChorus.Bypass
24-
summary: 'If true, audio streams are passed-through unaffected by this effect.'
25-
description: 'If true, audio streams are passed-through unaffected by this effect.'
24+
summary: |
25+
Whether audio streams are passed-through unaffected by this effect.
26+
description: |
27+
If `true`, audio streams are passed-through unaffected by this effect.
2628
code_samples: []
2729
type: bool
2830
tags: []
@@ -93,10 +95,12 @@ properties:
9395
can_save: true
9496
methods:
9597
- name: AudioChorus:GetConnectedWires
96-
summary: 'Returns an array of `Class.Wire|Wires` that are connected to the specified pin.'
98+
summary: |
99+
Returns an array of `Class.Wire|Wires` that are connected to the specified
100+
pin.
97101
description: |
98-
Returns an array of `Class.Wire|Wires` that are connected to the specified pin.
99-
`Class.AudioChorus` has one "Input" pin, and one "Output" pin.
102+
Returns an array of `Class.Wire|Wires` that are connected to the specified
103+
pin. `Class.AudioChorus` has one "Input" pin and one "Output" pin.
100104
code_samples: []
101105
parameters:
102106
- name: pin

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

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,10 @@ properties:
4040
can_load: true
4141
can_save: true
4242
- name: AudioCompressor.Bypass
43-
summary: 'If true, audio streams are passed-through unaffected by this effect.'
44-
description: 'If true, audio streams are passed-through unaffected by this effect.'
43+
summary: |
44+
Whether audio streams are passed-through unaffected by this effect.
45+
description: |
46+
If `true`, audio streams are passed-through unaffected by this effect.
4547
code_samples: []
4648
type: bool
4749
tags: []
@@ -144,10 +146,13 @@ properties:
144146
can_save: true
145147
methods:
146148
- name: AudioCompressor:GetConnectedWires
147-
summary: 'Returns an array of `Class.Wire|Wires` that are connected to the specified pin.'
149+
summary: |
150+
Returns an array of `Class.Wire|Wires` that are connected to the specified
151+
pin.
148152
description: |
149-
Returns an array of `Class.Wire|Wires` that are connected to the specified pin.
150-
`Class.AudioCompressor` has one "Input" pin, one "Sidechain" pin, and one "Output" pin.
153+
Returns an array of `Class.Wire|Wires` that are connected to the specified
154+
pin. `Class.AudioCompressor` has one "Input" pin, one "Sidechain" pin, and
155+
one "Output" pin.
151156
code_samples: []
152157
parameters:
153158
- name: pin

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -168,10 +168,12 @@ properties:
168168
can_save: true
169169
methods:
170170
- name: AudioDeviceInput:GetConnectedWires
171-
summary: 'Returns an array of `Class.Wire|Wires` that are connected to the specified pin.'
171+
summary: |
172+
Returns an array of `Class.Wire|Wires` that are connected to the specified
173+
pin.
172174
description: |
173-
Returns an array of `Class.Wire|Wires` that are connected to the specified pin.
174-
`Class.AudioDeviceInput` has one "Output" pin.
175+
Returns an array of `Class.Wire|Wires` that are connected to the specified
176+
pin. `Class.AudioDeviceInput` has one "Output" pin.
175177
code_samples: []
176178
parameters:
177179
- name: pin

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,12 @@ properties:
3838
can_save: true
3939
methods:
4040
- name: AudioDeviceOutput:GetConnectedWires
41-
summary: 'Returns an array of `Class.Wire|Wires` that are connected to the specified pin.'
41+
summary: |
42+
Returns an array of `Class.Wire|Wires` that are connected to the specified
43+
pin.
4244
description: |
43-
Returns an array of `Class.Wire|Wires` that are connected to the specified pin.
44-
`Class.AudioDeviceOutput` has one "Input" pin.
45+
Returns an array of `Class.Wire|Wires` that are connected to the specified
46+
pin. `Class.AudioDeviceOutput` has one "Input" pin.
4547
code_samples: []
4648
parameters:
4749
- name: pin

0 commit comments

Comments
 (0)