@rbxts/types 1.0.906 → 1.0.908
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;
|
|
@@ -681,6 +682,7 @@ interface Instances extends Services, CreatableInstances {
|
|
|
681
682
|
PVInstance: PVInstance;
|
|
682
683
|
RecommendationPages: RecommendationPages;
|
|
683
684
|
RobloxSerializableInstance: RobloxSerializableInstance;
|
|
685
|
+
RolloutValidation: RolloutValidation;
|
|
684
686
|
RootImportData: RootImportData;
|
|
685
687
|
ScreenshotHud: ScreenshotHud;
|
|
686
688
|
ScriptBuilder: ScriptBuilder;
|
|
@@ -3113,6 +3115,12 @@ interface AnalyticsService extends Instance {
|
|
|
3113
3115
|
}, statistics?: {
|
|
3114
3116
|
[index: string]: number;
|
|
3115
3117
|
}, customData?: unknown): void;
|
|
3118
|
+
/**
|
|
3119
|
+
* - **ThreadSafety**: Unsafe
|
|
3120
|
+
*
|
|
3121
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnalyticsService#GetDurationLoggerTimestamp)
|
|
3122
|
+
*/
|
|
3123
|
+
GetDurationLoggerTimestamp(this: AnalyticsService): number;
|
|
3116
3124
|
/**
|
|
3117
3125
|
* Logs an event used to track custom metrics of a user in experience.
|
|
3118
3126
|
*
|
|
@@ -4886,21 +4894,28 @@ interface AudioAnalyzer extends Instance {
|
|
|
4886
4894
|
*
|
|
4887
4895
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioAnalyzer#GetConnectedWires)
|
|
4888
4896
|
* @param this Takes measurements from audio streams that are connected to it via one or more `Wires`.
|
|
4889
|
-
* @param pin
|
|
4897
|
+
* @param pin An input or output pin on this instance
|
|
4898
|
+
* @returns An array of `Wires`
|
|
4890
4899
|
*/
|
|
4891
4900
|
GetConnectedWires(this: AudioAnalyzer, pin: string): Array<Instance>;
|
|
4892
4901
|
/**
|
|
4902
|
+
* Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
|
|
4903
|
+
*
|
|
4893
4904
|
* - **ThreadSafety**: Unsafe
|
|
4894
4905
|
*
|
|
4895
4906
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioAnalyzer#GetInputPins)
|
|
4896
4907
|
* @param this Takes measurements from audio streams that are connected to it via one or more `Wires`.
|
|
4908
|
+
* @returns An array of strings representing valid pin names.
|
|
4897
4909
|
*/
|
|
4898
4910
|
GetInputPins(this: AudioAnalyzer): Array<unknown>;
|
|
4899
4911
|
/**
|
|
4912
|
+
* Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
|
|
4913
|
+
*
|
|
4900
4914
|
* - **ThreadSafety**: Unsafe
|
|
4901
4915
|
*
|
|
4902
4916
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioAnalyzer#GetOutputPins)
|
|
4903
4917
|
* @param this Takes measurements from audio streams that are connected to it via one or more `Wires`.
|
|
4918
|
+
* @returns An array of strings representing valid pin names.
|
|
4904
4919
|
*/
|
|
4905
4920
|
GetOutputPins(this: AudioAnalyzer): Array<unknown>;
|
|
4906
4921
|
/**
|
|
@@ -4951,25 +4966,28 @@ interface AudioChannelMixer extends Instance {
|
|
|
4951
4966
|
*
|
|
4952
4967
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer#GetConnectedWires)
|
|
4953
4968
|
* @param this Combines multiple audio streams into a single, multichannel audio stream.
|
|
4954
|
-
* @param pin
|
|
4969
|
+
* @param pin An input or output pin on this instance
|
|
4970
|
+
* @returns An array of `Wires`
|
|
4955
4971
|
*/
|
|
4956
4972
|
GetConnectedWires(this: AudioChannelMixer, pin: string): Array<Instance>;
|
|
4957
4973
|
/**
|
|
4958
|
-
*
|
|
4974
|
+
* Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
|
|
4959
4975
|
*
|
|
4960
4976
|
* - **ThreadSafety**: Unsafe
|
|
4961
4977
|
*
|
|
4962
4978
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer#GetInputPins)
|
|
4963
4979
|
* @param this Combines multiple audio streams into a single, multichannel audio stream.
|
|
4980
|
+
* @returns An array of strings representing valid pin names.
|
|
4964
4981
|
*/
|
|
4965
4982
|
GetInputPins(this: AudioChannelMixer): Array<unknown>;
|
|
4966
4983
|
/**
|
|
4967
|
-
*
|
|
4984
|
+
* Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
|
|
4968
4985
|
*
|
|
4969
4986
|
* - **ThreadSafety**: Unsafe
|
|
4970
4987
|
*
|
|
4971
4988
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer#GetOutputPins)
|
|
4972
4989
|
* @param this Combines multiple audio streams into a single, multichannel audio stream.
|
|
4990
|
+
* @returns An array of strings representing valid pin names.
|
|
4973
4991
|
*/
|
|
4974
4992
|
GetOutputPins(this: AudioChannelMixer): Array<unknown>;
|
|
4975
4993
|
/**
|
|
@@ -5010,25 +5028,28 @@ interface AudioChannelSplitter extends Instance {
|
|
|
5010
5028
|
*
|
|
5011
5029
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter#GetConnectedWires)
|
|
5012
5030
|
* @param this Splits an audio stream into component channels so that each can be processed independently.
|
|
5013
|
-
* @param pin
|
|
5031
|
+
* @param pin An input or output pin on this instance
|
|
5032
|
+
* @returns An array of `Wires`
|
|
5014
5033
|
*/
|
|
5015
5034
|
GetConnectedWires(this: AudioChannelSplitter, pin: string): Array<Instance>;
|
|
5016
5035
|
/**
|
|
5017
|
-
*
|
|
5036
|
+
* Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
|
|
5018
5037
|
*
|
|
5019
5038
|
* - **ThreadSafety**: Unsafe
|
|
5020
5039
|
*
|
|
5021
5040
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter#GetInputPins)
|
|
5022
5041
|
* @param this Splits an audio stream into component channels so that each can be processed independently.
|
|
5042
|
+
* @returns An array of strings representing valid pin names.
|
|
5023
5043
|
*/
|
|
5024
5044
|
GetInputPins(this: AudioChannelSplitter): Array<unknown>;
|
|
5025
5045
|
/**
|
|
5026
|
-
*
|
|
5046
|
+
* Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
|
|
5027
5047
|
*
|
|
5028
5048
|
* - **ThreadSafety**: Unsafe
|
|
5029
5049
|
*
|
|
5030
5050
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter#GetOutputPins)
|
|
5031
5051
|
* @param this Splits an audio stream into component channels so that each can be processed independently.
|
|
5052
|
+
* @returns An array of strings representing valid pin names.
|
|
5032
5053
|
*/
|
|
5033
5054
|
GetOutputPins(this: AudioChannelSplitter): Array<unknown>;
|
|
5034
5055
|
/**
|
|
@@ -5093,21 +5114,28 @@ interface AudioChorus extends Instance {
|
|
|
5093
5114
|
*
|
|
5094
5115
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChorus#GetConnectedWires)
|
|
5095
5116
|
* @param this Makes an audio stream sound more voluminous. If applied to a single voice, it may sound like multiple voices.
|
|
5096
|
-
* @param pin
|
|
5117
|
+
* @param pin An input or output pin on this instance
|
|
5118
|
+
* @returns An array of `Wires`
|
|
5097
5119
|
*/
|
|
5098
5120
|
GetConnectedWires(this: AudioChorus, pin: string): Array<Instance>;
|
|
5099
5121
|
/**
|
|
5122
|
+
* Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
|
|
5123
|
+
*
|
|
5100
5124
|
* - **ThreadSafety**: Unsafe
|
|
5101
5125
|
*
|
|
5102
5126
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChorus#GetInputPins)
|
|
5103
5127
|
* @param this Makes an audio stream sound more voluminous. If applied to a single voice, it may sound like multiple voices.
|
|
5128
|
+
* @returns An array of strings representing valid pin names.
|
|
5104
5129
|
*/
|
|
5105
5130
|
GetInputPins(this: AudioChorus): Array<unknown>;
|
|
5106
5131
|
/**
|
|
5132
|
+
* Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
|
|
5133
|
+
*
|
|
5107
5134
|
* - **ThreadSafety**: Unsafe
|
|
5108
5135
|
*
|
|
5109
5136
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChorus#GetOutputPins)
|
|
5110
5137
|
* @param this Makes an audio stream sound more voluminous. If applied to a single voice, it may sound like multiple voices.
|
|
5138
|
+
* @returns An array of strings representing valid pin names.
|
|
5111
5139
|
*/
|
|
5112
5140
|
GetOutputPins(this: AudioChorus): Array<unknown>;
|
|
5113
5141
|
/**
|
|
@@ -5188,21 +5216,28 @@ interface AudioCompressor extends Instance {
|
|
|
5188
5216
|
*
|
|
5189
5217
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioCompressor#GetConnectedWires)
|
|
5190
5218
|
* @param this Adjusts the dynamic range of input streams.
|
|
5191
|
-
* @param pin
|
|
5219
|
+
* @param pin An input or output pin on this instance
|
|
5220
|
+
* @returns An array of `Wires`
|
|
5192
5221
|
*/
|
|
5193
5222
|
GetConnectedWires(this: AudioCompressor, pin: string): Array<Instance>;
|
|
5194
5223
|
/**
|
|
5224
|
+
* Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
|
|
5225
|
+
*
|
|
5195
5226
|
* - **ThreadSafety**: Unsafe
|
|
5196
5227
|
*
|
|
5197
5228
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioCompressor#GetInputPins)
|
|
5198
5229
|
* @param this Adjusts the dynamic range of input streams.
|
|
5230
|
+
* @returns An array of strings representing valid pin names.
|
|
5199
5231
|
*/
|
|
5200
5232
|
GetInputPins(this: AudioCompressor): Array<unknown>;
|
|
5201
5233
|
/**
|
|
5234
|
+
* Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
|
|
5235
|
+
*
|
|
5202
5236
|
* - **ThreadSafety**: Unsafe
|
|
5203
5237
|
*
|
|
5204
5238
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioCompressor#GetOutputPins)
|
|
5205
5239
|
* @param this Adjusts the dynamic range of input streams.
|
|
5240
|
+
* @returns An array of strings representing valid pin names.
|
|
5206
5241
|
*/
|
|
5207
5242
|
GetOutputPins(this: AudioCompressor): Array<unknown>;
|
|
5208
5243
|
/**
|
|
@@ -5275,21 +5310,28 @@ interface AudioDeviceInput extends Instance {
|
|
|
5275
5310
|
*
|
|
5276
5311
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioDeviceInput#GetConnectedWires)
|
|
5277
5312
|
* @param this Produces audio streams from physical devices, such as microphones.
|
|
5278
|
-
* @param pin
|
|
5313
|
+
* @param pin An input or output pin on this instance
|
|
5314
|
+
* @returns An array of `Wires`
|
|
5279
5315
|
*/
|
|
5280
5316
|
GetConnectedWires(this: AudioDeviceInput, pin: string): Array<Instance>;
|
|
5281
5317
|
/**
|
|
5318
|
+
* Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
|
|
5319
|
+
*
|
|
5282
5320
|
* - **ThreadSafety**: Unsafe
|
|
5283
5321
|
*
|
|
5284
5322
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioDeviceInput#GetInputPins)
|
|
5285
5323
|
* @param this Produces audio streams from physical devices, such as microphones.
|
|
5324
|
+
* @returns An array of strings representing valid pin names.
|
|
5286
5325
|
*/
|
|
5287
5326
|
GetInputPins(this: AudioDeviceInput): Array<unknown>;
|
|
5288
5327
|
/**
|
|
5328
|
+
* Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
|
|
5329
|
+
*
|
|
5289
5330
|
* - **ThreadSafety**: Unsafe
|
|
5290
5331
|
*
|
|
5291
5332
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioDeviceInput#GetOutputPins)
|
|
5292
5333
|
* @param this Produces audio streams from physical devices, such as microphones.
|
|
5334
|
+
* @returns An array of strings representing valid pin names.
|
|
5293
5335
|
*/
|
|
5294
5336
|
GetOutputPins(this: AudioDeviceInput): Array<unknown>;
|
|
5295
5337
|
/**
|
|
@@ -5349,21 +5391,28 @@ interface AudioDeviceOutput extends Instance {
|
|
|
5349
5391
|
*
|
|
5350
5392
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioDeviceOutput#GetConnectedWires)
|
|
5351
5393
|
* @param this Accepts audio streams to be rendered out to physical hardware devices such as speakers or headphones.
|
|
5352
|
-
* @param pin
|
|
5394
|
+
* @param pin An input or output pin on this instance
|
|
5395
|
+
* @returns An array of `Wires`
|
|
5353
5396
|
*/
|
|
5354
5397
|
GetConnectedWires(this: AudioDeviceOutput, pin: string): Array<Instance>;
|
|
5355
5398
|
/**
|
|
5399
|
+
* Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
|
|
5400
|
+
*
|
|
5356
5401
|
* - **ThreadSafety**: Unsafe
|
|
5357
5402
|
*
|
|
5358
5403
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioDeviceOutput#GetInputPins)
|
|
5359
5404
|
* @param this Accepts audio streams to be rendered out to physical hardware devices such as speakers or headphones.
|
|
5405
|
+
* @returns An array of strings representing valid pin names.
|
|
5360
5406
|
*/
|
|
5361
5407
|
GetInputPins(this: AudioDeviceOutput): Array<unknown>;
|
|
5362
5408
|
/**
|
|
5409
|
+
* Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
|
|
5410
|
+
*
|
|
5363
5411
|
* - **ThreadSafety**: Unsafe
|
|
5364
5412
|
*
|
|
5365
5413
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioDeviceOutput#GetOutputPins)
|
|
5366
5414
|
* @param this Accepts audio streams to be rendered out to physical hardware devices such as speakers or headphones.
|
|
5415
|
+
* @returns An array of strings representing valid pin names.
|
|
5367
5416
|
*/
|
|
5368
5417
|
GetOutputPins(this: AudioDeviceOutput): Array<unknown>;
|
|
5369
5418
|
/**
|
|
@@ -5412,21 +5461,28 @@ interface AudioDistortion extends Instance {
|
|
|
5412
5461
|
*
|
|
5413
5462
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioDistortion#GetConnectedWires)
|
|
5414
5463
|
* @param this Distorts audio streams, making them sound fuzzier, grittier, and louder.
|
|
5415
|
-
* @param pin
|
|
5464
|
+
* @param pin An input or output pin on this instance
|
|
5465
|
+
* @returns An array of `Wires`
|
|
5416
5466
|
*/
|
|
5417
5467
|
GetConnectedWires(this: AudioDistortion, pin: string): Array<Instance>;
|
|
5418
5468
|
/**
|
|
5469
|
+
* Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
|
|
5470
|
+
*
|
|
5419
5471
|
* - **ThreadSafety**: Unsafe
|
|
5420
5472
|
*
|
|
5421
5473
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioDistortion#GetInputPins)
|
|
5422
5474
|
* @param this Distorts audio streams, making them sound fuzzier, grittier, and louder.
|
|
5475
|
+
* @returns An array of strings representing valid pin names.
|
|
5423
5476
|
*/
|
|
5424
5477
|
GetInputPins(this: AudioDistortion): Array<unknown>;
|
|
5425
5478
|
/**
|
|
5479
|
+
* Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
|
|
5480
|
+
*
|
|
5426
5481
|
* - **ThreadSafety**: Unsafe
|
|
5427
5482
|
*
|
|
5428
5483
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioDistortion#GetOutputPins)
|
|
5429
5484
|
* @param this Distorts audio streams, making them sound fuzzier, grittier, and louder.
|
|
5485
|
+
* @returns An array of strings representing valid pin names.
|
|
5430
5486
|
*/
|
|
5431
5487
|
GetOutputPins(this: AudioDistortion): Array<unknown>;
|
|
5432
5488
|
/**
|
|
@@ -5505,21 +5561,28 @@ interface AudioEcho extends Instance {
|
|
|
5505
5561
|
*
|
|
5506
5562
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEcho#GetConnectedWires)
|
|
5507
5563
|
* @param this Overlays delayed copies of audio streams.
|
|
5508
|
-
* @param pin
|
|
5564
|
+
* @param pin An input or output pin on this instance
|
|
5565
|
+
* @returns An array of `Wires`
|
|
5509
5566
|
*/
|
|
5510
5567
|
GetConnectedWires(this: AudioEcho, pin: string): Array<Instance>;
|
|
5511
5568
|
/**
|
|
5569
|
+
* Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
|
|
5570
|
+
*
|
|
5512
5571
|
* - **ThreadSafety**: Unsafe
|
|
5513
5572
|
*
|
|
5514
5573
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEcho#GetInputPins)
|
|
5515
5574
|
* @param this Overlays delayed copies of audio streams.
|
|
5575
|
+
* @returns An array of strings representing valid pin names.
|
|
5516
5576
|
*/
|
|
5517
5577
|
GetInputPins(this: AudioEcho): Array<unknown>;
|
|
5518
5578
|
/**
|
|
5579
|
+
* Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
|
|
5580
|
+
*
|
|
5519
5581
|
* - **ThreadSafety**: Unsafe
|
|
5520
5582
|
*
|
|
5521
5583
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEcho#GetOutputPins)
|
|
5522
5584
|
* @param this Overlays delayed copies of audio streams.
|
|
5585
|
+
* @returns An array of strings representing valid pin names.
|
|
5523
5586
|
*/
|
|
5524
5587
|
GetOutputPins(this: AudioEcho): Array<unknown>;
|
|
5525
5588
|
/**
|
|
@@ -5600,7 +5663,8 @@ interface AudioEmitter extends Instance {
|
|
|
5600
5663
|
*
|
|
5601
5664
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#GetConnectedWires)
|
|
5602
5665
|
* @param this Emits audio streams into the world.
|
|
5603
|
-
* @param pin
|
|
5666
|
+
* @param pin An input or output pin on this instance
|
|
5667
|
+
* @returns An array of `Wires`
|
|
5604
5668
|
*/
|
|
5605
5669
|
GetConnectedWires(this: AudioEmitter, pin: string): Array<Instance>;
|
|
5606
5670
|
/**
|
|
@@ -5614,10 +5678,13 @@ interface AudioEmitter extends Instance {
|
|
|
5614
5678
|
*/
|
|
5615
5679
|
GetDistanceAttenuation(this: AudioEmitter): object;
|
|
5616
5680
|
/**
|
|
5681
|
+
* Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
|
|
5682
|
+
*
|
|
5617
5683
|
* - **ThreadSafety**: Unsafe
|
|
5618
5684
|
*
|
|
5619
5685
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#GetInputPins)
|
|
5620
5686
|
* @param this Emits audio streams into the world.
|
|
5687
|
+
* @returns An array of strings representing valid pin names.
|
|
5621
5688
|
*/
|
|
5622
5689
|
GetInputPins(this: AudioEmitter): Array<unknown>;
|
|
5623
5690
|
/**
|
|
@@ -5630,10 +5697,13 @@ interface AudioEmitter extends Instance {
|
|
|
5630
5697
|
*/
|
|
5631
5698
|
GetInteractingListeners(this: AudioEmitter): Array<Instance>;
|
|
5632
5699
|
/**
|
|
5700
|
+
* Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
|
|
5701
|
+
*
|
|
5633
5702
|
* - **ThreadSafety**: Unsafe
|
|
5634
5703
|
*
|
|
5635
5704
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#GetOutputPins)
|
|
5636
5705
|
* @param this Emits audio streams into the world.
|
|
5706
|
+
* @returns An array of strings representing valid pin names.
|
|
5637
5707
|
*/
|
|
5638
5708
|
GetOutputPins(this: AudioEmitter): Array<unknown>;
|
|
5639
5709
|
/**
|
|
@@ -5728,21 +5798,28 @@ interface AudioEqualizer extends Instance {
|
|
|
5728
5798
|
*
|
|
5729
5799
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEqualizer#GetConnectedWires)
|
|
5730
5800
|
* @param this Adjusts the frequency content of audio streams.
|
|
5731
|
-
* @param pin
|
|
5801
|
+
* @param pin An input or output pin on this instance
|
|
5802
|
+
* @returns An array of `Wires`
|
|
5732
5803
|
*/
|
|
5733
5804
|
GetConnectedWires(this: AudioEqualizer, pin: string): Array<Instance>;
|
|
5734
5805
|
/**
|
|
5806
|
+
* Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
|
|
5807
|
+
*
|
|
5735
5808
|
* - **ThreadSafety**: Unsafe
|
|
5736
5809
|
*
|
|
5737
5810
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEqualizer#GetInputPins)
|
|
5738
5811
|
* @param this Adjusts the frequency content of audio streams.
|
|
5812
|
+
* @returns An array of strings representing valid pin names.
|
|
5739
5813
|
*/
|
|
5740
5814
|
GetInputPins(this: AudioEqualizer): Array<unknown>;
|
|
5741
5815
|
/**
|
|
5816
|
+
* Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
|
|
5817
|
+
*
|
|
5742
5818
|
* - **ThreadSafety**: Unsafe
|
|
5743
5819
|
*
|
|
5744
5820
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEqualizer#GetOutputPins)
|
|
5745
5821
|
* @param this Adjusts the frequency content of audio streams.
|
|
5822
|
+
* @returns An array of strings representing valid pin names.
|
|
5746
5823
|
*/
|
|
5747
5824
|
GetOutputPins(this: AudioEqualizer): Array<unknown>;
|
|
5748
5825
|
/**
|
|
@@ -5791,21 +5868,28 @@ interface AudioFader extends Instance {
|
|
|
5791
5868
|
*
|
|
5792
5869
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioFader#GetConnectedWires)
|
|
5793
5870
|
* @param this Adjusts the volume of audio streams.
|
|
5794
|
-
* @param pin
|
|
5871
|
+
* @param pin An input or output pin on this instance
|
|
5872
|
+
* @returns An array of `Wires`
|
|
5795
5873
|
*/
|
|
5796
5874
|
GetConnectedWires(this: AudioFader, pin: string): Array<Instance>;
|
|
5797
5875
|
/**
|
|
5876
|
+
* Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
|
|
5877
|
+
*
|
|
5798
5878
|
* - **ThreadSafety**: Unsafe
|
|
5799
5879
|
*
|
|
5800
5880
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioFader#GetInputPins)
|
|
5801
5881
|
* @param this Adjusts the volume of audio streams.
|
|
5882
|
+
* @returns An array of strings representing valid pin names.
|
|
5802
5883
|
*/
|
|
5803
5884
|
GetInputPins(this: AudioFader): Array<unknown>;
|
|
5804
5885
|
/**
|
|
5886
|
+
* Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
|
|
5887
|
+
*
|
|
5805
5888
|
* - **ThreadSafety**: Unsafe
|
|
5806
5889
|
*
|
|
5807
5890
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioFader#GetOutputPins)
|
|
5808
5891
|
* @param this Adjusts the volume of audio streams.
|
|
5892
|
+
* @returns An array of strings representing valid pin names.
|
|
5809
5893
|
*/
|
|
5810
5894
|
GetOutputPins(this: AudioFader): Array<unknown>;
|
|
5811
5895
|
/**
|
|
@@ -5878,7 +5962,8 @@ interface AudioFilter extends Instance {
|
|
|
5878
5962
|
*
|
|
5879
5963
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioFilter#GetConnectedWires)
|
|
5880
5964
|
* @param this Adjusts the frequency content of audio streams.
|
|
5881
|
-
* @param pin
|
|
5965
|
+
* @param pin An input or output pin on this instance
|
|
5966
|
+
* @returns An array of `Wires`
|
|
5882
5967
|
*/
|
|
5883
5968
|
GetConnectedWires(this: AudioFilter, pin: string): Array<Instance>;
|
|
5884
5969
|
/**
|
|
@@ -5893,17 +5978,23 @@ interface AudioFilter extends Instance {
|
|
|
5893
5978
|
*/
|
|
5894
5979
|
GetGainAt(this: AudioFilter, frequency: number): number;
|
|
5895
5980
|
/**
|
|
5981
|
+
* Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
|
|
5982
|
+
*
|
|
5896
5983
|
* - **ThreadSafety**: Unsafe
|
|
5897
5984
|
*
|
|
5898
5985
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioFilter#GetInputPins)
|
|
5899
5986
|
* @param this Adjusts the frequency content of audio streams.
|
|
5987
|
+
* @returns An array of strings representing valid pin names.
|
|
5900
5988
|
*/
|
|
5901
5989
|
GetInputPins(this: AudioFilter): Array<unknown>;
|
|
5902
5990
|
/**
|
|
5991
|
+
* Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
|
|
5992
|
+
*
|
|
5903
5993
|
* - **ThreadSafety**: Unsafe
|
|
5904
5994
|
*
|
|
5905
5995
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioFilter#GetOutputPins)
|
|
5906
5996
|
* @param this Adjusts the frequency content of audio streams.
|
|
5997
|
+
* @returns An array of strings representing valid pin names.
|
|
5907
5998
|
*/
|
|
5908
5999
|
GetOutputPins(this: AudioFilter): Array<unknown>;
|
|
5909
6000
|
/**
|
|
@@ -5968,21 +6059,28 @@ interface AudioFlanger extends Instance {
|
|
|
5968
6059
|
*
|
|
5969
6060
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioFlanger#GetConnectedWires)
|
|
5970
6061
|
* @param this Imparts a whooshing or sweeping sound on audio streams.
|
|
5971
|
-
* @param pin
|
|
6062
|
+
* @param pin An input or output pin on this instance
|
|
6063
|
+
* @returns An array of `Wires`
|
|
5972
6064
|
*/
|
|
5973
6065
|
GetConnectedWires(this: AudioFlanger, pin: string): Array<Instance>;
|
|
5974
6066
|
/**
|
|
6067
|
+
* Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
|
|
6068
|
+
*
|
|
5975
6069
|
* - **ThreadSafety**: Unsafe
|
|
5976
6070
|
*
|
|
5977
6071
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioFlanger#GetInputPins)
|
|
5978
6072
|
* @param this Imparts a whooshing or sweeping sound on audio streams.
|
|
6073
|
+
* @returns An array of strings representing valid pin names.
|
|
5979
6074
|
*/
|
|
5980
6075
|
GetInputPins(this: AudioFlanger): Array<unknown>;
|
|
5981
6076
|
/**
|
|
6077
|
+
* Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
|
|
6078
|
+
*
|
|
5982
6079
|
* - **ThreadSafety**: Unsafe
|
|
5983
6080
|
*
|
|
5984
6081
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioFlanger#GetOutputPins)
|
|
5985
6082
|
* @param this Imparts a whooshing or sweeping sound on audio streams.
|
|
6083
|
+
* @returns An array of strings representing valid pin names.
|
|
5986
6084
|
*/
|
|
5987
6085
|
GetOutputPins(this: AudioFlanger): Array<unknown>;
|
|
5988
6086
|
/**
|
|
@@ -6046,28 +6144,39 @@ interface AudioGate extends Instance {
|
|
|
6046
6144
|
*/
|
|
6047
6145
|
Threshold: NumberRange;
|
|
6048
6146
|
/**
|
|
6147
|
+
* Returns an array of `Wires` that are connected to the specified pin.
|
|
6148
|
+
*
|
|
6049
6149
|
* - **ThreadSafety**: Unsafe
|
|
6050
6150
|
*
|
|
6051
6151
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#GetConnectedWires)
|
|
6052
6152
|
* @param this
|
|
6053
|
-
* @param pin
|
|
6153
|
+
* @param pin An input or output pin on this instance
|
|
6154
|
+
* @returns An array of `Wires`
|
|
6054
6155
|
*/
|
|
6055
6156
|
GetConnectedWires(this: AudioGate, pin: string): Array<Instance>;
|
|
6056
6157
|
/**
|
|
6158
|
+
* Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
|
|
6159
|
+
*
|
|
6057
6160
|
* - **ThreadSafety**: Unsafe
|
|
6058
6161
|
*
|
|
6059
6162
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#GetInputPins)
|
|
6060
6163
|
* @param this
|
|
6164
|
+
* @returns An array of strings representing valid pin names.
|
|
6061
6165
|
*/
|
|
6062
6166
|
GetInputPins(this: AudioGate): Array<unknown>;
|
|
6063
6167
|
/**
|
|
6168
|
+
* Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
|
|
6169
|
+
*
|
|
6064
6170
|
* - **ThreadSafety**: Unsafe
|
|
6065
6171
|
*
|
|
6066
6172
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#GetOutputPins)
|
|
6067
6173
|
* @param this
|
|
6174
|
+
* @returns An array of strings representing valid pin names.
|
|
6068
6175
|
*/
|
|
6069
6176
|
GetOutputPins(this: AudioGate): Array<unknown>;
|
|
6070
6177
|
/**
|
|
6178
|
+
* Fires when another instance is connected to or disconnected from the `AudioAnalyzer` via a `Wire`.
|
|
6179
|
+
*
|
|
6071
6180
|
* - **ThreadSafety**: Unsafe
|
|
6072
6181
|
*
|
|
6073
6182
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioGate#WiringChanged)
|
|
@@ -6119,21 +6228,28 @@ interface AudioLimiter extends Instance {
|
|
|
6119
6228
|
*
|
|
6120
6229
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioLimiter#GetConnectedWires)
|
|
6121
6230
|
* @param this Limits how loud audio streams are allowed to be.
|
|
6122
|
-
* @param pin
|
|
6231
|
+
* @param pin An input or output pin on this instance
|
|
6232
|
+
* @returns An array of `Wires`
|
|
6123
6233
|
*/
|
|
6124
6234
|
GetConnectedWires(this: AudioLimiter, pin: string): Array<Instance>;
|
|
6125
6235
|
/**
|
|
6236
|
+
* Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
|
|
6237
|
+
*
|
|
6126
6238
|
* - **ThreadSafety**: Unsafe
|
|
6127
6239
|
*
|
|
6128
6240
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioLimiter#GetInputPins)
|
|
6129
6241
|
* @param this Limits how loud audio streams are allowed to be.
|
|
6242
|
+
* @returns An array of strings representing valid pin names.
|
|
6130
6243
|
*/
|
|
6131
6244
|
GetInputPins(this: AudioLimiter): Array<unknown>;
|
|
6132
6245
|
/**
|
|
6246
|
+
* Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
|
|
6247
|
+
*
|
|
6133
6248
|
* - **ThreadSafety**: Unsafe
|
|
6134
6249
|
*
|
|
6135
6250
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioLimiter#GetOutputPins)
|
|
6136
6251
|
* @param this Limits how loud audio streams are allowed to be.
|
|
6252
|
+
* @returns An array of strings representing valid pin names.
|
|
6137
6253
|
*/
|
|
6138
6254
|
GetOutputPins(this: AudioLimiter): Array<unknown>;
|
|
6139
6255
|
/**
|
|
@@ -6214,7 +6330,8 @@ interface AudioListener extends Instance {
|
|
|
6214
6330
|
*
|
|
6215
6331
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioListener#GetConnectedWires)
|
|
6216
6332
|
* @param this Records an audio stream from its surrounding `AudioEmitters` in the 3D world.
|
|
6217
|
-
* @param pin
|
|
6333
|
+
* @param pin An input or output pin on this instance
|
|
6334
|
+
* @returns An array of `Wires`
|
|
6218
6335
|
*/
|
|
6219
6336
|
GetConnectedWires(this: AudioListener, pin: string): Array<Instance>;
|
|
6220
6337
|
/**
|
|
@@ -6228,10 +6345,13 @@ interface AudioListener extends Instance {
|
|
|
6228
6345
|
*/
|
|
6229
6346
|
GetDistanceAttenuation(this: AudioListener): object;
|
|
6230
6347
|
/**
|
|
6348
|
+
* Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
|
|
6349
|
+
*
|
|
6231
6350
|
* - **ThreadSafety**: Unsafe
|
|
6232
6351
|
*
|
|
6233
6352
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioListener#GetInputPins)
|
|
6234
6353
|
* @param this Records an audio stream from its surrounding `AudioEmitters` in the 3D world.
|
|
6354
|
+
* @returns An array of strings representing valid pin names.
|
|
6235
6355
|
*/
|
|
6236
6356
|
GetInputPins(this: AudioListener): Array<unknown>;
|
|
6237
6357
|
/**
|
|
@@ -6244,10 +6364,13 @@ interface AudioListener extends Instance {
|
|
|
6244
6364
|
*/
|
|
6245
6365
|
GetInteractingEmitters(this: AudioListener): Array<Instance>;
|
|
6246
6366
|
/**
|
|
6367
|
+
* Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
|
|
6368
|
+
*
|
|
6247
6369
|
* - **ThreadSafety**: Unsafe
|
|
6248
6370
|
*
|
|
6249
6371
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioListener#GetOutputPins)
|
|
6250
6372
|
* @param this Records an audio stream from its surrounding `AudioEmitters` in the 3D world.
|
|
6373
|
+
* @returns An array of strings representing valid pin names.
|
|
6251
6374
|
*/
|
|
6252
6375
|
GetOutputPins(this: AudioListener): Array<unknown>;
|
|
6253
6376
|
/**
|
|
@@ -6324,21 +6447,28 @@ interface AudioPitchShifter extends Instance {
|
|
|
6324
6447
|
*
|
|
6325
6448
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPitchShifter#GetConnectedWires)
|
|
6326
6449
|
* @param this Adjusts the perceived pitch of audio streams.
|
|
6327
|
-
* @param pin
|
|
6450
|
+
* @param pin An input or output pin on this instance
|
|
6451
|
+
* @returns An array of `Wires`
|
|
6328
6452
|
*/
|
|
6329
6453
|
GetConnectedWires(this: AudioPitchShifter, pin: string): Array<Instance>;
|
|
6330
6454
|
/**
|
|
6455
|
+
* Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
|
|
6456
|
+
*
|
|
6331
6457
|
* - **ThreadSafety**: Unsafe
|
|
6332
6458
|
*
|
|
6333
6459
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPitchShifter#GetInputPins)
|
|
6334
6460
|
* @param this Adjusts the perceived pitch of audio streams.
|
|
6461
|
+
* @returns An array of strings representing valid pin names.
|
|
6335
6462
|
*/
|
|
6336
6463
|
GetInputPins(this: AudioPitchShifter): Array<unknown>;
|
|
6337
6464
|
/**
|
|
6465
|
+
* Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
|
|
6466
|
+
*
|
|
6338
6467
|
* - **ThreadSafety**: Unsafe
|
|
6339
6468
|
*
|
|
6340
6469
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPitchShifter#GetOutputPins)
|
|
6341
6470
|
* @param this Adjusts the perceived pitch of audio streams.
|
|
6471
|
+
* @returns An array of strings representing valid pin names.
|
|
6342
6472
|
*/
|
|
6343
6473
|
GetOutputPins(this: AudioPitchShifter): Array<unknown>;
|
|
6344
6474
|
/**
|
|
@@ -6387,6 +6517,7 @@ interface AudioPlayer extends Instance {
|
|
|
6387
6517
|
AssetId: string;
|
|
6388
6518
|
/**
|
|
6389
6519
|
* - **ThreadSafety**: ReadSafe
|
|
6520
|
+
* - **Tags**: Hidden
|
|
6390
6521
|
*
|
|
6391
6522
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#AudioContent)
|
|
6392
6523
|
*/
|
|
@@ -6488,21 +6619,28 @@ interface AudioPlayer extends Instance {
|
|
|
6488
6619
|
*
|
|
6489
6620
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#GetConnectedWires)
|
|
6490
6621
|
* @param this Used to play audio assets.
|
|
6491
|
-
* @param pin
|
|
6622
|
+
* @param pin An input or output pin on this instance
|
|
6623
|
+
* @returns An array of `Wires`
|
|
6492
6624
|
*/
|
|
6493
6625
|
GetConnectedWires(this: AudioPlayer, pin: string): Array<Instance>;
|
|
6494
6626
|
/**
|
|
6627
|
+
* Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
|
|
6628
|
+
*
|
|
6495
6629
|
* - **ThreadSafety**: Unsafe
|
|
6496
6630
|
*
|
|
6497
6631
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#GetInputPins)
|
|
6498
6632
|
* @param this Used to play audio assets.
|
|
6633
|
+
* @returns An array of strings representing valid pin names.
|
|
6499
6634
|
*/
|
|
6500
6635
|
GetInputPins(this: AudioPlayer): Array<unknown>;
|
|
6501
6636
|
/**
|
|
6637
|
+
* Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
|
|
6638
|
+
*
|
|
6502
6639
|
* - **ThreadSafety**: Unsafe
|
|
6503
6640
|
*
|
|
6504
6641
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#GetOutputPins)
|
|
6505
6642
|
* @param this Used to play audio assets.
|
|
6643
|
+
* @returns An array of strings representing valid pin names.
|
|
6506
6644
|
*/
|
|
6507
6645
|
GetOutputPins(this: AudioPlayer): Array<unknown>;
|
|
6508
6646
|
/**
|
|
@@ -6595,25 +6733,34 @@ interface AudioRecorder extends Instance {
|
|
|
6595
6733
|
*/
|
|
6596
6734
|
Clear(this: AudioRecorder): void;
|
|
6597
6735
|
/**
|
|
6736
|
+
* Returns an array of `Wires` that are connected to the specified pin.
|
|
6737
|
+
*
|
|
6598
6738
|
* - **ThreadSafety**: Unsafe
|
|
6599
6739
|
*
|
|
6600
6740
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioRecorder#GetConnectedWires)
|
|
6601
6741
|
* @param this Records audio streams in-experience.
|
|
6602
|
-
* @param pin
|
|
6742
|
+
* @param pin An input or output pin on this instance
|
|
6743
|
+
* @returns An array of `Wires`
|
|
6603
6744
|
*/
|
|
6604
6745
|
GetConnectedWires(this: AudioRecorder, pin: string): Array<Instance>;
|
|
6605
6746
|
/**
|
|
6747
|
+
* Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
|
|
6748
|
+
*
|
|
6606
6749
|
* - **ThreadSafety**: Unsafe
|
|
6607
6750
|
*
|
|
6608
6751
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioRecorder#GetInputPins)
|
|
6609
6752
|
* @param this Records audio streams in-experience.
|
|
6753
|
+
* @returns An array of strings representing valid pin names.
|
|
6610
6754
|
*/
|
|
6611
6755
|
GetInputPins(this: AudioRecorder): Array<unknown>;
|
|
6612
6756
|
/**
|
|
6757
|
+
* Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
|
|
6758
|
+
*
|
|
6613
6759
|
* - **ThreadSafety**: Unsafe
|
|
6614
6760
|
*
|
|
6615
6761
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioRecorder#GetOutputPins)
|
|
6616
6762
|
* @param this Records audio streams in-experience.
|
|
6763
|
+
* @returns An array of strings representing valid pin names.
|
|
6617
6764
|
*/
|
|
6618
6765
|
GetOutputPins(this: AudioRecorder): Array<unknown>;
|
|
6619
6766
|
/**
|
|
@@ -6655,6 +6802,8 @@ interface AudioRecorder extends Instance {
|
|
|
6655
6802
|
*/
|
|
6656
6803
|
RecordAsync(this: AudioRecorder): void;
|
|
6657
6804
|
/**
|
|
6805
|
+
* Fires when another instance is connected to or disconnected from the `AudioAnalyzer` via a `Wire`.
|
|
6806
|
+
*
|
|
6658
6807
|
* - **ThreadSafety**: Unsafe
|
|
6659
6808
|
*
|
|
6660
6809
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioRecorder#WiringChanged)
|
|
@@ -6786,21 +6935,28 @@ interface AudioReverb extends Instance {
|
|
|
6786
6935
|
*
|
|
6787
6936
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioReverb#GetConnectedWires)
|
|
6788
6937
|
* @param this Reverberates audio streams.
|
|
6789
|
-
* @param pin
|
|
6938
|
+
* @param pin An input or output pin on this instance
|
|
6939
|
+
* @returns An array of `Wires`
|
|
6790
6940
|
*/
|
|
6791
6941
|
GetConnectedWires(this: AudioReverb, pin: string): Array<Instance>;
|
|
6792
6942
|
/**
|
|
6943
|
+
* Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
|
|
6944
|
+
*
|
|
6793
6945
|
* - **ThreadSafety**: Unsafe
|
|
6794
6946
|
*
|
|
6795
6947
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioReverb#GetInputPins)
|
|
6796
6948
|
* @param this Reverberates audio streams.
|
|
6949
|
+
* @returns An array of strings representing valid pin names.
|
|
6797
6950
|
*/
|
|
6798
6951
|
GetInputPins(this: AudioReverb): Array<unknown>;
|
|
6799
6952
|
/**
|
|
6953
|
+
* Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
|
|
6954
|
+
*
|
|
6800
6955
|
* - **ThreadSafety**: Unsafe
|
|
6801
6956
|
*
|
|
6802
6957
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioReverb#GetOutputPins)
|
|
6803
6958
|
* @param this Reverberates audio streams.
|
|
6959
|
+
* @returns An array of strings representing valid pin names.
|
|
6804
6960
|
*/
|
|
6805
6961
|
GetOutputPins(this: AudioReverb): Array<unknown>;
|
|
6806
6962
|
/**
|
|
@@ -6950,7 +7106,8 @@ interface AudioSpeechToText extends Instance {
|
|
|
6950
7106
|
*
|
|
6951
7107
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioSpeechToText#GetConnectedWires)
|
|
6952
7108
|
* @param this Converts spoken audio into text.
|
|
6953
|
-
* @param pin
|
|
7109
|
+
* @param pin An input or output pin on this instance
|
|
7110
|
+
* @returns An array of `Wires`
|
|
6954
7111
|
*/
|
|
6955
7112
|
GetConnectedWires(this: AudioSpeechToText, pin: string): Array<Instance>;
|
|
6956
7113
|
/**
|
|
@@ -7073,7 +7230,8 @@ interface AudioTextToSpeech extends Instance {
|
|
|
7073
7230
|
*
|
|
7074
7231
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTextToSpeech#GetConnectedWires)
|
|
7075
7232
|
* @param this Plays text as speech audio.
|
|
7076
|
-
* @param pin
|
|
7233
|
+
* @param pin An input or output pin on this instance
|
|
7234
|
+
* @returns An array of `Wires`
|
|
7077
7235
|
*/
|
|
7078
7236
|
GetConnectedWires(this: AudioTextToSpeech, pin: string): Array<Instance>;
|
|
7079
7237
|
/**
|
|
@@ -7217,28 +7375,39 @@ interface AudioTremolo extends Instance {
|
|
|
7217
7375
|
*/
|
|
7218
7376
|
Square: number;
|
|
7219
7377
|
/**
|
|
7378
|
+
* Returns an array of `Wires` that are connected to the specified pin.
|
|
7379
|
+
*
|
|
7220
7380
|
* - **ThreadSafety**: Unsafe
|
|
7221
7381
|
*
|
|
7222
7382
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#GetConnectedWires)
|
|
7223
7383
|
* @param this Creates a trembling effect on a sound by varying the volume of the sound up and down.
|
|
7224
|
-
* @param pin
|
|
7384
|
+
* @param pin An input or output pin on this instance
|
|
7385
|
+
* @returns An array of `Wires`
|
|
7225
7386
|
*/
|
|
7226
7387
|
GetConnectedWires(this: AudioTremolo, pin: string): Array<Instance>;
|
|
7227
7388
|
/**
|
|
7389
|
+
* Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
|
|
7390
|
+
*
|
|
7228
7391
|
* - **ThreadSafety**: Unsafe
|
|
7229
7392
|
*
|
|
7230
7393
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#GetInputPins)
|
|
7231
7394
|
* @param this Creates a trembling effect on a sound by varying the volume of the sound up and down.
|
|
7395
|
+
* @returns An array of strings representing valid pin names.
|
|
7232
7396
|
*/
|
|
7233
7397
|
GetInputPins(this: AudioTremolo): Array<unknown>;
|
|
7234
7398
|
/**
|
|
7399
|
+
* Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
|
|
7400
|
+
*
|
|
7235
7401
|
* - **ThreadSafety**: Unsafe
|
|
7236
7402
|
*
|
|
7237
7403
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#GetOutputPins)
|
|
7238
7404
|
* @param this Creates a trembling effect on a sound by varying the volume of the sound up and down.
|
|
7405
|
+
* @returns An array of strings representing valid pin names.
|
|
7239
7406
|
*/
|
|
7240
7407
|
GetOutputPins(this: AudioTremolo): Array<unknown>;
|
|
7241
7408
|
/**
|
|
7409
|
+
* Fires when another instance is connected to or disconnected from the `AudioAnalyzer` via a `Wire`.
|
|
7410
|
+
*
|
|
7242
7411
|
* - **ThreadSafety**: Unsafe
|
|
7243
7412
|
*
|
|
7244
7413
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#WiringChanged)
|
|
@@ -7598,7 +7767,7 @@ interface AvatarCreationService extends Instance {
|
|
|
7598
7767
|
*/
|
|
7599
7768
|
GetValidationRules(this: AvatarCreationService): object;
|
|
7600
7769
|
/**
|
|
7601
|
-
* Automatically sets up a custom `Model`
|
|
7770
|
+
* Automatically sets up a custom `Model` and/or avatar accessories.
|
|
7602
7771
|
*
|
|
7603
7772
|
* - **ThreadSafety**: Unsafe
|
|
7604
7773
|
* - **Tags**: Yields
|
|
@@ -7606,7 +7775,7 @@ interface AvatarCreationService extends Instance {
|
|
|
7606
7775
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#AutoSetupAvatarAsync)
|
|
7607
7776
|
* @param this A service to support developer avatar creators.
|
|
7608
7777
|
* @param player The `Player` that the avatar is being set up for.
|
|
7609
|
-
* @param
|
|
7778
|
+
* @param autoSetupParams A table containing the arguments. Type: `type AutoSetupAccessory = { AccessoryType: Enum.AccessoryType, IsLayered: bool, Instance: Model, } type AutoSetupParams = { Body: Model?, Accessories: {AutoSetupAccessory}, }`
|
|
7610
7779
|
* @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 }) -> ()`
|
|
7611
7780
|
* @returns A unique identifier for the generated avatar.
|
|
7612
7781
|
*/
|
|
@@ -7987,10 +8156,7 @@ interface AvatarEditorService extends Instance {
|
|
|
7987
8156
|
* @param this A service to support developer Avatar Editors.
|
|
7988
8157
|
* @param itemIds The list of item ids to get details of.
|
|
7989
8158
|
* @param itemType The type of the item ids provided.
|
|
7990
|
-
* @returns Returns an array of item details
|
|
7991
|
-
* ```lua
|
|
7992
|
-
* { "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 }
|
|
7993
|
-
* ``` .
|
|
8159
|
+
* @returns Returns an array of item details. See `AvatarEditorService:GetBatchItemDetailsAsync()` for the response format.
|
|
7994
8160
|
*
|
|
7995
8161
|
* @deprecated GetBatchItemDetailsAsync
|
|
7996
8162
|
*/
|
|
@@ -8007,10 +8173,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8007
8173
|
* @param this A service to support developer Avatar Editors.
|
|
8008
8174
|
* @param itemIds The list of item ids to get details of.
|
|
8009
8175
|
* @param itemType The type of the item ids provided.
|
|
8010
|
-
* @returns Returns an array of item details
|
|
8011
|
-
* ```lua
|
|
8012
|
-
* { "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 }
|
|
8013
|
-
* ``` .
|
|
8176
|
+
* @returns Returns an array of item details.
|
|
8014
8177
|
*/
|
|
8015
8178
|
GetBatchItemDetailsAsync(this: AvatarEditorService, itemIds: Array<unknown>, itemType: CastsToEnum<Enum.AvatarItemType>): Array<unknown>;
|
|
8016
8179
|
/**
|
|
@@ -8110,7 +8273,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8110
8273
|
* @param this A service to support developer Avatar Editors.
|
|
8111
8274
|
* @param itemId The ID of the item whose details are being retrieved.
|
|
8112
8275
|
* @param itemType An enum value indicating the type of item whose details are being retrieved.
|
|
8113
|
-
* @returns A table containing the item info for the retrieved item.
|
|
8276
|
+
* @returns A table containing the item info for the retrieved item.
|
|
8114
8277
|
*/
|
|
8115
8278
|
GetItemDetailsAsync(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType>): object;
|
|
8116
8279
|
/**
|
|
@@ -8251,6 +8414,7 @@ interface AvatarEditorService extends Instance {
|
|
|
8251
8414
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#SearchCatalogAsync)
|
|
8252
8415
|
* @param this A service to support developer Avatar Editors.
|
|
8253
8416
|
* @param searchParameters An object containing the parameters used for the search.
|
|
8417
|
+
* @returns A `CatalogPages` object containing the search results.
|
|
8254
8418
|
*/
|
|
8255
8419
|
SearchCatalogAsync(this: AvatarEditorService, searchParameters: CatalogSearchParams): CatalogPages;
|
|
8256
8420
|
/**
|
|
@@ -10390,6 +10554,8 @@ interface BodyPartDescription extends Instance {
|
|
|
10390
10554
|
*/
|
|
10391
10555
|
Color: Color3;
|
|
10392
10556
|
/**
|
|
10557
|
+
* Specifies the head shape identifier to apply to a Dynamic Head when this `BodyPartDescription` is applied.
|
|
10558
|
+
*
|
|
10393
10559
|
* - **ThreadSafety**: ReadSafe
|
|
10394
10560
|
*
|
|
10395
10561
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BodyPartDescription#HeadShape)
|
|
@@ -10603,6 +10769,7 @@ interface CaptureService extends Instance {
|
|
|
10603
10769
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#ReadCapturesFromGalleryAsync)
|
|
10604
10770
|
* @param this A service which provides control over screenshot and video capture features.
|
|
10605
10771
|
* @param captureTypeFilters An array of `CaptureType`.
|
|
10772
|
+
* @param readFromAllEligibleExperiences A boolean; default is `false`.
|
|
10606
10773
|
* @returns Tuple of (result: `ReadCapturesFromGalleryResult`, capturesPages: `CapturesPages`)
|
|
10607
10774
|
*/
|
|
10608
10775
|
ReadCapturesFromGalleryAsync(this: CaptureService, captureTypeFilters?: Array<unknown>, readFromAllEligibleExperiences?: boolean): unknown;
|
|
@@ -10821,6 +10988,12 @@ interface CharacterMesh extends CharacterAppearance {
|
|
|
10821
10988
|
* @deprecated
|
|
10822
10989
|
*/
|
|
10823
10990
|
readonly _nominal_CharacterMesh: unique symbol;
|
|
10991
|
+
/**
|
|
10992
|
+
* - **ThreadSafety**: ReadSafe
|
|
10993
|
+
*
|
|
10994
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CharacterMesh#BaseTextureContent)
|
|
10995
|
+
*/
|
|
10996
|
+
BaseTextureContent: Content;
|
|
10824
10997
|
/**
|
|
10825
10998
|
* The texture of a CharacterMesh. It can be overridden by Shirts, Pants, T-Shirts, and the `CharacterMesh.OverlayTextureId` property.
|
|
10826
10999
|
*
|
|
@@ -10837,6 +11010,12 @@ interface CharacterMesh extends CharacterAppearance {
|
|
|
10837
11010
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CharacterMesh#BodyPart)
|
|
10838
11011
|
*/
|
|
10839
11012
|
BodyPart: Enum.BodyPart;
|
|
11013
|
+
/**
|
|
11014
|
+
* - **ThreadSafety**: ReadSafe
|
|
11015
|
+
*
|
|
11016
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CharacterMesh#MeshContent)
|
|
11017
|
+
*/
|
|
11018
|
+
MeshContent: Content;
|
|
10840
11019
|
/**
|
|
10841
11020
|
* Used to load a mesh file, and apply it to the given BodyPart.
|
|
10842
11021
|
*
|
|
@@ -10845,6 +11024,12 @@ interface CharacterMesh extends CharacterAppearance {
|
|
|
10845
11024
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CharacterMesh#MeshId)
|
|
10846
11025
|
*/
|
|
10847
11026
|
MeshId: number;
|
|
11027
|
+
/**
|
|
11028
|
+
* - **ThreadSafety**: ReadSafe
|
|
11029
|
+
*
|
|
11030
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CharacterMesh#OverlayTextureContent)
|
|
11031
|
+
*/
|
|
11032
|
+
OverlayTextureContent: Content;
|
|
10848
11033
|
/**
|
|
10849
11034
|
* The assetId of the overlay texture. The overlay covers Shirts, Pants, T-Shirts, and the `CharacterMesh.BaseTextureId`.
|
|
10850
11035
|
*
|
|
@@ -15256,6 +15441,12 @@ interface DataStoreService extends Instance {
|
|
|
15256
15441
|
* @param requestType
|
|
15257
15442
|
*/
|
|
15258
15443
|
GetRequestBudgetForRequestType(this: DataStoreService, requestType: CastsToEnum<Enum.DataStoreRequestType>): number;
|
|
15444
|
+
/**
|
|
15445
|
+
* - **ThreadSafety**: Unsafe
|
|
15446
|
+
*
|
|
15447
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataStoreService#SetRateLimitForRequestType)
|
|
15448
|
+
*/
|
|
15449
|
+
SetRateLimitForRequestType(this: DataStoreService, requestType: CastsToEnum<Enum.DataStoreRequestType>, baseLimit: number, perPlayerLimit: number): void;
|
|
15259
15450
|
/**
|
|
15260
15451
|
* Returns a `DataStoreListingPages` object for enumerating through all of the experience's data stores.
|
|
15261
15452
|
*
|
|
@@ -17040,20 +17231,29 @@ interface GenerationService extends Instance {
|
|
|
17040
17231
|
* @param this Service that allows developers to generate 3D objects from text prompts.
|
|
17041
17232
|
* @param inputs A dictionary containing the mesh generation prompts. Currently, the only supported key is the `Prompt` (string) that describes the mesh to generate.
|
|
17042
17233
|
* @param player The `Player` requesting the generation.
|
|
17043
|
-
* @param options A dictionary for additional generation options to influence the result. The
|
|
17234
|
+
* @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.
|
|
17044
17235
|
* @param intermediateResultCallback A callback function triggered with intermediate generation results. Useful for retrieving early mesh versions before textures are applied.
|
|
17045
17236
|
* @returns A tuple of the generation ID (a unique ID returned for each invocation of `GenerateMeshAsync()`) and context ID (not currently used).
|
|
17046
17237
|
*/
|
|
17047
17238
|
GenerateMeshAsync(this: GenerationService, inputs: object, player: Player, options: object, intermediateResultCallback?: Callback): unknown;
|
|
17048
17239
|
/**
|
|
17240
|
+
* Enables generation of multi-mesh geometries according to provided `inputs` and a `schema`.
|
|
17241
|
+
*
|
|
17049
17242
|
* - **ThreadSafety**: Unsafe
|
|
17050
17243
|
* - **Tags**: Yields
|
|
17051
17244
|
*
|
|
17052
17245
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#GenerateModelAsync)
|
|
17053
17246
|
* @param this Service that allows developers to generate 3D objects from text prompts.
|
|
17054
|
-
* @param inputs
|
|
17055
|
-
*
|
|
17056
|
-
*
|
|
17247
|
+
* @param inputs A table representing conditioning inputs with the following keys: - `TextPrompt` — String description of the object to generate.
|
|
17248
|
+
* - `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.
|
|
17249
|
+
* - `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.
|
|
17250
|
+
* - `GenerateTextures` — `true` (default) textures the resulting generation, while `false` will not generate textures.
|
|
17251
|
+
*
|
|
17252
|
+
*
|
|
17253
|
+
* @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.
|
|
17254
|
+
* @param options Currently not used; reserved for future customization options.
|
|
17255
|
+
* @returns Tuple with the following elements: - A standard `Model` container instance that is compliant with the specified `schema`.
|
|
17256
|
+
* - A table containing a UUID and other metadata about the generation.
|
|
17057
17257
|
*/
|
|
17058
17258
|
GenerateModelAsync(this: GenerationService, inputs: object, schema: object, options?: object): unknown;
|
|
17059
17259
|
/**
|
|
@@ -19738,21 +19938,28 @@ interface VideoDisplay extends GuiObject {
|
|
|
19738
19938
|
*
|
|
19739
19939
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#GetConnectedWires)
|
|
19740
19940
|
* @param this A GUI object that displays video content from a connected `VideoPlayer`.
|
|
19741
|
-
* @param pin
|
|
19941
|
+
* @param pin An input or output pin on this instance
|
|
19942
|
+
* @returns An array of `Wires`
|
|
19742
19943
|
*/
|
|
19743
19944
|
GetConnectedWires(this: VideoDisplay, pin: string): Array<Instance>;
|
|
19744
19945
|
/**
|
|
19946
|
+
* Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
|
|
19947
|
+
*
|
|
19745
19948
|
* - **ThreadSafety**: Unsafe
|
|
19746
19949
|
*
|
|
19747
19950
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#GetInputPins)
|
|
19748
19951
|
* @param this A GUI object that displays video content from a connected `VideoPlayer`.
|
|
19952
|
+
* @returns An array of strings representing valid pin names.
|
|
19749
19953
|
*/
|
|
19750
19954
|
GetInputPins(this: VideoDisplay): Array<unknown>;
|
|
19751
19955
|
/**
|
|
19956
|
+
* Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
|
|
19957
|
+
*
|
|
19752
19958
|
* - **ThreadSafety**: Unsafe
|
|
19753
19959
|
*
|
|
19754
19960
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoDisplay#GetOutputPins)
|
|
19755
19961
|
* @param this A GUI object that displays video content from a connected `VideoPlayer`.
|
|
19962
|
+
* @returns An array of strings representing valid pin names.
|
|
19756
19963
|
*/
|
|
19757
19964
|
GetOutputPins(this: VideoDisplay): Array<unknown>;
|
|
19758
19965
|
/**
|
|
@@ -23908,6 +24115,12 @@ interface HumanoidDescription extends Instance {
|
|
|
23908
24115
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#ShouldersAccessory)
|
|
23909
24116
|
*/
|
|
23910
24117
|
ShouldersAccessory: string;
|
|
24118
|
+
/**
|
|
24119
|
+
* - **ThreadSafety**: ReadSafe
|
|
24120
|
+
*
|
|
24121
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#StaticFacialAnimation)
|
|
24122
|
+
*/
|
|
24123
|
+
StaticFacialAnimation: boolean;
|
|
23911
24124
|
/**
|
|
23912
24125
|
* When this description is `applied` to a `Humanoid`, this determines the `Animation.AnimationId` to play when its `state` is `Swimming`.
|
|
23913
24126
|
*
|
|
@@ -25165,6 +25378,12 @@ interface InputBinding extends Instance {
|
|
|
25165
25378
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Backward)
|
|
25166
25379
|
*/
|
|
25167
25380
|
Backward: Enum.KeyCode;
|
|
25381
|
+
/**
|
|
25382
|
+
* - **ThreadSafety**: ReadSafe
|
|
25383
|
+
*
|
|
25384
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#ClampMagnitudeToOne)
|
|
25385
|
+
*/
|
|
25386
|
+
ClampMagnitudeToOne: boolean;
|
|
25168
25387
|
/**
|
|
25169
25388
|
* Specifies an alternate `KeyCode` for dispatching directionally "down" inputs to the parent `InputAction`.
|
|
25170
25389
|
*
|
|
@@ -25212,6 +25431,8 @@ interface InputBinding extends Instance {
|
|
|
25212
25431
|
*/
|
|
25213
25432
|
PressedThreshold: number;
|
|
25214
25433
|
/**
|
|
25434
|
+
* Specifies a primary `KeyCode` that must be pressed for the binding to activate.
|
|
25435
|
+
*
|
|
25215
25436
|
* - **ThreadSafety**: ReadSafe
|
|
25216
25437
|
*
|
|
25217
25438
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#PrimaryModifier)
|
|
@@ -25250,6 +25471,8 @@ interface InputBinding extends Instance {
|
|
|
25250
25471
|
*/
|
|
25251
25472
|
Scale: number;
|
|
25252
25473
|
/**
|
|
25474
|
+
* Specifies a secondary `KeyCode` that must be pressed for the binding to activate.
|
|
25475
|
+
*
|
|
25253
25476
|
* - **ThreadSafety**: ReadSafe
|
|
25254
25477
|
*
|
|
25255
25478
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#SecondaryModifier)
|
|
@@ -34310,6 +34533,21 @@ interface PlatformFriendsService extends Instance {
|
|
|
34310
34533
|
*/
|
|
34311
34534
|
readonly _nominal_PlatformFriendsService: unique symbol;
|
|
34312
34535
|
}
|
|
34536
|
+
/**
|
|
34537
|
+
* - **Tags**: NotCreatable, Service
|
|
34538
|
+
*
|
|
34539
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PlatformLibraries)
|
|
34540
|
+
*/
|
|
34541
|
+
interface PlatformLibraries extends Instance {
|
|
34542
|
+
/**
|
|
34543
|
+
* **DO NOT USE!**
|
|
34544
|
+
*
|
|
34545
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
34546
|
+
* @hidden
|
|
34547
|
+
* @deprecated
|
|
34548
|
+
*/
|
|
34549
|
+
readonly _nominal_PlatformLibraries: unique symbol;
|
|
34550
|
+
}
|
|
34313
34551
|
/**
|
|
34314
34552
|
* An object that represents a presently connected client to the experience.
|
|
34315
34553
|
*
|
|
@@ -34858,7 +35096,7 @@ interface Player extends Instance {
|
|
|
34858
35096
|
*/
|
|
34859
35097
|
SaveString(this: Player, key: string, value: string): void;
|
|
34860
35098
|
/**
|
|
34861
|
-
* **Deprecated:** This method has been superseded by `
|
|
35099
|
+
* **Deprecated:** This method has been superseded by `GetFriendsOnlineAsync()`.
|
|
34862
35100
|
*
|
|
34863
35101
|
* Returns a dictionary of online connections. Returns the product information of an asset using its asset ID.
|
|
34864
35102
|
*
|
|
@@ -36931,17 +37169,29 @@ interface ReflectionService extends Instance {
|
|
|
36931
37169
|
*/
|
|
36932
37170
|
GetClasses(this: ReflectionService, filter?: object): Array<unknown>;
|
|
36933
37171
|
/**
|
|
37172
|
+
* Returns a list of events for a given class with filters applied.
|
|
37173
|
+
*
|
|
36934
37174
|
* - **ThreadSafety**: Unsafe
|
|
36935
37175
|
* - **Tags**: CustomLuaState
|
|
36936
37176
|
*
|
|
36937
37177
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ReflectionService#GetEventsOfClass)
|
|
37178
|
+
* @param this
|
|
37179
|
+
* @param className The name of the class for which you wish to retrieve events.
|
|
37180
|
+
* @param filter An optional filter to restrict or expand the set of events that this method can return and change the method's behavior.
|
|
37181
|
+
* @returns A list of `ReflectedEvent` dictionaries with reflection information for each event of the class that matches the filter criteria.
|
|
36938
37182
|
*/
|
|
36939
37183
|
GetEventsOfClass(this: ReflectionService, className: string, filter?: object): Array<unknown>;
|
|
36940
37184
|
/**
|
|
37185
|
+
* Returns a list of methods for a given class with filters applied.
|
|
37186
|
+
*
|
|
36941
37187
|
* - **ThreadSafety**: Unsafe
|
|
36942
37188
|
* - **Tags**: CustomLuaState
|
|
36943
37189
|
*
|
|
36944
37190
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ReflectionService#GetMethodsOfClass)
|
|
37191
|
+
* @param this
|
|
37192
|
+
* @param className The name of the class for which you wish to retrieve methods.
|
|
37193
|
+
* @param filter An optional filter to restrict or expand the set of methods that this method can return and change the method's behavior.
|
|
37194
|
+
* @returns A list of `ReflectedMethod` dictionaries with reflection information for each method of the class that matches the filter criteria.
|
|
36945
37195
|
*/
|
|
36946
37196
|
GetMethodsOfClass(this: ReflectionService, className: string, filter?: object): Array<unknown>;
|
|
36947
37197
|
/**
|
|
@@ -37204,6 +37454,21 @@ interface RobloxServerStorage extends Instance {
|
|
|
37204
37454
|
*/
|
|
37205
37455
|
readonly _nominal_RobloxServerStorage: unique symbol;
|
|
37206
37456
|
}
|
|
37457
|
+
/**
|
|
37458
|
+
* - **Tags**: NotCreatable
|
|
37459
|
+
*
|
|
37460
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RolloutValidation)
|
|
37461
|
+
*/
|
|
37462
|
+
interface RolloutValidation extends Instance {
|
|
37463
|
+
/**
|
|
37464
|
+
* **DO NOT USE!**
|
|
37465
|
+
*
|
|
37466
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
37467
|
+
* @hidden
|
|
37468
|
+
* @deprecated
|
|
37469
|
+
*/
|
|
37470
|
+
readonly _nominal_RolloutValidation: unique symbol;
|
|
37471
|
+
}
|
|
37207
37472
|
/**
|
|
37208
37473
|
* - **Tags**: NotCreatable, Service
|
|
37209
37474
|
*
|
|
@@ -39306,6 +39571,13 @@ interface Sound extends Instance {
|
|
|
39306
39571
|
/**
|
|
39307
39572
|
* - **ThreadSafety**: ReadSafe
|
|
39308
39573
|
*
|
|
39574
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sound#AcousticSimulationEnabled)
|
|
39575
|
+
*/
|
|
39576
|
+
AcousticSimulationEnabled: boolean;
|
|
39577
|
+
/**
|
|
39578
|
+
* - **ThreadSafety**: ReadSafe
|
|
39579
|
+
* - **Tags**: Hidden
|
|
39580
|
+
*
|
|
39309
39581
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sound#AudioContent)
|
|
39310
39582
|
*/
|
|
39311
39583
|
AudioContent: Content;
|
|
@@ -40998,24 +41270,6 @@ interface StudioCameraService extends Instance {
|
|
|
40998
41270
|
* @deprecated
|
|
40999
41271
|
*/
|
|
41000
41272
|
readonly _nominal_StudioCameraService: unique symbol;
|
|
41001
|
-
/**
|
|
41002
|
-
* - **ThreadSafety**: ReadSafe
|
|
41003
|
-
*
|
|
41004
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioCameraService#LockCameraSpeed)
|
|
41005
|
-
*/
|
|
41006
|
-
LockCameraSpeed: boolean;
|
|
41007
|
-
/**
|
|
41008
|
-
* - **ThreadSafety**: ReadSafe
|
|
41009
|
-
*
|
|
41010
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioCameraService#LoggingEnabled)
|
|
41011
|
-
*/
|
|
41012
|
-
LoggingEnabled: boolean;
|
|
41013
|
-
/**
|
|
41014
|
-
* - **ThreadSafety**: Unsafe
|
|
41015
|
-
*
|
|
41016
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioCameraService#ShowCameraSpeed)
|
|
41017
|
-
*/
|
|
41018
|
-
readonly ShowCameraSpeed: RBXScriptSignal<(speed: number) => void>;
|
|
41019
41273
|
}
|
|
41020
41274
|
/**
|
|
41021
41275
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
@@ -41286,6 +41540,12 @@ interface StyleRule extends StyleBase {
|
|
|
41286
41540
|
* @returns Value of the property.
|
|
41287
41541
|
*/
|
|
41288
41542
|
GetProperty(this: StyleRule, name: string): unknown;
|
|
41543
|
+
/**
|
|
41544
|
+
* - **ThreadSafety**: Unsafe
|
|
41545
|
+
*
|
|
41546
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleRule#GetPropertyTransitions)
|
|
41547
|
+
*/
|
|
41548
|
+
GetPropertyTransitions(this: StyleRule): object;
|
|
41289
41549
|
/**
|
|
41290
41550
|
* Lets you declare and set multiple properties of the `StyleRule` at once.
|
|
41291
41551
|
*
|
|
@@ -41305,6 +41565,12 @@ interface StyleRule extends StyleBase {
|
|
|
41305
41565
|
* @param value Property value to set, for example `Color3.new(1, 0, 0.25)`.
|
|
41306
41566
|
*/
|
|
41307
41567
|
SetProperty(this: StyleRule, name: string, value: unknown): void;
|
|
41568
|
+
/**
|
|
41569
|
+
* - **ThreadSafety**: Unsafe
|
|
41570
|
+
*
|
|
41571
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleRule#SetPropertyTransitions)
|
|
41572
|
+
*/
|
|
41573
|
+
SetPropertyTransitions(this: StyleRule, properties: object): void;
|
|
41308
41574
|
}
|
|
41309
41575
|
/**
|
|
41310
41576
|
* Aggregates `StyleRules` and can be linked to `DataModel` trees to apply style properties to instances.
|
|
@@ -41832,7 +42098,7 @@ interface TeleportOptions extends Instance {
|
|
|
41832
42098
|
SetTeleportData(this: TeleportOptions, teleportData: unknown): void;
|
|
41833
42099
|
}
|
|
41834
42100
|
/**
|
|
41835
|
-
* Enables transporting
|
|
42101
|
+
* Enables transporting <code>Players</code> between places and servers. <pre><code>For more information on how to teleport players between servers, see </code></pre> <a href="../../../projects/teleport.md">Teleport between places</a>.
|
|
41836
42102
|
*
|
|
41837
42103
|
* - **Tags**: NotCreatable, Service
|
|
41838
42104
|
*
|
|
@@ -41866,7 +42132,7 @@ interface TeleportService extends Instance {
|
|
|
41866
42132
|
* - **ThreadSafety**: Unsafe
|
|
41867
42133
|
*
|
|
41868
42134
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TeleportService#GetArrivingTeleportGui)
|
|
41869
|
-
* @param this Enables transporting
|
|
42135
|
+
* @param this Enables transporting <code>Players</code> between places and servers. <pre><code>For more information on how to teleport players between servers, see </code></pre> <a href="../../../projects/teleport.md">Teleport between places</a>.
|
|
41870
42136
|
* @returns The *customLoadingScreen* the `LocalPlayer` arrived into the place with.
|
|
41871
42137
|
*/
|
|
41872
42138
|
GetArrivingTeleportGui(this: TeleportService): ScreenGui | undefined;
|
|
@@ -41876,7 +42142,7 @@ interface TeleportService extends Instance {
|
|
|
41876
42142
|
* - **ThreadSafety**: Unsafe
|
|
41877
42143
|
*
|
|
41878
42144
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TeleportService#GetLocalPlayerTeleportData)
|
|
41879
|
-
* @param this Enables transporting
|
|
42145
|
+
* @param this Enables transporting <code>Players</code> between places and servers. <pre><code>For more information on how to teleport players between servers, see </code></pre> <a href="../../../projects/teleport.md">Teleport between places</a>.
|
|
41880
42146
|
* @returns The teleport data the `Players.LocalPlayer` arrived into the place with.
|
|
41881
42147
|
*/
|
|
41882
42148
|
GetLocalPlayerTeleportData(this: TeleportService): unknown;
|
|
@@ -41886,7 +42152,7 @@ interface TeleportService extends Instance {
|
|
|
41886
42152
|
* - **ThreadSafety**: Unsafe
|
|
41887
42153
|
*
|
|
41888
42154
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TeleportService#GetTeleportSetting)
|
|
41889
|
-
* @param this Enables transporting
|
|
42155
|
+
* @param this Enables transporting <code>Players</code> between places and servers. <pre><code>For more information on how to teleport players between servers, see </code></pre> <a href="../../../projects/teleport.md">Teleport between places</a>.
|
|
41890
42156
|
* @param setting The key the value was stored under using `TeleportService:SetTeleportSetting()`.
|
|
41891
42157
|
* @returns The value stored under the given key.
|
|
41892
42158
|
*/
|
|
@@ -41897,7 +42163,7 @@ interface TeleportService extends Instance {
|
|
|
41897
42163
|
* - **ThreadSafety**: Unsafe
|
|
41898
42164
|
*
|
|
41899
42165
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TeleportService#SetTeleportGui)
|
|
41900
|
-
* @param this Enables transporting
|
|
42166
|
+
* @param this Enables transporting <code>Players</code> between places and servers. <pre><code>For more information on how to teleport players between servers, see </code></pre> <a href="../../../projects/teleport.md">Teleport between places</a>.
|
|
41901
42167
|
* @param gui The loading `ScreenGui` that is to be displayed during teleportation.
|
|
41902
42168
|
*/
|
|
41903
42169
|
SetTeleportGui(this: TeleportService, gui: ScreenGui): void;
|
|
@@ -41907,7 +42173,7 @@ interface TeleportService extends Instance {
|
|
|
41907
42173
|
* - **ThreadSafety**: Unsafe
|
|
41908
42174
|
*
|
|
41909
42175
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TeleportService#SetTeleportSetting)
|
|
41910
|
-
* @param this Enables transporting
|
|
42176
|
+
* @param this Enables transporting <code>Players</code> between places and servers. <pre><code>For more information on how to teleport players between servers, see </code></pre> <a href="../../../projects/teleport.md">Teleport between places</a>.
|
|
41911
42177
|
* @param setting The key to store the *value* under. This key can be used to retrieve the value using `TeleportService:GetTeleportSetting()`.
|
|
41912
42178
|
* @param value The value to store.
|
|
41913
42179
|
*/
|
|
@@ -41918,7 +42184,7 @@ interface TeleportService extends Instance {
|
|
|
41918
42184
|
* - **ThreadSafety**: Unsafe
|
|
41919
42185
|
*
|
|
41920
42186
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TeleportService#Teleport)
|
|
41921
|
-
* @param this Enables transporting
|
|
42187
|
+
* @param this Enables transporting <code>Players</code> between places and servers. <pre><code>For more information on how to teleport players between servers, see </code></pre> <a href="../../../projects/teleport.md">Teleport between places</a>.
|
|
41922
42188
|
* @param placeId The ID of the place to teleport to.
|
|
41923
42189
|
* @param player The `Player` to teleport, if this function is being called from the client this defaults to the `Players.LocalPlayer`.
|
|
41924
42190
|
* @param teleportData Optional data to be passed to the destination place. Can be retrieved using `TeleportService:GetLocalPlayerTeleportData()`.
|
|
@@ -41931,7 +42197,7 @@ interface TeleportService extends Instance {
|
|
|
41931
42197
|
* - **ThreadSafety**: Unsafe
|
|
41932
42198
|
*
|
|
41933
42199
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TeleportService#TeleportToPlaceInstance)
|
|
41934
|
-
* @param this Enables transporting
|
|
42200
|
+
* @param this Enables transporting <code>Players</code> between places and servers. <pre><code>For more information on how to teleport players between servers, see </code></pre> <a href="../../../projects/teleport.md">Teleport between places</a>.
|
|
41935
42201
|
* @param placeId The ID of the place to teleport to.
|
|
41936
42202
|
* @param instanceId The `DataModel.JobId` of the server instance to teleport to.
|
|
41937
42203
|
* @param player The `Player` to teleport, if this function is being called from the client this defaults to the `Players.LocalPlayer`.
|
|
@@ -41946,7 +42212,7 @@ interface TeleportService extends Instance {
|
|
|
41946
42212
|
* - **ThreadSafety**: Unsafe
|
|
41947
42213
|
*
|
|
41948
42214
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TeleportService#TeleportToPrivateServer)
|
|
41949
|
-
* @param this Enables transporting
|
|
42215
|
+
* @param this Enables transporting <code>Players</code> between places and servers. <pre><code>For more information on how to teleport players between servers, see </code></pre> <a href="../../../projects/teleport.md">Teleport between places</a>.
|
|
41950
42216
|
* @param placeId The ID of the place to teleport to.
|
|
41951
42217
|
* @param reservedServerAccessCode The reserved server access code returned by `TeleportService:ReserveServerAsync()`.
|
|
41952
42218
|
* @param players An array of `Players` to teleport.
|
|
@@ -41961,7 +42227,7 @@ interface TeleportService extends Instance {
|
|
|
41961
42227
|
* - **ThreadSafety**: Unsafe
|
|
41962
42228
|
*
|
|
41963
42229
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TeleportService#TeleportToSpawnByName)
|
|
41964
|
-
* @param this Enables transporting
|
|
42230
|
+
* @param this Enables transporting <code>Players</code> between places and servers. <pre><code>For more information on how to teleport players between servers, see </code></pre> <a href="../../../projects/teleport.md">Teleport between places</a>.
|
|
41965
42231
|
* @param placeId The ID of the place to teleport to.
|
|
41966
42232
|
* @param spawnName The name of the `SpawnLocation` to spawn at.
|
|
41967
42233
|
* @param player The `Player` to teleport, if this function is being called from the client this defaults to the `Players.LocalPlayer`.
|
|
@@ -41976,7 +42242,7 @@ interface TeleportService extends Instance {
|
|
|
41976
42242
|
* - **Tags**: Yields
|
|
41977
42243
|
*
|
|
41978
42244
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TeleportService#GetPlayerPlaceInstanceAsync)
|
|
41979
|
-
* @param this Enables transporting
|
|
42245
|
+
* @param this Enables transporting <code>Players</code> between places and servers. <pre><code>For more information on how to teleport players between servers, see </code></pre> <a href="../../../projects/teleport.md">Teleport between places</a>.
|
|
41980
42246
|
* @param userId The `Player.UserId` of the `Player`.
|
|
41981
42247
|
* @returns See the table above.
|
|
41982
42248
|
*/
|
|
@@ -41993,7 +42259,7 @@ interface TeleportService extends Instance {
|
|
|
41993
42259
|
* - **Tags**: Yields
|
|
41994
42260
|
*
|
|
41995
42261
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TeleportService#PromptExperienceDetailsAsync)
|
|
41996
|
-
* @param this Enables transporting
|
|
42262
|
+
* @param this Enables transporting <code>Players</code> between places and servers. <pre><code>For more information on how to teleport players between servers, see </code></pre> <a href="../../../projects/teleport.md">Teleport between places</a>.
|
|
41997
42263
|
* @param player The `Player` to be presented the prompt.
|
|
41998
42264
|
* @param universeId `DataModel.UniverseId` of the experience to be presented to the `Player`
|
|
41999
42265
|
* @returns `PromptExperienceDetailsResult`
|
|
@@ -42008,7 +42274,7 @@ interface TeleportService extends Instance {
|
|
|
42008
42274
|
* - **Tags**: Yields
|
|
42009
42275
|
*
|
|
42010
42276
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TeleportService#ReserveServer)
|
|
42011
|
-
* @param this Enables transporting
|
|
42277
|
+
* @param this Enables transporting <code>Players</code> between places and servers. <pre><code>For more information on how to teleport players between servers, see </code></pre> <a href="../../../projects/teleport.md">Teleport between places</a>.
|
|
42012
42278
|
* @param placeId The `DataModel.PlaceId` of the place the reserved server is being created for.
|
|
42013
42279
|
* @returns The server access code required by `TeleportService:TeleportToPrivateServer()` and the `DataModel.PrivateServerId` for the reserved server.
|
|
42014
42280
|
*
|
|
@@ -42025,7 +42291,7 @@ interface TeleportService extends Instance {
|
|
|
42025
42291
|
* - **Tags**: Yields
|
|
42026
42292
|
*
|
|
42027
42293
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TeleportService#ReserveServerAsync)
|
|
42028
|
-
* @param this Enables transporting
|
|
42294
|
+
* @param this Enables transporting <code>Players</code> between places and servers. <pre><code>For more information on how to teleport players between servers, see </code></pre> <a href="../../../projects/teleport.md">Teleport between places</a>.
|
|
42029
42295
|
* @param placeId The `DataModel.PlaceId` of the place the reserved server is being created for.
|
|
42030
42296
|
* @returns The server access code required by `TeleportService:TeleportToPrivateServer()` and the `DataModel.PrivateServerId` for the reserved server.
|
|
42031
42297
|
*/
|
|
@@ -42037,7 +42303,7 @@ interface TeleportService extends Instance {
|
|
|
42037
42303
|
* - **Tags**: Yields
|
|
42038
42304
|
*
|
|
42039
42305
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TeleportService#TeleportAsync)
|
|
42040
|
-
* @param this Enables transporting
|
|
42306
|
+
* @param this Enables transporting <code>Players</code> between places and servers. <pre><code>For more information on how to teleport players between servers, see </code></pre> <a href="../../../projects/teleport.md">Teleport between places</a>.
|
|
42041
42307
|
* @param placeId The place ID the player(s) should be teleported to.
|
|
42042
42308
|
* @param players An array of the player(s) to teleport.
|
|
42043
42309
|
* @param teleportOptions An optional `TeleportOptions` object containing additional arguments to the `TeleportService:TeleportAsync()` call. If this is not passed, no result will be returned.
|
|
@@ -42051,7 +42317,7 @@ interface TeleportService extends Instance {
|
|
|
42051
42317
|
* - **Tags**: Yields
|
|
42052
42318
|
*
|
|
42053
42319
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TeleportService#TeleportPartyAsync)
|
|
42054
|
-
* @param this Enables transporting
|
|
42320
|
+
* @param this Enables transporting <code>Players</code> between places and servers. <pre><code>For more information on how to teleport players between servers, see </code></pre> <a href="../../../projects/teleport.md">Teleport between places</a>.
|
|
42055
42321
|
* @param placeId The ID of the place to teleport to.
|
|
42056
42322
|
* @param players An array containing the `Players` to teleport.
|
|
42057
42323
|
* @param teleportData Optional data to be passed to the destination place. Can be retrieved using `TeleportService:GetLocalPlayerTeleportData()`.
|
|
@@ -42414,14 +42680,27 @@ interface TestService extends Instance {
|
|
|
42414
42680
|
* @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.
|
|
42415
42681
|
*/
|
|
42416
42682
|
ScopeTime(this: TestService): object;
|
|
42683
|
+
/**
|
|
42684
|
+
* - **ThreadSafety**: Unsafe
|
|
42685
|
+
*
|
|
42686
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#StartTestSession)
|
|
42687
|
+
*/
|
|
42688
|
+
StartTestSession(this: TestService): void;
|
|
42689
|
+
/**
|
|
42690
|
+
* - **ThreadSafety**: Unsafe
|
|
42691
|
+
*
|
|
42692
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#StopTestSession)
|
|
42693
|
+
*/
|
|
42694
|
+
StopTestSession(this: TestService): void;
|
|
42417
42695
|
/**
|
|
42418
42696
|
* - **ThreadSafety**: Unsafe
|
|
42419
42697
|
*
|
|
42420
42698
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#TakeSnapshot)
|
|
42421
42699
|
* @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.
|
|
42422
42700
|
* @param snapshotname
|
|
42701
|
+
* @param source
|
|
42423
42702
|
*/
|
|
42424
|
-
TakeSnapshot(this: TestService, snapshotname: string): void;
|
|
42703
|
+
TakeSnapshot(this: TestService, snapshotname: string, source?: Instance): void;
|
|
42425
42704
|
/**
|
|
42426
42705
|
* Prints if a condition is `true`, otherwise prints a warning.
|
|
42427
42706
|
*
|
|
@@ -42435,6 +42714,12 @@ interface TestService extends Instance {
|
|
|
42435
42714
|
* @param line
|
|
42436
42715
|
*/
|
|
42437
42716
|
Warn(this: TestService, condition: boolean, description: string, source?: Instance, line?: number): void;
|
|
42717
|
+
/**
|
|
42718
|
+
* - **ThreadSafety**: Unsafe
|
|
42719
|
+
*
|
|
42720
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#getTestSessionProviderStats)
|
|
42721
|
+
*/
|
|
42722
|
+
getTestSessionProviderStats(this: TestService, providerName: string): object;
|
|
42438
42723
|
/**
|
|
42439
42724
|
* - **ThreadSafety**: Unsafe
|
|
42440
42725
|
*
|
|
@@ -43543,8 +43828,8 @@ interface TextChatService extends Instance {
|
|
|
43543
43828
|
*
|
|
43544
43829
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextChatService#CanUsersChatAsync)
|
|
43545
43830
|
* @param this A service handling in-experience text chat.
|
|
43546
|
-
* @param userIdFrom
|
|
43547
|
-
* @param userIdTo
|
|
43831
|
+
* @param userIdFrom The user must be in the current server, otherwise an error will occur.
|
|
43832
|
+
* @param userIdTo The user must be in the current server, otherwise an error will occur.
|
|
43548
43833
|
*/
|
|
43549
43834
|
CanUsersChatAsync(this: TextChatService, userIdFrom: number, userIdTo: number): boolean;
|
|
43550
43835
|
/**
|
|
@@ -43561,10 +43846,15 @@ interface TextChatService extends Instance {
|
|
|
43561
43846
|
*/
|
|
43562
43847
|
CanUsersDirectChatAsync(this: TextChatService, requesterUserId: number, userIds: Array<unknown>): Array<unknown>;
|
|
43563
43848
|
/**
|
|
43849
|
+
* Returns chat group IDs that indicate which players can synchronously text chat together.
|
|
43850
|
+
*
|
|
43564
43851
|
* - **ThreadSafety**: Unsafe
|
|
43565
43852
|
* - **Tags**: Yields
|
|
43566
43853
|
*
|
|
43567
43854
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextChatService#GetChatGroupsAsync)
|
|
43855
|
+
* @param this A service handling in-experience text chat.
|
|
43856
|
+
* @param players A list of `Players` currently in the experience to evaluate for text chat compatibility.
|
|
43857
|
+
* @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.
|
|
43568
43858
|
*/
|
|
43569
43859
|
GetChatGroupsAsync(this: TextChatService, players: Array<Instance>): Array<unknown>;
|
|
43570
43860
|
/**
|
|
@@ -47522,21 +47812,28 @@ interface VideoPlayer extends Instance {
|
|
|
47522
47812
|
*
|
|
47523
47813
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#GetConnectedWires)
|
|
47524
47814
|
* @param this Used to play video assets.
|
|
47525
|
-
* @param pin
|
|
47815
|
+
* @param pin An input or output pin on this instance
|
|
47816
|
+
* @returns An array of `Wires`
|
|
47526
47817
|
*/
|
|
47527
47818
|
GetConnectedWires(this: VideoPlayer, pin: string): Array<Instance>;
|
|
47528
47819
|
/**
|
|
47820
|
+
* Gets the list of pins that `Wire` can use in `Wire.TargetName` to connect to this instance via its `Wire.TargetInstance` property.
|
|
47821
|
+
*
|
|
47529
47822
|
* - **ThreadSafety**: Unsafe
|
|
47530
47823
|
*
|
|
47531
47824
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#GetInputPins)
|
|
47532
47825
|
* @param this Used to play video assets.
|
|
47826
|
+
* @returns An array of strings representing valid pin names.
|
|
47533
47827
|
*/
|
|
47534
47828
|
GetInputPins(this: VideoPlayer): Array<unknown>;
|
|
47535
47829
|
/**
|
|
47830
|
+
* Gets the list of pins that `Wire` can use in `Wire.SourceName` to connect to this instance via its `Wire.SourceInstance` property.
|
|
47831
|
+
*
|
|
47536
47832
|
* - **ThreadSafety**: Unsafe
|
|
47537
47833
|
*
|
|
47538
47834
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoPlayer#GetOutputPins)
|
|
47539
47835
|
* @param this Used to play video assets.
|
|
47836
|
+
* @returns An array of strings representing valid pin names.
|
|
47540
47837
|
*/
|
|
47541
47838
|
GetOutputPins(this: VideoPlayer): Array<unknown>;
|
|
47542
47839
|
/**
|
|
@@ -47911,10 +48208,15 @@ interface VoiceChatService extends Instance {
|
|
|
47911
48208
|
*/
|
|
47912
48209
|
readonly _nominal_VoiceChatService: unique symbol;
|
|
47913
48210
|
/**
|
|
48211
|
+
* Returns chat group IDs that indicate which players can voice chat together.
|
|
48212
|
+
*
|
|
47914
48213
|
* - **ThreadSafety**: Unsafe
|
|
47915
48214
|
* - **Tags**: Yields
|
|
47916
48215
|
*
|
|
47917
48216
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VoiceChatService#GetChatGroupsAsync)
|
|
48217
|
+
* @param this **VoiceChatService** is responsible for voice chat's high-level functionality.
|
|
48218
|
+
* @param players A list of `Players` currently in the experience to evaluate for voice chat compatibility.
|
|
48219
|
+
* @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.
|
|
47918
48220
|
*/
|
|
47919
48221
|
GetChatGroupsAsync(this: VoiceChatService, players: Array<Instance>): Array<unknown>;
|
|
47920
48222
|
/**
|
|
@@ -48316,7 +48618,7 @@ interface TerrainWriteOperation extends RBXObject {
|
|
|
48316
48618
|
/**
|
|
48317
48619
|
* An object for sampling frames from video content.
|
|
48318
48620
|
*
|
|
48319
|
-
* - **Tags**: NotCreatable
|
|
48621
|
+
* - **Tags**: NotCreatable, NotReplicated
|
|
48320
48622
|
*
|
|
48321
48623
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VideoSampler)
|
|
48322
48624
|
*/
|