Skip to content

Commit 06ac873

Browse files
rbx-open-source-docs[bot]rbx-open-source-docs[bot]
committed
update Open Source Docs from Roblox internal teams
1 parent d358d6d commit 06ac873

20 files changed

+300
-116
lines changed

‎content/en-us/cloud/open-cloud/api-keys.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ To create an API key:
6262
1. Copy and save the API key string to a secure location that is **not** a
6363
public repository of your code.
6464
1. Check your created API key on the
65-
[Credentials](https://create.roblox.com/credentials) page of **Creator
65+
[API Extensions](https://create.roblox.com/dashboard/credentials) page of **Creator
6666
Dashboard**.
6767

6868
<Alert severity="warning"> The API key string is equivalent to the password of

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

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -133,26 +133,35 @@ methods:
133133
writeCapabilities: []
134134
events:
135135
- name: AudioAnalyzer.WiringChanged
136-
summary: ''
137-
description: ''
136+
summary: |
137+
Fires when another instance is connected to or disconnected from the
138+
`Class.AudioAnalyzer` via a `Class.Wire`.
139+
description: |
140+
Event that fires after a `Class.Wire` becomes connected or disconnected,
141+
and that `Class.Wire` is now or was previously connected to a pin on the
142+
`Class.AudioAnalyzer` and to some other wirable instance.
138143
code_samples: []
139144
parameters:
140145
- name: connected
141146
type: bool
142147
default:
143-
summary: ''
148+
summary: |
149+
Whether the instance got connected or disconnected.
144150
- name: pin
145151
type: string
146152
default:
147-
summary: ''
153+
summary: |
154+
The pin on the `Class.AudioAnalyzer` that the `Class.Wire` targets.
148155
- name: wire
149156
type: Wire
150157
default:
151-
summary: ''
158+
summary: |
159+
The `Class.Wire` between the `Class.AudioAnalyzer` and the other instance.
152160
- name: instance
153161
type: Instance
154162
default:
155-
summary: ''
163+
summary: |
164+
The other instance that is or was connected through the `Class.Wire`.
156165
tags: []
157166
deprecation_message: ''
158167
security: None

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

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -130,26 +130,35 @@ methods:
130130
writeCapabilities: []
131131
events:
132132
- name: AudioChorus.WiringChanged
133-
summary: ''
134-
description: ''
133+
summary: |
134+
Fires when another instance is connected to or disconnected from the
135+
`Class.AudioChorus` via a `Class.Wire`.
136+
description: |
137+
Event that fires after a `Class.Wire` becomes connected or disconnected,
138+
and that `Class.Wire` is now or was previously connected to a pin on the
139+
`Class.AudioChorus` and to some other wirable instance.
135140
code_samples: []
136141
parameters:
137142
- name: connected
138143
type: bool
139144
default:
140-
summary: ''
145+
summary: |
146+
Whether the instance got connected or disconnected.
141147
- name: pin
142148
type: string
143149
default:
144-
summary: ''
150+
summary: |
151+
The pin on the `Class.AudioChorus` that the `Class.Wire` targets.
145152
- name: wire
146153
type: Wire
147154
default:
148-
summary: ''
155+
summary: |
156+
The `Class.Wire` between the `Class.AudioChorus` and the other instance.
149157
- name: instance
150158
type: Instance
151159
default:
152-
summary: ''
160+
summary: |
161+
The other instance that is or was connected through the `Class.Wire`.
153162
tags: []
154163
deprecation_message: ''
155164
security: None

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

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -188,26 +188,35 @@ methods:
188188
writeCapabilities: []
189189
events:
190190
- name: AudioCompressor.WiringChanged
191-
summary: ''
192-
description: ''
191+
summary: |
192+
Fires when another instance is connected to or disconnected from the
193+
`Class.AudioCompressor` via a `Class.Wire`.
194+
description: |
195+
Event that fires after a `Class.Wire` becomes connected or disconnected,
196+
and that `Class.Wire` is now or was previously connected to a pin on the
197+
`Class.AudioCompressor` and to some other wirable instance.
193198
code_samples: []
194199
parameters:
195200
- name: connected
196201
type: bool
197202
default:
198-
summary: ''
203+
summary: |
204+
Whether the instance got connected or disconnected.
199205
- name: pin
200206
type: string
201207
default:
202-
summary: ''
208+
summary: |
209+
The pin on the `Class.AudioCompressor` that the `Class.Wire` targets.
203210
- name: wire
204211
type: Wire
205212
default:
206-
summary: ''
213+
summary: |
214+
The `Class.Wire` between the `Class.AudioCompressor` and the other instance.
207215
- name: instance
208216
type: Instance
209217
default:
210-
summary: ''
218+
summary: |
219+
The other instance that is or was connected through the `Class.Wire`.
211220
tags: []
212221
deprecation_message: ''
213222
security: None

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

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -250,26 +250,35 @@ methods:
250250
writeCapabilities: []
251251
events:
252252
- name: AudioDeviceInput.WiringChanged
253-
summary: ''
254-
description: ''
253+
summary: |
254+
Fires when another instance is connected to or disconnected from the
255+
`Class.AudioDeviceInput` via a `Class.Wire`.
256+
description: |
257+
Event that fires after a `Class.Wire` becomes connected or disconnected,
258+
and that `Class.Wire` is now or was previously connected to a pin on the
259+
`Class.AudioDeviceInput` and to some other wirable instance.
255260
code_samples: []
256261
parameters:
257262
- name: connected
258263
type: bool
259264
default:
260-
summary: ''
265+
summary: |
266+
Whether the instance got connected or disconnected.
261267
- name: pin
262268
type: string
263269
default:
264-
summary: ''
270+
summary: |
271+
The pin on the `Class.AudioDeviceInput` that the `Class.Wire` targets.
265272
- name: wire
266273
type: Wire
267274
default:
268-
summary: ''
275+
summary: |
276+
The `Class.Wire` between the `Class.AudioDeviceInput` and the other instance.
269277
- name: instance
270278
type: Instance
271279
default:
272-
summary: ''
280+
summary: |
281+
The other instance that is or was connected through the `Class.Wire`.
273282
tags: []
274283
deprecation_message: ''
275284
security: None

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

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,26 +64,35 @@ methods:
6464
writeCapabilities: []
6565
events:
6666
- name: AudioDeviceOutput.WiringChanged
67-
summary: ''
68-
description: ''
67+
summary: |
68+
Fires when another instance is connected to or disconnected from the
69+
`Class.AudioDeviceOutput` via a `Class.Wire`.
70+
description: |
71+
Event that fires after a `Class.Wire` becomes connected or disconnected,
72+
and that `Class.Wire` is now or was previously connected to a pin on the
73+
`Class.AudioDeviceOutput` and to some other wirable instance.
6974
code_samples: []
7075
parameters:
7176
- name: connected
7277
type: bool
7378
default:
74-
summary: ''
79+
summary: |
80+
Whether the instance got connected or disconnected.
7581
- name: pin
7682
type: string
7783
default:
78-
summary: ''
84+
summary: |
85+
The pin on the `Class.AudioDeviceOutput` that the `Class.Wire` targets.
7986
- name: wire
8087
type: Wire
8188
default:
82-
summary: ''
89+
summary: |
90+
The `Class.Wire` between the `Class.AudioDeviceOutput` and the other instance.
8391
- name: instance
8492
type: Instance
8593
default:
86-
summary: ''
94+
summary: |
95+
The other instance that is or was connected through the `Class.Wire`.
8796
tags: []
8897
deprecation_message: ''
8998
security: None

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

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -79,26 +79,35 @@ methods:
7979
writeCapabilities: []
8080
events:
8181
- name: AudioDistortion.WiringChanged
82-
summary: ''
83-
description: ''
82+
summary: |
83+
Fires when another instance is connected to or disconnected from the
84+
`Class.AudioDistortion` via a `Class.Wire`.
85+
description: |
86+
Event that fires after a `Class.Wire` becomes connected or disconnected,
87+
and that `Class.Wire` is now or was previously connected to a pin on the
88+
`Class.AudioDistortion` and to some other wirable instance.
8489
code_samples: []
8590
parameters:
8691
- name: connected
8792
type: bool
8893
default:
89-
summary: ''
94+
summary: |
95+
Whether the instance got connected or disconnected.
9096
- name: pin
9197
type: string
9298
default:
93-
summary: ''
99+
summary: |
100+
The pin on the `Class.AudioDistortion` that the `Class.Wire` targets.
94101
- name: wire
95102
type: Wire
96103
default:
97-
summary: ''
104+
summary: |
105+
The `Class.Wire` between the `Class.AudioDistortion` and the other instance.
98106
- name: instance
99107
type: Instance
100108
default:
101-
summary: ''
109+
summary: |
110+
The other instance that is or was connected through the `Class.Wire`.
102111
tags: []
103112
deprecation_message: ''
104113
security: None

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

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -162,26 +162,35 @@ methods:
162162
writeCapabilities: []
163163
events:
164164
- name: AudioEcho.WiringChanged
165-
summary: ''
166-
description: ''
165+
summary: |
166+
Fires when another instance is connected to or disconnected from the
167+
`Class.AudioEcho` via a `Class.Wire`.
168+
description: |
169+
Event that fires after a `Class.Wire` becomes connected or disconnected,
170+
and that `Class.Wire` is now or was previously connected to a pin on the
171+
`Class.AudioEcho` and to some other wirable instance.
167172
code_samples: []
168173
parameters:
169174
- name: connected
170175
type: bool
171176
default:
172-
summary: ''
177+
summary: |
178+
Whether the instance got connected or disconnected.
173179
- name: pin
174180
type: string
175181
default:
176-
summary: ''
182+
summary: |
183+
The pin on the `Class.AudioEcho` that the `Class.Wire` targets.
177184
- name: wire
178185
type: Wire
179186
default:
180-
summary: ''
187+
summary: |
188+
The `Class.Wire` between the `Class.AudioEcho` and the other instance.
181189
- name: instance
182190
type: Instance
183191
default:
184-
summary: ''
192+
summary: |
193+
The other instance that is or was connected through the `Class.Wire`.
185194
tags: []
186195
deprecation_message: ''
187196
security: None

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

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -297,26 +297,35 @@ methods:
297297
writeCapabilities: []
298298
events:
299299
- name: AudioEmitter.WiringChanged
300-
summary: ''
301-
description: ''
300+
summary: |
301+
Fires when another instance is connected to or disconnected from the
302+
`Class.AudioEmitter` via a `Class.Wire`.
303+
description: |
304+
Event that fires after a `Class.Wire` becomes connected or disconnected,
305+
and that `Class.Wire` is now or was previously connected to a pin on the
306+
`Class.AudioEmitter` and to some other wirable instance.
302307
code_samples: []
303308
parameters:
304309
- name: connected
305310
type: bool
306311
default:
307-
summary: ''
312+
summary: |
313+
Whether the instance got connected or disconnected.
308314
- name: pin
309315
type: string
310316
default:
311-
summary: ''
317+
summary: |
318+
The pin on the `Class.AudioEmitter` that the `Class.Wire` targets.
312319
- name: wire
313320
type: Wire
314321
default:
315-
summary: ''
322+
summary: |
323+
The `Class.Wire` between the `Class.AudioEmitter` and the other instance.
316324
- name: instance
317325
type: Instance
318326
default:
319-
summary: ''
327+
summary: |
328+
The other instance that is or was connected through the `Class.Wire`.
320329
tags: []
321330
deprecation_message: ''
322331
security: None

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

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -172,26 +172,35 @@ methods:
172172
writeCapabilities: []
173173
events:
174174
- name: AudioEqualizer.WiringChanged
175-
summary: ''
176-
description: ''
175+
summary: |
176+
Fires when another instance is connected to or disconnected from the
177+
`Class.AudioEqualizer` via a `Class.Wire`.
178+
description: |
179+
Event that fires after a `Class.Wire` becomes connected or disconnected,
180+
and that `Class.Wire` is now or was previously connected to a pin on the
181+
`Class.AudioEqualizer` and to some other wirable instance.
177182
code_samples: []
178183
parameters:
179184
- name: connected
180185
type: bool
181186
default:
182-
summary: ''
187+
summary: |
188+
Whether the instance got connected or disconnected.
183189
- name: pin
184190
type: string
185191
default:
186-
summary: ''
192+
summary: |
193+
The pin on the `Class.AudioEqualizer` that the `Class.Wire` targets.
187194
- name: wire
188195
type: Wire
189196
default:
190-
summary: ''
197+
summary: |
198+
The `Class.Wire` between the `Class.AudioEqualizer` and the other instance.
191199
- name: instance
192200
type: Instance
193201
default:
194-
summary: ''
202+
summary: |
203+
The other instance that is or was connected through the `Class.Wire`.
195204
tags: []
196205
deprecation_message: ''
197206
security: None

0 commit comments

Comments
 (0)