@rbxts/types 1.0.923 → 1.0.924
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.
|
@@ -7957,7 +7957,7 @@ interface AvatarCreationService extends Instance {
|
|
|
7957
7957
|
*/
|
|
7958
7958
|
AutoSetupAvatarAsync(this: AvatarCreationService, player: Player, autoSetupParams: object, progressCallback?: Callback): string;
|
|
7959
7959
|
/**
|
|
7960
|
-
* Creates a 2D avatar preview and returns a previewId
|
|
7960
|
+
* Creates a 2D avatar preview and returns a `previewId`.
|
|
7961
7961
|
*
|
|
7962
7962
|
* - **ThreadSafety**: Unsafe
|
|
7963
7963
|
* - **Tags**: Yields
|
|
@@ -12835,6 +12835,18 @@ interface AnimationConstraint extends Constraint {
|
|
|
12835
12835
|
* @deprecated
|
|
12836
12836
|
*/
|
|
12837
12837
|
readonly _nominal_AnimationConstraint: unique symbol;
|
|
12838
|
+
/**
|
|
12839
|
+
* - **ThreadSafety**: ReadSafe
|
|
12840
|
+
*
|
|
12841
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationConstraint#AngularDamping)
|
|
12842
|
+
*/
|
|
12843
|
+
AngularDamping: number;
|
|
12844
|
+
/**
|
|
12845
|
+
* - **ThreadSafety**: ReadSafe
|
|
12846
|
+
*
|
|
12847
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationConstraint#AngularStrength)
|
|
12848
|
+
*/
|
|
12849
|
+
AngularStrength: number;
|
|
12838
12850
|
/**
|
|
12839
12851
|
* - **ThreadSafety**: ReadSafe
|
|
12840
12852
|
* - **Tags**: Hidden, NotReplicated
|
|
@@ -12861,6 +12873,18 @@ interface AnimationConstraint extends Constraint {
|
|
|
12861
12873
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationConstraint#IsKinematic)
|
|
12862
12874
|
*/
|
|
12863
12875
|
IsKinematic: boolean;
|
|
12876
|
+
/**
|
|
12877
|
+
* - **ThreadSafety**: ReadSafe
|
|
12878
|
+
*
|
|
12879
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationConstraint#LinearDamping)
|
|
12880
|
+
*/
|
|
12881
|
+
LinearDamping: number;
|
|
12882
|
+
/**
|
|
12883
|
+
* - **ThreadSafety**: ReadSafe
|
|
12884
|
+
*
|
|
12885
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationConstraint#LinearStrength)
|
|
12886
|
+
*/
|
|
12887
|
+
LinearStrength: number;
|
|
12864
12888
|
/**
|
|
12865
12889
|
* Maximum force magnitude the constraint can apply to achieve its goal.
|
|
12866
12890
|
*
|
|
@@ -18442,6 +18466,13 @@ interface GroupService extends Instance {
|
|
|
18442
18466
|
* @returns An array of dictionaries containing information on the group's the `Player` is a member of.
|
|
18443
18467
|
*/
|
|
18444
18468
|
GetGroupsAsync(this: GroupService, userId: number): Array<GetGroupsAsyncResult>;
|
|
18469
|
+
/**
|
|
18470
|
+
* - **ThreadSafety**: Unsafe
|
|
18471
|
+
* - **Tags**: Yields
|
|
18472
|
+
*
|
|
18473
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GroupService#GetRolesInGroupAsync)
|
|
18474
|
+
*/
|
|
18475
|
+
GetRolesInGroupAsync(this: GroupService, userId: number, groupId: number): unknown;
|
|
18445
18476
|
/**
|
|
18446
18477
|
* Prompts the local `Player` to join a specified Roblox group via a native modal.
|
|
18447
18478
|
*
|
|
@@ -22760,6 +22791,8 @@ interface GuiService extends Instance {
|
|
|
22760
22791
|
Vector2
|
|
22761
22792
|
]>;
|
|
22762
22793
|
/**
|
|
22794
|
+
* Takes an `ScreenInsets` value and returns a `Rect2D` describing the inset region, relative to the `CoreUISafeInsets` area.
|
|
22795
|
+
*
|
|
22763
22796
|
* - **ThreadSafety**: Unsafe
|
|
22764
22797
|
*
|
|
22765
22798
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#GetInsetArea)
|
|
@@ -25412,7 +25445,8 @@ interface HumanoidRigDescription extends Instance {
|
|
|
25412
25445
|
*
|
|
25413
25446
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#GetJointFromName)
|
|
25414
25447
|
* @param this
|
|
25415
|
-
* @param name
|
|
25448
|
+
* @param name string
|
|
25449
|
+
* @returns Instance
|
|
25416
25450
|
*/
|
|
25417
25451
|
GetJointFromName(this: HumanoidRigDescription, name: string): Instance | undefined;
|
|
25418
25452
|
/**
|
|
@@ -25420,6 +25454,7 @@ interface HumanoidRigDescription extends Instance {
|
|
|
25420
25454
|
*
|
|
25421
25455
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#GetJointNames)
|
|
25422
25456
|
* @param this
|
|
25457
|
+
* @returns Array
|
|
25423
25458
|
*/
|
|
25424
25459
|
GetJointNames(this: HumanoidRigDescription): Array<unknown>;
|
|
25425
25460
|
/**
|
|
@@ -25427,6 +25462,7 @@ interface HumanoidRigDescription extends Instance {
|
|
|
25427
25462
|
*
|
|
25428
25463
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#GetR15JointNames)
|
|
25429
25464
|
* @param this
|
|
25465
|
+
* @returns Array
|
|
25430
25466
|
*/
|
|
25431
25467
|
GetR15JointNames(this: HumanoidRigDescription): Array<unknown>;
|
|
25432
25468
|
/**
|
|
@@ -25434,6 +25470,7 @@ interface HumanoidRigDescription extends Instance {
|
|
|
25434
25470
|
*
|
|
25435
25471
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription#GetR6JointNames)
|
|
25436
25472
|
* @param this
|
|
25473
|
+
* @returns Array
|
|
25437
25474
|
*/
|
|
25438
25475
|
GetR6JointNames(this: HumanoidRigDescription): Array<unknown>;
|
|
25439
25476
|
}
|
|
@@ -29624,6 +29661,32 @@ interface MicroProfilerService extends Instance {
|
|
|
29624
29661
|
* @deprecated
|
|
29625
29662
|
*/
|
|
29626
29663
|
readonly _nominal_MicroProfilerService: unique symbol;
|
|
29664
|
+
/**
|
|
29665
|
+
* - **ThreadSafety**: Unsafe
|
|
29666
|
+
* - **Tags**: CustomLuaState
|
|
29667
|
+
*
|
|
29668
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MicroProfilerService#GetDataInRange)
|
|
29669
|
+
*/
|
|
29670
|
+
GetDataInRange(this: MicroProfilerService, slotId: number, offset: number, size: number, destBuffer: buffer, destBufferOffset: number): number;
|
|
29671
|
+
/**
|
|
29672
|
+
* - **ThreadSafety**: Unsafe
|
|
29673
|
+
*
|
|
29674
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MicroProfilerService#GetDataSize)
|
|
29675
|
+
*/
|
|
29676
|
+
GetDataSize(this: MicroProfilerService, slotId: number): number;
|
|
29677
|
+
/**
|
|
29678
|
+
* - **ThreadSafety**: Unsafe
|
|
29679
|
+
* - **Tags**: CustomLuaState
|
|
29680
|
+
*
|
|
29681
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MicroProfilerService#ProcessCommand)
|
|
29682
|
+
*/
|
|
29683
|
+
ProcessCommand(this: MicroProfilerService, cmdBuf: buffer, cmdOffset: number, cmdSize: number, respBuf: buffer, respOffset: number, respSize: number): number;
|
|
29684
|
+
/**
|
|
29685
|
+
* - **ThreadSafety**: Unsafe
|
|
29686
|
+
*
|
|
29687
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MicroProfilerService#DataChanged)
|
|
29688
|
+
*/
|
|
29689
|
+
readonly DataChanged: RBXScriptSignal<(slotId: number, flags: number) => void>;
|
|
29627
29690
|
}
|
|
29628
29691
|
/**
|
|
29629
29692
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
@@ -30843,12 +30906,15 @@ interface BasePart extends PVInstance {
|
|
|
30843
30906
|
*/
|
|
30844
30907
|
Velocity: Vector3;
|
|
30845
30908
|
/**
|
|
30909
|
+
* Returns the torque needed to achieve a given angular acceleration on this part's assembly, optionally accounting for gyroscopic effects.
|
|
30910
|
+
*
|
|
30846
30911
|
* - **ThreadSafety**: Unsafe
|
|
30847
30912
|
*
|
|
30848
30913
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BasePart#AngularAccelerationToTorque)
|
|
30849
30914
|
* @param this The abstract base class for in-world objects that physically interact.
|
|
30850
|
-
* @param angAcceleration
|
|
30851
|
-
* @param angVelocity
|
|
30915
|
+
* @param angAcceleration The desired angular acceleration vector in world space.
|
|
30916
|
+
* @param angVelocity The current angular velocity of the assembly in world space. Defaults to `(0, 0, 0)`. Supply the assembly's angular velocity to account for gyroscopic effects.
|
|
30917
|
+
* @returns A `Vector3` representing the world-space torque required to produce the specified angular acceleration.
|
|
30852
30918
|
*/
|
|
30853
30919
|
AngularAccelerationToTorque(this: BasePart, angAcceleration: Vector3, angVelocity?: Vector3): Vector3;
|
|
30854
30920
|
/**
|
|
@@ -31090,12 +31156,15 @@ interface BasePart extends PVInstance {
|
|
|
31090
31156
|
*/
|
|
31091
31157
|
SetNetworkOwnershipAuto(this: BasePart): void;
|
|
31092
31158
|
/**
|
|
31159
|
+
* Returns the angular acceleration that would result from applying a given torque to this part's assembly, optionally accounting for gyroscopic effects.
|
|
31160
|
+
*
|
|
31093
31161
|
* - **ThreadSafety**: Unsafe
|
|
31094
31162
|
*
|
|
31095
31163
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BasePart#TorqueToAngularAcceleration)
|
|
31096
31164
|
* @param this The abstract base class for in-world objects that physically interact.
|
|
31097
|
-
* @param torque
|
|
31098
|
-
* @param angVelocity
|
|
31165
|
+
* @param torque The torque vector applied to the assembly in world space.
|
|
31166
|
+
* @param angVelocity The current angular velocity of the assembly in world space. Defaults to `(0, 0, 0)`. Supply the assembly's angular velocity to account for gyroscopic effects.
|
|
31167
|
+
* @returns A `Vector3` representing the resulting angular acceleration in world space.
|
|
31099
31168
|
*/
|
|
31100
31169
|
TorqueToAngularAcceleration(this: BasePart, torque: Vector3, angVelocity?: Vector3): Vector3;
|
|
31101
31170
|
/**
|
|
@@ -32342,7 +32411,7 @@ interface VehicleSeat extends BasePart {
|
|
|
32342
32411
|
*/
|
|
32343
32412
|
readonly _nominal_VehicleSeat: unique symbol;
|
|
32344
32413
|
/**
|
|
32345
|
-
* Displays how many hinges are detected by the VehicleSeat
|
|
32414
|
+
* Displays how many hinges are detected by the `VehicleSeat`. Useful for debugging vehicle designs.
|
|
32346
32415
|
*
|
|
32347
32416
|
* - **ThreadSafety**: ReadSafe
|
|
32348
32417
|
* - **Tags**: NotReplicated
|
|
@@ -32359,7 +32428,7 @@ interface VehicleSeat extends BasePart {
|
|
|
32359
32428
|
*/
|
|
32360
32429
|
Disabled: boolean;
|
|
32361
32430
|
/**
|
|
32362
|
-
* If true
|
|
32431
|
+
* If `true`, a UI speed bar will be displayed on screen that tells you what speed the vehicle is moving at.
|
|
32363
32432
|
*
|
|
32364
32433
|
* - **ThreadSafety**: ReadSafe
|
|
32365
32434
|
*
|
|
@@ -32375,7 +32444,7 @@ interface VehicleSeat extends BasePart {
|
|
|
32375
32444
|
*/
|
|
32376
32445
|
MaxSpeed: number;
|
|
32377
32446
|
/**
|
|
32378
|
-
* The
|
|
32447
|
+
* The `Humanoid` that is sitting in the seat.
|
|
32379
32448
|
*
|
|
32380
32449
|
* - **ThreadSafety**: ReadSafe
|
|
32381
32450
|
* - **Tags**: NotReplicated
|
|
@@ -32384,7 +32453,7 @@ interface VehicleSeat extends BasePart {
|
|
|
32384
32453
|
*/
|
|
32385
32454
|
readonly Occupant: Humanoid | undefined;
|
|
32386
32455
|
/**
|
|
32387
|
-
* The direction of movement, tied to
|
|
32456
|
+
* The direction of movement, tied to left and right movement inputs.
|
|
32388
32457
|
*
|
|
32389
32458
|
* - **ThreadSafety**: ReadSafe
|
|
32390
32459
|
* - **Tags**: NotReplicated
|
|
@@ -32393,7 +32462,7 @@ interface VehicleSeat extends BasePart {
|
|
|
32393
32462
|
*/
|
|
32394
32463
|
Steer: number;
|
|
32395
32464
|
/**
|
|
32396
|
-
*
|
|
32465
|
+
* The left-to-right movement float, tied to left and right movement inputs.
|
|
32397
32466
|
*
|
|
32398
32467
|
* - **ThreadSafety**: ReadSafe
|
|
32399
32468
|
*
|
|
@@ -32401,7 +32470,7 @@ interface VehicleSeat extends BasePart {
|
|
|
32401
32470
|
*/
|
|
32402
32471
|
SteerFloat: number;
|
|
32403
32472
|
/**
|
|
32404
|
-
* The direction of
|
|
32473
|
+
* The direction of throttle, tied to forward and backward movement inputs.
|
|
32405
32474
|
*
|
|
32406
32475
|
* - **ThreadSafety**: ReadSafe
|
|
32407
32476
|
* - **Tags**: NotReplicated
|
|
@@ -32410,7 +32479,7 @@ interface VehicleSeat extends BasePart {
|
|
|
32410
32479
|
*/
|
|
32411
32480
|
Throttle: number;
|
|
32412
32481
|
/**
|
|
32413
|
-
*
|
|
32482
|
+
* The forward-to-reverse throttle float, tied to forward and backward movement inputs.
|
|
32414
32483
|
*
|
|
32415
32484
|
* - **ThreadSafety**: ReadSafe
|
|
32416
32485
|
*
|
|
@@ -32418,7 +32487,7 @@ interface VehicleSeat extends BasePart {
|
|
|
32418
32487
|
*/
|
|
32419
32488
|
ThrottleFloat: number;
|
|
32420
32489
|
/**
|
|
32421
|
-
* How fast the
|
|
32490
|
+
* How fast the vehicle will be able to attain `MaxSpeed`.
|
|
32422
32491
|
*
|
|
32423
32492
|
* - **ThreadSafety**: ReadSafe
|
|
32424
32493
|
*
|
|
@@ -32434,13 +32503,13 @@ interface VehicleSeat extends BasePart {
|
|
|
32434
32503
|
*/
|
|
32435
32504
|
TurnSpeed: number;
|
|
32436
32505
|
/**
|
|
32437
|
-
* Forces the character with the specified `Humanoid` to sit in the VehicleSeat
|
|
32506
|
+
* Forces the character with the specified `Humanoid` to sit in the `VehicleSeat`.
|
|
32438
32507
|
*
|
|
32439
32508
|
* - **ThreadSafety**: Unsafe
|
|
32440
32509
|
*
|
|
32441
32510
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VehicleSeat#Sit)
|
|
32442
32511
|
* @param this A seat object that can be used to control a vehicle.
|
|
32443
|
-
* @param humanoid The
|
|
32512
|
+
* @param humanoid The `Humanoid` being forced to sit in the `VehicleSeat`.
|
|
32444
32513
|
*/
|
|
32445
32514
|
Sit(this: VehicleSeat, humanoid: Instance): void;
|
|
32446
32515
|
/**
|
|
@@ -35915,6 +35984,8 @@ interface Player extends Instance {
|
|
|
35915
35984
|
* @param this An object that represents a presently connected client to the experience.
|
|
35916
35985
|
* @param groupId The `groupId` of the specified group.
|
|
35917
35986
|
* @returns The player's rank in the group.
|
|
35987
|
+
*
|
|
35988
|
+
* @deprecated GetRolesInGroupAsync
|
|
35918
35989
|
*/
|
|
35919
35990
|
GetRankInGroupAsync(this: Player, groupId: number): number;
|
|
35920
35991
|
/**
|
|
@@ -35943,6 +36014,8 @@ interface Player extends Instance {
|
|
|
35943
36014
|
* @param this An object that represents a presently connected client to the experience.
|
|
35944
36015
|
* @param groupId The group ID of the specified group.
|
|
35945
36016
|
* @returns The player's role in the specified group, or `Guest` if the player is not a member.
|
|
36017
|
+
*
|
|
36018
|
+
* @deprecated GetRolesInGroupAsync
|
|
35946
36019
|
*/
|
|
35947
36020
|
GetRoleInGroupAsync(this: Player, groupId: number): string;
|
|
35948
36021
|
/**
|
|
@@ -37946,11 +38019,11 @@ interface RecommendationService extends Instance {
|
|
|
37946
38019
|
*
|
|
37947
38020
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#LogPreferenceEvent)
|
|
37948
38021
|
* @param this A service that provides an interface for you to manage and display personalized content recommendations.
|
|
37949
|
-
* @param preferenceType
|
|
37950
|
-
* @param targetType
|
|
37951
|
-
* @param targetId
|
|
37952
|
-
* @param tracingId
|
|
37953
|
-
* @param itemId
|
|
38022
|
+
* @param preferenceType The enum for the type of preference.
|
|
38023
|
+
* @param targetType The enum for the type of target.
|
|
38024
|
+
* @param targetId The identifier of the preference target. The format depends on `targetType`.
|
|
38025
|
+
* @param tracingId The tracing ID returned from the `GenerateItemListAsync` response. Pass an empty string if the preference originates outside a recommendation feed.
|
|
38026
|
+
* @param itemId The item ID returned from the `GenerateItemListAsync` response. Pass an empty string if the preference originates outside a recommendation feed.
|
|
37954
38027
|
*/
|
|
37955
38028
|
LogPreferenceEvent(this: RecommendationService, preferenceType: CastsToEnum<Enum.RecommendationPreferenceType>, targetType: CastsToEnum<Enum.RecommendationPreferenceTargetType>, targetId: string, tracingId?: string, itemId?: string): void;
|
|
37956
38029
|
/**
|
|
@@ -40508,8 +40581,9 @@ interface SocialService extends Instance {
|
|
|
40508
40581
|
*
|
|
40509
40582
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#PromptFeedbackSubmissionAsync)
|
|
40510
40583
|
* @param this Facilitates social functions that impact relationships made on the Roblox platform.
|
|
40584
|
+
* @param options Optional `Dictionary` configuring the prompt. Supported keys: - `FeedbackType` (`FeedbackType`). Selects which feedback flow to display. Defaults to `FeedbackType.Feedback`.
|
|
40511
40585
|
*/
|
|
40512
|
-
PromptFeedbackSubmissionAsync(this: SocialService): void;
|
|
40586
|
+
PromptFeedbackSubmissionAsync(this: SocialService, options?: object): void;
|
|
40513
40587
|
/**
|
|
40514
40588
|
* **Deprecated:**
|
|
40515
40589
|
*
|
|
@@ -41104,7 +41178,7 @@ interface AssetSoundEffect extends CustomSoundEffect {
|
|
|
41104
41178
|
readonly _nominal_AssetSoundEffect: unique symbol;
|
|
41105
41179
|
}
|
|
41106
41180
|
/**
|
|
41107
|
-
* - **Tags**: NotCreatable
|
|
41181
|
+
* - **Tags**: NotCreatable
|
|
41108
41182
|
*
|
|
41109
41183
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ChannelSelectorSoundEffect)
|
|
41110
41184
|
*/
|
|
@@ -47681,7 +47755,7 @@ interface UserInputService extends Instance {
|
|
|
47681
47755
|
*/
|
|
47682
47756
|
readonly VREnabled: boolean;
|
|
47683
47757
|
/**
|
|
47684
|
-
* Creates a `VirtualInput` object
|
|
47758
|
+
* Creates a `VirtualInput` object for simulating mouse, keyboard, and pointer input.
|
|
47685
47759
|
*
|
|
47686
47760
|
* - **ThreadSafety**: Unsafe
|
|
47687
47761
|
*
|
|
@@ -48185,6 +48259,13 @@ interface UserService extends Instance {
|
|
|
48185
48259
|
* @deprecated
|
|
48186
48260
|
*/
|
|
48187
48261
|
readonly _nominal_UserService: unique symbol;
|
|
48262
|
+
/**
|
|
48263
|
+
* - **ThreadSafety**: Unsafe
|
|
48264
|
+
* - **Tags**: Yields
|
|
48265
|
+
*
|
|
48266
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/UserService#GetUserFromGlobalUserIdAsync)
|
|
48267
|
+
*/
|
|
48268
|
+
GetUserFromGlobalUserIdAsync(this: UserService, userId: number): User;
|
|
48188
48269
|
/**
|
|
48189
48270
|
* Returns an array of user information including user name and display name.
|
|
48190
48271
|
*
|
|
@@ -49420,15 +49501,6 @@ interface VoiceChatInternal extends Instance {
|
|
|
49420
49501
|
* @deprecated
|
|
49421
49502
|
*/
|
|
49422
49503
|
GetParticipants(this: VoiceChatInternal): Array<unknown>;
|
|
49423
|
-
/**
|
|
49424
|
-
* - **ThreadSafety**: Unsafe
|
|
49425
|
-
* - **Tags**:
|
|
49426
|
-
*
|
|
49427
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VoiceChatInternal#GetSpeakerDevices)
|
|
49428
|
-
*
|
|
49429
|
-
* @deprecated
|
|
49430
|
-
*/
|
|
49431
|
-
GetSpeakerDevices(this: VoiceChatInternal): unknown;
|
|
49432
49504
|
/**
|
|
49433
49505
|
* - **ThreadSafety**: Unsafe
|
|
49434
49506
|
* - **Tags**:
|
|
@@ -49510,15 +49582,6 @@ interface VoiceChatInternal extends Instance {
|
|
|
49510
49582
|
* @deprecated
|
|
49511
49583
|
*/
|
|
49512
49584
|
SetMicDevice(this: VoiceChatInternal, micDeviceName: string, micDeviceGuid: string): void;
|
|
49513
|
-
/**
|
|
49514
|
-
* - **ThreadSafety**: Unsafe
|
|
49515
|
-
* - **Tags**:
|
|
49516
|
-
*
|
|
49517
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VoiceChatInternal#SetSpeakerDevice)
|
|
49518
|
-
*
|
|
49519
|
-
* @deprecated
|
|
49520
|
-
*/
|
|
49521
|
-
SetSpeakerDevice(this: VoiceChatInternal, speakerDeviceName: string, speakerDeviceGuid: string): void;
|
|
49522
49585
|
/**
|
|
49523
49586
|
* - **ThreadSafety**: Unsafe
|
|
49524
49587
|
* - **Tags**:
|
|
@@ -50052,7 +50115,7 @@ interface VideoSampler extends RBXObject {
|
|
|
50052
50115
|
GetSamplesAtTimesAsync(this: VideoSampler, times: Array<unknown>): Array<unknown>;
|
|
50053
50116
|
}
|
|
50054
50117
|
/**
|
|
50055
|
-
*
|
|
50118
|
+
* Simulates mouse, keyboard, and pointer input as if it were performed by a real player.
|
|
50056
50119
|
*
|
|
50057
50120
|
* - **Tags**: NotCreatable, NotReplicated
|
|
50058
50121
|
*
|
|
@@ -50073,7 +50136,7 @@ interface VirtualInput extends RBXObject {
|
|
|
50073
50136
|
* - **ThreadSafety**: Unsafe
|
|
50074
50137
|
*
|
|
50075
50138
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendKey)
|
|
50076
|
-
* @param this
|
|
50139
|
+
* @param this Simulates mouse, keyboard, and pointer input as if it were performed by a real player.
|
|
50077
50140
|
* @param isPressed Whether to simulate a key press (`true`) or a key release (`false`).
|
|
50078
50141
|
* @param keyCode The `KeyCode` of the key to inject.
|
|
50079
50142
|
* @param isRepeatedKey Whether this is an auto-repeat event, as occurs when a key is held down. Only valid for text-manipulation keys such as `KeyCode.Backspace`, `KeyCode.Delete`, and the arrow keys. Defaults to `false`.
|
|
@@ -50085,7 +50148,7 @@ interface VirtualInput extends RBXObject {
|
|
|
50085
50148
|
* - **ThreadSafety**: Unsafe
|
|
50086
50149
|
*
|
|
50087
50150
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendMouseButton)
|
|
50088
|
-
* @param this
|
|
50151
|
+
* @param this Simulates mouse, keyboard, and pointer input as if it were performed by a real player.
|
|
50089
50152
|
* @param position The screen-space position in pixels at which to inject the event.
|
|
50090
50153
|
* @param button The mouse button to use. Supported values are `UserInputType.MouseButton1`, `UserInputType.MouseButton2`, and `UserInputType.MouseButton3`.
|
|
50091
50154
|
* @param isDown Whether to simulate a button press (`true`) or a button release (`false`).
|
|
@@ -50098,7 +50161,7 @@ interface VirtualInput extends RBXObject {
|
|
|
50098
50161
|
* - **ThreadSafety**: Unsafe
|
|
50099
50162
|
*
|
|
50100
50163
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendMouseDelta)
|
|
50101
|
-
* @param this
|
|
50164
|
+
* @param this Simulates mouse, keyboard, and pointer input as if it were performed by a real player.
|
|
50102
50165
|
* @param positionDelta The relative mouse movement in pixels along each axis.
|
|
50103
50166
|
*/
|
|
50104
50167
|
SendMouseDelta(this: VirtualInput, positionDelta: Vector2): void;
|
|
@@ -50108,7 +50171,7 @@ interface VirtualInput extends RBXObject {
|
|
|
50108
50171
|
* - **ThreadSafety**: Unsafe
|
|
50109
50172
|
*
|
|
50110
50173
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendMousePosition)
|
|
50111
|
-
* @param this
|
|
50174
|
+
* @param this Simulates mouse, keyboard, and pointer input as if it were performed by a real player.
|
|
50112
50175
|
* @param position The target screen-space position in pixels.
|
|
50113
50176
|
*/
|
|
50114
50177
|
SendMousePosition(this: VirtualInput, position: Vector2): void;
|
|
@@ -50118,7 +50181,7 @@ interface VirtualInput extends RBXObject {
|
|
|
50118
50181
|
* - **ThreadSafety**: Unsafe
|
|
50119
50182
|
*
|
|
50120
50183
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendPointerAction)
|
|
50121
|
-
* @param this
|
|
50184
|
+
* @param this Simulates mouse, keyboard, and pointer input as if it were performed by a real player.
|
|
50122
50185
|
* @param position The screen-space position in pixels at which to inject the event.
|
|
50123
50186
|
* @param pointerAction A dictionary describing the pointer action to inject. Accepted keys are `Wheel` (number), `Pan` (`Vector2`), and `Pinch` (number). At least one key must have a non-zero value.
|
|
50124
50187
|
*/
|
|
@@ -50129,7 +50192,7 @@ interface VirtualInput extends RBXObject {
|
|
|
50129
50192
|
* - **ThreadSafety**: Unsafe
|
|
50130
50193
|
*
|
|
50131
50194
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput#SendTextInput)
|
|
50132
|
-
* @param this
|
|
50195
|
+
* @param this Simulates mouse, keyboard, and pointer input as if it were performed by a real player.
|
|
50133
50196
|
* @param text The string to inject as text input.
|
|
50134
50197
|
*/
|
|
50135
50198
|
SendTextInput(this: VirtualInput, text: string): void;
|
|
@@ -9791,6 +9791,12 @@ interface Workspace extends WorldRoot {
|
|
|
9791
9791
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#StreamingEnabled)
|
|
9792
9792
|
*/
|
|
9793
9793
|
set StreamingEnabled(value: boolean);
|
|
9794
|
+
/**
|
|
9795
|
+
* - **ThreadSafety**: Unsafe
|
|
9796
|
+
*
|
|
9797
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#ApplyRecommendedStreamingSettings)
|
|
9798
|
+
*/
|
|
9799
|
+
ApplyRecommendedStreamingSettings(this: Workspace): boolean;
|
|
9794
9800
|
/**
|
|
9795
9801
|
* **Deprecated:**
|
|
9796
9802
|
*
|
|
@@ -13634,7 +13640,7 @@ interface AssetSoundEffect extends CustomSoundEffect {
|
|
|
13634
13640
|
readonly _nominal_AssetSoundEffect: unique symbol;
|
|
13635
13641
|
}
|
|
13636
13642
|
/**
|
|
13637
|
-
* - **Tags**: NotCreatable
|
|
13643
|
+
* - **Tags**: NotCreatable
|
|
13638
13644
|
*
|
|
13639
13645
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ChannelSelectorSoundEffect)
|
|
13640
13646
|
*/
|
|
@@ -17090,7 +17096,7 @@ interface VideoSampler extends RBXObject {
|
|
|
17090
17096
|
readonly _nominal_VideoSampler: unique symbol;
|
|
17091
17097
|
}
|
|
17092
17098
|
/**
|
|
17093
|
-
*
|
|
17099
|
+
* Simulates mouse, keyboard, and pointer input as if it were performed by a real player.
|
|
17094
17100
|
*
|
|
17095
17101
|
* - **Tags**: NotCreatable, NotReplicated
|
|
17096
17102
|
*
|
|
@@ -11798,15 +11798,6 @@ declare namespace Enum {
|
|
|
11798
11798
|
EnumType: typeof globalThis.Enum.DomainType;
|
|
11799
11799
|
}
|
|
11800
11800
|
export const EXPERIENCE: EXPERIENCE;
|
|
11801
|
-
/**
|
|
11802
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DomainType#GROUP)
|
|
11803
|
-
*/
|
|
11804
|
-
export interface GROUP extends globalThis.EnumItem {
|
|
11805
|
-
Name: "GROUP";
|
|
11806
|
-
Value: 2;
|
|
11807
|
-
EnumType: typeof globalThis.Enum.DomainType;
|
|
11808
|
-
}
|
|
11809
|
-
export const GROUP: GROUP;
|
|
11810
11801
|
/**
|
|
11811
11802
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/DomainType#OAUTH)
|
|
11812
11803
|
*/
|
|
@@ -11820,7 +11811,7 @@ declare namespace Enum {
|
|
|
11820
11811
|
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.DomainType | undefined;
|
|
11821
11812
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.DomainType | undefined;
|
|
11822
11813
|
}
|
|
11823
|
-
export type DomainType = DomainType.EXPERIENCE | DomainType.
|
|
11814
|
+
export type DomainType = DomainType.EXPERIENCE | DomainType.OAUTH;
|
|
11824
11815
|
/**
|
|
11825
11816
|
* Used by `UIAspectRatioConstraint.DominantAxis` for resizing the object to maintain the aspect ratio.
|
|
11826
11817
|
*
|
|
@@ -13579,6 +13570,33 @@ declare namespace Enum {
|
|
|
13579
13570
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.FeatureRestrictionAbuseVector | undefined;
|
|
13580
13571
|
}
|
|
13581
13572
|
export type FeatureRestrictionAbuseVector = FeatureRestrictionAbuseVector.ExperienceChat | FeatureRestrictionAbuseVector.Communication;
|
|
13573
|
+
/**
|
|
13574
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FeedbackType)
|
|
13575
|
+
*/
|
|
13576
|
+
export namespace FeedbackType {
|
|
13577
|
+
/**
|
|
13578
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FeedbackType#Feedback)
|
|
13579
|
+
*/
|
|
13580
|
+
export interface Feedback extends globalThis.EnumItem {
|
|
13581
|
+
Name: "Feedback";
|
|
13582
|
+
Value: 0;
|
|
13583
|
+
EnumType: typeof globalThis.Enum.FeedbackType;
|
|
13584
|
+
}
|
|
13585
|
+
export const Feedback: Feedback;
|
|
13586
|
+
/**
|
|
13587
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FeedbackType#PlayerSupport)
|
|
13588
|
+
*/
|
|
13589
|
+
export interface PlayerSupport extends globalThis.EnumItem {
|
|
13590
|
+
Name: "PlayerSupport";
|
|
13591
|
+
Value: 1;
|
|
13592
|
+
EnumType: typeof globalThis.Enum.FeedbackType;
|
|
13593
|
+
}
|
|
13594
|
+
export const PlayerSupport: PlayerSupport;
|
|
13595
|
+
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.FeedbackType>;
|
|
13596
|
+
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.FeedbackType | undefined;
|
|
13597
|
+
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.FeedbackType | undefined;
|
|
13598
|
+
}
|
|
13599
|
+
export type FeedbackType = FeedbackType.Feedback | FeedbackType.PlayerSupport;
|
|
13582
13600
|
/**
|
|
13583
13601
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/FieldOfViewMode)
|
|
13584
13602
|
*/
|
|
@@ -15858,7 +15876,7 @@ declare namespace Enum {
|
|
|
15858
15876
|
}
|
|
15859
15877
|
export const Joined: Joined;
|
|
15860
15878
|
/**
|
|
15861
|
-
* The player submitted a request to join the group.
|
|
15879
|
+
* The player submitted a request to join the group, or already had a pending join request prior to prompting.
|
|
15862
15880
|
*
|
|
15863
15881
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/GroupMembershipStatus#JoinRequestPending)
|
|
15864
15882
|
*/
|
|
@@ -24317,6 +24335,8 @@ declare namespace Enum {
|
|
|
24317
24335
|
*/
|
|
24318
24336
|
export namespace OutfitType {
|
|
24319
24337
|
/**
|
|
24338
|
+
* Returns outfits of every type, with no filtering applied.
|
|
24339
|
+
*
|
|
24320
24340
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/OutfitType#All)
|
|
24321
24341
|
*/
|
|
24322
24342
|
export interface All extends globalThis.EnumItem {
|
|
@@ -24326,6 +24346,8 @@ declare namespace Enum {
|
|
|
24326
24346
|
}
|
|
24327
24347
|
export const All: All;
|
|
24328
24348
|
/**
|
|
24349
|
+
* A full-body avatar outfit.
|
|
24350
|
+
*
|
|
24329
24351
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/OutfitType#Avatar)
|
|
24330
24352
|
*/
|
|
24331
24353
|
export interface Avatar extends globalThis.EnumItem {
|
|
@@ -24335,6 +24357,8 @@ declare namespace Enum {
|
|
|
24335
24357
|
}
|
|
24336
24358
|
export const Avatar: Avatar;
|
|
24337
24359
|
/**
|
|
24360
|
+
* An outfit containing a dynamic head.
|
|
24361
|
+
*
|
|
24338
24362
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/OutfitType#DynamicHead)
|
|
24339
24363
|
*/
|
|
24340
24364
|
export interface DynamicHead extends globalThis.EnumItem {
|
|
@@ -24344,6 +24368,8 @@ declare namespace Enum {
|
|
|
24344
24368
|
}
|
|
24345
24369
|
export const DynamicHead: DynamicHead;
|
|
24346
24370
|
/**
|
|
24371
|
+
* An outfit consisting of a pair of shoes.
|
|
24372
|
+
*
|
|
24347
24373
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/OutfitType#Shoes)
|
|
24348
24374
|
*/
|
|
24349
24375
|
export interface Shoes extends globalThis.EnumItem {
|
|
@@ -24352,11 +24378,22 @@ declare namespace Enum {
|
|
|
24352
24378
|
EnumType: typeof globalThis.Enum.OutfitType;
|
|
24353
24379
|
}
|
|
24354
24380
|
export const Shoes: Shoes;
|
|
24381
|
+
/**
|
|
24382
|
+
* An outfit consisting of makeup items applied to the avatar's face.
|
|
24383
|
+
*
|
|
24384
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/OutfitType#Makeup)
|
|
24385
|
+
*/
|
|
24386
|
+
export interface Makeup extends globalThis.EnumItem {
|
|
24387
|
+
Name: "Makeup";
|
|
24388
|
+
Value: 5;
|
|
24389
|
+
EnumType: typeof globalThis.Enum.OutfitType;
|
|
24390
|
+
}
|
|
24391
|
+
export const Makeup: Makeup;
|
|
24355
24392
|
export function GetEnumItems(this: globalThis.Enum): Array<globalThis.Enum.OutfitType>;
|
|
24356
24393
|
export function FromName(this: globalThis.Enum, name: string): globalThis.Enum.OutfitType | undefined;
|
|
24357
24394
|
export function FromValue(this: globalThis.Enum, value: number): globalThis.Enum.OutfitType | undefined;
|
|
24358
24395
|
}
|
|
24359
|
-
export type OutfitType = OutfitType.All | OutfitType.Avatar | OutfitType.DynamicHead | OutfitType.Shoes;
|
|
24396
|
+
export type OutfitType = OutfitType.All | OutfitType.Avatar | OutfitType.DynamicHead | OutfitType.Shoes | OutfitType.Makeup;
|
|
24360
24397
|
/**
|
|
24361
24398
|
* Sets the layout mode of the output.
|
|
24362
24399
|
*
|
|
@@ -27717,7 +27754,7 @@ declare namespace Enum {
|
|
|
27717
27754
|
}
|
|
27718
27755
|
export const DeveloperProduct: DeveloperProduct;
|
|
27719
27756
|
/**
|
|
27720
|
-
* Used for processing receipts for the user who initiated a Robux transfer. The receipt's `PlayerId` is the sender's user ID and includes a `TransferRequestId` field.
|
|
27757
|
+
* Used for processing receipts for the user who initiated a Robux transfer. The receipt's `PlayerId` is the sender's user ID and includes a `TransferRequestId` field. Delivered immediately if no receiver approval was required, otherwise deferred until the sender's next session join.
|
|
27721
27758
|
*
|
|
27722
27759
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ReceiptType#RobuxTransferSender)
|
|
27723
27760
|
*/
|
|
@@ -27728,7 +27765,7 @@ declare namespace Enum {
|
|
|
27728
27765
|
}
|
|
27729
27766
|
export const RobuxTransferSender: RobuxTransferSender;
|
|
27730
27767
|
/**
|
|
27731
|
-
* Used for processing receipts for the user who received Robux via a transfer. The receipt's `PlayerId` is the receiver's user ID and includes a `TransferRequestId` field.
|
|
27768
|
+
* Used for processing receipts for the user who received Robux via a transfer. The receipt's `PlayerId` is the receiver's user ID and includes a `TransferRequestId` field. Always deferred until the receiver's next session join.
|
|
27732
27769
|
*
|
|
27733
27770
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ReceiptType#RobuxTransferReceiver)
|
|
27734
27771
|
*/
|
|
@@ -27970,6 +28007,8 @@ declare namespace Enum {
|
|
|
27970
28007
|
*/
|
|
27971
28008
|
export namespace RecommendationPreferenceTargetType {
|
|
27972
28009
|
/**
|
|
28010
|
+
* The target is another Roblox user. The `targetId` is the user key.
|
|
28011
|
+
*
|
|
27973
28012
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/RecommendationPreferenceTargetType#User)
|
|
27974
28013
|
*/
|
|
27975
28014
|
export interface User extends globalThis.EnumItem {
|
|
@@ -27979,6 +28018,8 @@ declare namespace Enum {
|
|
|
27979
28018
|
}
|
|
27980
28019
|
export const User: User;
|
|
27981
28020
|
/**
|
|
28021
|
+
* The target is a universe. The `targetId` is the universe ID as a string.
|
|
28022
|
+
*
|
|
27982
28023
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/RecommendationPreferenceTargetType#Universe)
|
|
27983
28024
|
*/
|
|
27984
28025
|
export interface Universe extends globalThis.EnumItem {
|
|
@@ -27988,6 +28029,8 @@ declare namespace Enum {
|
|
|
27988
28029
|
}
|
|
27989
28030
|
export const Universe: Universe;
|
|
27990
28031
|
/**
|
|
28032
|
+
* The target is a custom content tag. The `targetId` is the tag string.
|
|
28033
|
+
*
|
|
27991
28034
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/RecommendationPreferenceTargetType#CustomTag)
|
|
27992
28035
|
*/
|
|
27993
28036
|
export interface CustomTag extends globalThis.EnumItem {
|
|
@@ -28006,6 +28049,8 @@ declare namespace Enum {
|
|
|
28006
28049
|
*/
|
|
28007
28050
|
export namespace RecommendationPreferenceType {
|
|
28008
28051
|
/**
|
|
28052
|
+
* The user started following the target.
|
|
28053
|
+
*
|
|
28009
28054
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/RecommendationPreferenceType#AddFollow)
|
|
28010
28055
|
*/
|
|
28011
28056
|
export interface AddFollow extends globalThis.EnumItem {
|
|
@@ -28015,6 +28060,8 @@ declare namespace Enum {
|
|
|
28015
28060
|
}
|
|
28016
28061
|
export const AddFollow: AddFollow;
|
|
28017
28062
|
/**
|
|
28063
|
+
* The user stopped following the target.
|
|
28064
|
+
*
|
|
28018
28065
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/RecommendationPreferenceType#RemoveFollow)
|
|
28019
28066
|
*/
|
|
28020
28067
|
export interface RemoveFollow extends globalThis.EnumItem {
|
|
@@ -28024,6 +28071,8 @@ declare namespace Enum {
|
|
|
28024
28071
|
}
|
|
28025
28072
|
export const RemoveFollow: RemoveFollow;
|
|
28026
28073
|
/**
|
|
28074
|
+
* The user muted the target.
|
|
28075
|
+
*
|
|
28027
28076
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/RecommendationPreferenceType#AddMute)
|
|
28028
28077
|
*/
|
|
28029
28078
|
export interface AddMute extends globalThis.EnumItem {
|
|
@@ -28033,6 +28082,8 @@ declare namespace Enum {
|
|
|
28033
28082
|
}
|
|
28034
28083
|
export const AddMute: AddMute;
|
|
28035
28084
|
/**
|
|
28085
|
+
* The user unmuted a previously muted target.
|
|
28086
|
+
*
|
|
28036
28087
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/RecommendationPreferenceType#RemoveMute)
|
|
28037
28088
|
*/
|
|
28038
28089
|
export interface RemoveMute extends globalThis.EnumItem {
|