@rbxts/types 1.0.905 → 1.0.907

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -137,6 +137,7 @@ interface Services {
137
137
  PlaceStatsService: PlaceStatsService;
138
138
  PlatformCloudStorageService: PlatformCloudStorageService;
139
139
  PlatformFriendsService: PlatformFriendsService;
140
+ PlatformLibraries: PlatformLibraries;
140
141
  PlayerDataService: PlayerDataService;
141
142
  PlayerHydrationService: PlayerHydrationService;
142
143
  Players: Players;
@@ -218,6 +219,7 @@ interface Services {
218
219
  TextService: TextService;
219
220
  TextureGenerationService: TextureGenerationService;
220
221
  ToastNotificationService: ToastNotificationService;
222
+ TraceRouteService: TraceRouteService;
221
223
  TracerService: TracerService;
222
224
  TutorialService: TutorialService;
223
225
  TweenService: TweenService;
@@ -240,6 +242,7 @@ interface Services {
240
242
  WebSocketService: WebSocketService;
241
243
  WebViewService: WebViewService;
242
244
  Workspace: Workspace;
245
+ WrapDeformMeshProvider: WrapDeformMeshProvider;
243
246
  }
244
247
  interface CreatableInstances {
245
248
  Accessory: Accessory;
@@ -679,6 +682,7 @@ interface Instances extends Services, CreatableInstances {
679
682
  PVInstance: PVInstance;
680
683
  RecommendationPages: RecommendationPages;
681
684
  RobloxSerializableInstance: RobloxSerializableInstance;
685
+ RolloutValidation: RolloutValidation;
682
686
  RootImportData: RootImportData;
683
687
  ScreenshotHud: ScreenshotHud;
684
688
  ScriptBuilder: ScriptBuilder;
@@ -4884,21 +4888,28 @@ interface AudioAnalyzer extends Instance {
4884
4888
  *
4885
4889
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioAnalyzer#GetConnectedWires)
4886
4890
  * @param this Takes measurements from audio streams that are connected to it via one or more `Wires`.
4887
- * @param pin
4891
+ * @param pin An input or output pin on this instance
4892
+ * @returns An array of `Wires`
4888
4893
  */
4889
4894
  GetConnectedWires(this: AudioAnalyzer, pin: string): Array<Instance>;
4890
4895
  /**
4896
+ * Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
4897
+ *
4891
4898
  * - **ThreadSafety**: Unsafe
4892
4899
  *
4893
4900
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioAnalyzer#GetInputPins)
4894
4901
  * @param this Takes measurements from audio streams that are connected to it via one or more `Wires`.
4902
+ * @returns An array of strings representing valid pin names.
4895
4903
  */
4896
4904
  GetInputPins(this: AudioAnalyzer): Array<unknown>;
4897
4905
  /**
4906
+ * Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
4907
+ *
4898
4908
  * - **ThreadSafety**: Unsafe
4899
4909
  *
4900
4910
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioAnalyzer#GetOutputPins)
4901
4911
  * @param this Takes measurements from audio streams that are connected to it via one or more `Wires`.
4912
+ * @returns An array of strings representing valid pin names.
4902
4913
  */
4903
4914
  GetOutputPins(this: AudioAnalyzer): Array<unknown>;
4904
4915
  /**
@@ -4949,25 +4960,28 @@ interface AudioChannelMixer extends Instance {
4949
4960
  *
4950
4961
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer#GetConnectedWires)
4951
4962
  * @param this Combines multiple audio streams into a single, multichannel audio stream.
4952
- * @param pin
4963
+ * @param pin An input or output pin on this instance
4964
+ * @returns An array of `Wires`
4953
4965
  */
4954
4966
  GetConnectedWires(this: AudioChannelMixer, pin: string): Array<Instance>;
4955
4967
  /**
4956
- * Returns the input pins that can be selected by `Wire.TargetName`.
4968
+ * Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
4957
4969
  *
4958
4970
  * - **ThreadSafety**: Unsafe
4959
4971
  *
4960
4972
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer#GetInputPins)
4961
4973
  * @param this Combines multiple audio streams into a single, multichannel audio stream.
4974
+ * @returns An array of strings representing valid pin names.
4962
4975
  */
4963
4976
  GetInputPins(this: AudioChannelMixer): Array<unknown>;
4964
4977
  /**
4965
- * Returns the output pin available for `Wire.SourceName`.
4978
+ * Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
4966
4979
  *
4967
4980
  * - **ThreadSafety**: Unsafe
4968
4981
  *
4969
4982
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer#GetOutputPins)
4970
4983
  * @param this Combines multiple audio streams into a single, multichannel audio stream.
4984
+ * @returns An array of strings representing valid pin names.
4971
4985
  */
4972
4986
  GetOutputPins(this: AudioChannelMixer): Array<unknown>;
4973
4987
  /**
@@ -5008,25 +5022,28 @@ interface AudioChannelSplitter extends Instance {
5008
5022
  *
5009
5023
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter#GetConnectedWires)
5010
5024
  * @param this Splits an audio stream into component channels so that each can be processed independently.
5011
- * @param pin
5025
+ * @param pin An input or output pin on this instance
5026
+ * @returns An array of `Wires`
5012
5027
  */
5013
5028
  GetConnectedWires(this: AudioChannelSplitter, pin: string): Array<Instance>;
5014
5029
  /**
5015
- * Returns the input pin available for `Wire.TargetName`.
5030
+ * Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
5016
5031
  *
5017
5032
  * - **ThreadSafety**: Unsafe
5018
5033
  *
5019
5034
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter#GetInputPins)
5020
5035
  * @param this Splits an audio stream into component channels so that each can be processed independently.
5036
+ * @returns An array of strings representing valid pin names.
5021
5037
  */
5022
5038
  GetInputPins(this: AudioChannelSplitter): Array<unknown>;
5023
5039
  /**
5024
- * Returns the output pins that can be selected by `Wire.SourceName`.
5040
+ * Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
5025
5041
  *
5026
5042
  * - **ThreadSafety**: Unsafe
5027
5043
  *
5028
5044
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter#GetOutputPins)
5029
5045
  * @param this Splits an audio stream into component channels so that each can be processed independently.
5046
+ * @returns An array of strings representing valid pin names.
5030
5047
  */
5031
5048
  GetOutputPins(this: AudioChannelSplitter): Array<unknown>;
5032
5049
  /**
@@ -5091,21 +5108,28 @@ interface AudioChorus extends Instance {
5091
5108
  *
5092
5109
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChorus#GetConnectedWires)
5093
5110
  * @param this Makes an audio stream sound more voluminous. If applied to a single voice, it may sound like multiple voices.
5094
- * @param pin
5111
+ * @param pin An input or output pin on this instance
5112
+ * @returns An array of `Wires`
5095
5113
  */
5096
5114
  GetConnectedWires(this: AudioChorus, pin: string): Array<Instance>;
5097
5115
  /**
5116
+ * Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
5117
+ *
5098
5118
  * - **ThreadSafety**: Unsafe
5099
5119
  *
5100
5120
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChorus#GetInputPins)
5101
5121
  * @param this Makes an audio stream sound more voluminous. If applied to a single voice, it may sound like multiple voices.
5122
+ * @returns An array of strings representing valid pin names.
5102
5123
  */
5103
5124
  GetInputPins(this: AudioChorus): Array<unknown>;
5104
5125
  /**
5126
+ * Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
5127
+ *
5105
5128
  * - **ThreadSafety**: Unsafe
5106
5129
  *
5107
5130
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChorus#GetOutputPins)
5108
5131
  * @param this Makes an audio stream sound more voluminous. If applied to a single voice, it may sound like multiple voices.
5132
+ * @returns An array of strings representing valid pin names.
5109
5133
  */
5110
5134
  GetOutputPins(this: AudioChorus): Array<unknown>;
5111
5135
  /**
@@ -5186,21 +5210,28 @@ interface AudioCompressor extends Instance {
5186
5210
  *
5187
5211
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioCompressor#GetConnectedWires)
5188
5212
  * @param this Adjusts the dynamic range of input streams.
5189
- * @param pin
5213
+ * @param pin An input or output pin on this instance
5214
+ * @returns An array of `Wires`
5190
5215
  */
5191
5216
  GetConnectedWires(this: AudioCompressor, pin: string): Array<Instance>;
5192
5217
  /**
5218
+ * Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
5219
+ *
5193
5220
  * - **ThreadSafety**: Unsafe
5194
5221
  *
5195
5222
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioCompressor#GetInputPins)
5196
5223
  * @param this Adjusts the dynamic range of input streams.
5224
+ * @returns An array of strings representing valid pin names.
5197
5225
  */
5198
5226
  GetInputPins(this: AudioCompressor): Array<unknown>;
5199
5227
  /**
5228
+ * Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
5229
+ *
5200
5230
  * - **ThreadSafety**: Unsafe
5201
5231
  *
5202
5232
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioCompressor#GetOutputPins)
5203
5233
  * @param this Adjusts the dynamic range of input streams.
5234
+ * @returns An array of strings representing valid pin names.
5204
5235
  */
5205
5236
  GetOutputPins(this: AudioCompressor): Array<unknown>;
5206
5237
  /**
@@ -5273,21 +5304,28 @@ interface AudioDeviceInput extends Instance {
5273
5304
  *
5274
5305
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioDeviceInput#GetConnectedWires)
5275
5306
  * @param this Produces audio streams from physical devices, such as microphones.
5276
- * @param pin
5307
+ * @param pin An input or output pin on this instance
5308
+ * @returns An array of `Wires`
5277
5309
  */
5278
5310
  GetConnectedWires(this: AudioDeviceInput, pin: string): Array<Instance>;
5279
5311
  /**
5312
+ * Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
5313
+ *
5280
5314
  * - **ThreadSafety**: Unsafe
5281
5315
  *
5282
5316
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioDeviceInput#GetInputPins)
5283
5317
  * @param this Produces audio streams from physical devices, such as microphones.
5318
+ * @returns An array of strings representing valid pin names.
5284
5319
  */
5285
5320
  GetInputPins(this: AudioDeviceInput): Array<unknown>;
5286
5321
  /**
5322
+ * Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
5323
+ *
5287
5324
  * - **ThreadSafety**: Unsafe
5288
5325
  *
5289
5326
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioDeviceInput#GetOutputPins)
5290
5327
  * @param this Produces audio streams from physical devices, such as microphones.
5328
+ * @returns An array of strings representing valid pin names.
5291
5329
  */
5292
5330
  GetOutputPins(this: AudioDeviceInput): Array<unknown>;
5293
5331
  /**
@@ -5347,21 +5385,28 @@ interface AudioDeviceOutput extends Instance {
5347
5385
  *
5348
5386
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioDeviceOutput#GetConnectedWires)
5349
5387
  * @param this Accepts audio streams to be rendered out to physical hardware devices such as speakers or headphones.
5350
- * @param pin
5388
+ * @param pin An input or output pin on this instance
5389
+ * @returns An array of `Wires`
5351
5390
  */
5352
5391
  GetConnectedWires(this: AudioDeviceOutput, pin: string): Array<Instance>;
5353
5392
  /**
5393
+ * Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
5394
+ *
5354
5395
  * - **ThreadSafety**: Unsafe
5355
5396
  *
5356
5397
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioDeviceOutput#GetInputPins)
5357
5398
  * @param this Accepts audio streams to be rendered out to physical hardware devices such as speakers or headphones.
5399
+ * @returns An array of strings representing valid pin names.
5358
5400
  */
5359
5401
  GetInputPins(this: AudioDeviceOutput): Array<unknown>;
5360
5402
  /**
5403
+ * Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
5404
+ *
5361
5405
  * - **ThreadSafety**: Unsafe
5362
5406
  *
5363
5407
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioDeviceOutput#GetOutputPins)
5364
5408
  * @param this Accepts audio streams to be rendered out to physical hardware devices such as speakers or headphones.
5409
+ * @returns An array of strings representing valid pin names.
5365
5410
  */
5366
5411
  GetOutputPins(this: AudioDeviceOutput): Array<unknown>;
5367
5412
  /**
@@ -5410,21 +5455,28 @@ interface AudioDistortion extends Instance {
5410
5455
  *
5411
5456
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioDistortion#GetConnectedWires)
5412
5457
  * @param this Distorts audio streams, making them sound fuzzier, grittier, and louder.
5413
- * @param pin
5458
+ * @param pin An input or output pin on this instance
5459
+ * @returns An array of `Wires`
5414
5460
  */
5415
5461
  GetConnectedWires(this: AudioDistortion, pin: string): Array<Instance>;
5416
5462
  /**
5463
+ * Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
5464
+ *
5417
5465
  * - **ThreadSafety**: Unsafe
5418
5466
  *
5419
5467
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioDistortion#GetInputPins)
5420
5468
  * @param this Distorts audio streams, making them sound fuzzier, grittier, and louder.
5469
+ * @returns An array of strings representing valid pin names.
5421
5470
  */
5422
5471
  GetInputPins(this: AudioDistortion): Array<unknown>;
5423
5472
  /**
5473
+ * Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
5474
+ *
5424
5475
  * - **ThreadSafety**: Unsafe
5425
5476
  *
5426
5477
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioDistortion#GetOutputPins)
5427
5478
  * @param this Distorts audio streams, making them sound fuzzier, grittier, and louder.
5479
+ * @returns An array of strings representing valid pin names.
5428
5480
  */
5429
5481
  GetOutputPins(this: AudioDistortion): Array<unknown>;
5430
5482
  /**
@@ -5503,21 +5555,28 @@ interface AudioEcho extends Instance {
5503
5555
  *
5504
5556
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEcho#GetConnectedWires)
5505
5557
  * @param this Overlays delayed copies of audio streams.
5506
- * @param pin
5558
+ * @param pin An input or output pin on this instance
5559
+ * @returns An array of `Wires`
5507
5560
  */
5508
5561
  GetConnectedWires(this: AudioEcho, pin: string): Array<Instance>;
5509
5562
  /**
5563
+ * Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
5564
+ *
5510
5565
  * - **ThreadSafety**: Unsafe
5511
5566
  *
5512
5567
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEcho#GetInputPins)
5513
5568
  * @param this Overlays delayed copies of audio streams.
5569
+ * @returns An array of strings representing valid pin names.
5514
5570
  */
5515
5571
  GetInputPins(this: AudioEcho): Array<unknown>;
5516
5572
  /**
5573
+ * Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
5574
+ *
5517
5575
  * - **ThreadSafety**: Unsafe
5518
5576
  *
5519
5577
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEcho#GetOutputPins)
5520
5578
  * @param this Overlays delayed copies of audio streams.
5579
+ * @returns An array of strings representing valid pin names.
5521
5580
  */
5522
5581
  GetOutputPins(this: AudioEcho): Array<unknown>;
5523
5582
  /**
@@ -5598,7 +5657,8 @@ interface AudioEmitter extends Instance {
5598
5657
  *
5599
5658
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#GetConnectedWires)
5600
5659
  * @param this Emits audio streams into the world.
5601
- * @param pin
5660
+ * @param pin An input or output pin on this instance
5661
+ * @returns An array of `Wires`
5602
5662
  */
5603
5663
  GetConnectedWires(this: AudioEmitter, pin: string): Array<Instance>;
5604
5664
  /**
@@ -5612,10 +5672,13 @@ interface AudioEmitter extends Instance {
5612
5672
  */
5613
5673
  GetDistanceAttenuation(this: AudioEmitter): object;
5614
5674
  /**
5675
+ * Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
5676
+ *
5615
5677
  * - **ThreadSafety**: Unsafe
5616
5678
  *
5617
5679
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#GetInputPins)
5618
5680
  * @param this Emits audio streams into the world.
5681
+ * @returns An array of strings representing valid pin names.
5619
5682
  */
5620
5683
  GetInputPins(this: AudioEmitter): Array<unknown>;
5621
5684
  /**
@@ -5628,10 +5691,13 @@ interface AudioEmitter extends Instance {
5628
5691
  */
5629
5692
  GetInteractingListeners(this: AudioEmitter): Array<Instance>;
5630
5693
  /**
5694
+ * Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
5695
+ *
5631
5696
  * - **ThreadSafety**: Unsafe
5632
5697
  *
5633
5698
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#GetOutputPins)
5634
5699
  * @param this Emits audio streams into the world.
5700
+ * @returns An array of strings representing valid pin names.
5635
5701
  */
5636
5702
  GetOutputPins(this: AudioEmitter): Array<unknown>;
5637
5703
  /**
@@ -5726,21 +5792,28 @@ interface AudioEqualizer extends Instance {
5726
5792
  *
5727
5793
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEqualizer#GetConnectedWires)
5728
5794
  * @param this Adjusts the frequency content of audio streams.
5729
- * @param pin
5795
+ * @param pin An input or output pin on this instance
5796
+ * @returns An array of `Wires`
5730
5797
  */
5731
5798
  GetConnectedWires(this: AudioEqualizer, pin: string): Array<Instance>;
5732
5799
  /**
5800
+ * Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
5801
+ *
5733
5802
  * - **ThreadSafety**: Unsafe
5734
5803
  *
5735
5804
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEqualizer#GetInputPins)
5736
5805
  * @param this Adjusts the frequency content of audio streams.
5806
+ * @returns An array of strings representing valid pin names.
5737
5807
  */
5738
5808
  GetInputPins(this: AudioEqualizer): Array<unknown>;
5739
5809
  /**
5810
+ * Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
5811
+ *
5740
5812
  * - **ThreadSafety**: Unsafe
5741
5813
  *
5742
5814
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEqualizer#GetOutputPins)
5743
5815
  * @param this Adjusts the frequency content of audio streams.
5816
+ * @returns An array of strings representing valid pin names.
5744
5817
  */
5745
5818
  GetOutputPins(this: AudioEqualizer): Array<unknown>;
5746
5819
  /**
@@ -5789,21 +5862,28 @@ interface AudioFader extends Instance {
5789
5862
  *
5790
5863
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioFader#GetConnectedWires)
5791
5864
  * @param this Adjusts the volume of audio streams.
5792
- * @param pin
5865
+ * @param pin An input or output pin on this instance
5866
+ * @returns An array of `Wires`
5793
5867
  */
5794
5868
  GetConnectedWires(this: AudioFader, pin: string): Array<Instance>;
5795
5869
  /**
5870
+ * Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
5871
+ *
5796
5872
  * - **ThreadSafety**: Unsafe
5797
5873
  *
5798
5874
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioFader#GetInputPins)
5799
5875
  * @param this Adjusts the volume of audio streams.
5876
+ * @returns An array of strings representing valid pin names.
5800
5877
  */
5801
5878
  GetInputPins(this: AudioFader): Array<unknown>;
5802
5879
  /**
5880
+ * Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
5881
+ *
5803
5882
  * - **ThreadSafety**: Unsafe
5804
5883
  *
5805
5884
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioFader#GetOutputPins)
5806
5885
  * @param this Adjusts the volume of audio streams.
5886
+ * @returns An array of strings representing valid pin names.
5807
5887
  */
5808
5888
  GetOutputPins(this: AudioFader): Array<unknown>;
5809
5889
  /**
@@ -5876,7 +5956,8 @@ interface AudioFilter extends Instance {
5876
5956
  *
5877
5957
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioFilter#GetConnectedWires)
5878
5958
  * @param this Adjusts the frequency content of audio streams.
5879
- * @param pin
5959
+ * @param pin An input or output pin on this instance
5960
+ * @returns An array of `Wires`
5880
5961
  */
5881
5962
  GetConnectedWires(this: AudioFilter, pin: string): Array<Instance>;
5882
5963
  /**
@@ -5891,17 +5972,23 @@ interface AudioFilter extends Instance {
5891
5972
  */
5892
5973
  GetGainAt(this: AudioFilter, frequency: number): number;
5893
5974
  /**
5975
+ * Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
5976
+ *
5894
5977
  * - **ThreadSafety**: Unsafe
5895
5978
  *
5896
5979
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioFilter#GetInputPins)
5897
5980
  * @param this Adjusts the frequency content of audio streams.
5981
+ * @returns An array of strings representing valid pin names.
5898
5982
  */
5899
5983
  GetInputPins(this: AudioFilter): Array<unknown>;
5900
5984
  /**
5985
+ * Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
5986
+ *
5901
5987
  * - **ThreadSafety**: Unsafe
5902
5988
  *
5903
5989
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioFilter#GetOutputPins)
5904
5990
  * @param this Adjusts the frequency content of audio streams.
5991
+ * @returns An array of strings representing valid pin names.
5905
5992
  */
5906
5993
  GetOutputPins(this: AudioFilter): Array<unknown>;
5907
5994
  /**
@@ -5966,21 +6053,28 @@ interface AudioFlanger extends Instance {
5966
6053
  *
5967
6054
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioFlanger#GetConnectedWires)
5968
6055
  * @param this Imparts a whooshing or sweeping sound on audio streams.
5969
- * @param pin
6056
+ * @param pin An input or output pin on this instance
6057
+ * @returns An array of `Wires`
5970
6058
  */
5971
6059
  GetConnectedWires(this: AudioFlanger, pin: string): Array<Instance>;
5972
6060
  /**
6061
+ * Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
6062
+ *
5973
6063
  * - **ThreadSafety**: Unsafe
5974
6064
  *
5975
6065
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioFlanger#GetInputPins)
5976
6066
  * @param this Imparts a whooshing or sweeping sound on audio streams.
6067
+ * @returns An array of strings representing valid pin names.
5977
6068
  */
5978
6069
  GetInputPins(this: AudioFlanger): Array<unknown>;
5979
6070
  /**
6071
+ * Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
6072
+ *
5980
6073
  * - **ThreadSafety**: Unsafe
5981
6074
  *
5982
6075
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioFlanger#GetOutputPins)
5983
6076
  * @param this Imparts a whooshing or sweeping sound on audio streams.
6077
+ * @returns An array of strings representing valid pin names.
5984
6078
  */
5985
6079
  GetOutputPins(this: AudioFlanger): Array<unknown>;
5986
6080
  /**
@@ -6044,28 +6138,39 @@ interface AudioGate extends Instance {
6044
6138
  */
6045
6139
  Threshold: NumberRange;
6046
6140
  /**
6141
+ * Returns an array of `Wires` that are connected to the specified pin.
6142
+ *
6047
6143
  * - **ThreadSafety**: Unsafe
6048
6144
  *
6049
6145
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#GetConnectedWires)
6050
6146
  * @param this
6051
- * @param pin
6147
+ * @param pin An input or output pin on this instance
6148
+ * @returns An array of `Wires`
6052
6149
  */
6053
6150
  GetConnectedWires(this: AudioGate, pin: string): Array<Instance>;
6054
6151
  /**
6152
+ * Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
6153
+ *
6055
6154
  * - **ThreadSafety**: Unsafe
6056
6155
  *
6057
6156
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#GetInputPins)
6058
6157
  * @param this
6158
+ * @returns An array of strings representing valid pin names.
6059
6159
  */
6060
6160
  GetInputPins(this: AudioGate): Array<unknown>;
6061
6161
  /**
6162
+ * Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
6163
+ *
6062
6164
  * - **ThreadSafety**: Unsafe
6063
6165
  *
6064
6166
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#GetOutputPins)
6065
6167
  * @param this
6168
+ * @returns An array of strings representing valid pin names.
6066
6169
  */
6067
6170
  GetOutputPins(this: AudioGate): Array<unknown>;
6068
6171
  /**
6172
+ * Fires when another instance is connected to or disconnected from the `AudioAnalyzer` via a `Wire`.
6173
+ *
6069
6174
  * - **ThreadSafety**: Unsafe
6070
6175
  *
6071
6176
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#WiringChanged)
@@ -6117,21 +6222,28 @@ interface AudioLimiter extends Instance {
6117
6222
  *
6118
6223
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioLimiter#GetConnectedWires)
6119
6224
  * @param this Limits how loud audio streams are allowed to be.
6120
- * @param pin
6225
+ * @param pin An input or output pin on this instance
6226
+ * @returns An array of `Wires`
6121
6227
  */
6122
6228
  GetConnectedWires(this: AudioLimiter, pin: string): Array<Instance>;
6123
6229
  /**
6230
+ * Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
6231
+ *
6124
6232
  * - **ThreadSafety**: Unsafe
6125
6233
  *
6126
6234
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioLimiter#GetInputPins)
6127
6235
  * @param this Limits how loud audio streams are allowed to be.
6236
+ * @returns An array of strings representing valid pin names.
6128
6237
  */
6129
6238
  GetInputPins(this: AudioLimiter): Array<unknown>;
6130
6239
  /**
6240
+ * Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
6241
+ *
6131
6242
  * - **ThreadSafety**: Unsafe
6132
6243
  *
6133
6244
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioLimiter#GetOutputPins)
6134
6245
  * @param this Limits how loud audio streams are allowed to be.
6246
+ * @returns An array of strings representing valid pin names.
6135
6247
  */
6136
6248
  GetOutputPins(this: AudioLimiter): Array<unknown>;
6137
6249
  /**
@@ -6212,7 +6324,8 @@ interface AudioListener extends Instance {
6212
6324
  *
6213
6325
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioListener#GetConnectedWires)
6214
6326
  * @param this Records an audio stream from its surrounding `AudioEmitters` in the 3D world.
6215
- * @param pin
6327
+ * @param pin An input or output pin on this instance
6328
+ * @returns An array of `Wires`
6216
6329
  */
6217
6330
  GetConnectedWires(this: AudioListener, pin: string): Array<Instance>;
6218
6331
  /**
@@ -6226,10 +6339,13 @@ interface AudioListener extends Instance {
6226
6339
  */
6227
6340
  GetDistanceAttenuation(this: AudioListener): object;
6228
6341
  /**
6342
+ * Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
6343
+ *
6229
6344
  * - **ThreadSafety**: Unsafe
6230
6345
  *
6231
6346
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioListener#GetInputPins)
6232
6347
  * @param this Records an audio stream from its surrounding `AudioEmitters` in the 3D world.
6348
+ * @returns An array of strings representing valid pin names.
6233
6349
  */
6234
6350
  GetInputPins(this: AudioListener): Array<unknown>;
6235
6351
  /**
@@ -6242,10 +6358,13 @@ interface AudioListener extends Instance {
6242
6358
  */
6243
6359
  GetInteractingEmitters(this: AudioListener): Array<Instance>;
6244
6360
  /**
6361
+ * Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
6362
+ *
6245
6363
  * - **ThreadSafety**: Unsafe
6246
6364
  *
6247
6365
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioListener#GetOutputPins)
6248
6366
  * @param this Records an audio stream from its surrounding `AudioEmitters` in the 3D world.
6367
+ * @returns An array of strings representing valid pin names.
6249
6368
  */
6250
6369
  GetOutputPins(this: AudioListener): Array<unknown>;
6251
6370
  /**
@@ -6322,21 +6441,28 @@ interface AudioPitchShifter extends Instance {
6322
6441
  *
6323
6442
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPitchShifter#GetConnectedWires)
6324
6443
  * @param this Adjusts the perceived pitch of audio streams.
6325
- * @param pin
6444
+ * @param pin An input or output pin on this instance
6445
+ * @returns An array of `Wires`
6326
6446
  */
6327
6447
  GetConnectedWires(this: AudioPitchShifter, pin: string): Array<Instance>;
6328
6448
  /**
6449
+ * Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
6450
+ *
6329
6451
  * - **ThreadSafety**: Unsafe
6330
6452
  *
6331
6453
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPitchShifter#GetInputPins)
6332
6454
  * @param this Adjusts the perceived pitch of audio streams.
6455
+ * @returns An array of strings representing valid pin names.
6333
6456
  */
6334
6457
  GetInputPins(this: AudioPitchShifter): Array<unknown>;
6335
6458
  /**
6459
+ * Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
6460
+ *
6336
6461
  * - **ThreadSafety**: Unsafe
6337
6462
  *
6338
6463
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPitchShifter#GetOutputPins)
6339
6464
  * @param this Adjusts the perceived pitch of audio streams.
6465
+ * @returns An array of strings representing valid pin names.
6340
6466
  */
6341
6467
  GetOutputPins(this: AudioPitchShifter): Array<unknown>;
6342
6468
  /**
@@ -6486,21 +6612,28 @@ interface AudioPlayer extends Instance {
6486
6612
  *
6487
6613
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#GetConnectedWires)
6488
6614
  * @param this Used to play audio assets.
6489
- * @param pin
6615
+ * @param pin An input or output pin on this instance
6616
+ * @returns An array of `Wires`
6490
6617
  */
6491
6618
  GetConnectedWires(this: AudioPlayer, pin: string): Array<Instance>;
6492
6619
  /**
6620
+ * Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
6621
+ *
6493
6622
  * - **ThreadSafety**: Unsafe
6494
6623
  *
6495
6624
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#GetInputPins)
6496
6625
  * @param this Used to play audio assets.
6626
+ * @returns An array of strings representing valid pin names.
6497
6627
  */
6498
6628
  GetInputPins(this: AudioPlayer): Array<unknown>;
6499
6629
  /**
6630
+ * Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
6631
+ *
6500
6632
  * - **ThreadSafety**: Unsafe
6501
6633
  *
6502
6634
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#GetOutputPins)
6503
6635
  * @param this Used to play audio assets.
6636
+ * @returns An array of strings representing valid pin names.
6504
6637
  */
6505
6638
  GetOutputPins(this: AudioPlayer): Array<unknown>;
6506
6639
  /**
@@ -6593,25 +6726,34 @@ interface AudioRecorder extends Instance {
6593
6726
  */
6594
6727
  Clear(this: AudioRecorder): void;
6595
6728
  /**
6729
+ * Returns an array of `Wires` that are connected to the specified pin.
6730
+ *
6596
6731
  * - **ThreadSafety**: Unsafe
6597
6732
  *
6598
6733
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioRecorder#GetConnectedWires)
6599
6734
  * @param this Records audio streams in-experience.
6600
- * @param pin
6735
+ * @param pin An input or output pin on this instance
6736
+ * @returns An array of `Wires`
6601
6737
  */
6602
6738
  GetConnectedWires(this: AudioRecorder, pin: string): Array<Instance>;
6603
6739
  /**
6740
+ * Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
6741
+ *
6604
6742
  * - **ThreadSafety**: Unsafe
6605
6743
  *
6606
6744
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioRecorder#GetInputPins)
6607
6745
  * @param this Records audio streams in-experience.
6746
+ * @returns An array of strings representing valid pin names.
6608
6747
  */
6609
6748
  GetInputPins(this: AudioRecorder): Array<unknown>;
6610
6749
  /**
6750
+ * Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
6751
+ *
6611
6752
  * - **ThreadSafety**: Unsafe
6612
6753
  *
6613
6754
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioRecorder#GetOutputPins)
6614
6755
  * @param this Records audio streams in-experience.
6756
+ * @returns An array of strings representing valid pin names.
6615
6757
  */
6616
6758
  GetOutputPins(this: AudioRecorder): Array<unknown>;
6617
6759
  /**
@@ -6653,6 +6795,8 @@ interface AudioRecorder extends Instance {
6653
6795
  */
6654
6796
  RecordAsync(this: AudioRecorder): void;
6655
6797
  /**
6798
+ * Fires when another instance is connected to or disconnected from the `AudioAnalyzer` via a `Wire`.
6799
+ *
6656
6800
  * - **ThreadSafety**: Unsafe
6657
6801
  *
6658
6802
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioRecorder#WiringChanged)
@@ -6784,21 +6928,28 @@ interface AudioReverb extends Instance {
6784
6928
  *
6785
6929
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioReverb#GetConnectedWires)
6786
6930
  * @param this Reverberates audio streams.
6787
- * @param pin
6931
+ * @param pin An input or output pin on this instance
6932
+ * @returns An array of `Wires`
6788
6933
  */
6789
6934
  GetConnectedWires(this: AudioReverb, pin: string): Array<Instance>;
6790
6935
  /**
6936
+ * Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
6937
+ *
6791
6938
  * - **ThreadSafety**: Unsafe
6792
6939
  *
6793
6940
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioReverb#GetInputPins)
6794
6941
  * @param this Reverberates audio streams.
6942
+ * @returns An array of strings representing valid pin names.
6795
6943
  */
6796
6944
  GetInputPins(this: AudioReverb): Array<unknown>;
6797
6945
  /**
6946
+ * Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
6947
+ *
6798
6948
  * - **ThreadSafety**: Unsafe
6799
6949
  *
6800
6950
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioReverb#GetOutputPins)
6801
6951
  * @param this Reverberates audio streams.
6952
+ * @returns An array of strings representing valid pin names.
6802
6953
  */
6803
6954
  GetOutputPins(this: AudioReverb): Array<unknown>;
6804
6955
  /**
@@ -6948,7 +7099,8 @@ interface AudioSpeechToText extends Instance {
6948
7099
  *
6949
7100
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioSpeechToText#GetConnectedWires)
6950
7101
  * @param this Converts spoken audio into text.
6951
- * @param pin
7102
+ * @param pin An input or output pin on this instance
7103
+ * @returns An array of `Wires`
6952
7104
  */
6953
7105
  GetConnectedWires(this: AudioSpeechToText, pin: string): Array<Instance>;
6954
7106
  /**
@@ -7071,7 +7223,8 @@ interface AudioTextToSpeech extends Instance {
7071
7223
  *
7072
7224
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#GetConnectedWires)
7073
7225
  * @param this Plays text as speech audio.
7074
- * @param pin
7226
+ * @param pin An input or output pin on this instance
7227
+ * @returns An array of `Wires`
7075
7228
  */
7076
7229
  GetConnectedWires(this: AudioTextToSpeech, pin: string): Array<Instance>;
7077
7230
  /**
@@ -7215,28 +7368,39 @@ interface AudioTremolo extends Instance {
7215
7368
  */
7216
7369
  Square: number;
7217
7370
  /**
7371
+ * Returns an array of `Wires` that are connected to the specified pin.
7372
+ *
7218
7373
  * - **ThreadSafety**: Unsafe
7219
7374
  *
7220
7375
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#GetConnectedWires)
7221
7376
  * @param this Creates a trembling effect on a sound by varying the volume of the sound up and down.
7222
- * @param pin
7377
+ * @param pin An input or output pin on this instance
7378
+ * @returns An array of `Wires`
7223
7379
  */
7224
7380
  GetConnectedWires(this: AudioTremolo, pin: string): Array<Instance>;
7225
7381
  /**
7382
+ * Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
7383
+ *
7226
7384
  * - **ThreadSafety**: Unsafe
7227
7385
  *
7228
7386
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#GetInputPins)
7229
7387
  * @param this Creates a trembling effect on a sound by varying the volume of the sound up and down.
7388
+ * @returns An array of strings representing valid pin names.
7230
7389
  */
7231
7390
  GetInputPins(this: AudioTremolo): Array<unknown>;
7232
7391
  /**
7392
+ * Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
7393
+ *
7233
7394
  * - **ThreadSafety**: Unsafe
7234
7395
  *
7235
7396
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#GetOutputPins)
7236
7397
  * @param this Creates a trembling effect on a sound by varying the volume of the sound up and down.
7398
+ * @returns An array of strings representing valid pin names.
7237
7399
  */
7238
7400
  GetOutputPins(this: AudioTremolo): Array<unknown>;
7239
7401
  /**
7402
+ * Fires when another instance is connected to or disconnected from the `AudioAnalyzer` via a `Wire`.
7403
+ *
7240
7404
  * - **ThreadSafety**: Unsafe
7241
7405
  *
7242
7406
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#WiringChanged)
@@ -7596,7 +7760,7 @@ interface AvatarCreationService extends Instance {
7596
7760
  */
7597
7761
  GetValidationRules(this: AvatarCreationService): object;
7598
7762
  /**
7599
- * Automatically sets up a custom `Model` as an avatar asset.
7763
+ * Automatically sets up a custom `Model` and/or avatar accessories.
7600
7764
  *
7601
7765
  * - **ThreadSafety**: Unsafe
7602
7766
  * - **Tags**: Yields
@@ -7604,7 +7768,7 @@ interface AvatarCreationService extends Instance {
7604
7768
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#AutoSetupAvatarAsync)
7605
7769
  * @param this A service to support developer avatar creators.
7606
7770
  * @param player The `Player` that the avatar is being set up for.
7607
- * @param model The humanoid `Model` that will be set up as an avatar.
7771
+ * @param autoSetupParams A table containing the arguments. Type: `type AutoSetupAccessory = { AccessoryType: Enum.AccessoryType, IsLayered: bool, Instance: Model, } type AutoSetupParams = { Body: Model?, Accessories: {AutoSetupAccessory}, }`
7608
7772
  * @param progressCallback Optional callback function that will be invoked periodically with a progressInfo table with the overall progress (from 0 to 1). Type: `(progressInfo: { Progress: number }) -> ()`
7609
7773
  * @returns A unique identifier for the generated avatar.
7610
7774
  */
@@ -7985,10 +8149,7 @@ interface AvatarEditorService extends Instance {
7985
8149
  * @param this A service to support developer Avatar Editors.
7986
8150
  * @param itemIds The list of item ids to get details of.
7987
8151
  * @param itemType The type of the item ids provided.
7988
- * @returns Returns an array of item details with the following fields:
7989
- * ```lua
7990
- * { "AssetType" = "string", "CreatorName" = "string", "CreatorTargetId" = 0, "CreatorType" = "string", "Description" = "string", "FavoriteCount" = 0, "Genres" = [ "All" ], "Id" = 0, "ItemRestrictions" = [ "Limited" ], "ItemStatus": [ "New" ], "ItemType" = "string", "LowestPrice" = 0, "Name" = "string", "Price" = 0, "ProductId" = 0 }
7991
- * ``` .
8152
+ * @returns Returns an array of item details. See `AvatarEditorService:GetBatchItemDetailsAsync()` for the response format.
7992
8153
  *
7993
8154
  * @deprecated GetBatchItemDetailsAsync
7994
8155
  */
@@ -8005,10 +8166,7 @@ interface AvatarEditorService extends Instance {
8005
8166
  * @param this A service to support developer Avatar Editors.
8006
8167
  * @param itemIds The list of item ids to get details of.
8007
8168
  * @param itemType The type of the item ids provided.
8008
- * @returns Returns an array of item details with the following fields:
8009
- * ```lua
8010
- * { "AssetType" = "string", "CreatorName" = "string", "CreatorTargetId" = 0, "CreatorType" = "string", "Description" = "string", "FavoriteCount" = 0, "Genres" = [ "All" ], "Id" = 0, "ItemRestrictions" = [ "Limited" ], "ItemStatus": [ "New" ], "ItemType" = "string", "LowestPrice" = 0, "Name" = "string", "Price" = 0, "ProductId" = 0 }
8011
- * ``` .
8169
+ * @returns Returns an array of item details.
8012
8170
  */
8013
8171
  GetBatchItemDetailsAsync(this: AvatarEditorService, itemIds: Array<unknown>, itemType: CastsToEnum<Enum.AvatarItemType>): Array<unknown>;
8014
8172
  /**
@@ -8108,7 +8266,7 @@ interface AvatarEditorService extends Instance {
8108
8266
  * @param this A service to support developer Avatar Editors.
8109
8267
  * @param itemId The ID of the item whose details are being retrieved.
8110
8268
  * @param itemType An enum value indicating the type of item whose details are being retrieved.
8111
- * @returns A table containing the item info for the retrieved item. See above for a sample table.
8269
+ * @returns A table containing the item info for the retrieved item.
8112
8270
  */
8113
8271
  GetItemDetailsAsync(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType>): object;
8114
8272
  /**
@@ -8249,6 +8407,7 @@ interface AvatarEditorService extends Instance {
8249
8407
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#SearchCatalogAsync)
8250
8408
  * @param this A service to support developer Avatar Editors.
8251
8409
  * @param searchParameters An object containing the parameters used for the search.
8410
+ * @returns A `CatalogPages` object containing the search results.
8252
8411
  */
8253
8412
  SearchCatalogAsync(this: AvatarEditorService, searchParameters: CatalogSearchParams): CatalogPages;
8254
8413
  /**
@@ -10388,6 +10547,8 @@ interface BodyPartDescription extends Instance {
10388
10547
  */
10389
10548
  Color: Color3;
10390
10549
  /**
10550
+ * Specifies the head shape identifier to apply to a Dynamic Head when this `BodyPartDescription` is applied.
10551
+ *
10391
10552
  * - **ThreadSafety**: ReadSafe
10392
10553
  *
10393
10554
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BodyPartDescription#HeadShape)
@@ -10601,9 +10762,10 @@ interface CaptureService extends Instance {
10601
10762
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#ReadCapturesFromGalleryAsync)
10602
10763
  * @param this A service which provides control over screenshot and video capture features.
10603
10764
  * @param captureTypeFilters An array of `CaptureType`.
10765
+ * @param readFromAllEligibleExperiences A boolean; default is `false`.
10604
10766
  * @returns Tuple of (result: `ReadCapturesFromGalleryResult`, capturesPages: `CapturesPages`)
10605
10767
  */
10606
- ReadCapturesFromGalleryAsync(this: CaptureService, captureTypeFilters?: Array<unknown>): unknown;
10768
+ ReadCapturesFromGalleryAsync(this: CaptureService, captureTypeFilters?: Array<unknown>, readFromAllEligibleExperiences?: boolean): unknown;
10607
10769
  /**
10608
10770
  * Initiates a video capture recording.
10609
10771
  *
@@ -12445,7 +12607,7 @@ interface AnimationConstraint extends Constraint {
12445
12607
  */
12446
12608
  readonly C1: CFrame;
12447
12609
  /**
12448
- * Toggles whether the `AnimationConstraint` is kinematic or physically simulated.
12610
+ * Toggles whether the constraint is kinematic or physically simulated.
12449
12611
  *
12450
12612
  * - **ThreadSafety**: ReadSafe
12451
12613
  *
@@ -12491,7 +12653,7 @@ interface AnimationConstraint extends Constraint {
12491
12653
  */
12492
12654
  readonly Part1: BasePart | undefined;
12493
12655
  /**
12494
- * Describes the current animation offset of the `AnimationConstraint` joint.
12656
+ * Describes the current animation offset of the constraint joint.
12495
12657
  *
12496
12658
  * - **ThreadSafety**: ReadSafe
12497
12659
  *
@@ -17038,20 +17200,29 @@ interface GenerationService extends Instance {
17038
17200
  * @param this Service that allows developers to generate 3D objects from text prompts.
17039
17201
  * @param inputs A dictionary containing the mesh generation prompts. Currently, the only supported key is the `Prompt` (string) that describes the mesh to generate.
17040
17202
  * @param player The `Player` requesting the generation.
17041
- * @param options A dictionary for additional generation options to influence the result. The following key is supported: - `SuggestedSize` Optional `Vector3` representing a size guide for the generated asset. The service will attempt to create a model with a size and proportion similar to the provided `Vector3`. This does not guarantee the final output size.
17203
+ * @param options A dictionary for additional generation options to influence the result. The optional `SuggestedSize` key (`Vector3`) represents a size guide for the generated asset, meaning `GenerationService` will attempt to create a model with a size and proportion similar to the provided `Vector3`, although there is no guarantee on the final output size.
17042
17204
  * @param intermediateResultCallback A callback function triggered with intermediate generation results. Useful for retrieving early mesh versions before textures are applied.
17043
17205
  * @returns A tuple of the generation ID (a unique ID returned for each invocation of `GenerateMeshAsync()`) and context ID (not currently used).
17044
17206
  */
17045
17207
  GenerateMeshAsync(this: GenerationService, inputs: object, player: Player, options: object, intermediateResultCallback?: Callback): unknown;
17046
17208
  /**
17209
+ * Enables generation of multi-mesh geometries according to provided `inputs` and a `schema`.
17210
+ *
17047
17211
  * - **ThreadSafety**: Unsafe
17048
17212
  * - **Tags**: Yields
17049
17213
  *
17050
17214
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#GenerateModelAsync)
17051
17215
  * @param this Service that allows developers to generate 3D objects from text prompts.
17052
- * @param inputs
17053
- * @param schema
17054
- * @param options
17216
+ * @param inputs A table representing conditioning inputs with the following keys: - `TextPrompt` — String description of the object to generate.
17217
+ * - `Size` — Optional `Vector3` describing the object size to generate. This is only approximate; scale the model extents post‑generation if you need a specific size.
17218
+ * - `MaxTriangles` — Optional integer describing the maximum number of triangles that the returned model will contain. Lower values result in more faceted and low-poly generations.
17219
+ * - `GenerateTextures` — `true` (default) textures the resulting generation, while `false` will not generate textures.
17220
+ *
17221
+ *
17222
+ * @param schema Table representing the generation schema. Must contain a `PredefinedSchema` key with a string value; current valid options are `Car5` for a basic vehicle chassis consisting of five `Models`, or `Body1` which results in a single mesh output.
17223
+ * @param options Currently not used; reserved for future customization options.
17224
+ * @returns Tuple with the following elements: - A standard `Model` container instance that is compliant with the specified `schema`.
17225
+ * - A table containing a UUID and other metadata about the generation.
17055
17226
  */
17056
17227
  GenerateModelAsync(this: GenerationService, inputs: object, schema: object, options?: object): unknown;
17057
17228
  /**
@@ -19736,21 +19907,28 @@ interface VideoDisplay extends GuiObject {
19736
19907
  *
19737
19908
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#GetConnectedWires)
19738
19909
  * @param this A GUI object that displays video content from a connected `VideoPlayer`.
19739
- * @param pin
19910
+ * @param pin An input or output pin on this instance
19911
+ * @returns An array of `Wires`
19740
19912
  */
19741
19913
  GetConnectedWires(this: VideoDisplay, pin: string): Array<Instance>;
19742
19914
  /**
19915
+ * Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
19916
+ *
19743
19917
  * - **ThreadSafety**: Unsafe
19744
19918
  *
19745
19919
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#GetInputPins)
19746
19920
  * @param this A GUI object that displays video content from a connected `VideoPlayer`.
19921
+ * @returns An array of strings representing valid pin names.
19747
19922
  */
19748
19923
  GetInputPins(this: VideoDisplay): Array<unknown>;
19749
19924
  /**
19925
+ * Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
19926
+ *
19750
19927
  * - **ThreadSafety**: Unsafe
19751
19928
  *
19752
19929
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#GetOutputPins)
19753
19930
  * @param this A GUI object that displays video content from a connected `VideoPlayer`.
19931
+ * @returns An array of strings representing valid pin names.
19754
19932
  */
19755
19933
  GetOutputPins(this: VideoDisplay): Array<unknown>;
19756
19934
  /**
@@ -27078,13 +27256,14 @@ interface LocalizationTable extends Instance {
27078
27256
  */
27079
27257
  GetString(this: LocalizationTable, targetLocaleId: string, key: string): string;
27080
27258
  /**
27081
- * Returns a `Translator` for entries in this LocalizationTable, in the specified language.
27259
+ * Returns a `Translator` for entries in this LocalizationTable, in the specified locale.
27082
27260
  *
27083
27261
  * - **ThreadSafety**: Unsafe
27084
27262
  *
27085
27263
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LocalizationTable#GetTranslator)
27086
27264
  * @param this A LocalizationTable is a database of translations. It contains source strings and translations for various languages.
27087
27265
  * @param localeId
27266
+ * @returns The `Translator` instance for the specified locale.
27088
27267
  */
27089
27268
  GetTranslator(this: LocalizationTable, localeId: string): Translator;
27090
27269
  /**
@@ -34307,6 +34486,21 @@ interface PlatformFriendsService extends Instance {
34307
34486
  */
34308
34487
  readonly _nominal_PlatformFriendsService: unique symbol;
34309
34488
  }
34489
+ /**
34490
+ * - **Tags**: NotCreatable, Service
34491
+ *
34492
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlatformLibraries)
34493
+ */
34494
+ interface PlatformLibraries extends Instance {
34495
+ /**
34496
+ * **DO NOT USE!**
34497
+ *
34498
+ * This field exists to force TypeScript to recognize this as a nominal type
34499
+ * @hidden
34500
+ * @deprecated
34501
+ */
34502
+ readonly _nominal_PlatformLibraries: unique symbol;
34503
+ }
34310
34504
  /**
34311
34505
  * An object that represents a presently connected client to the experience.
34312
34506
  *
@@ -34855,7 +35049,7 @@ interface Player extends Instance {
34855
35049
  */
34856
35050
  SaveString(this: Player, key: string, value: string): void;
34857
35051
  /**
34858
- * **Deprecated:** This method has been superseded by `GetFriendsOnline()`.
35052
+ * **Deprecated:** This method has been superseded by `GetFriendsOnlineAsync()`.
34859
35053
  *
34860
35054
  * Returns a dictionary of online connections. Returns the product information of an asset using its asset ID.
34861
35055
  *
@@ -36927,6 +37121,20 @@ interface ReflectionService extends Instance {
36927
37121
  * @returns A list of `ReflectedClass` dictionaries with reflection information for each class that matches the filter criteria.
36928
37122
  */
36929
37123
  GetClasses(this: ReflectionService, filter?: object): Array<unknown>;
37124
+ /**
37125
+ * - **ThreadSafety**: Unsafe
37126
+ * - **Tags**: CustomLuaState
37127
+ *
37128
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ReflectionService#GetEventsOfClass)
37129
+ */
37130
+ GetEventsOfClass(this: ReflectionService, className: string, filter?: object): Array<unknown>;
37131
+ /**
37132
+ * - **ThreadSafety**: Unsafe
37133
+ * - **Tags**: CustomLuaState
37134
+ *
37135
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ReflectionService#GetMethodsOfClass)
37136
+ */
37137
+ GetMethodsOfClass(this: ReflectionService, className: string, filter?: object): Array<unknown>;
36930
37138
  /**
36931
37139
  * Returns a list of properties for a given class with filters applied.
36932
37140
  *
@@ -37187,6 +37395,21 @@ interface RobloxServerStorage extends Instance {
37187
37395
  */
37188
37396
  readonly _nominal_RobloxServerStorage: unique symbol;
37189
37397
  }
37398
+ /**
37399
+ * - **Tags**: NotCreatable
37400
+ *
37401
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RolloutValidation)
37402
+ */
37403
+ interface RolloutValidation extends Instance {
37404
+ /**
37405
+ * **DO NOT USE!**
37406
+ *
37407
+ * This field exists to force TypeScript to recognize this as a nominal type
37408
+ * @hidden
37409
+ * @deprecated
37410
+ */
37411
+ readonly _nominal_RolloutValidation: unique symbol;
37412
+ }
37190
37413
  /**
37191
37414
  * - **Tags**: NotCreatable, Service
37192
37415
  *
@@ -42403,8 +42626,9 @@ interface TestService extends Instance {
42403
42626
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#TakeSnapshot)
42404
42627
  * @param this A service used by Roblox to run controlled tests of the engine. It is available for developers to use, to a limited degree.
42405
42628
  * @param snapshotname
42629
+ * @param source
42406
42630
  */
42407
- TakeSnapshot(this: TestService, snapshotname: string): void;
42631
+ TakeSnapshot(this: TestService, snapshotname: string, source?: Instance): void;
42408
42632
  /**
42409
42633
  * Prints if a condition is `true`, otherwise prints a warning.
42410
42634
  *
@@ -43526,8 +43750,8 @@ interface TextChatService extends Instance {
43526
43750
  *
43527
43751
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextChatService#CanUsersChatAsync)
43528
43752
  * @param this A service handling in-experience text chat.
43529
- * @param userIdFrom
43530
- * @param userIdTo
43753
+ * @param userIdFrom The user must be in the current server, otherwise an error will occur.
43754
+ * @param userIdTo The user must be in the current server, otherwise an error will occur.
43531
43755
  */
43532
43756
  CanUsersChatAsync(this: TextChatService, userIdFrom: number, userIdTo: number): boolean;
43533
43757
  /**
@@ -43543,6 +43767,18 @@ interface TextChatService extends Instance {
43543
43767
  * @returns A list of users who could participate in the direct chat request. If none of the users can direct chat with the requesterUserId, the result is an empty array.
43544
43768
  */
43545
43769
  CanUsersDirectChatAsync(this: TextChatService, requesterUserId: number, userIds: Array<unknown>): Array<unknown>;
43770
+ /**
43771
+ * Returns chat group IDs that indicate which players can synchronously text chat together.
43772
+ *
43773
+ * - **ThreadSafety**: Unsafe
43774
+ * - **Tags**: Yields
43775
+ *
43776
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextChatService#GetChatGroupsAsync)
43777
+ * @param this A service handling in-experience text chat.
43778
+ * @param players A list of `Players` currently in the experience to evaluate for text chat compatibility.
43779
+ * @returns A sorted array of arrays of chat group ID strings. Players who share a matching chat group ID are eligible to synchronously text chat with each other.
43780
+ */
43781
+ GetChatGroupsAsync(this: TextChatService, players: Array<Instance>): Array<unknown>;
43546
43782
  /**
43547
43783
  * Fires when `TextChatService:DisplayBubble()` is called.
43548
43784
  *
@@ -43976,6 +44212,21 @@ interface TouchTransmitter extends Instance {
43976
44212
  */
43977
44213
  readonly _nominal_TouchTransmitter: unique symbol;
43978
44214
  }
44215
+ /**
44216
+ * - **Tags**: NotCreatable, Service
44217
+ *
44218
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TraceRouteService)
44219
+ */
44220
+ interface TraceRouteService extends Instance {
44221
+ /**
44222
+ * **DO NOT USE!**
44223
+ *
44224
+ * This field exists to force TypeScript to recognize this as a nominal type
44225
+ * @hidden
44226
+ * @deprecated
44227
+ */
44228
+ readonly _nominal_TraceRouteService: unique symbol;
44229
+ }
43979
44230
  /**
43980
44231
  * - **Tags**: NotCreatable, Service, NotReplicated
43981
44232
  *
@@ -46058,7 +46309,7 @@ interface UserInputService extends Instance {
46058
46309
  CFrame
46059
46310
  ]>;
46060
46311
  /**
46061
- * Returns the currently `TextBox` the client is currently focused on.
46312
+ * Returns the `TextBox` the client is currently focused on.
46062
46313
  *
46063
46314
  * - **ThreadSafety**: Unsafe
46064
46315
  *
@@ -47483,21 +47734,28 @@ interface VideoPlayer extends Instance {
47483
47734
  *
47484
47735
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#GetConnectedWires)
47485
47736
  * @param this Used to play video assets.
47486
- * @param pin
47737
+ * @param pin An input or output pin on this instance
47738
+ * @returns An array of `Wires`
47487
47739
  */
47488
47740
  GetConnectedWires(this: VideoPlayer, pin: string): Array<Instance>;
47489
47741
  /**
47742
+ * Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
47743
+ *
47490
47744
  * - **ThreadSafety**: Unsafe
47491
47745
  *
47492
47746
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#GetInputPins)
47493
47747
  * @param this Used to play video assets.
47748
+ * @returns An array of strings representing valid pin names.
47494
47749
  */
47495
47750
  GetInputPins(this: VideoPlayer): Array<unknown>;
47496
47751
  /**
47752
+ * Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
47753
+ *
47497
47754
  * - **ThreadSafety**: Unsafe
47498
47755
  *
47499
47756
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#GetOutputPins)
47500
47757
  * @param this Used to play video assets.
47758
+ * @returns An array of strings representing valid pin names.
47501
47759
  */
47502
47760
  GetOutputPins(this: VideoPlayer): Array<unknown>;
47503
47761
  /**
@@ -47871,6 +48129,18 @@ interface VoiceChatService extends Instance {
47871
48129
  * @deprecated
47872
48130
  */
47873
48131
  readonly _nominal_VoiceChatService: unique symbol;
48132
+ /**
48133
+ * Returns chat group IDs that indicate which players can voice chat together.
48134
+ *
48135
+ * - **ThreadSafety**: Unsafe
48136
+ * - **Tags**: Yields
48137
+ *
48138
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VoiceChatService#GetChatGroupsAsync)
48139
+ * @param this **VoiceChatService** is responsible for voice chat's high-level functionality.
48140
+ * @param players A list of `Players` currently in the experience to evaluate for voice chat compatibility.
48141
+ * @returns A sorted array of arrays of chat group ID strings. Players who share a matching chat group ID are eligible to voice chat with each other.
48142
+ */
48143
+ GetChatGroupsAsync(this: VoiceChatService, players: Array<Instance>): Array<unknown>;
47874
48144
  /**
47875
48145
  * Returns whether or not the given user has voice enabled.
47876
48146
  *
@@ -48079,6 +48349,21 @@ interface Wire extends Instance {
48079
48349
  */
48080
48350
  TargetName: string;
48081
48351
  }
48352
+ /**
48353
+ * - **Tags**: NotCreatable, Service, NotReplicated
48354
+ *
48355
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/WrapDeformMeshProvider)
48356
+ */
48357
+ interface WrapDeformMeshProvider extends Instance {
48358
+ /**
48359
+ * **DO NOT USE!**
48360
+ *
48361
+ * This field exists to force TypeScript to recognize this as a nominal type
48362
+ * @hidden
48363
+ * @deprecated
48364
+ */
48365
+ readonly _nominal_WrapDeformMeshProvider: unique symbol;
48366
+ }
48082
48367
  /**
48083
48368
  * `WrapTextureTransfer` allows a parent `Decal` to be wrapped around its parent `MeshPart` based on the cage of its `WrapTarget`.
48084
48369
  *