@rbxts/types 1.0.832 → 1.0.834
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.
|
@@ -162,6 +162,7 @@ interface Services {
|
|
|
162
162
|
Stats: Stats;
|
|
163
163
|
StreamingService: StreamingService;
|
|
164
164
|
StudioAssetService: StudioAssetService;
|
|
165
|
+
StudioCameraService: StudioCameraService;
|
|
165
166
|
StudioDeviceEmulatorService: StudioDeviceEmulatorService;
|
|
166
167
|
StudioPublishService: StudioPublishService;
|
|
167
168
|
StudioScriptDebugEventListener: StudioScriptDebugEventListener;
|
|
@@ -188,6 +189,7 @@ interface Services {
|
|
|
188
189
|
TweenService: TweenService;
|
|
189
190
|
UGCAvatarService: UGCAvatarService;
|
|
190
191
|
UIDragDetectorService: UIDragDetectorService;
|
|
192
|
+
UniqueIdLookupService: UniqueIdLookupService;
|
|
191
193
|
UnvalidatedAssetService: UnvalidatedAssetService;
|
|
192
194
|
UserInputService: UserInputService;
|
|
193
195
|
UserService: UserService;
|
|
@@ -224,6 +226,8 @@ interface CreatableInstances {
|
|
|
224
226
|
AtmosphereSensor: AtmosphereSensor;
|
|
225
227
|
Attachment: Attachment;
|
|
226
228
|
AudioAnalyzer: AudioAnalyzer;
|
|
229
|
+
AudioChannelMixer: AudioChannelMixer;
|
|
230
|
+
AudioChannelSplitter: AudioChannelSplitter;
|
|
227
231
|
AudioChorus: AudioChorus;
|
|
228
232
|
AudioCompressor: AudioCompressor;
|
|
229
233
|
AudioDeviceInput: AudioDeviceInput;
|
|
@@ -1390,15 +1394,6 @@ interface EditableMesh extends RBXObject {
|
|
|
1390
1394
|
* @param this Instance which allows for the runtime creation and manipulation of meshes.
|
|
1391
1395
|
*/
|
|
1392
1396
|
Triangulate(this: EditableMesh): void;
|
|
1393
|
-
/**
|
|
1394
|
-
* - **ThreadSafety**: Unsafe
|
|
1395
|
-
* - **Tags**: Yields
|
|
1396
|
-
*
|
|
1397
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EditableMesh#CreateMeshPartAsync)
|
|
1398
|
-
*
|
|
1399
|
-
* @deprecated
|
|
1400
|
-
*/
|
|
1401
|
-
CreateMeshPartAsync(this: EditableMesh, initialSize: Vector3, options?: CreateMeshPartAsyncOptions): MeshPart;
|
|
1402
1397
|
}
|
|
1403
1398
|
/**
|
|
1404
1399
|
* Instance is the base class for all classes in the Roblox class hierarchy which can be part of the DataModel tree.
|
|
@@ -3268,22 +3263,6 @@ interface AssetService extends Instance {
|
|
|
3268
3263
|
* @returns The new `EditableMesh` instance.
|
|
3269
3264
|
*/
|
|
3270
3265
|
CreateEditableMeshAsync(this: AssetService, content: Content, editableMeshOptions?: object): EditableMesh;
|
|
3271
|
-
/**
|
|
3272
|
-
* **Deprecated:** This function has been deprecated - use `AssetService:CreateEditableMeshAsync()`.
|
|
3273
|
-
*
|
|
3274
|
-
* Returns a new `EditableMesh` instance created from an existing `MeshPart`.
|
|
3275
|
-
*
|
|
3276
|
-
* - **ThreadSafety**: Unsafe
|
|
3277
|
-
* - **Tags**: Yields
|
|
3278
|
-
*
|
|
3279
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#CreateEditableMeshFromPartAsync)
|
|
3280
|
-
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
3281
|
-
* @param meshPart The `MeshPart` from which to create an `EditableMesh` instance. The part must have a valid `MeshId` for this method to operate.
|
|
3282
|
-
* @returns The new `EditableMesh` instance.
|
|
3283
|
-
*
|
|
3284
|
-
* @deprecated CreateEditableMeshAsync
|
|
3285
|
-
*/
|
|
3286
|
-
CreateEditableMeshFromPartAsync(this: AssetService, meshPart: Instance): EditableMesh;
|
|
3287
3266
|
/**
|
|
3288
3267
|
* Creates a new `MeshPart` with a specified mesh ID and an optional table of fidelity values.
|
|
3289
3268
|
*
|
|
@@ -3815,6 +3794,18 @@ interface AudioAnalyzer extends Instance {
|
|
|
3815
3794
|
* @param pin
|
|
3816
3795
|
*/
|
|
3817
3796
|
GetConnectedWires(this: AudioAnalyzer, pin: string): Array<Instance>;
|
|
3797
|
+
/**
|
|
3798
|
+
* - **ThreadSafety**: Unsafe
|
|
3799
|
+
*
|
|
3800
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioAnalyzer#GetInputPins)
|
|
3801
|
+
*/
|
|
3802
|
+
GetInputPins(this: AudioAnalyzer): Array<unknown>;
|
|
3803
|
+
/**
|
|
3804
|
+
* - **ThreadSafety**: Unsafe
|
|
3805
|
+
*
|
|
3806
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioAnalyzer#GetOutputPins)
|
|
3807
|
+
*/
|
|
3808
|
+
GetOutputPins(this: AudioAnalyzer): Array<unknown>;
|
|
3818
3809
|
/**
|
|
3819
3810
|
* Returns the frequency spectrum of the last audio buffer.
|
|
3820
3811
|
*
|
|
@@ -3834,6 +3825,72 @@ interface AudioAnalyzer extends Instance {
|
|
|
3834
3825
|
*/
|
|
3835
3826
|
readonly WiringChanged: RBXScriptSignal<(connected: boolean, pin: string, wire: Wire, instance: Instance) => void>;
|
|
3836
3827
|
}
|
|
3828
|
+
/**
|
|
3829
|
+
* - **Tags**: NotBrowsable
|
|
3830
|
+
*
|
|
3831
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer)
|
|
3832
|
+
*/
|
|
3833
|
+
interface AudioChannelMixer extends Instance {
|
|
3834
|
+
/**
|
|
3835
|
+
* **DO NOT USE!**
|
|
3836
|
+
*
|
|
3837
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
3838
|
+
* @hidden
|
|
3839
|
+
* @deprecated
|
|
3840
|
+
*/
|
|
3841
|
+
readonly _nominal_AudioChannelMixer: unique symbol;
|
|
3842
|
+
/**
|
|
3843
|
+
* - **ThreadSafety**: ReadSafe
|
|
3844
|
+
*
|
|
3845
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer#Layout)
|
|
3846
|
+
*/
|
|
3847
|
+
Layout: Enum.AudioChannelLayout;
|
|
3848
|
+
/**
|
|
3849
|
+
* - **ThreadSafety**: Unsafe
|
|
3850
|
+
*
|
|
3851
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer#GetConnectedWires)
|
|
3852
|
+
*/
|
|
3853
|
+
GetConnectedWires(this: AudioChannelMixer, pin: string): Array<Instance>;
|
|
3854
|
+
/**
|
|
3855
|
+
* - **ThreadSafety**: Unsafe
|
|
3856
|
+
*
|
|
3857
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelMixer#WiringChanged)
|
|
3858
|
+
*/
|
|
3859
|
+
readonly WiringChanged: RBXScriptSignal<(connected: boolean, pin: string, wire: Wire, instance: Instance) => void>;
|
|
3860
|
+
}
|
|
3861
|
+
/**
|
|
3862
|
+
* - **Tags**: NotBrowsable
|
|
3863
|
+
*
|
|
3864
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter)
|
|
3865
|
+
*/
|
|
3866
|
+
interface AudioChannelSplitter extends Instance {
|
|
3867
|
+
/**
|
|
3868
|
+
* **DO NOT USE!**
|
|
3869
|
+
*
|
|
3870
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
3871
|
+
* @hidden
|
|
3872
|
+
* @deprecated
|
|
3873
|
+
*/
|
|
3874
|
+
readonly _nominal_AudioChannelSplitter: unique symbol;
|
|
3875
|
+
/**
|
|
3876
|
+
* - **ThreadSafety**: ReadSafe
|
|
3877
|
+
*
|
|
3878
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter#Layout)
|
|
3879
|
+
*/
|
|
3880
|
+
Layout: Enum.AudioChannelLayout;
|
|
3881
|
+
/**
|
|
3882
|
+
* - **ThreadSafety**: Unsafe
|
|
3883
|
+
*
|
|
3884
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter#GetConnectedWires)
|
|
3885
|
+
*/
|
|
3886
|
+
GetConnectedWires(this: AudioChannelSplitter, pin: string): Array<Instance>;
|
|
3887
|
+
/**
|
|
3888
|
+
* - **ThreadSafety**: Unsafe
|
|
3889
|
+
*
|
|
3890
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChannelSplitter#WiringChanged)
|
|
3891
|
+
*/
|
|
3892
|
+
readonly WiringChanged: RBXScriptSignal<(connected: boolean, pin: string, wire: Wire, instance: Instance) => void>;
|
|
3893
|
+
}
|
|
3837
3894
|
/**
|
|
3838
3895
|
* Makes an audio stream sound more voluminous. If applied to a single voice, it may sound like multiple voices.
|
|
3839
3896
|
*
|
|
@@ -3890,6 +3947,18 @@ interface AudioChorus extends Instance {
|
|
|
3890
3947
|
* @param pin
|
|
3891
3948
|
*/
|
|
3892
3949
|
GetConnectedWires(this: AudioChorus, pin: string): Array<Instance>;
|
|
3950
|
+
/**
|
|
3951
|
+
* - **ThreadSafety**: Unsafe
|
|
3952
|
+
*
|
|
3953
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChorus#GetInputPins)
|
|
3954
|
+
*/
|
|
3955
|
+
GetInputPins(this: AudioChorus): Array<unknown>;
|
|
3956
|
+
/**
|
|
3957
|
+
* - **ThreadSafety**: Unsafe
|
|
3958
|
+
*
|
|
3959
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioChorus#GetOutputPins)
|
|
3960
|
+
*/
|
|
3961
|
+
GetOutputPins(this: AudioChorus): Array<unknown>;
|
|
3893
3962
|
/**
|
|
3894
3963
|
* Fires when another instance is connected to or disconnected from the `AudioChorus` via a `Wire`.
|
|
3895
3964
|
*
|
|
@@ -3971,6 +4040,18 @@ interface AudioCompressor extends Instance {
|
|
|
3971
4040
|
* @param pin
|
|
3972
4041
|
*/
|
|
3973
4042
|
GetConnectedWires(this: AudioCompressor, pin: string): Array<Instance>;
|
|
4043
|
+
/**
|
|
4044
|
+
* - **ThreadSafety**: Unsafe
|
|
4045
|
+
*
|
|
4046
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioCompressor#GetInputPins)
|
|
4047
|
+
*/
|
|
4048
|
+
GetInputPins(this: AudioCompressor): Array<unknown>;
|
|
4049
|
+
/**
|
|
4050
|
+
* - **ThreadSafety**: Unsafe
|
|
4051
|
+
*
|
|
4052
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioCompressor#GetOutputPins)
|
|
4053
|
+
*/
|
|
4054
|
+
GetOutputPins(this: AudioCompressor): Array<unknown>;
|
|
3974
4055
|
/**
|
|
3975
4056
|
* Fires when another instance is connected to or disconnected from the `AudioCompressor` via a `Wire`.
|
|
3976
4057
|
*
|
|
@@ -4044,6 +4125,18 @@ interface AudioDeviceInput extends Instance {
|
|
|
4044
4125
|
* @param pin
|
|
4045
4126
|
*/
|
|
4046
4127
|
GetConnectedWires(this: AudioDeviceInput, pin: string): Array<Instance>;
|
|
4128
|
+
/**
|
|
4129
|
+
* - **ThreadSafety**: Unsafe
|
|
4130
|
+
*
|
|
4131
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioDeviceInput#GetInputPins)
|
|
4132
|
+
*/
|
|
4133
|
+
GetInputPins(this: AudioDeviceInput): Array<unknown>;
|
|
4134
|
+
/**
|
|
4135
|
+
* - **ThreadSafety**: Unsafe
|
|
4136
|
+
*
|
|
4137
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioDeviceInput#GetOutputPins)
|
|
4138
|
+
*/
|
|
4139
|
+
GetOutputPins(this: AudioDeviceInput): Array<unknown>;
|
|
4047
4140
|
/**
|
|
4048
4141
|
* Returns a list of user IDs that are either permitted to hear or blocked from hearing this `AudioDeviceInput`.
|
|
4049
4142
|
*
|
|
@@ -4104,6 +4197,18 @@ interface AudioDeviceOutput extends Instance {
|
|
|
4104
4197
|
* @param pin
|
|
4105
4198
|
*/
|
|
4106
4199
|
GetConnectedWires(this: AudioDeviceOutput, pin: string): Array<Instance>;
|
|
4200
|
+
/**
|
|
4201
|
+
* - **ThreadSafety**: Unsafe
|
|
4202
|
+
*
|
|
4203
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioDeviceOutput#GetInputPins)
|
|
4204
|
+
*/
|
|
4205
|
+
GetInputPins(this: AudioDeviceOutput): Array<unknown>;
|
|
4206
|
+
/**
|
|
4207
|
+
* - **ThreadSafety**: Unsafe
|
|
4208
|
+
*
|
|
4209
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioDeviceOutput#GetOutputPins)
|
|
4210
|
+
*/
|
|
4211
|
+
GetOutputPins(this: AudioDeviceOutput): Array<unknown>;
|
|
4107
4212
|
/**
|
|
4108
4213
|
* Fires when another instance is connected to or disconnected from the `AudioDeviceOutput` via a `Wire`.
|
|
4109
4214
|
*
|
|
@@ -4153,6 +4258,18 @@ interface AudioDistortion extends Instance {
|
|
|
4153
4258
|
* @param pin
|
|
4154
4259
|
*/
|
|
4155
4260
|
GetConnectedWires(this: AudioDistortion, pin: string): Array<Instance>;
|
|
4261
|
+
/**
|
|
4262
|
+
* - **ThreadSafety**: Unsafe
|
|
4263
|
+
*
|
|
4264
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioDistortion#GetInputPins)
|
|
4265
|
+
*/
|
|
4266
|
+
GetInputPins(this: AudioDistortion): Array<unknown>;
|
|
4267
|
+
/**
|
|
4268
|
+
* - **ThreadSafety**: Unsafe
|
|
4269
|
+
*
|
|
4270
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioDistortion#GetOutputPins)
|
|
4271
|
+
*/
|
|
4272
|
+
GetOutputPins(this: AudioDistortion): Array<unknown>;
|
|
4156
4273
|
/**
|
|
4157
4274
|
* Fires when another instance is connected to or disconnected from the `AudioDistortion` via a `Wire`.
|
|
4158
4275
|
*
|
|
@@ -4232,6 +4349,18 @@ interface AudioEcho extends Instance {
|
|
|
4232
4349
|
* @param pin
|
|
4233
4350
|
*/
|
|
4234
4351
|
GetConnectedWires(this: AudioEcho, pin: string): Array<Instance>;
|
|
4352
|
+
/**
|
|
4353
|
+
* - **ThreadSafety**: Unsafe
|
|
4354
|
+
*
|
|
4355
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEcho#GetInputPins)
|
|
4356
|
+
*/
|
|
4357
|
+
GetInputPins(this: AudioEcho): Array<unknown>;
|
|
4358
|
+
/**
|
|
4359
|
+
* - **ThreadSafety**: Unsafe
|
|
4360
|
+
*
|
|
4361
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEcho#GetOutputPins)
|
|
4362
|
+
*/
|
|
4363
|
+
GetOutputPins(this: AudioEcho): Array<unknown>;
|
|
4235
4364
|
/**
|
|
4236
4365
|
* Fires when another instance is connected to or disconnected from the `AudioEcho` via a `Wire`.
|
|
4237
4366
|
*
|
|
@@ -4280,6 +4409,12 @@ interface AudioEmitter extends Instance {
|
|
|
4280
4409
|
* @returns Table mapping angle to volume, as described above.
|
|
4281
4410
|
*/
|
|
4282
4411
|
GetAngleAttenuation(this: AudioEmitter): object;
|
|
4412
|
+
/**
|
|
4413
|
+
* - **ThreadSafety**: Unsafe
|
|
4414
|
+
*
|
|
4415
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#GetAudibilityFor)
|
|
4416
|
+
*/
|
|
4417
|
+
GetAudibilityFor(this: AudioEmitter, listener: AudioListener): number;
|
|
4283
4418
|
/**
|
|
4284
4419
|
* Returns an array of `Wires` that are connected to the specified pin.
|
|
4285
4420
|
*
|
|
@@ -4300,6 +4435,12 @@ interface AudioEmitter extends Instance {
|
|
|
4300
4435
|
* @param this Emits audio streams into the world.
|
|
4301
4436
|
*/
|
|
4302
4437
|
GetDistanceAttenuation(this: AudioEmitter): object;
|
|
4438
|
+
/**
|
|
4439
|
+
* - **ThreadSafety**: Unsafe
|
|
4440
|
+
*
|
|
4441
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#GetInputPins)
|
|
4442
|
+
*/
|
|
4443
|
+
GetInputPins(this: AudioEmitter): Array<unknown>;
|
|
4303
4444
|
/**
|
|
4304
4445
|
* - **ThreadSafety**: Unsafe
|
|
4305
4446
|
*
|
|
@@ -4307,6 +4448,12 @@ interface AudioEmitter extends Instance {
|
|
|
4307
4448
|
* @param this Emits audio streams into the world.
|
|
4308
4449
|
*/
|
|
4309
4450
|
GetInteractingListeners(this: AudioEmitter): Array<Instance>;
|
|
4451
|
+
/**
|
|
4452
|
+
* - **ThreadSafety**: Unsafe
|
|
4453
|
+
*
|
|
4454
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEmitter#GetOutputPins)
|
|
4455
|
+
*/
|
|
4456
|
+
GetOutputPins(this: AudioEmitter): Array<unknown>;
|
|
4310
4457
|
/**
|
|
4311
4458
|
* Sets the angle attenuation curve that the `AudioEmitter` should use, or uses a constant curve of volume `1` if none is provided.
|
|
4312
4459
|
*
|
|
@@ -4402,6 +4549,18 @@ interface AudioEqualizer extends Instance {
|
|
|
4402
4549
|
* @param pin
|
|
4403
4550
|
*/
|
|
4404
4551
|
GetConnectedWires(this: AudioEqualizer, pin: string): Array<Instance>;
|
|
4552
|
+
/**
|
|
4553
|
+
* - **ThreadSafety**: Unsafe
|
|
4554
|
+
*
|
|
4555
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEqualizer#GetInputPins)
|
|
4556
|
+
*/
|
|
4557
|
+
GetInputPins(this: AudioEqualizer): Array<unknown>;
|
|
4558
|
+
/**
|
|
4559
|
+
* - **ThreadSafety**: Unsafe
|
|
4560
|
+
*
|
|
4561
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioEqualizer#GetOutputPins)
|
|
4562
|
+
*/
|
|
4563
|
+
GetOutputPins(this: AudioEqualizer): Array<unknown>;
|
|
4405
4564
|
/**
|
|
4406
4565
|
* Fires when another instance is connected to or disconnected from the `AudioEqualizer` via a `Wire`.
|
|
4407
4566
|
*
|
|
@@ -4451,6 +4610,18 @@ interface AudioFader extends Instance {
|
|
|
4451
4610
|
* @param pin
|
|
4452
4611
|
*/
|
|
4453
4612
|
GetConnectedWires(this: AudioFader, pin: string): Array<Instance>;
|
|
4613
|
+
/**
|
|
4614
|
+
* - **ThreadSafety**: Unsafe
|
|
4615
|
+
*
|
|
4616
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioFader#GetInputPins)
|
|
4617
|
+
*/
|
|
4618
|
+
GetInputPins(this: AudioFader): Array<unknown>;
|
|
4619
|
+
/**
|
|
4620
|
+
* - **ThreadSafety**: Unsafe
|
|
4621
|
+
*
|
|
4622
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioFader#GetOutputPins)
|
|
4623
|
+
*/
|
|
4624
|
+
GetOutputPins(this: AudioFader): Array<unknown>;
|
|
4454
4625
|
/**
|
|
4455
4626
|
* Fires when another instance is connected to or disconnected from the `AudioFader` via a `Wire`.
|
|
4456
4627
|
*
|
|
@@ -4535,6 +4706,18 @@ interface AudioFilter extends Instance {
|
|
|
4535
4706
|
* @returns The gain value, in decibels, at the given frequency.
|
|
4536
4707
|
*/
|
|
4537
4708
|
GetGainAt(this: AudioFilter, frequency: number): number;
|
|
4709
|
+
/**
|
|
4710
|
+
* - **ThreadSafety**: Unsafe
|
|
4711
|
+
*
|
|
4712
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioFilter#GetInputPins)
|
|
4713
|
+
*/
|
|
4714
|
+
GetInputPins(this: AudioFilter): Array<unknown>;
|
|
4715
|
+
/**
|
|
4716
|
+
* - **ThreadSafety**: Unsafe
|
|
4717
|
+
*
|
|
4718
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioFilter#GetOutputPins)
|
|
4719
|
+
*/
|
|
4720
|
+
GetOutputPins(this: AudioFilter): Array<unknown>;
|
|
4538
4721
|
/**
|
|
4539
4722
|
* Fires when another instance is connected to or disconnected from the `AudioFilter` via a `Wire`.
|
|
4540
4723
|
*
|
|
@@ -4600,6 +4783,18 @@ interface AudioFlanger extends Instance {
|
|
|
4600
4783
|
* @param pin
|
|
4601
4784
|
*/
|
|
4602
4785
|
GetConnectedWires(this: AudioFlanger, pin: string): Array<Instance>;
|
|
4786
|
+
/**
|
|
4787
|
+
* - **ThreadSafety**: Unsafe
|
|
4788
|
+
*
|
|
4789
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioFlanger#GetInputPins)
|
|
4790
|
+
*/
|
|
4791
|
+
GetInputPins(this: AudioFlanger): Array<unknown>;
|
|
4792
|
+
/**
|
|
4793
|
+
* - **ThreadSafety**: Unsafe
|
|
4794
|
+
*
|
|
4795
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioFlanger#GetOutputPins)
|
|
4796
|
+
*/
|
|
4797
|
+
GetOutputPins(this: AudioFlanger): Array<unknown>;
|
|
4603
4798
|
/**
|
|
4604
4799
|
* Fires when another instance is connected to or disconnected from the `AudioFlanger` via a `Wire`.
|
|
4605
4800
|
*
|
|
@@ -4672,6 +4867,18 @@ interface AudioLimiter extends Instance {
|
|
|
4672
4867
|
* @param pin
|
|
4673
4868
|
*/
|
|
4674
4869
|
GetConnectedWires(this: AudioLimiter, pin: string): Array<Instance>;
|
|
4870
|
+
/**
|
|
4871
|
+
* - **ThreadSafety**: Unsafe
|
|
4872
|
+
*
|
|
4873
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioLimiter#GetInputPins)
|
|
4874
|
+
*/
|
|
4875
|
+
GetInputPins(this: AudioLimiter): Array<unknown>;
|
|
4876
|
+
/**
|
|
4877
|
+
* - **ThreadSafety**: Unsafe
|
|
4878
|
+
*
|
|
4879
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioLimiter#GetOutputPins)
|
|
4880
|
+
*/
|
|
4881
|
+
GetOutputPins(this: AudioLimiter): Array<unknown>;
|
|
4675
4882
|
/**
|
|
4676
4883
|
* Fires when another instance is connected to or disconnected from the `AudioLimiter` via a `Wire`.
|
|
4677
4884
|
*
|
|
@@ -4720,6 +4927,12 @@ interface AudioListener extends Instance {
|
|
|
4720
4927
|
* @returns Table mapping angle to volume, as described above.
|
|
4721
4928
|
*/
|
|
4722
4929
|
GetAngleAttenuation(this: AudioListener): object;
|
|
4930
|
+
/**
|
|
4931
|
+
* - **ThreadSafety**: Unsafe
|
|
4932
|
+
*
|
|
4933
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioListener#GetAudibilityFor)
|
|
4934
|
+
*/
|
|
4935
|
+
GetAudibilityFor(this: AudioListener, emitter: AudioEmitter): number;
|
|
4723
4936
|
/**
|
|
4724
4937
|
* Returns an array of `Wires` that are connected to the specified pin.
|
|
4725
4938
|
*
|
|
@@ -4740,6 +4953,12 @@ interface AudioListener extends Instance {
|
|
|
4740
4953
|
* @param this Records an audio stream from its surrounding `AudioEmitters` in the 3D world.
|
|
4741
4954
|
*/
|
|
4742
4955
|
GetDistanceAttenuation(this: AudioListener): object;
|
|
4956
|
+
/**
|
|
4957
|
+
* - **ThreadSafety**: Unsafe
|
|
4958
|
+
*
|
|
4959
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioListener#GetInputPins)
|
|
4960
|
+
*/
|
|
4961
|
+
GetInputPins(this: AudioListener): Array<unknown>;
|
|
4743
4962
|
/**
|
|
4744
4963
|
* - **ThreadSafety**: Unsafe
|
|
4745
4964
|
*
|
|
@@ -4747,6 +4966,12 @@ interface AudioListener extends Instance {
|
|
|
4747
4966
|
* @param this Records an audio stream from its surrounding `AudioEmitters` in the 3D world.
|
|
4748
4967
|
*/
|
|
4749
4968
|
GetInteractingEmitters(this: AudioListener): Array<Instance>;
|
|
4969
|
+
/**
|
|
4970
|
+
* - **ThreadSafety**: Unsafe
|
|
4971
|
+
*
|
|
4972
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioListener#GetOutputPins)
|
|
4973
|
+
*/
|
|
4974
|
+
GetOutputPins(this: AudioListener): Array<unknown>;
|
|
4750
4975
|
/**
|
|
4751
4976
|
* Sets the angle attenuation curve that the `AudioListener` should use, or uses a constant curve of volume `1` if none is provided.
|
|
4752
4977
|
*
|
|
@@ -4824,6 +5049,18 @@ interface AudioPitchShifter extends Instance {
|
|
|
4824
5049
|
* @param pin
|
|
4825
5050
|
*/
|
|
4826
5051
|
GetConnectedWires(this: AudioPitchShifter, pin: string): Array<Instance>;
|
|
5052
|
+
/**
|
|
5053
|
+
* - **ThreadSafety**: Unsafe
|
|
5054
|
+
*
|
|
5055
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPitchShifter#GetInputPins)
|
|
5056
|
+
*/
|
|
5057
|
+
GetInputPins(this: AudioPitchShifter): Array<unknown>;
|
|
5058
|
+
/**
|
|
5059
|
+
* - **ThreadSafety**: Unsafe
|
|
5060
|
+
*
|
|
5061
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPitchShifter#GetOutputPins)
|
|
5062
|
+
*/
|
|
5063
|
+
GetOutputPins(this: AudioPitchShifter): Array<unknown>;
|
|
4827
5064
|
/**
|
|
4828
5065
|
* Fires when another instance is connected to or disconnected from the `AudioPitchShifter` via a `Wire`.
|
|
4829
5066
|
*
|
|
@@ -4854,6 +5091,8 @@ interface AudioPlayer extends Instance {
|
|
|
4854
5091
|
*/
|
|
4855
5092
|
Asset: ContentId;
|
|
4856
5093
|
/**
|
|
5094
|
+
* **Deprecated:**
|
|
5095
|
+
*
|
|
4857
5096
|
* The asset to be loaded into the `AudioPlayer`.
|
|
4858
5097
|
*
|
|
4859
5098
|
* - **ThreadSafety**: ReadSafe
|
|
@@ -4956,6 +5195,18 @@ interface AudioPlayer extends Instance {
|
|
|
4956
5195
|
* @param pin
|
|
4957
5196
|
*/
|
|
4958
5197
|
GetConnectedWires(this: AudioPlayer, pin: string): Array<Instance>;
|
|
5198
|
+
/**
|
|
5199
|
+
* - **ThreadSafety**: Unsafe
|
|
5200
|
+
*
|
|
5201
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#GetInputPins)
|
|
5202
|
+
*/
|
|
5203
|
+
GetInputPins(this: AudioPlayer): Array<unknown>;
|
|
5204
|
+
/**
|
|
5205
|
+
* - **ThreadSafety**: Unsafe
|
|
5206
|
+
*
|
|
5207
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#GetOutputPins)
|
|
5208
|
+
*/
|
|
5209
|
+
GetOutputPins(this: AudioPlayer): Array<unknown>;
|
|
4959
5210
|
/**
|
|
4960
5211
|
* Plays the `AudioPlayer` from wherever its `TimePosition` is.
|
|
4961
5212
|
*
|
|
@@ -5137,6 +5388,18 @@ interface AudioReverb extends Instance {
|
|
|
5137
5388
|
* @param pin
|
|
5138
5389
|
*/
|
|
5139
5390
|
GetConnectedWires(this: AudioReverb, pin: string): Array<Instance>;
|
|
5391
|
+
/**
|
|
5392
|
+
* - **ThreadSafety**: Unsafe
|
|
5393
|
+
*
|
|
5394
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioReverb#GetInputPins)
|
|
5395
|
+
*/
|
|
5396
|
+
GetInputPins(this: AudioReverb): Array<unknown>;
|
|
5397
|
+
/**
|
|
5398
|
+
* - **ThreadSafety**: Unsafe
|
|
5399
|
+
*
|
|
5400
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioReverb#GetOutputPins)
|
|
5401
|
+
*/
|
|
5402
|
+
GetOutputPins(this: AudioReverb): Array<unknown>;
|
|
5140
5403
|
/**
|
|
5141
5404
|
* Fires when another instance is connected to or disconnected from the `AudioReverb` via a `Wire`.
|
|
5142
5405
|
*
|
|
@@ -5254,6 +5517,12 @@ interface AuroraService extends Instance {
|
|
|
5254
5517
|
* @deprecated
|
|
5255
5518
|
*/
|
|
5256
5519
|
readonly _nominal_AuroraService: unique symbol;
|
|
5520
|
+
/**
|
|
5521
|
+
* - **ThreadSafety**: ReadSafe
|
|
5522
|
+
*
|
|
5523
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#RollbackEnabled)
|
|
5524
|
+
*/
|
|
5525
|
+
RollbackEnabled: boolean;
|
|
5257
5526
|
/**
|
|
5258
5527
|
* - **ThreadSafety**: Unsafe
|
|
5259
5528
|
*
|
|
@@ -5302,12 +5571,24 @@ interface AuroraService extends Instance {
|
|
|
5302
5571
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#SetIncomingReplicationLag)
|
|
5303
5572
|
*/
|
|
5304
5573
|
SetIncomingReplicationLag(this: AuroraService, seconds: number): void;
|
|
5574
|
+
/**
|
|
5575
|
+
* - **ThreadSafety**: Unsafe
|
|
5576
|
+
*
|
|
5577
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#StartPrediction)
|
|
5578
|
+
*/
|
|
5579
|
+
StartPrediction(this: AuroraService, target: Instance): void;
|
|
5305
5580
|
/**
|
|
5306
5581
|
* - **ThreadSafety**: Unsafe
|
|
5307
5582
|
*
|
|
5308
5583
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#StepPhysics)
|
|
5309
5584
|
*/
|
|
5310
5585
|
StepPhysics(this: AuroraService, worldSteps: number, parts?: Array<Instance>): void;
|
|
5586
|
+
/**
|
|
5587
|
+
* - **ThreadSafety**: Unsafe
|
|
5588
|
+
*
|
|
5589
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#StopPrediction)
|
|
5590
|
+
*/
|
|
5591
|
+
StopPrediction(this: AuroraService, target: Instance): void;
|
|
5311
5592
|
/**
|
|
5312
5593
|
* - **ThreadSafety**: Unsafe
|
|
5313
5594
|
*
|
|
@@ -5326,6 +5607,18 @@ interface AuroraService extends Instance {
|
|
|
5326
5607
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#FixedRateTick)
|
|
5327
5608
|
*/
|
|
5328
5609
|
readonly FixedRateTick: RBXScriptSignal<(deltaTime: number, worldStepId: number) => void>;
|
|
5610
|
+
/**
|
|
5611
|
+
* - **ThreadSafety**: Unsafe
|
|
5612
|
+
*
|
|
5613
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#Rollback)
|
|
5614
|
+
*/
|
|
5615
|
+
readonly Rollback: RBXScriptSignal<() => void>;
|
|
5616
|
+
/**
|
|
5617
|
+
* - **ThreadSafety**: Unsafe
|
|
5618
|
+
*
|
|
5619
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AuroraService#Step)
|
|
5620
|
+
*/
|
|
5621
|
+
readonly Step: RBXScriptSignal<() => void>;
|
|
5329
5622
|
/**
|
|
5330
5623
|
* - **ThreadSafety**: Unsafe
|
|
5331
5624
|
*
|
|
@@ -6906,7 +7199,7 @@ interface WrapDeformer extends BaseWrap {
|
|
|
6906
7199
|
* @param this Allows for the real-time deformation of a `MeshPart`.
|
|
6907
7200
|
* @param content
|
|
6908
7201
|
*/
|
|
6909
|
-
SetCageMeshContent(this: WrapDeformer, content: Content): void;
|
|
7202
|
+
SetCageMeshContent(this: WrapDeformer, content: Content, cageOrigin?: CFrame): void;
|
|
6910
7203
|
/**
|
|
6911
7204
|
* Returns an `EditableMesh` (currently unskinned) equivalent to the deformed parent mesh.
|
|
6912
7205
|
*
|
|
@@ -12734,7 +13027,7 @@ interface DataStoreService extends Instance {
|
|
|
12734
13027
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataStoreService#ListDataStoresAsync)
|
|
12735
13028
|
* @param this A game service that gives access to persistent data storage across places in a game.
|
|
12736
13029
|
* @param prefix **(Optional)** Prefix to enumerate data stores that start with the given prefix.
|
|
12737
|
-
* @param pageSize **(Optional)** Number of items to be returned in each page.
|
|
13030
|
+
* @param pageSize **(Optional)** Number of items to be returned in each page. If no value is given, the engine sends a default value of 0 to the data store web service, which in turn defaults to 32 items per page.
|
|
12738
13031
|
* @param cursor **(Optional)** Cursor to continue iteration.
|
|
12739
13032
|
* @returns `DataStoreListingPages` instance containing `DataStoreInfo` instances that provide details such as name, creation time, and time last updated.
|
|
12740
13033
|
*/
|
|
@@ -14629,7 +14922,7 @@ interface DataStore extends GlobalDataStore {
|
|
|
14629
14922
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataStore#ListKeysAsync)
|
|
14630
14923
|
* @param this
|
|
14631
14924
|
* @param prefix **(Optional)** Prefix to use for locating keys.
|
|
14632
|
-
* @param pageSize **(Optional)**
|
|
14925
|
+
* @param pageSize **(Optional)** Number of items to be returned in each page. If no value is given, the engine sends a default value of 0 to the data store web service, which in turn defaults to 50 items per page.
|
|
14633
14926
|
* @param cursor **(Optional)** Cursor to continue iteration.
|
|
14634
14927
|
* @param excludeDeleted **(Optional)** Exclude deleted keys from being returned. When enabled ListKeys will check up to 512 keys. If all checked keys are deleted then it will return an empty list with a cursor to continue iteration.
|
|
14635
14928
|
* @returns A `DataStoreKeyPages` instance that enumerates the keys as `DataStoreKey` instances.
|
|
@@ -14644,10 +14937,10 @@ interface DataStore extends GlobalDataStore {
|
|
|
14644
14937
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataStore#ListVersionsAsync)
|
|
14645
14938
|
* @param this
|
|
14646
14939
|
* @param key Key name for the versions to list. If `DataStoreOptions.AllScopes` was set to true when accessing the data store through `DataStoreService:GetDataStore()`, this key name must be prepended with the original scope as in "scope/key".
|
|
14647
|
-
* @param sortDirection Enum specifying ascending or descending sort order.
|
|
14648
|
-
* @param minDate Unix timestamp in milliseconds after which the versions should be listed.
|
|
14649
|
-
* @param maxDate Unix timestamp in milliseconds up to which the versions should be listed.
|
|
14650
|
-
* @param pageSize Number of items to be returned in each page.
|
|
14940
|
+
* @param sortDirection **(Optional)** Enum specifying ascending or descending sort order.
|
|
14941
|
+
* @param minDate **(Optional)** Unix timestamp in milliseconds after which the versions should be listed.
|
|
14942
|
+
* @param maxDate **(Optional)** Unix timestamp in milliseconds up to which the versions should be listed.
|
|
14943
|
+
* @param pageSize **(Optional)** Number of items to be returned in each page. If no value is given, the engine sends a default value of 0 to the data store web service, which in turn defaults to 1024 items per page.
|
|
14651
14944
|
* @returns A `DataStoreVersionPages` instance that enumerates all the versions of the key as `DataStoreObjectVersionInfo` instances.
|
|
14652
14945
|
*/
|
|
14653
14946
|
ListVersionsAsync(this: DataStore, key: string, sortDirection?: CastsToEnum<Enum.SortDirection>, minDate?: number, maxDate?: number, pageSize?: number): DataStoreVersionPages;
|
|
@@ -16306,6 +16599,8 @@ interface RelativeGui extends GuiObject {
|
|
|
16306
16599
|
readonly _nominal_RelativeGui: unique symbol;
|
|
16307
16600
|
}
|
|
16308
16601
|
/**
|
|
16602
|
+
* `ScrollingFrame` is a special `Frame` type with built-in scrolling interactivity and different ways to customize how the scrolling works.
|
|
16603
|
+
*
|
|
16309
16604
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame)
|
|
16310
16605
|
*/
|
|
16311
16606
|
interface ScrollingFrame extends GuiObject {
|
|
@@ -16318,7 +16613,7 @@ interface ScrollingFrame extends GuiObject {
|
|
|
16318
16613
|
*/
|
|
16319
16614
|
readonly _nominal_ScrollingFrame: unique symbol;
|
|
16320
16615
|
/**
|
|
16321
|
-
* The size
|
|
16616
|
+
* The size of the area that is scrollable, in offsets.
|
|
16322
16617
|
*
|
|
16323
16618
|
* - **ThreadSafety**: Unsafe
|
|
16324
16619
|
* - **Tags**: NotReplicated
|
|
@@ -16327,7 +16622,7 @@ interface ScrollingFrame extends GuiObject {
|
|
|
16327
16622
|
*/
|
|
16328
16623
|
readonly AbsoluteCanvasSize: Vector2;
|
|
16329
16624
|
/**
|
|
16330
|
-
* The size
|
|
16625
|
+
* The size of the frame, in offsets, without the scroll bars.
|
|
16331
16626
|
*
|
|
16332
16627
|
* - **ThreadSafety**: Unsafe
|
|
16333
16628
|
* - **Tags**: NotReplicated
|
|
@@ -16344,7 +16639,7 @@ interface ScrollingFrame extends GuiObject {
|
|
|
16344
16639
|
*/
|
|
16345
16640
|
AutomaticCanvasSize: Enum.AutomaticSize;
|
|
16346
16641
|
/**
|
|
16347
|
-
*
|
|
16642
|
+
* Image that displays on the bottom of a vertical scroll bar, or the right of a horizontal scroll bar (rotated 90° counterclockwise for a horizontal scroll bar).
|
|
16348
16643
|
*
|
|
16349
16644
|
* - **ThreadSafety**: ReadSafe
|
|
16350
16645
|
*
|
|
@@ -16352,7 +16647,7 @@ interface ScrollingFrame extends GuiObject {
|
|
|
16352
16647
|
*/
|
|
16353
16648
|
BottomImage: ContentId;
|
|
16354
16649
|
/**
|
|
16355
|
-
*
|
|
16650
|
+
* Reflects the **current** positional offset of the canvas within the frame, in pixels, and sets the position of scroll bars accordingly.
|
|
16356
16651
|
*
|
|
16357
16652
|
* - **ThreadSafety**: ReadSafe
|
|
16358
16653
|
*
|
|
@@ -16360,7 +16655,7 @@ interface ScrollingFrame extends GuiObject {
|
|
|
16360
16655
|
*/
|
|
16361
16656
|
CanvasPosition: Vector2;
|
|
16362
16657
|
/**
|
|
16363
|
-
* Determines the size of the
|
|
16658
|
+
* Determines the size of the scrollable area.
|
|
16364
16659
|
*
|
|
16365
16660
|
* - **ThreadSafety**: ReadSafe
|
|
16366
16661
|
*
|
|
@@ -16368,7 +16663,7 @@ interface ScrollingFrame extends GuiObject {
|
|
|
16368
16663
|
*/
|
|
16369
16664
|
CanvasSize: UDim2;
|
|
16370
16665
|
/**
|
|
16371
|
-
* Determines when elastic scrolling is allowed.
|
|
16666
|
+
* Determines if and when elastic scrolling is allowed on touch‑enabled devices.
|
|
16372
16667
|
*
|
|
16373
16668
|
* - **ThreadSafety**: ReadSafe
|
|
16374
16669
|
*
|
|
@@ -16376,7 +16671,7 @@ interface ScrollingFrame extends GuiObject {
|
|
|
16376
16671
|
*/
|
|
16377
16672
|
ElasticBehavior: Enum.ElasticBehavior;
|
|
16378
16673
|
/**
|
|
16379
|
-
* Indicates
|
|
16674
|
+
* Indicates whether `CanvasSize` is inset by `ScrollBarThickness` on the horizontal axis.
|
|
16380
16675
|
*
|
|
16381
16676
|
* - **ThreadSafety**: ReadSafe
|
|
16382
16677
|
*
|
|
@@ -16384,7 +16679,7 @@ interface ScrollingFrame extends GuiObject {
|
|
|
16384
16679
|
*/
|
|
16385
16680
|
HorizontalScrollBarInset: Enum.ScrollBarInset;
|
|
16386
16681
|
/**
|
|
16387
|
-
*
|
|
16682
|
+
* Image which spans the area between `TopImage` and `BottomImage` (rotated 90° counterclockwise for a horizontal scroll bar).
|
|
16388
16683
|
*
|
|
16389
16684
|
* - **ThreadSafety**: ReadSafe
|
|
16390
16685
|
*
|
|
@@ -16392,7 +16687,7 @@ interface ScrollingFrame extends GuiObject {
|
|
|
16392
16687
|
*/
|
|
16393
16688
|
MidImage: ContentId;
|
|
16394
16689
|
/**
|
|
16395
|
-
* Determines how
|
|
16690
|
+
* Determines how the rendered scroll bar images are colorized.
|
|
16396
16691
|
*
|
|
16397
16692
|
* - **ThreadSafety**: ReadSafe
|
|
16398
16693
|
*
|
|
@@ -16400,7 +16695,7 @@ interface ScrollingFrame extends GuiObject {
|
|
|
16400
16695
|
*/
|
|
16401
16696
|
ScrollBarImageColor3: Color3;
|
|
16402
16697
|
/**
|
|
16403
|
-
* Determines the
|
|
16698
|
+
* Determines the opacity of the scroll bar images.
|
|
16404
16699
|
*
|
|
16405
16700
|
* - **ThreadSafety**: ReadSafe
|
|
16406
16701
|
*
|
|
@@ -16408,7 +16703,7 @@ interface ScrollingFrame extends GuiObject {
|
|
|
16408
16703
|
*/
|
|
16409
16704
|
ScrollBarImageTransparency: number;
|
|
16410
16705
|
/**
|
|
16411
|
-
*
|
|
16706
|
+
* Thickness of the scroll bar in pixels; applies to both horizontal and vertical scroll bars.
|
|
16412
16707
|
*
|
|
16413
16708
|
* - **ThreadSafety**: ReadSafe
|
|
16414
16709
|
*
|
|
@@ -16416,7 +16711,7 @@ interface ScrollingFrame extends GuiObject {
|
|
|
16416
16711
|
*/
|
|
16417
16712
|
ScrollBarThickness: number;
|
|
16418
16713
|
/**
|
|
16419
|
-
* Determines the direction scrolling is allowed
|
|
16714
|
+
* Determines the direction(s) in which scrolling is allowed.
|
|
16420
16715
|
*
|
|
16421
16716
|
* - **ThreadSafety**: ReadSafe
|
|
16422
16717
|
*
|
|
@@ -16424,7 +16719,7 @@ interface ScrollingFrame extends GuiObject {
|
|
|
16424
16719
|
*/
|
|
16425
16720
|
ScrollingDirection: Enum.ScrollingDirection;
|
|
16426
16721
|
/**
|
|
16427
|
-
* Determines whether
|
|
16722
|
+
* Determines whether scrolling is allowed on the frame.
|
|
16428
16723
|
*
|
|
16429
16724
|
* - **ThreadSafety**: ReadSafe
|
|
16430
16725
|
*
|
|
@@ -16432,7 +16727,7 @@ interface ScrollingFrame extends GuiObject {
|
|
|
16432
16727
|
*/
|
|
16433
16728
|
ScrollingEnabled: boolean;
|
|
16434
16729
|
/**
|
|
16435
|
-
*
|
|
16730
|
+
* Image which displays on the top of a vertical scroll bar, or the left of a horizontal scroll bar (rotated 90° counterclockwise for a horizontal scroll bar).
|
|
16436
16731
|
*
|
|
16437
16732
|
* - **ThreadSafety**: ReadSafe
|
|
16438
16733
|
*
|
|
@@ -16440,7 +16735,7 @@ interface ScrollingFrame extends GuiObject {
|
|
|
16440
16735
|
*/
|
|
16441
16736
|
TopImage: ContentId;
|
|
16442
16737
|
/**
|
|
16443
|
-
* Indicates
|
|
16738
|
+
* Indicates whether `CanvasSize` is inset by `ScrollBarThickness` on the vertical axis.
|
|
16444
16739
|
*
|
|
16445
16740
|
* - **ThreadSafety**: ReadSafe
|
|
16446
16741
|
*
|
|
@@ -16448,7 +16743,7 @@ interface ScrollingFrame extends GuiObject {
|
|
|
16448
16743
|
*/
|
|
16449
16744
|
VerticalScrollBarInset: Enum.ScrollBarInset;
|
|
16450
16745
|
/**
|
|
16451
|
-
* Indicates the
|
|
16746
|
+
* Indicates whether the vertical scroll bar is positioned to the left or right of the canvas.
|
|
16452
16747
|
*
|
|
16453
16748
|
* - **ThreadSafety**: ReadSafe
|
|
16454
16749
|
*
|
|
@@ -16936,7 +17231,7 @@ interface VideoFrame extends GuiObject {
|
|
|
16936
17231
|
readonly Played: RBXScriptSignal<(video: string) => void>;
|
|
16937
17232
|
}
|
|
16938
17233
|
/**
|
|
16939
|
-
* `GuiObject` that
|
|
17234
|
+
* `GuiObject` that renders 3D objects inside its bounds.
|
|
16940
17235
|
*
|
|
16941
17236
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ViewportFrame)
|
|
16942
17237
|
*/
|
|
@@ -16967,7 +17262,7 @@ interface ViewportFrame extends GuiObject {
|
|
|
16967
17262
|
*/
|
|
16968
17263
|
CurrentCamera: Camera | undefined;
|
|
16969
17264
|
/**
|
|
16970
|
-
* Determines how
|
|
17265
|
+
* Determines how the rendered viewport image will be colorized.
|
|
16971
17266
|
*
|
|
16972
17267
|
* - **ThreadSafety**: ReadSafe
|
|
16973
17268
|
*
|
|
@@ -16975,7 +17270,7 @@ interface ViewportFrame extends GuiObject {
|
|
|
16975
17270
|
*/
|
|
16976
17271
|
ImageColor3: Color3;
|
|
16977
17272
|
/**
|
|
16978
|
-
* Determines the transparency of the rendered image.
|
|
17273
|
+
* Determines the transparency of the rendered viewport image.
|
|
16979
17274
|
*
|
|
16980
17275
|
* - **ThreadSafety**: ReadSafe
|
|
16981
17276
|
*
|
|
@@ -18908,27 +19203,23 @@ interface HapticEffect extends Instance {
|
|
|
18908
19203
|
* - **ThreadSafety**: Unsafe
|
|
18909
19204
|
*
|
|
18910
19205
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HapticEffect#Play)
|
|
18911
|
-
* @param this
|
|
18912
19206
|
*/
|
|
18913
19207
|
Play(this: HapticEffect): void;
|
|
18914
19208
|
/**
|
|
18915
19209
|
* - **ThreadSafety**: Unsafe
|
|
18916
19210
|
*
|
|
18917
19211
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HapticEffect#SetWaveformKeys)
|
|
18918
|
-
* @param this
|
|
18919
|
-
* @param keys
|
|
18920
19212
|
*/
|
|
18921
19213
|
SetWaveformKeys(this: HapticEffect, keys: Array<unknown>): void;
|
|
18922
19214
|
/**
|
|
18923
19215
|
* - **ThreadSafety**: Unsafe
|
|
18924
19216
|
*
|
|
18925
19217
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HapticEffect#Stop)
|
|
18926
|
-
* @param this
|
|
18927
19218
|
*/
|
|
18928
19219
|
Stop(this: HapticEffect): void;
|
|
18929
19220
|
}
|
|
18930
19221
|
/**
|
|
18931
|
-
* Provides haptic feedback to
|
|
19222
|
+
* Provides haptic feedback to controllers and devices.
|
|
18932
19223
|
*
|
|
18933
19224
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
18934
19225
|
*
|
|
@@ -18944,38 +19235,38 @@ interface HapticService extends Instance {
|
|
|
18944
19235
|
*/
|
|
18945
19236
|
readonly _nominal_HapticService: unique symbol;
|
|
18946
19237
|
/**
|
|
18947
|
-
* Returns the current vibration value set to the specified `UserInputType` and `VibrationMotor`.
|
|
19238
|
+
* Returns the current vibration value set to the specified `UserInputType` and `VibrationMotor`.
|
|
18948
19239
|
*
|
|
18949
19240
|
* - **ThreadSafety**: Unsafe
|
|
18950
19241
|
*
|
|
18951
19242
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HapticService#GetMotor)
|
|
18952
|
-
* @param this Provides haptic feedback to
|
|
19243
|
+
* @param this Provides haptic feedback to controllers and devices.
|
|
18953
19244
|
* @param inputType The specified `UserInputType`.
|
|
18954
19245
|
* @param vibrationMotor The specified `VibrationMotor`.
|
|
18955
|
-
* @returns The current vibration value set to the specified `UserInputType` and `VibrationMotor` or nil if `SetMotor` has not been called prior.
|
|
19246
|
+
* @returns The current vibration value set to the specified `UserInputType` and `VibrationMotor` or `nil` if `SetMotor()` has not been called prior.
|
|
18956
19247
|
*/
|
|
18957
19248
|
GetMotor(this: HapticService, inputType: CastsToEnum<Enum.UserInputType>, vibrationMotor: CastsToEnum<Enum.VibrationMotor>): unknown;
|
|
18958
19249
|
/**
|
|
18959
|
-
* Returns true if the specified motor is available to be used with the specified `UserInputType`.
|
|
19250
|
+
* Returns `true` if the specified motor is available to be used with the specified `UserInputType`.
|
|
18960
19251
|
*
|
|
18961
19252
|
* - **ThreadSafety**: Unsafe
|
|
18962
19253
|
*
|
|
18963
19254
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HapticService#IsMotorSupported)
|
|
18964
|
-
* @param this Provides haptic feedback to
|
|
19255
|
+
* @param this Provides haptic feedback to controllers and devices.
|
|
18965
19256
|
* @param inputType The specific `UserInputType` being checked for `VibrationMotor` support.
|
|
18966
19257
|
* @param vibrationMotor The specified `VibrationMotor` checked to see if it supports the specified `UserInputType`.
|
|
18967
|
-
* @returns
|
|
19258
|
+
* @returns Boolean of `true` if the specified motor is available to be used with the specified `UserInputType`, `false` if not.
|
|
18968
19259
|
*/
|
|
18969
19260
|
IsMotorSupported(this: HapticService, inputType: CastsToEnum<Enum.UserInputType>, vibrationMotor: CastsToEnum<Enum.VibrationMotor>): boolean;
|
|
18970
19261
|
/**
|
|
18971
|
-
* Returns true if the specified `UserInputType` supports haptic feedback.
|
|
19262
|
+
* Returns `true` if the specified `UserInputType` supports haptic feedback.
|
|
18972
19263
|
*
|
|
18973
19264
|
* - **ThreadSafety**: Unsafe
|
|
18974
19265
|
*
|
|
18975
19266
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HapticService#IsVibrationSupported)
|
|
18976
|
-
* @param this Provides haptic feedback to
|
|
19267
|
+
* @param this Provides haptic feedback to controllers and devices.
|
|
18977
19268
|
* @param inputType The specified `UserInputType` checked to see if it supports haptic feedback.
|
|
18978
|
-
* @returns
|
|
19269
|
+
* @returns Boolean of `true` if the specified `UserInputType` supports haptic feedback.
|
|
18979
19270
|
*/
|
|
18980
19271
|
IsVibrationSupported(this: HapticService, inputType: CastsToEnum<Enum.UserInputType>): boolean;
|
|
18981
19272
|
/**
|
|
@@ -18984,7 +19275,7 @@ interface HapticService extends Instance {
|
|
|
18984
19275
|
* - **ThreadSafety**: Unsafe
|
|
18985
19276
|
*
|
|
18986
19277
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HapticService#SetMotor)
|
|
18987
|
-
* @param this Provides haptic feedback to
|
|
19278
|
+
* @param this Provides haptic feedback to controllers and devices.
|
|
18988
19279
|
* @param inputType The specified `UserInputType`.
|
|
18989
19280
|
* @param vibrationMotor The specified `VibrationMotor`.
|
|
18990
19281
|
* @param vibrationValues How intensely the motor should vibrate. Only uses the first value in the tuple, which should be a number.
|
|
@@ -19643,7 +19934,7 @@ interface Humanoid extends Instance {
|
|
|
19643
19934
|
*/
|
|
19644
19935
|
GetAppliedDescription(this: Humanoid): HumanoidDescription;
|
|
19645
19936
|
/**
|
|
19646
|
-
* Pass a body part to this
|
|
19937
|
+
* Pass a body part to this method (the body part should be a sibling of Humanoid, and a child of a Model) to get the `BodyPartR15` of the `Part`.
|
|
19647
19938
|
*
|
|
19648
19939
|
* - **ThreadSafety**: Unsafe
|
|
19649
19940
|
*
|
|
@@ -21177,7 +21468,7 @@ interface JointInstance extends Instance {
|
|
|
21177
21468
|
*
|
|
21178
21469
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/JointInstance#Part0)
|
|
21179
21470
|
*/
|
|
21180
|
-
Part0
|
|
21471
|
+
Part0: BasePart | undefined;
|
|
21181
21472
|
/**
|
|
21182
21473
|
* The second `BasePart` that the joint connects.
|
|
21183
21474
|
*
|
|
@@ -21185,7 +21476,7 @@ interface JointInstance extends Instance {
|
|
|
21185
21476
|
*
|
|
21186
21477
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/JointInstance#Part1)
|
|
21187
21478
|
*/
|
|
21188
|
-
Part1
|
|
21479
|
+
Part1: BasePart | undefined;
|
|
21189
21480
|
}
|
|
21190
21481
|
/**
|
|
21191
21482
|
* The base class for classic motor joints.
|
|
@@ -22249,8 +22540,6 @@ interface LiveSyncService extends Instance {
|
|
|
22249
22540
|
* - **ThreadSafety**: Unsafe
|
|
22250
22541
|
*
|
|
22251
22542
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LiveSyncService#GetSyncState)
|
|
22252
|
-
* @param this
|
|
22253
|
-
* @param instance
|
|
22254
22543
|
*/
|
|
22255
22544
|
GetSyncState(this: LiveSyncService, instance: Instance): unknown;
|
|
22256
22545
|
/**
|
|
@@ -23624,7 +23913,7 @@ interface MemoryStoreSortedMap extends Instance {
|
|
|
23624
23913
|
* - Sort key, or nil -- if there's no sort key associated with the specified key.
|
|
23625
23914
|
*/
|
|
23626
23915
|
GetAsync(this: MemoryStoreSortedMap, key: string): LuaTuple<[
|
|
23627
|
-
|
|
23916
|
+
value?: unknown,
|
|
23628
23917
|
sortKey?: string | number
|
|
23629
23918
|
]>;
|
|
23630
23919
|
/**
|
|
@@ -29041,6 +29330,12 @@ interface Player extends Instance {
|
|
|
29041
29330
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#UserId)
|
|
29042
29331
|
*/
|
|
29043
29332
|
readonly UserId: number;
|
|
29333
|
+
/**
|
|
29334
|
+
* - **ThreadSafety**: Unsafe
|
|
29335
|
+
*
|
|
29336
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#AddReplicationFocus)
|
|
29337
|
+
*/
|
|
29338
|
+
AddReplicationFocus(this: Player, part: BasePart): void;
|
|
29044
29339
|
/**
|
|
29045
29340
|
* Removes all accessories and other character appearance objects from a player's Character.
|
|
29046
29341
|
*
|
|
@@ -29206,6 +29501,12 @@ interface Player extends Instance {
|
|
|
29206
29501
|
* @param relativeToCamera A boolean indicating whether the player should move relative to the player's camera.
|
|
29207
29502
|
*/
|
|
29208
29503
|
Move(this: Player, walkDirection: Vector3, relativeToCamera?: boolean): void;
|
|
29504
|
+
/**
|
|
29505
|
+
* - **ThreadSafety**: Unsafe
|
|
29506
|
+
*
|
|
29507
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#RemoveReplicationFocus)
|
|
29508
|
+
*/
|
|
29509
|
+
RemoveReplicationFocus(this: Player, part: BasePart): void;
|
|
29209
29510
|
/**
|
|
29210
29511
|
* **Deprecated:** This item is deprecated, as it may have been used for a now obsolete data persistence method. Please save and load player data using `DataStoreService` for new work.
|
|
29211
29512
|
*
|
|
@@ -29982,17 +30283,20 @@ interface PolicyService extends Instance {
|
|
|
29982
30283
|
*/
|
|
29983
30284
|
readonly _nominal_PolicyService: unique symbol;
|
|
29984
30285
|
/**
|
|
30286
|
+
* Determines if a user can see brand project assets inside your experience.
|
|
30287
|
+
*
|
|
29985
30288
|
* - **ThreadSafety**: Unsafe
|
|
29986
30289
|
* - **Tags**: Yields
|
|
29987
30290
|
*
|
|
29988
30291
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PolicyService#CanViewBrandProjectAsync)
|
|
29989
30292
|
* @param this Helps you query information regarding policy compliance for players around the world based on age range, location, and platform type.
|
|
29990
|
-
* @param player
|
|
29991
|
-
* @param brandProjectId
|
|
30293
|
+
* @param player The `Player` object you're trying to show the brand project to.
|
|
30294
|
+
* @param brandProjectId The brand project ID provided by Roblox. Represents all assets associated with a brand project.
|
|
30295
|
+
* @returns Whether or not the brand project can be shown to the specific user.
|
|
29992
30296
|
*/
|
|
29993
30297
|
CanViewBrandProjectAsync(this: PolicyService, player: Player, brandProjectId: string): boolean;
|
|
29994
30298
|
/**
|
|
29995
|
-
* Returns policy information about a player
|
|
30299
|
+
* Returns policy information about a player based on geolocation, age group, and platform.
|
|
29996
30300
|
*
|
|
29997
30301
|
* - **ThreadSafety**: Unsafe
|
|
29998
30302
|
* - **Tags**: Yields
|
|
@@ -33103,7 +33407,7 @@ interface CompressorSoundEffect extends SoundEffect {
|
|
|
33103
33407
|
*
|
|
33104
33408
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CompressorSoundEffect#SideChain)
|
|
33105
33409
|
*/
|
|
33106
|
-
SideChain
|
|
33410
|
+
SideChain: Sound | SoundGroup | undefined;
|
|
33107
33411
|
/**
|
|
33108
33412
|
* Volume level at which point the compressor applies its effect.
|
|
33109
33413
|
*
|
|
@@ -34258,6 +34562,21 @@ interface StudioCallout extends Instance {
|
|
|
34258
34562
|
*/
|
|
34259
34563
|
readonly _nominal_StudioCallout: unique symbol;
|
|
34260
34564
|
}
|
|
34565
|
+
/**
|
|
34566
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
34567
|
+
*
|
|
34568
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioCameraService)
|
|
34569
|
+
*/
|
|
34570
|
+
interface StudioCameraService extends Instance {
|
|
34571
|
+
/**
|
|
34572
|
+
* **DO NOT USE!**
|
|
34573
|
+
*
|
|
34574
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
34575
|
+
* @hidden
|
|
34576
|
+
* @deprecated
|
|
34577
|
+
*/
|
|
34578
|
+
readonly _nominal_StudioCameraService: unique symbol;
|
|
34579
|
+
}
|
|
34261
34580
|
/**
|
|
34262
34581
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
34263
34582
|
*
|
|
@@ -35241,8 +35560,11 @@ interface TestService extends Instance {
|
|
|
35241
35560
|
* Sets whether or not the physics engine should be throttled to 30 FPS while the test is being ran.
|
|
35242
35561
|
*
|
|
35243
35562
|
* - **ThreadSafety**: ReadSafe
|
|
35563
|
+
* - **Tags**: NotReplicated
|
|
35244
35564
|
*
|
|
35245
35565
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#Is30FpsThrottleEnabled)
|
|
35566
|
+
*
|
|
35567
|
+
* @deprecated ThrottlePhysicsToRealtime
|
|
35246
35568
|
*/
|
|
35247
35569
|
Is30FpsThrottleEnabled: boolean;
|
|
35248
35570
|
/**
|
|
@@ -35286,6 +35608,12 @@ interface TestService extends Instance {
|
|
|
35286
35608
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#TestCount)
|
|
35287
35609
|
*/
|
|
35288
35610
|
readonly TestCount: number;
|
|
35611
|
+
/**
|
|
35612
|
+
* - **ThreadSafety**: ReadSafe
|
|
35613
|
+
*
|
|
35614
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TestService#ThrottlePhysicsToRealtime)
|
|
35615
|
+
*/
|
|
35616
|
+
ThrottlePhysicsToRealtime: boolean;
|
|
35289
35617
|
/**
|
|
35290
35618
|
* The maximum amount of time that tests are allowed to run for.
|
|
35291
35619
|
*
|
|
@@ -38466,6 +38794,21 @@ interface UIDragDetectorService extends Instance {
|
|
|
38466
38794
|
*/
|
|
38467
38795
|
readonly _nominal_UIDragDetectorService: unique symbol;
|
|
38468
38796
|
}
|
|
38797
|
+
/**
|
|
38798
|
+
* - **Tags**: NotCreatable, Service
|
|
38799
|
+
*
|
|
38800
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UniqueIdLookupService)
|
|
38801
|
+
*/
|
|
38802
|
+
interface UniqueIdLookupService extends Instance {
|
|
38803
|
+
/**
|
|
38804
|
+
* **DO NOT USE!**
|
|
38805
|
+
*
|
|
38806
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
38807
|
+
* @hidden
|
|
38808
|
+
* @deprecated
|
|
38809
|
+
*/
|
|
38810
|
+
readonly _nominal_UniqueIdLookupService: unique symbol;
|
|
38811
|
+
}
|
|
38469
38812
|
/**
|
|
38470
38813
|
* - **Tags**: NotCreatable, Service
|
|
38471
38814
|
*
|