@rbxts/types 1.0.895 → 1.0.901

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.
@@ -93,6 +93,7 @@ interface Services {
93
93
  IncrementalPatchBuilder: IncrementalPatchBuilder;
94
94
  InsertService: InsertService;
95
95
  InstanceExtensionsService: InstanceExtensionsService;
96
+ InstanceFileSyncService: InstanceFileSyncService;
96
97
  InternalSyncService: InternalSyncService;
97
98
  IXPService: IXPService;
98
99
  JointsService: JointsService;
@@ -174,7 +175,9 @@ interface Services {
174
175
  SessionCheckService: SessionCheckService;
175
176
  SessionService: SessionService;
176
177
  SharedTableRegistry: SharedTableRegistry;
178
+ SlimAnimationReplicationService: SlimAnimationReplicationService;
177
179
  SlimContentProvider: SlimContentProvider;
180
+ SlimReplicationService: SlimReplicationService;
178
181
  SlimService: SlimService;
179
182
  SmoothVoxelsUpgraderService: SmoothVoxelsUpgraderService;
180
183
  SnippetService: SnippetService;
@@ -679,6 +682,7 @@ interface Instances extends Services, CreatableInstances {
679
682
  SensorBase: SensorBase;
680
683
  ServiceProvider: ServiceProvider;
681
684
  SlidingBallConstraint: SlidingBallConstraint;
685
+ SlimAnimationDataEntity: SlimAnimationDataEntity;
682
686
  SoundEffect: SoundEffect;
683
687
  StackFrame: StackFrame;
684
688
  StandardPages: StandardPages;
@@ -900,6 +904,8 @@ interface VideoCapture extends Capture {
900
904
  readonly TimeLength: number;
901
905
  }
902
906
  /**
907
+ * A snapshot of configuration values at a given version. Can be player-specific.
908
+ *
903
909
  * - **Tags**: NotCreatable, NotReplicated
904
910
  *
905
911
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot)
@@ -914,6 +920,8 @@ interface ConfigSnapshot extends RBXObject {
914
920
  */
915
921
  readonly _nominal_ConfigSnapshot: unique symbol;
916
922
  /**
923
+ * Populated if snapshot was in an error state.
924
+ *
917
925
  * - **ThreadSafety**: ReadSafe
918
926
  * - **Tags**: NotReplicated
919
927
  *
@@ -921,6 +929,8 @@ interface ConfigSnapshot extends RBXObject {
921
929
  */
922
930
  readonly Error: Enum.ConfigSnapshotErrorState;
923
931
  /**
932
+ * If true, indicates the snapshot is outdated and can be refreshed to newer values.
933
+ *
924
934
  * - **ThreadSafety**: ReadSafe
925
935
  * - **Tags**: NotReplicated
926
936
  *
@@ -928,29 +938,39 @@ interface ConfigSnapshot extends RBXObject {
928
938
  */
929
939
  readonly Outdated: boolean;
930
940
  /**
941
+ * Returns the value for the given key.
942
+ *
931
943
  * - **ThreadSafety**: Unsafe
932
944
  *
933
945
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#GetValue)
934
- * @param this
935
- * @param key
946
+ * @param this A snapshot of configuration values at a given version. Can be player-specific.
947
+ * @param key Key of the configuration to get the value for.
948
+ * @returns The value of the configuration for the given key.
936
949
  */
937
950
  GetValue(this: ConfigSnapshot, key: string): unknown;
938
951
  /**
952
+ * Returns a signal that fires when the value for the given key changes due to a refresh.
953
+ *
939
954
  * - **ThreadSafety**: Unsafe
940
955
  *
941
956
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#GetValueChangedSignal)
942
- * @param this
943
- * @param key
957
+ * @param this A snapshot of configuration values at a given version. Can be player-specific.
958
+ * @param key Key of the configuration to get the change signal for.
959
+ * @returns A `RBXScriptSignal` that fires when the value for the given key changes upon refresh.
944
960
  */
945
961
  GetValueChangedSignal(this: ConfigSnapshot, key: string): RBXScriptSignal;
946
962
  /**
963
+ * Refreshes the snapshot to the latest configuration values.
964
+ *
947
965
  * - **ThreadSafety**: Unsafe
948
966
  *
949
967
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#Refresh)
950
- * @param this
968
+ * @param this A snapshot of configuration values at a given version. Can be player-specific.
951
969
  */
952
970
  Refresh(this: ConfigSnapshot): void;
953
971
  /**
972
+ * Fires when a newer version of the configuration is available.
973
+ *
954
974
  * - **ThreadSafety**: Unsafe
955
975
  *
956
976
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#UpdateAvailable)
@@ -1032,7 +1052,7 @@ interface EditableImage extends RBXObject {
1032
1052
  * @param brushConfig Brush configuration dictionary including the following key-value pairs: - `AlphaBlendType` (`ImageAlphaType`) which determines how this projection will blend alpha values.
1033
1053
  * - `ColorBlendType` (`ImageCombineType`) which determines how this projection will blend color values.
1034
1054
  * - `Decal` (`EditableImage`) as the image used for projection.
1035
- * - `FadeAngle` (number) as the angle in degrees for the projection edges to fall off.
1055
+ * - `FadeAngle` (number) as the angle in degrees for the projection edges to start to fall off. The projection will be fully faded out at 90 degrees. An angle of 0 means fading starts immediately at 0 degrees and an angle of 90 means no fading but instead a hard edge at 90 degrees. An angle of 70 degrees would mean the projection starts to fade at 70 degrees and is fully faded out at 90 degrees.
1036
1056
  * - `BlendIntensity` (number) as the value between `0` and `1` which controls how much of the projection is blended into the resulting image.
1037
1057
  */
1038
1058
  DrawImageProjected(this: EditableImage, mesh: EditableMesh, projection: DrawImageProjectedProjection, brushConfig: DrawImageProjectedBrushConfig): void;
@@ -3378,6 +3398,8 @@ interface AnimationClipProvider extends Instance {
3378
3398
  */
3379
3399
  GetAnimationClipAsync(this: AnimationClipProvider, assetId: ContentId): AnimationClip;
3380
3400
  /**
3401
+ * **Deprecated:**
3402
+ *
3381
3403
  * This function returns an `InventoryPages` object which can be used to iterate over animations owned by a specific user.
3382
3404
  *
3383
3405
  * - **ThreadSafety**: Unsafe
@@ -3387,8 +3409,22 @@ interface AnimationClipProvider extends Instance {
3387
3409
  * @param this Provides functions to load and preview `AnimationClips`.
3388
3410
  * @param userId The user ID of the user.
3389
3411
  * @returns An `InventoryPages` of animations.
3412
+ *
3413
+ * @deprecated GetAnimationsAsync
3390
3414
  */
3391
3415
  GetAnimations(this: AnimationClipProvider, userId: number): Instance | undefined;
3416
+ /**
3417
+ * This function returns an `InventoryPages` object which can be used to iterate over animations owned by a specific user.
3418
+ *
3419
+ * - **ThreadSafety**: Unsafe
3420
+ * - **Tags**: Yields
3421
+ *
3422
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationClipProvider#GetAnimationsAsync)
3423
+ * @param this Provides functions to load and preview `AnimationClips`.
3424
+ * @param userId The user ID of the user.
3425
+ * @returns An `InventoryPages` of animations.
3426
+ */
3427
+ GetAnimationsAsync(this: AnimationClipProvider, userId: number): Instance | undefined;
3392
3428
  /**
3393
3429
  * - **ThreadSafety**: Unsafe
3394
3430
  * - **Tags**: Yields
@@ -3729,12 +3765,15 @@ interface AnimationTrack extends Instance {
3729
3765
  * - **ThreadSafety**: Unsafe
3730
3766
  *
3731
3767
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#GetParameter)
3768
+ * @param this Controls the playback of an animation on an `Animator`.
3769
+ * @param key
3732
3770
  */
3733
3771
  GetParameter(this: AnimationTrack, key: string): unknown;
3734
3772
  /**
3735
3773
  * - **ThreadSafety**: Unsafe
3736
3774
  *
3737
3775
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#GetParameterDefaults)
3776
+ * @param this Controls the playback of an animation on an `Animator`.
3738
3777
  */
3739
3778
  GetParameterDefaults(this: AnimationTrack): object;
3740
3779
  /**
@@ -3780,6 +3819,9 @@ interface AnimationTrack extends Instance {
3780
3819
  * - **ThreadSafety**: Unsafe
3781
3820
  *
3782
3821
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#SetParameter)
3822
+ * @param this Controls the playback of an animation on an `Animator`.
3823
+ * @param key
3824
+ * @param value
3783
3825
  */
3784
3826
  SetParameter(this: AnimationTrack, key: string, value: unknown): void;
3785
3827
  /**
@@ -4322,6 +4364,8 @@ interface AssetService extends Instance {
4322
4364
  */
4323
4365
  CreateSurfaceAppearanceAsync(this: AssetService, content: object): SurfaceAppearance;
4324
4366
  /**
4367
+ * **Deprecated:**
4368
+ *
4325
4369
  * Returns an array of asset IDs that are contained in a specified package.
4326
4370
  *
4327
4371
  * - **ThreadSafety**: Unsafe
@@ -4331,8 +4375,22 @@ interface AssetService extends Instance {
4331
4375
  * @param this A non-replicated service that handles asset-related queries to the Roblox web API.
4332
4376
  * @param packageAssetId
4333
4377
  * @returns Asset IDs that are contained in a specified package.
4378
+ *
4379
+ * @deprecated GetAssetIdsForPackageAsync
4334
4380
  */
4335
4381
  GetAssetIdsForPackage(this: AssetService, packageAssetId: number): Array<number>;
4382
+ /**
4383
+ * Returns an array of asset IDs that are contained in a specified package.
4384
+ *
4385
+ * - **ThreadSafety**: Unsafe
4386
+ * - **Tags**: Yields
4387
+ *
4388
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#GetAssetIdsForPackageAsync)
4389
+ * @param this A non-replicated service that handles asset-related queries to the Roblox web API.
4390
+ * @param packageAssetId
4391
+ * @returns Asset IDs that are contained in a specified package.
4392
+ */
4393
+ GetAssetIdsForPackageAsync(this: AssetService, packageAssetId: number): Array<unknown>;
4336
4394
  /**
4337
4395
  * Provides relevant metadata about a specific audio source.
4338
4396
  *
@@ -4446,6 +4504,8 @@ interface AssetService extends Instance {
4446
4504
  */
4447
4505
  SavePlaceAsync(this: AssetService, requestParameters?: object): void;
4448
4506
  /**
4507
+ * **Deprecated:**
4508
+ *
4449
4509
  * Finds audio assets matching a variety of search criteria.
4450
4510
  *
4451
4511
  * - **ThreadSafety**: Unsafe
@@ -4454,8 +4514,21 @@ interface AssetService extends Instance {
4454
4514
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#SearchAudio)
4455
4515
  * @param this A non-replicated service that handles asset-related queries to the Roblox web API.
4456
4516
  * @param searchParameters
4517
+ *
4518
+ * @deprecated SearchAudioAsync
4457
4519
  */
4458
4520
  SearchAudio(this: AssetService, searchParameters: AudioSearchParams): AudioPages;
4521
+ /**
4522
+ * Finds audio assets matching a variety of search criteria.
4523
+ *
4524
+ * - **ThreadSafety**: Unsafe
4525
+ * - **Tags**: Yields
4526
+ *
4527
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#SearchAudioAsync)
4528
+ * @param this A non-replicated service that handles asset-related queries to the Roblox web API.
4529
+ * @param searchParameters
4530
+ */
4531
+ SearchAudioAsync(this: AssetService, searchParameters: AudioSearchParams): AudioPages;
4459
4532
  }
4460
4533
  /**
4461
4534
  * The `Atmosphere` object pushes Roblox closer toward realistic environments where sunlight scatters in different ways depending on density and other air particle properties.
@@ -6334,6 +6407,8 @@ interface AudioPlayer extends Instance {
6334
6407
  */
6335
6408
  AutoLoad: boolean;
6336
6409
  /**
6410
+ * Denotes whether this `AudioPlayer` starts playing as soon as it spawns in for the first time.
6411
+ *
6337
6412
  * - **ThreadSafety**: ReadSafe
6338
6413
  *
6339
6414
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#AutoPlay)
@@ -7152,18 +7227,22 @@ interface AudioTremolo extends Instance {
7152
7227
  * - **ThreadSafety**: Unsafe
7153
7228
  *
7154
7229
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#GetConnectedWires)
7230
+ * @param this Creates a trembling effect on a sound by varying the volume of the sound up and down.
7231
+ * @param pin
7155
7232
  */
7156
7233
  GetConnectedWires(this: AudioTremolo, pin: string): Array<Instance>;
7157
7234
  /**
7158
7235
  * - **ThreadSafety**: Unsafe
7159
7236
  *
7160
7237
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#GetInputPins)
7238
+ * @param this Creates a trembling effect on a sound by varying the volume of the sound up and down.
7161
7239
  */
7162
7240
  GetInputPins(this: AudioTremolo): Array<unknown>;
7163
7241
  /**
7164
7242
  * - **ThreadSafety**: Unsafe
7165
7243
  *
7166
7244
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#GetOutputPins)
7245
+ * @param this Creates a trembling effect on a sound by varying the volume of the sound up and down.
7167
7246
  */
7168
7247
  GetOutputPins(this: AudioTremolo): Array<unknown>;
7169
7248
  /**
@@ -7841,6 +7920,8 @@ interface AvatarEditorService extends Instance {
7841
7920
  */
7842
7921
  PromptUpdateOutfit(this: AvatarEditorService, outfitId: number, updatedOutfit: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>): void;
7843
7922
  /**
7923
+ * **Deprecated:**
7924
+ *
7844
7925
  * Used to apply default clothing to the `HumanoidDescription` if necessary.
7845
7926
  *
7846
7927
  * - **ThreadSafety**: Unsafe
@@ -7850,18 +7931,47 @@ interface AvatarEditorService extends Instance {
7850
7931
  * @param this A service to support developer Avatar Editors.
7851
7932
  * @param humanoidDescription The HumanoidDescription to check if default clothing is required.
7852
7933
  * @returns Returns a HumanoidDescription if default clothing was necessary. Otherwise returns `nil`.
7934
+ *
7935
+ * @deprecated CheckApplyDefaultClothingAsync
7853
7936
  */
7854
7937
  CheckApplyDefaultClothing(this: AvatarEditorService, humanoidDescription: HumanoidDescription): HumanoidDescription | undefined;
7855
7938
  /**
7939
+ * Used to apply default clothing to the `HumanoidDescription` if necessary.
7940
+ *
7941
+ * - **ThreadSafety**: Unsafe
7942
+ * - **Tags**: Yields
7943
+ *
7944
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#CheckApplyDefaultClothingAsync)
7945
+ * @param this A service to support developer Avatar Editors.
7946
+ * @param humanoidDescription The HumanoidDescription to check if default clothing is required.
7947
+ * @returns Returns a HumanoidDescription if default clothing was necessary. Otherwise returns `nil`.
7948
+ */
7949
+ CheckApplyDefaultClothingAsync(this: AvatarEditorService, humanoidDescription: HumanoidDescription): HumanoidDescription;
7950
+ /**
7951
+ * **Deprecated:**
7952
+ *
7856
7953
  * - **ThreadSafety**: Unsafe
7857
7954
  * - **Tags**: Yields
7858
7955
  *
7859
7956
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#ConformToAvatarRules)
7860
7957
  * @param this A service to support developer Avatar Editors.
7861
7958
  * @param humanoidDescription
7959
+ *
7960
+ * @deprecated ConformToAvatarRulesAsync
7862
7961
  */
7863
7962
  ConformToAvatarRules(this: AvatarEditorService, humanoidDescription: HumanoidDescription): HumanoidDescription;
7864
7963
  /**
7964
+ * - **ThreadSafety**: Unsafe
7965
+ * - **Tags**: Yields
7966
+ *
7967
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#ConformToAvatarRulesAsync)
7968
+ * @param this A service to support developer Avatar Editors.
7969
+ * @param humanoidDescription
7970
+ */
7971
+ ConformToAvatarRulesAsync(this: AvatarEditorService, humanoidDescription: HumanoidDescription): HumanoidDescription;
7972
+ /**
7973
+ * **Deprecated:**
7974
+ *
7865
7975
  * Returns the platform Avatar rules for things such as scaling, default shirts and pants, number of wearable assets.
7866
7976
  *
7867
7977
  * - **ThreadSafety**: Unsafe
@@ -7870,9 +7980,24 @@ interface AvatarEditorService extends Instance {
7870
7980
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetAvatarRules)
7871
7981
  * @param this A service to support developer Avatar Editors.
7872
7982
  * @returns A dictionary containing the platform Avatar rules for things like scaling, default shirts and pants, number of wearable assets, ect. See the example return in the main description above.
7983
+ *
7984
+ * @deprecated GetAvatarRulesAsync
7873
7985
  */
7874
7986
  GetAvatarRules(this: AvatarEditorService): AvatarRules;
7875
7987
  /**
7988
+ * Returns the platform Avatar rules for things such as scaling, default shirts and pants, number of wearable assets.
7989
+ *
7990
+ * - **ThreadSafety**: Unsafe
7991
+ * - **Tags**: Yields
7992
+ *
7993
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetAvatarRulesAsync)
7994
+ * @param this A service to support developer Avatar Editors.
7995
+ * @returns A dictionary containing the platform Avatar rules for things like scaling, default shirts and pants, number of wearable assets, ect. See the example return in the main description above.
7996
+ */
7997
+ GetAvatarRulesAsync(this: AvatarEditorService): object;
7998
+ /**
7999
+ * **Deprecated:**
8000
+ *
7876
8001
  * Gets the item details for a list of items at once.
7877
8002
  *
7878
8003
  * - **ThreadSafety**: Unsafe
@@ -7886,11 +8011,31 @@ interface AvatarEditorService extends Instance {
7886
8011
  * ```lua
7887
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 }
7888
8013
  * ``` .
8014
+ *
8015
+ * @deprecated GetBatchItemDetailsAsync
7889
8016
  */
7890
8017
  GetBatchItemDetails(this: AvatarEditorService, itemIds: ReadonlyArray<number>, itemType: CastsToEnum<Enum.AvatarItemType.Asset>): ReadonlyArray<AssetItemDetails>;
7891
8018
  GetBatchItemDetails(this: AvatarEditorService, itemIds: ReadonlyArray<number>, itemType: CastsToEnum<Enum.AvatarItemType.Bundle>): ReadonlyArray<BundleItemDetails>;
7892
8019
  GetBatchItemDetails(this: AvatarEditorService, itemIds: ReadonlyArray<number>, itemType: CastsToEnum<Enum.AvatarItemType>): ReadonlyArray<ItemDetails>;
7893
8020
  /**
8021
+ * Gets the item details for a list of items at once.
8022
+ *
8023
+ * - **ThreadSafety**: Unsafe
8024
+ * - **Tags**: Yields
8025
+ *
8026
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetBatchItemDetailsAsync)
8027
+ * @param this A service to support developer Avatar Editors.
8028
+ * @param itemIds The list of item ids to get details of.
8029
+ * @param itemType The type of the item ids provided.
8030
+ * @returns Returns an array of item details with the following fields:
8031
+ * ```lua
8032
+ * { "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 }
8033
+ * ``` .
8034
+ */
8035
+ GetBatchItemDetailsAsync(this: AvatarEditorService, itemIds: Array<unknown>, itemType: CastsToEnum<Enum.AvatarItemType>): Array<unknown>;
8036
+ /**
8037
+ * **Deprecated:**
8038
+ *
7894
8039
  * Returns if the `Players.LocalPlayer` has favorited the given bundle or asset.
7895
8040
  *
7896
8041
  * - **ThreadSafety**: Unsafe
@@ -7901,9 +8046,26 @@ interface AvatarEditorService extends Instance {
7901
8046
  * @param itemId The ID of the specified asset or bundle.
7902
8047
  * @param itemType The `AvatarItemType` of the specified asset or bundle.
7903
8048
  * @returns Whether the `LocalPlayer` has favorited the given bundle or asset.
8049
+ *
8050
+ * @deprecated GetFavoriteAsync
7904
8051
  */
7905
8052
  GetFavorite(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType>): boolean;
7906
8053
  /**
8054
+ * Returns if the `Players.LocalPlayer` has favorited the given bundle or asset.
8055
+ *
8056
+ * - **ThreadSafety**: Unsafe
8057
+ * - **Tags**: Yields
8058
+ *
8059
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetFavoriteAsync)
8060
+ * @param this A service to support developer Avatar Editors.
8061
+ * @param itemId The ID of the specified asset or bundle.
8062
+ * @param itemType The `AvatarItemType` of the specified asset or bundle.
8063
+ * @returns Whether the `LocalPlayer` has favorited the given bundle or asset.
8064
+ */
8065
+ GetFavoriteAsync(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType>): boolean;
8066
+ /**
8067
+ * **Deprecated:**
8068
+ *
7907
8069
  * Returns an `InventoryPages` object with information about owned items in the users inventory with the given AvatarAssetTypes.
7908
8070
  *
7909
8071
  * - **ThreadSafety**: Unsafe
@@ -7912,6 +8074,8 @@ interface AvatarEditorService extends Instance {
7912
8074
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetInventory)
7913
8075
  * @param this A service to support developer Avatar Editors.
7914
8076
  * @param assetTypes The `AvatarAssetType` that can will be checked for in the player's inventory.
8077
+ *
8078
+ * @deprecated GetInventoryAsync
7915
8079
  */
7916
8080
  GetInventory(this: AvatarEditorService, assetTypes: ReadonlyArray<Enum.AvatarAssetType>): InventoryPages<{
7917
8081
  AssetId: number;
@@ -7920,6 +8084,19 @@ interface AvatarEditorService extends Instance {
7920
8084
  Name: string;
7921
8085
  }>;
7922
8086
  /**
8087
+ * Returns an `InventoryPages` object with information about owned items in the users inventory with the given AvatarAssetTypes.
8088
+ *
8089
+ * - **ThreadSafety**: Unsafe
8090
+ * - **Tags**: Yields
8091
+ *
8092
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetInventoryAsync)
8093
+ * @param this A service to support developer Avatar Editors.
8094
+ * @param assetTypes The `AvatarAssetType` that can will be checked for in the player's inventory.
8095
+ */
8096
+ GetInventoryAsync(this: AvatarEditorService, assetTypes: Array<unknown>): InventoryPages;
8097
+ /**
8098
+ * **Deprecated:**
8099
+ *
7923
8100
  * Returns the item details for the given item.
7924
8101
  *
7925
8102
  * - **ThreadSafety**: Unsafe
@@ -7930,11 +8107,28 @@ interface AvatarEditorService extends Instance {
7930
8107
  * @param itemId The ID of the item whose details are being retrieved.
7931
8108
  * @param itemType An enum value indicating the type of item whose details are being retrieved.
7932
8109
  * @returns A table containing the item info for the retrieved item. See above for a sample table.
8110
+ *
8111
+ * @deprecated GetItemDetailsAsync
7933
8112
  */
7934
8113
  GetItemDetails(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType.Asset>): AssetItemDetails;
7935
8114
  GetItemDetails(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType.Bundle>): BundleItemDetails;
7936
8115
  GetItemDetails(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType>): ItemDetails;
7937
8116
  /**
8117
+ * Returns the item details for the given item.
8118
+ *
8119
+ * - **ThreadSafety**: Unsafe
8120
+ * - **Tags**: Yields
8121
+ *
8122
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetItemDetailsAsync)
8123
+ * @param this A service to support developer Avatar Editors.
8124
+ * @param itemId The ID of the item whose details are being retrieved.
8125
+ * @param itemType An enum value indicating the type of item whose details are being retrieved.
8126
+ * @returns A table containing the item info for the retrieved item. See above for a sample table.
8127
+ */
8128
+ GetItemDetailsAsync(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType>): object;
8129
+ /**
8130
+ * **Deprecated:**
8131
+ *
7938
8132
  * Returns the outfit details for the given outfit.
7939
8133
  *
7940
8134
  * - **ThreadSafety**: Unsafe
@@ -7944,9 +8138,25 @@ interface AvatarEditorService extends Instance {
7944
8138
  * @param this A service to support developer Avatar Editors.
7945
8139
  * @param outfitId The ID of the outfit whose details are being retrieved.
7946
8140
  * @returns A table containing the outfit info for the retrieved outfit. See above for a sample table.
8141
+ *
8142
+ * @deprecated GetOutfitDetailsAsync
7947
8143
  */
7948
8144
  GetOutfitDetails(this: AvatarEditorService, outfitId: number): object;
7949
8145
  /**
8146
+ * Returns the outfit details for the given outfit.
8147
+ *
8148
+ * - **ThreadSafety**: Unsafe
8149
+ * - **Tags**: Yields
8150
+ *
8151
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetOutfitDetailsAsync)
8152
+ * @param this A service to support developer Avatar Editors.
8153
+ * @param outfitId The ID of the outfit whose details are being retrieved.
8154
+ * @returns A table containing the outfit info for the retrieved outfit. See above for a sample table.
8155
+ */
8156
+ GetOutfitDetailsAsync(this: AvatarEditorService, outfitId: number): object;
8157
+ /**
8158
+ * **Deprecated:**
8159
+ *
7950
8160
  * Returns outfit data for the `Players.LocalPlayer`.
7951
8161
  *
7952
8162
  * - **ThreadSafety**: Unsafe
@@ -7956,9 +8166,25 @@ interface AvatarEditorService extends Instance {
7956
8166
  * @param this A service to support developer Avatar Editors.
7957
8167
  * @param outfitSource
7958
8168
  * @param outfitType
8169
+ *
8170
+ * @deprecated GetOutfitsAsync
7959
8171
  */
7960
8172
  GetOutfits(this: AvatarEditorService, outfitSource?: CastsToEnum<Enum.OutfitSource>, outfitType?: CastsToEnum<Enum.OutfitType>): OutfitPages;
7961
8173
  /**
8174
+ * Returns outfit data for the `Players.LocalPlayer`.
8175
+ *
8176
+ * - **ThreadSafety**: Unsafe
8177
+ * - **Tags**: Yields
8178
+ *
8179
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetOutfitsAsync)
8180
+ * @param this A service to support developer Avatar Editors.
8181
+ * @param outfitSource
8182
+ * @param outfitType
8183
+ */
8184
+ GetOutfitsAsync(this: AvatarEditorService, outfitSource?: CastsToEnum<Enum.OutfitSource>, outfitType?: CastsToEnum<Enum.OutfitType>): OutfitPages;
8185
+ /**
8186
+ * **Deprecated:**
8187
+ *
7962
8188
  * Returns a list of recommended assets based on a given `AssetType` and asset ID.
7963
8189
  *
7964
8190
  * - **ThreadSafety**: Unsafe
@@ -7969,9 +8195,26 @@ interface AvatarEditorService extends Instance {
7969
8195
  * @param assetType The type of asset recommendations to retrieve recommendations for. Only affects the response when item based recommendations don't exist for the given `contextAssetId`.
7970
8196
  * @param contextAssetId The ID of an asset with a type matching the provided assetType used for context when retrieving recommendations.
7971
8197
  * @returns A list of recommendations based on the given `AssetType`.
8198
+ *
8199
+ * @deprecated GetRecommendedAssetsAsync
7972
8200
  */
7973
8201
  GetRecommendedAssets(this: AvatarEditorService, assetType: CastsToEnum<Enum.AvatarAssetType>, contextAssetId?: number): ReadonlyArray<RecommendedAsset>;
7974
8202
  /**
8203
+ * Returns a list of recommended assets based on a given `AssetType` and asset ID.
8204
+ *
8205
+ * - **ThreadSafety**: Unsafe
8206
+ * - **Tags**: Yields
8207
+ *
8208
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetRecommendedAssetsAsync)
8209
+ * @param this A service to support developer Avatar Editors.
8210
+ * @param assetType The type of asset recommendations to retrieve recommendations for. Only affects the response when item based recommendations don't exist for the given `contextAssetId`.
8211
+ * @param contextAssetId The ID of an asset with a type matching the provided assetType used for context when retrieving recommendations.
8212
+ * @returns A list of recommendations based on the given `AssetType`.
8213
+ */
8214
+ GetRecommendedAssetsAsync(this: AvatarEditorService, assetType: CastsToEnum<Enum.AvatarAssetType>, contextAssetId?: number): Array<unknown>;
8215
+ /**
8216
+ * **Deprecated:**
8217
+ *
7975
8218
  * Returns a list of recommended bundles for a given bundle id.
7976
8219
  *
7977
8220
  * - **ThreadSafety**: Unsafe
@@ -7981,9 +8224,25 @@ interface AvatarEditorService extends Instance {
7981
8224
  * @param this A service to support developer Avatar Editors.
7982
8225
  * @param bundleId A list of recommended bundles.
7983
8226
  * @returns The bundle ID that the recommended bundles will be returned for.
8227
+ *
8228
+ * @deprecated GetRecommendedBundlesAsync
7984
8229
  */
7985
8230
  GetRecommendedBundles(this: AvatarEditorService, bundleId: number): ReadonlyArray<RecommendedBundle>;
7986
8231
  /**
8232
+ * Returns a list of recommended bundles for a given bundle id.
8233
+ *
8234
+ * - **ThreadSafety**: Unsafe
8235
+ * - **Tags**: Yields
8236
+ *
8237
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetRecommendedBundlesAsync)
8238
+ * @param this A service to support developer Avatar Editors.
8239
+ * @param bundleId A list of recommended bundles.
8240
+ * @returns The bundle ID that the recommended bundles will be returned for.
8241
+ */
8242
+ GetRecommendedBundlesAsync(this: AvatarEditorService, bundleId: number): Array<unknown>;
8243
+ /**
8244
+ * **Deprecated:**
8245
+ *
7987
8246
  * Returns a `CatalogPages` object containing the result of the given search.
7988
8247
  *
7989
8248
  * - **ThreadSafety**: Unsafe
@@ -7992,8 +8251,21 @@ interface AvatarEditorService extends Instance {
7992
8251
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#SearchCatalog)
7993
8252
  * @param this A service to support developer Avatar Editors.
7994
8253
  * @param searchParameters An object containing the parameters used for the search.
8254
+ *
8255
+ * @deprecated SearchCatalogAsync
7995
8256
  */
7996
8257
  SearchCatalog(this: AvatarEditorService, searchParameters: CatalogSearchParams): CatalogPages;
8258
+ /**
8259
+ * Returns a `CatalogPages` object containing the result of the given search.
8260
+ *
8261
+ * - **ThreadSafety**: Unsafe
8262
+ * - **Tags**: Yields
8263
+ *
8264
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#SearchCatalogAsync)
8265
+ * @param this A service to support developer Avatar Editors.
8266
+ * @param searchParameters An object containing the parameters used for the search.
8267
+ */
8268
+ SearchCatalogAsync(this: AvatarEditorService, searchParameters: CatalogSearchParams): CatalogPages;
7997
8269
  /**
7998
8270
  * Fires when the `AvatarEditorService:PromptAllowInventoryReadAccess()` prompt is responded to by the user.
7999
8271
  *
@@ -8126,6 +8398,8 @@ interface BadgeService extends Instance {
8126
8398
  */
8127
8399
  readonly _nominal_BadgeService: unique symbol;
8128
8400
  /**
8401
+ * **Deprecated:**
8402
+ *
8129
8403
  * Award a badge to a player given the ID of each.
8130
8404
  *
8131
8405
  * - **ThreadSafety**: Unsafe
@@ -8136,8 +8410,23 @@ interface BadgeService extends Instance {
8136
8410
  * @param userId The `Player.UserId` of the user the badge is to be awarded to.
8137
8411
  * @param badgeId The ID of the badge to be awarded.
8138
8412
  * @returns Boolean of `true` if the badge was awarded successfully.
8413
+ *
8414
+ * @deprecated AwardBadgeAsync
8139
8415
  */
8140
8416
  AwardBadge(this: BadgeService, userId: number, badgeId: number): boolean;
8417
+ /**
8418
+ * Award a badge to a player given the ID of each.
8419
+ *
8420
+ * - **ThreadSafety**: Unsafe
8421
+ * - **Tags**: Yields
8422
+ *
8423
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BadgeService#AwardBadgeAsync)
8424
+ * @param this Provides information on badges and awards them.
8425
+ * @param userId The `Player.UserId` of the user the badge is to be awarded to.
8426
+ * @param badgeId The ID of the badge to be awarded.
8427
+ * @returns Boolean of `true` if the badge was awarded successfully.
8428
+ */
8429
+ AwardBadgeAsync(this: BadgeService, userId: number, badgeId: number): boolean;
8141
8430
  /**
8142
8431
  * Checks a list of badge IDs against a `UserId` and returns a list of badge IDs that the player owns.
8143
8432
  *
@@ -10175,8 +10464,8 @@ interface CaptureService extends Instance {
10175
10464
  *
10176
10465
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#PromptSaveCapturesToGallery)
10177
10466
  * @param this A service which provides control over screenshot and video capture features.
10178
- * @param captures
10179
- * @param resultCallback A callback function that will be invoked with a dictionary mapping each `contentId` to a boolean indicating if the user accepted saving that capture.
10467
+ * @param captures An array of content IDs and/or `Capture` objects.
10468
+ * @param resultCallback A callback function that will be invoked with a dictionary mapping each `contentId` and/or `Capture` object to a boolean indicating if the user accepted saving that capture.
10180
10469
  */
10181
10470
  PromptSaveCapturesToGallery<T extends string>(this: CaptureService, contentIds: Array<T>, resultCallback: (results: Record<T, boolean>) => void): void;
10182
10471
  /**
@@ -10186,7 +10475,7 @@ interface CaptureService extends Instance {
10186
10475
  *
10187
10476
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#PromptShareCapture)
10188
10477
  * @param this A service which provides control over screenshot and video capture features.
10189
- * @param captureContent
10478
+ * @param captureContent A `Content` containing a `contentId` or `Capture` object.
10190
10479
  * @param launchData An optional string to include as launch data in the invite link.
10191
10480
  * @param onAcceptedCallback An optional callback function invoked if the user accepts sharing.
10192
10481
  * @param onDeniedCallback An optional callback function invoked if the user denies sharing.
@@ -10252,7 +10541,7 @@ interface CaptureService extends Instance {
10252
10541
  *
10253
10542
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#StartVideoCaptureAsync)
10254
10543
  * @param this A service which provides control over screenshot and video capture features.
10255
- * @param onCaptureReady
10544
+ * @param onCaptureReady A callback function that is called on video capture completion with a `VideoCaptureResult` and, if successful, a `VideoCapture`.
10256
10545
  * @param captureParams
10257
10546
  */
10258
10547
  StartVideoCaptureAsync(this: CaptureService, onCaptureReady: Callback, captureParams?: object): Enum.VideoCaptureStartedResult;
@@ -11546,6 +11835,8 @@ interface CommerceService extends Instance {
11546
11835
  readonly PromptCommerceProductPurchaseFinished: RBXScriptSignal<(user: Player, productId: string) => void>;
11547
11836
  }
11548
11837
  /**
11838
+ * An animation curve that groups child `FloatCurves` which each animate a different component of a non-unary value.
11839
+ *
11549
11840
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CompositeValueCurve)
11550
11841
  */
11551
11842
  interface CompositeValueCurve extends Instance {
@@ -11558,25 +11849,37 @@ interface CompositeValueCurve extends Instance {
11558
11849
  */
11559
11850
  readonly _nominal_CompositeValueCurve: unique symbol;
11560
11851
  /**
11852
+ * The type of value animated by this `CompositeValueCurve`.
11853
+ *
11561
11854
  * - **ThreadSafety**: ReadSafe
11562
11855
  *
11563
11856
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CompositeValueCurve#CurveType)
11564
11857
  */
11565
11858
  CurveType: Enum.CompositeValueCurveType;
11566
11859
  /**
11860
+ * Returns the child curves with the given names for the `CurveType` of this `CompositeValueCurve`.
11861
+ *
11567
11862
  * - **ThreadSafety**: Unsafe
11568
11863
  *
11569
11864
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CompositeValueCurve#GetComponentCurves)
11865
+ * @param this An animation curve that groups child `FloatCurves` which each animate a different component of a non-unary value.
11570
11866
  */
11571
11867
  GetComponentCurves(this: CompositeValueCurve): Array<Instance>;
11572
11868
  /**
11869
+ * Returns the sampled animated value at the passed `time` argument.
11870
+ *
11573
11871
  * - **ThreadSafety**: Unsafe
11574
11872
  *
11575
11873
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CompositeValueCurve#GetValueAtTime)
11874
+ * @param this An animation curve that groups child `FloatCurves` which each animate a different component of a non-unary value.
11875
+ * @param time Time at which to get the value.
11876
+ * @returns The value of the curve at the passed time.
11576
11877
  */
11577
11878
  GetValueAtTime(this: CompositeValueCurve, time: number): unknown;
11578
11879
  }
11579
11880
  /**
11881
+ * A game service that gives access to in-experience configuration with updates in real time.
11882
+ *
11580
11883
  * - **Tags**: NotCreatable, Service, NotReplicated
11581
11884
  *
11582
11885
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigService)
@@ -11591,37 +11894,47 @@ interface ConfigService extends Instance {
11591
11894
  */
11592
11895
  readonly _nominal_ConfigService: unique symbol;
11593
11896
  /**
11897
+ * Clears current testing value for the given key.
11898
+ *
11594
11899
  * - **ThreadSafety**: Unsafe
11595
11900
  *
11596
11901
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigService#ClearTestingValue)
11597
- * @param this
11598
- * @param key
11902
+ * @param this A game service that gives access to in-experience configuration with updates in real time.
11903
+ * @param key Key of the configuration to clear testing value for.
11599
11904
  */
11600
11905
  ClearTestingValue(this: ConfigService, key: string): void;
11601
11906
  /**
11907
+ * Sets a testing override for the given key.
11908
+ *
11602
11909
  * - **ThreadSafety**: Unsafe
11603
11910
  *
11604
11911
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigService#SetTestingValue)
11605
- * @param this
11606
- * @param key
11607
- * @param value
11912
+ * @param this A game service that gives access to in-experience configuration with updates in real time.
11913
+ * @param key Key of the configuration to override with a testing value.
11914
+ * @param value Value to set as the testing override.
11608
11915
  */
11609
11916
  SetTestingValue(this: ConfigService, key: string, value: unknown): void;
11610
11917
  /**
11918
+ * Retrieves a snapshot of the latest configuration.
11919
+ *
11611
11920
  * - **ThreadSafety**: Unsafe
11612
11921
  * - **Tags**: Yields
11613
11922
  *
11614
11923
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigService#GetConfigAsync)
11615
- * @param this
11924
+ * @param this A game service that gives access to in-experience configuration with updates in real time.
11925
+ * @returns A `ConfigSnapshot` instance with the latest configuration.
11616
11926
  */
11617
11927
  GetConfigAsync(this: ConfigService): ConfigSnapshot;
11618
11928
  /**
11929
+ * Retrieves a snapshot of the latest configuration for a specific player.
11930
+ *
11619
11931
  * - **ThreadSafety**: Unsafe
11620
11932
  * - **Tags**: Yields
11621
11933
  *
11622
11934
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigService#GetConfigForPlayerAsync)
11623
- * @param this
11624
- * @param player
11935
+ * @param this A game service that gives access to in-experience configuration with updates in real time.
11936
+ * @param player The player to get the configuration for.
11937
+ * @returns A `ConfigSnapshot` instance with the latest configuration targeted to the player.
11625
11938
  */
11626
11939
  GetConfigForPlayerAsync(this: ConfigService, player: Player): ConfigSnapshot;
11627
11940
  }
@@ -12027,6 +12340,8 @@ interface AngularVelocity extends Constraint {
12027
12340
  /**
12028
12341
  * Aligns two `BaseParts` with an animate-able kinematic or force-based joint.
12029
12342
  *
12343
+ * - **Tags**: NotBrowsable
12344
+ *
12030
12345
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationConstraint)
12031
12346
  */
12032
12347
  interface AnimationConstraint extends Constraint {
@@ -16616,6 +16931,10 @@ interface GenerationService extends Instance {
16616
16931
  * - **Tags**: Yields
16617
16932
  *
16618
16933
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#GenerateModelAsync)
16934
+ * @param this Service that allows developers to generate 3D objects from text prompts.
16935
+ * @param inputs
16936
+ * @param schema
16937
+ * @param options
16619
16938
  */
16620
16939
  GenerateModelAsync(this: GenerationService, inputs: object, schema: object, options?: object): unknown;
16621
16940
  /**
@@ -17133,10 +17452,15 @@ interface GroupService extends Instance {
17133
17452
  */
17134
17453
  GetGroupsAsync(this: GroupService, userId: number): Array<GetGroupsAsyncResult>;
17135
17454
  /**
17455
+ * Prompts the local `Player` to join a specified Roblox group via a native modal.
17456
+ *
17136
17457
  * - **ThreadSafety**: Unsafe
17137
17458
  * - **Tags**: Yields
17138
17459
  *
17139
17460
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GroupService#PromptJoinAsync)
17461
+ * @param this GroupService is a service that allows developers to fetch information about a Roblox group from within a game.
17462
+ * @param groupId ID of the group to prompt the player to join. This must be a valid group ID.
17463
+ * @returns `GroupMembershipStatus` indicating the player's group membership status after the prompt is closed. If the player closes the prompt without joining, this will return `GroupMembershipStatus.None` or their previous status if they were already a member.
17140
17464
  */
17141
17465
  PromptJoinAsync(this: GroupService, groupId: number): Enum.GroupMembershipStatus;
17142
17466
  }
@@ -18870,6 +19194,18 @@ interface ScrollingFrame extends GuiObject {
18870
19194
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame#VerticalScrollBarPosition)
18871
19195
  */
18872
19196
  VerticalScrollBarPosition: Enum.VerticalScrollBarPosition;
19197
+ /**
19198
+ * - **ThreadSafety**: Unsafe
19199
+ *
19200
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame#GetScrollVelocity)
19201
+ */
19202
+ GetScrollVelocity(this: ScrollingFrame): Vector2;
19203
+ /**
19204
+ * - **ThreadSafety**: Unsafe
19205
+ *
19206
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame#ResetScrollVelocity)
19207
+ */
19208
+ ResetScrollVelocity(this: ScrollingFrame): void;
18873
19209
  }
18874
19210
  /**
18875
19211
  * A 2D user interface element that displays player-editable text.
@@ -21381,6 +21717,12 @@ interface GuiService extends Instance {
21381
21717
  Vector2,
21382
21718
  Vector2
21383
21719
  ]>;
21720
+ /**
21721
+ * - **ThreadSafety**: Unsafe
21722
+ *
21723
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#GetInsetArea)
21724
+ */
21725
+ GetInsetArea(this: GuiService, screenInsets: CastsToEnum<Enum.ScreenInsets>): Rect;
21384
21726
  /**
21385
21727
  * Returns whether the avatar inspection menu is enabled.
21386
21728
  *
@@ -22863,6 +23205,8 @@ interface Humanoid extends Instance {
22863
23205
  */
22864
23206
  UnequipTools(this: Humanoid): void;
22865
23207
  /**
23208
+ * **Deprecated:**
23209
+ *
22866
23210
  * Makes the character's look match that of the passed in `HumanoidDescription`.
22867
23211
  *
22868
23212
  * - **ThreadSafety**: Unsafe
@@ -22872,9 +23216,25 @@ interface Humanoid extends Instance {
22872
23216
  * @param this A special object that gives models the functionality of a character.
22873
23217
  * @param humanoidDescription The `HumanoidDescription` instance which you want to set the character to match.
22874
23218
  * @param assetTypeVerification The asset type verification mode.
23219
+ *
23220
+ * @deprecated ApplyDescriptionAsync
22875
23221
  */
22876
23222
  ApplyDescription(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
22877
23223
  /**
23224
+ * Makes the character's look match that of the passed in `HumanoidDescription`.
23225
+ *
23226
+ * - **ThreadSafety**: Unsafe
23227
+ * - **Tags**: Yields
23228
+ *
23229
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Humanoid#ApplyDescriptionAsync)
23230
+ * @param this A special object that gives models the functionality of a character.
23231
+ * @param humanoidDescription The `HumanoidDescription` instance which you want to set the character to match.
23232
+ * @param assetTypeVerification The asset type verification mode.
23233
+ */
23234
+ ApplyDescriptionAsync(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
23235
+ /**
23236
+ * **Deprecated:**
23237
+ *
22878
23238
  * Makes the character's look match that of the passed in `HumanoidDescription`, even after external changes.
22879
23239
  *
22880
23240
  * - **ThreadSafety**: Unsafe
@@ -22884,9 +23244,25 @@ interface Humanoid extends Instance {
22884
23244
  * @param this A special object that gives models the functionality of a character.
22885
23245
  * @param humanoidDescription The `HumanoidDescription` instance which you want to set the character to match.
22886
23246
  * @param assetTypeVerification The asset type verification mode.
23247
+ *
23248
+ * @deprecated ApplyDescriptionResetAsync
22887
23249
  */
22888
23250
  ApplyDescriptionReset(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
22889
23251
  /**
23252
+ * Makes the character's look match that of the passed in `HumanoidDescription`, even after external changes.
23253
+ *
23254
+ * - **ThreadSafety**: Unsafe
23255
+ * - **Tags**: Yields
23256
+ *
23257
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Humanoid#ApplyDescriptionResetAsync)
23258
+ * @param this A special object that gives models the functionality of a character.
23259
+ * @param humanoidDescription The `HumanoidDescription` instance which you want to set the character to match.
23260
+ * @param assetTypeVerification The asset type verification mode.
23261
+ */
23262
+ ApplyDescriptionResetAsync(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
23263
+ /**
23264
+ * **Deprecated:**
23265
+ *
22890
23266
  * Plays emotes and returns if was successfully ran.
22891
23267
  *
22892
23268
  * - **ThreadSafety**: Unsafe
@@ -22896,8 +23272,22 @@ interface Humanoid extends Instance {
22896
23272
  * @param this A special object that gives models the functionality of a character.
22897
23273
  * @param emoteName name of the emote to play.
22898
23274
  * @returns successfully played.
23275
+ *
23276
+ * @deprecated PlayEmoteAsync
22899
23277
  */
22900
23278
  PlayEmote(this: Humanoid, emoteName: string): boolean;
23279
+ /**
23280
+ * Plays emotes and returns if was successfully ran.
23281
+ *
23282
+ * - **ThreadSafety**: Unsafe
23283
+ * - **Tags**: Yields
23284
+ *
23285
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Humanoid#PlayEmoteAsync)
23286
+ * @param this A special object that gives models the functionality of a character.
23287
+ * @param emoteName name of the emote to play.
23288
+ * @returns successfully played.
23289
+ */
23290
+ PlayEmoteAsync(this: Humanoid, emoteName: string): boolean;
22901
23291
  /**
22902
23292
  * **Deprecated:**
22903
23293
  *
@@ -23565,8 +23955,6 @@ interface HumanoidDescription extends Instance {
23565
23955
  readonly EquippedEmotesChanged: RBXScriptSignal<(newEquippedEmotes: EquippedEmotes) => void>;
23566
23956
  }
23567
23957
  /**
23568
- * - **Tags**: NotBrowsable
23569
- *
23570
23958
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription)
23571
23959
  */
23572
23960
  interface HumanoidRigDescription extends Instance {
@@ -24682,6 +25070,12 @@ interface InputBinding extends Instance {
24682
25070
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Left)
24683
25071
  */
24684
25072
  Left: Enum.KeyCode;
25073
+ /**
25074
+ * - **ThreadSafety**: ReadSafe
25075
+ *
25076
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#PointerIndex)
25077
+ */
25078
+ PointerIndex: number;
24685
25079
  /**
24686
25080
  * Numerical value above which to fire an `InputAction` with a `Type` of `Bool`.
24687
25081
  *
@@ -24690,6 +25084,12 @@ interface InputBinding extends Instance {
24690
25084
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#PressedThreshold)
24691
25085
  */
24692
25086
  PressedThreshold: number;
25087
+ /**
25088
+ * - **ThreadSafety**: ReadSafe
25089
+ *
25090
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#PrimaryModifier)
25091
+ */
25092
+ PrimaryModifier: Enum.KeyCode;
24693
25093
  /**
24694
25094
  * Numerical value below which to fire an `InputAction` with a `Type` of `Bool`.
24695
25095
  *
@@ -24722,6 +25122,12 @@ interface InputBinding extends Instance {
24722
25122
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Scale)
24723
25123
  */
24724
25124
  Scale: number;
25125
+ /**
25126
+ * - **ThreadSafety**: ReadSafe
25127
+ *
25128
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#SecondaryModifier)
25129
+ */
25130
+ SecondaryModifier: Enum.KeyCode;
24725
25131
  /**
24726
25132
  * Connects a `GuiButton` to a boolean action.
24727
25133
  *
@@ -24986,6 +25392,8 @@ interface InsertService extends Instance {
24986
25392
  */
24987
25393
  GetCollection(this: InsertService, categoryId: number): Array<CollectionInfo>;
24988
25394
  /**
25395
+ * **Deprecated:**
25396
+ *
24989
25397
  * Retrieves a list of free Decals from the Catalog.
24990
25398
  *
24991
25399
  * - **ThreadSafety**: Unsafe
@@ -24996,11 +25404,28 @@ interface InsertService extends Instance {
24996
25404
  * @param searchText String used to search for free decals in the Catalog.
24997
25405
  * @param pageNum The page number in the Catalog to return.
24998
25406
  * @returns A single table (of returned free decals) wrapped in a table.
25407
+ *
25408
+ * @deprecated GetFreeDecalsAsync
24999
25409
  */
25000
25410
  GetFreeDecals(this: InsertService, searchText: string, pageNum: number): [
25001
25411
  Array<FreeSearchResult>
25002
25412
  ];
25003
25413
  /**
25414
+ * Retrieves a list of free Decals from the Catalog.
25415
+ *
25416
+ * - **ThreadSafety**: Unsafe
25417
+ * - **Tags**: Yields
25418
+ *
25419
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InsertService#GetFreeDecalsAsync)
25420
+ * @param this Used to insert assets from the Roblox website.
25421
+ * @param searchText String used to search for free decals in the Catalog.
25422
+ * @param pageNum The page number in the Catalog to return.
25423
+ * @returns A single table (of returned free decals) wrapped in a table.
25424
+ */
25425
+ GetFreeDecalsAsync(this: InsertService, searchText: string, pageNum: number): Array<unknown>;
25426
+ /**
25427
+ * **Deprecated:**
25428
+ *
25004
25429
  * Retrieves a list of Free Models from the Catalog.
25005
25430
  *
25006
25431
  * - **ThreadSafety**: Unsafe
@@ -25011,10 +25436,25 @@ interface InsertService extends Instance {
25011
25436
  * @param searchText String used to search for free decals in the Catalog.
25012
25437
  * @param pageNum The page number in the Catalog to return.
25013
25438
  * @returns A single table (of returned free models) wrapped in a table.
25439
+ *
25440
+ * @deprecated GetFreeModelsAsync
25014
25441
  */
25015
25442
  GetFreeModels(this: InsertService, searchText: string, pageNum: number): [
25016
25443
  Array<FreeSearchResult>
25017
25444
  ];
25445
+ /**
25446
+ * Retrieves a list of Free Models from the Catalog.
25447
+ *
25448
+ * - **ThreadSafety**: Unsafe
25449
+ * - **Tags**: Yields
25450
+ *
25451
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InsertService#GetFreeModelsAsync)
25452
+ * @param this Used to insert assets from the Roblox website.
25453
+ * @param searchText String used to search for free decals in the Catalog.
25454
+ * @param pageNum The page number in the Catalog to return.
25455
+ * @returns A single table (of returned free models) wrapped in a table.
25456
+ */
25457
+ GetFreeModelsAsync(this: InsertService, searchText: string, pageNum: number): Array<unknown>;
25018
25458
  /**
25019
25459
  * Returns the latest AssetVersionId of an asset for assets created by the place creator. Can be used in combination with `InsertService:LoadAssetVersion()` to load the latest version of a model, even if it gets updated while the game is running.
25020
25460
  *
@@ -25100,6 +25540,21 @@ interface InstanceExtensionsService extends Instance {
25100
25540
  */
25101
25541
  readonly _nominal_InstanceExtensionsService: unique symbol;
25102
25542
  }
25543
+ /**
25544
+ * - **Tags**: NotCreatable, Service, NotReplicated
25545
+ *
25546
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InstanceFileSyncService)
25547
+ */
25548
+ interface InstanceFileSyncService extends Instance {
25549
+ /**
25550
+ * **DO NOT USE!**
25551
+ *
25552
+ * This field exists to force TypeScript to recognize this as a nominal type
25553
+ * @hidden
25554
+ * @deprecated
25555
+ */
25556
+ readonly _nominal_InstanceFileSyncService: unique symbol;
25557
+ }
25103
25558
  /**
25104
25559
  * - **Tags**: NotReplicated
25105
25560
  *
@@ -25770,6 +26225,8 @@ interface KeyframeSequenceProvider extends Instance {
25770
26225
  */
25771
26226
  RegisterKeyframeSequence(this: KeyframeSequenceProvider, keyframeSequence: Instance): ContentId;
25772
26227
  /**
26228
+ * **Deprecated:**
26229
+ *
25773
26230
  * This function returns an `InventoryPages` object which can be used to iterate over animations owned by a specific user.
25774
26231
  *
25775
26232
  * - **ThreadSafety**: Unsafe
@@ -25779,8 +26236,22 @@ interface KeyframeSequenceProvider extends Instance {
25779
26236
  * @param this Provides functions to load and preview `KeyframeSequence`.
25780
26237
  * @param userId The user ID of the user.
25781
26238
  * @returns An `InventoryPages` of animations.
26239
+ *
26240
+ * @deprecated GetAnimationsAsync
25782
26241
  */
25783
26242
  GetAnimations(this: KeyframeSequenceProvider, userId: number): InventoryPages<number>;
26243
+ /**
26244
+ * This function returns an `InventoryPages` object which can be used to iterate over animations owned by a specific user.
26245
+ *
26246
+ * - **ThreadSafety**: Unsafe
26247
+ * - **Tags**: Yields
26248
+ *
26249
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/KeyframeSequenceProvider#GetAnimationsAsync)
26250
+ * @param this Provides functions to load and preview `KeyframeSequence`.
26251
+ * @param userId The user ID of the user.
26252
+ * @returns An `InventoryPages` of animations.
26253
+ */
26254
+ GetAnimationsAsync(this: KeyframeSequenceProvider, userId: number): Instance | undefined;
25784
26255
  /**
25785
26256
  * Returns a KeyframeSequence based on the specified assetId asynchronously.
25786
26257
  *
@@ -26998,6 +27469,8 @@ interface MLService extends Instance {
26998
27469
  CreateSessionAsync(this: MLService, assetId: string): MLSession;
26999
27470
  }
27000
27471
  /**
27472
+ * - **Tags**: NotBrowsable
27473
+ *
27001
27474
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MakeupDescription)
27002
27475
  */
27003
27476
  interface MakeupDescription extends Instance {
@@ -27240,6 +27713,8 @@ interface MarketplaceService extends Instance {
27240
27713
  Name: string;
27241
27714
  }>;
27242
27715
  /**
27716
+ * **Deprecated:**
27717
+ *
27243
27718
  * Returns the product information of an asset using its asset ID.
27244
27719
  *
27245
27720
  * - **ThreadSafety**: Unsafe
@@ -27250,6 +27725,8 @@ interface MarketplaceService extends Instance {
27250
27725
  * @param assetId The asset ID of the specified product.
27251
27726
  * @param infoType An `InfoType` enum value specifying the type of information being retrieved.
27252
27727
  * @returns A dictionary containing information about the queried item, described in the previous tables.
27728
+ *
27729
+ * @deprecated GetProductInfoAsync
27253
27730
  */
27254
27731
  GetProductInfo(this: MarketplaceService, id: number): AssetProductInfo;
27255
27732
  GetProductInfo(this: MarketplaceService, id: number, infoType: CastsToEnum<Enum.InfoType.Asset>): AssetProductInfo;
@@ -27258,6 +27735,19 @@ interface MarketplaceService extends Instance {
27258
27735
  GetProductInfo(this: MarketplaceService, id: number, infoType: CastsToEnum<Enum.InfoType.Product>): DeveloperProductInfo;
27259
27736
  GetProductInfo(this: MarketplaceService, id: number, infoType: CastsToEnum<Enum.InfoType.Subscription>): SubscriptionProductInfo;
27260
27737
  GetProductInfo(this: MarketplaceService, id: number, infoType?: CastsToEnum<Enum.InfoType>): AssetProductInfo | BundleInfo | GamePassProductInfo | DeveloperProductInfo | SubscriptionProductInfo;
27738
+ /**
27739
+ * Returns the product information of an asset using its asset ID.
27740
+ *
27741
+ * - **ThreadSafety**: Unsafe
27742
+ * - **Tags**: Yields
27743
+ *
27744
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#GetProductInfoAsync)
27745
+ * @param this The service responsible for in-experience transactions.
27746
+ * @param assetId The asset ID of the specified product.
27747
+ * @param infoType An `InfoType` enum value specifying the type of information being retrieved.
27748
+ * @returns A dictionary containing information about the queried item, described in the previous tables.
27749
+ */
27750
+ GetProductInfoAsync(this: MarketplaceService, assetId: number, infoType?: CastsToEnum<Enum.InfoType>): object;
27261
27751
  /**
27262
27752
  * Returns the product information of a subscription for the given `subscriptionId`.
27263
27753
  *
@@ -27318,6 +27808,8 @@ interface MarketplaceService extends Instance {
27318
27808
  */
27319
27809
  GetUsersPriceLevelsAsync(this: MarketplaceService, userIds: Array<unknown>): Array<unknown>;
27320
27810
  /**
27811
+ * **Deprecated:**
27812
+ *
27321
27813
  * Returns whether the given user has the given asset.
27322
27814
  *
27323
27815
  * - **ThreadSafety**: Unsafe
@@ -27328,9 +27820,26 @@ interface MarketplaceService extends Instance {
27328
27820
  * @param player The `Player` whose inventory is tested for ownership of the given asset.
27329
27821
  * @param assetId The asset ID for which the given player's inventory is tested.
27330
27822
  * @returns Indicates whether the given player's inventory contains the given asset.
27823
+ *
27824
+ * @deprecated PlayerOwnsAssetAsync
27331
27825
  */
27332
27826
  PlayerOwnsAsset(this: MarketplaceService, player: Player, assetId: number): boolean;
27333
27827
  /**
27828
+ * Returns whether the given user has the given asset.
27829
+ *
27830
+ * - **ThreadSafety**: Unsafe
27831
+ * - **Tags**: Yields
27832
+ *
27833
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PlayerOwnsAssetAsync)
27834
+ * @param this The service responsible for in-experience transactions.
27835
+ * @param player The `Player` whose inventory is tested for ownership of the given asset.
27836
+ * @param assetId The asset ID for which the given player's inventory is tested.
27837
+ * @returns Indicates whether the given player's inventory contains the given asset.
27838
+ */
27839
+ PlayerOwnsAssetAsync(this: MarketplaceService, player: Instance, assetId: number): boolean;
27840
+ /**
27841
+ * **Deprecated:**
27842
+ *
27334
27843
  * Returns whether the given player owns the given bundle.
27335
27844
  *
27336
27845
  * - **ThreadSafety**: Unsafe
@@ -27341,20 +27850,59 @@ interface MarketplaceService extends Instance {
27341
27850
  * @param player The `Player` whose inventory is tested for ownership of the given bundle.
27342
27851
  * @param bundleId The bundle ID for which the given player's inventory is tested.
27343
27852
  * @returns Indicates whether the given player's inventory contains the given bundle.
27853
+ *
27854
+ * @deprecated PlayerOwnsBundleAsync
27344
27855
  */
27345
27856
  PlayerOwnsBundle(this: MarketplaceService, player: Player, bundleId: number): boolean;
27346
27857
  /**
27858
+ * Returns whether the given player owns the given bundle.
27859
+ *
27860
+ * - **ThreadSafety**: Unsafe
27861
+ * - **Tags**: Yields
27862
+ *
27863
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PlayerOwnsBundleAsync)
27864
+ * @param this The service responsible for in-experience transactions.
27865
+ * @param player The `Player` whose inventory is tested for ownership of the given bundle.
27866
+ * @param bundleId The bundle ID for which the given player's inventory is tested.
27867
+ * @returns Indicates whether the given player's inventory contains the given bundle.
27868
+ */
27869
+ PlayerOwnsBundleAsync(this: MarketplaceService, player: Player, bundleId: number): boolean;
27870
+ /**
27871
+ * Takes a list of product IDs and returns a personalized ordered list of those products.
27872
+ *
27347
27873
  * - **ThreadSafety**: Unsafe
27348
27874
  * - **Tags**: Yields
27349
27875
  *
27350
27876
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#RankProductsAsync)
27877
+ * @param this The service responsible for in-experience transactions.
27878
+ * @param productIdentifiers An array of objects identifying the products you want to rank. This array can include up to 50 items. Each `ProductIdentifier` has: - `InfoType`: Enum.InfoType
27879
+ * - Must be either `InfoType.GamePass` or `InfoType.Product`.
27880
+ * - `Id`: number
27881
+ * - The ID of the game pass or developer product.
27882
+ *
27883
+ *
27884
+ * ```lua
27885
+ * local ProductIdentifier = { InfoType = Enum.InfoType.GamePass, Id = 123456 }
27886
+ * ```
27887
+ * @returns The array of ranked items in a personalized order for the current user. Each array has: - `ProductIdentifier`: The corresponding ID from the input array.
27888
+ * - `ProductInfo`: The standard product info dictionary returned by `GetProductInfo`.
27351
27889
  */
27352
27890
  RankProductsAsync(this: MarketplaceService, productIdentifiers: Array<unknown>): Array<unknown>;
27353
27891
  /**
27892
+ * - Takes an array of `InfoType` and returns up to 50 items representing the products a user is most likely to engage with and purchase.
27893
+ *
27894
+ *
27895
+ *
27354
27896
  * - **ThreadSafety**: Unsafe
27355
27897
  * - **Tags**: Yields
27356
27898
  *
27357
27899
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#RecommendTopProductsAsync)
27900
+ * @param this The service responsible for in-experience transactions.
27901
+ * @param infoTypes An array of `InfoType` values specifying the types of product to retrieve recommendations for. Supported `InfoTypes`: `InfoType.GamePass`, `InfoType.Product`.
27902
+ * ```lua
27903
+ * local infoTypes = { Enum.InfoType.GamePass, Enum.InfoType.Product }
27904
+ * ```
27905
+ * @returns A ranked list of up to 50 items the user is most likely to engage with, based on the provided `InfoTypes`. If no recommendations can be determined, the method returns an empty list.
27358
27906
  */
27359
27907
  RecommendTopProductsAsync(this: MarketplaceService, infoTypes: Array<unknown>): Array<unknown>;
27360
27908
  /**
@@ -27577,6 +28125,13 @@ interface MaterialVariant extends Instance {
27577
28125
  * @deprecated
27578
28126
  */
27579
28127
  readonly _nominal_MaterialVariant: unique symbol;
28128
+ /**
28129
+ * - **ThreadSafety**: ReadSafe
28130
+ * - **Tags**: NotBrowsable
28131
+ *
28132
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MaterialVariant#AlphaMode)
28133
+ */
28134
+ AlphaMode: Enum.AlphaMode;
27580
28135
  /**
27581
28136
  * Category Material this variant belongs to.
27582
28137
  *
@@ -28083,12 +28638,17 @@ interface ModerationService extends Instance {
28083
28638
  * - **ThreadSafety**: Unsafe
28084
28639
  *
28085
28640
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService#BindReviewableContentEventProcessor)
28641
+ * @param this
28642
+ * @param priority
28643
+ * @param callback
28086
28644
  */
28087
28645
  BindReviewableContentEventProcessor(this: ModerationService, priority: number, callback: Callback): RBXScriptConnection;
28088
28646
  /**
28089
28647
  * - **ThreadSafety**: Unsafe
28090
28648
  *
28091
28649
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService#CreateReviewableContentKey)
28650
+ * @param this
28651
+ * @param content
28092
28652
  */
28093
28653
  CreateReviewableContentKey(this: ModerationService, content: Content): string;
28094
28654
  /**
@@ -28096,6 +28656,8 @@ interface ModerationService extends Instance {
28096
28656
  * - **Tags**: Yields
28097
28657
  *
28098
28658
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService#CreateReviewableContentAsync)
28659
+ * @param this
28660
+ * @param config
28099
28661
  */
28100
28662
  CreateReviewableContentAsync(this: ModerationService, config: object): string;
28101
28663
  /**
@@ -32059,12 +32621,6 @@ interface Workspace extends WorldRoot {
32059
32621
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#AllowThirdPartySales)
32060
32622
  */
32061
32623
  AllowThirdPartySales: boolean;
32062
- /**
32063
- * - **ThreadSafety**: ReadSafe
32064
- *
32065
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#AuthorityMode)
32066
- */
32067
- AuthorityMode: Enum.AuthorityMode;
32068
32624
  /**
32069
32625
  * Specifies the animation throttling mode for the local client.
32070
32626
  *
@@ -32173,13 +32729,13 @@ interface Workspace extends WorldRoot {
32173
32729
  */
32174
32730
  GetNumAwakeParts(this: Workspace): number;
32175
32731
  /**
32176
- * Returns an integer, between 0 and 100, representing the percentage of real-time that physics simulation is currently being throttled to.
32732
+ * Returns an integer, between 0 and 100, representing the percentage of real time that physics simulation is currently being throttled to.
32177
32733
  *
32178
32734
  * - **ThreadSafety**: Safe
32179
32735
  *
32180
32736
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#GetPhysicsThrottling)
32181
32737
  * @param this **Workspace** houses 3D objects which are rendered to the 3D world. Objects not descending from it will not be rendered or physically interact with the world.
32182
- * @returns The percentage of real-time that physics simulation is currently being throttled to.
32738
+ * @returns The percentage of real time that physics simulation is currently being throttled to.
32183
32739
  */
32184
32740
  GetPhysicsThrottling(this: Workspace): number;
32185
32741
  /**
@@ -33987,7 +34543,7 @@ interface Player extends Instance {
33987
34543
  */
33988
34544
  GetMouse(this: Player): PlayerMouse;
33989
34545
  /**
33990
- * Returns the isolated network latency in seconds.
34546
+ * Returns the round-trip, isolated network latency in seconds.
33991
34547
  *
33992
34548
  * - **ThreadSafety**: Safe
33993
34549
  *
@@ -34186,6 +34742,8 @@ interface Player extends Instance {
34186
34742
  */
34187
34743
  SaveString(this: Player, key: string, value: string): void;
34188
34744
  /**
34745
+ * **Deprecated:**
34746
+ *
34189
34747
  * Returns a dictionary of online connections.
34190
34748
  *
34191
34749
  * - **ThreadSafety**: Unsafe
@@ -34195,9 +34753,25 @@ interface Player extends Instance {
34195
34753
  * @param this An object that represents a presently connected client to the experience.
34196
34754
  * @param maxFriends The maximum number of online connections to return.
34197
34755
  * @returns A dictionary of online connections (see the table above).
34756
+ *
34757
+ * @deprecated GetFriendsOnlineAsync
34198
34758
  */
34199
34759
  GetFriendsOnline(this: Player, maxFriends?: number): Array<FriendOnlineInfo>;
34200
34760
  /**
34761
+ * Returns a dictionary of online connections.
34762
+ *
34763
+ * - **ThreadSafety**: Unsafe
34764
+ * - **Tags**: Yields
34765
+ *
34766
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetFriendsOnlineAsync)
34767
+ * @param this An object that represents a presently connected client to the experience.
34768
+ * @param maxFriends The maximum number of online connections to return.
34769
+ * @returns A dictionary of online connections (see the table above).
34770
+ */
34771
+ GetFriendsOnlineAsync(this: Player, maxFriends?: number): Array<unknown>;
34772
+ /**
34773
+ * **Deprecated:**
34774
+ *
34201
34775
  * Returns the player's rank in the group as an integer.
34202
34776
  *
34203
34777
  * - **ThreadSafety**: Unsafe
@@ -34207,9 +34781,25 @@ interface Player extends Instance {
34207
34781
  * @param this An object that represents a presently connected client to the experience.
34208
34782
  * @param groupId The `groupId` of the specified group.
34209
34783
  * @returns The player's rank in the group.
34784
+ *
34785
+ * @deprecated GetRankInGroupAsync
34210
34786
  */
34211
34787
  GetRankInGroup(this: Player, groupId: number): number;
34212
34788
  /**
34789
+ * Returns the player's rank in the group as an integer.
34790
+ *
34791
+ * - **ThreadSafety**: Unsafe
34792
+ * - **Tags**: Yields
34793
+ *
34794
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetRankInGroupAsync)
34795
+ * @param this An object that represents a presently connected client to the experience.
34796
+ * @param groupId The `groupId` of the specified group.
34797
+ * @returns The player's rank in the group.
34798
+ */
34799
+ GetRankInGroupAsync(this: Player, groupId: number): number;
34800
+ /**
34801
+ * **Deprecated:**
34802
+ *
34213
34803
  * Returns the player's role in the group as a string, or `Guest` if the player isn't part of the group.
34214
34804
  *
34215
34805
  * - **ThreadSafety**: Unsafe
@@ -34219,8 +34809,22 @@ interface Player extends Instance {
34219
34809
  * @param this An object that represents a presently connected client to the experience.
34220
34810
  * @param groupId The group ID of the specified group.
34221
34811
  * @returns The player's role in the specified group, or `Guest` if the player is not a member.
34812
+ *
34813
+ * @deprecated GetRoleInGroupAsync
34222
34814
  */
34223
34815
  GetRoleInGroup(this: Player, groupId: number): string;
34816
+ /**
34817
+ * Returns the player's role in the group as a string, or `Guest` if the player isn't part of the group.
34818
+ *
34819
+ * - **ThreadSafety**: Unsafe
34820
+ * - **Tags**: Yields
34821
+ *
34822
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetRoleInGroupAsync)
34823
+ * @param this An object that represents a presently connected client to the experience.
34824
+ * @param groupId The group ID of the specified group.
34825
+ * @returns The player's role in the specified group, or `Guest` if the player is not a member.
34826
+ */
34827
+ GetRoleInGroupAsync(this: Player, groupId: number): string;
34224
34828
  /**
34225
34829
  * **Deprecated:** This function is obsolete because the Best Friends feature was removed. Use `Player:IsFriendsWith()` instead.
34226
34830
  *
@@ -34237,6 +34841,8 @@ interface Player extends Instance {
34237
34841
  */
34238
34842
  IsBestFriendsWith(this: Player, userId: number): boolean;
34239
34843
  /**
34844
+ * **Deprecated:**
34845
+ *
34240
34846
  * Checks whether a player is a connection of the user with the given `Player.UserId`.
34241
34847
  *
34242
34848
  * - **ThreadSafety**: Unsafe
@@ -34246,9 +34852,25 @@ interface Player extends Instance {
34246
34852
  * @param this An object that represents a presently connected client to the experience.
34247
34853
  * @param userId The `Player.UserId` of the specified player.
34248
34854
  * @returns A boolean indicating whether a player is a connection of the specified user.
34855
+ *
34856
+ * @deprecated IsFriendsWithAsync
34249
34857
  */
34250
34858
  IsFriendsWith(this: Player, userId: number): boolean;
34251
34859
  /**
34860
+ * Checks whether a player is a connection of the user with the given `Player.UserId`.
34861
+ *
34862
+ * - **ThreadSafety**: Unsafe
34863
+ * - **Tags**: Yields
34864
+ *
34865
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#IsFriendsWithAsync)
34866
+ * @param this An object that represents a presently connected client to the experience.
34867
+ * @param userId The `Player.UserId` of the specified player.
34868
+ * @returns A boolean indicating whether a player is a connection of the specified user.
34869
+ */
34870
+ IsFriendsWithAsync(this: Player, userId: number): boolean;
34871
+ /**
34872
+ * **Deprecated:**
34873
+ *
34252
34874
  * Checks whether a player is a member of a group with the given ID.
34253
34875
  *
34254
34876
  * - **ThreadSafety**: Unsafe
@@ -34258,9 +34880,25 @@ interface Player extends Instance {
34258
34880
  * @param this An object that represents a presently connected client to the experience.
34259
34881
  * @param groupId The group ID of the specified group.
34260
34882
  * @returns A boolean indicating whether the player is in the specified group.
34883
+ *
34884
+ * @deprecated IsInGroupAsync
34261
34885
  */
34262
34886
  IsInGroup(this: Player, groupId: number): boolean;
34263
34887
  /**
34888
+ * Checks whether a player is a member of a group with the given ID.
34889
+ *
34890
+ * - **ThreadSafety**: Unsafe
34891
+ * - **Tags**: Yields
34892
+ *
34893
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#IsInGroupAsync)
34894
+ * @param this An object that represents a presently connected client to the experience.
34895
+ * @param groupId The group ID of the specified group.
34896
+ * @returns A boolean indicating whether the player is in the specified group.
34897
+ */
34898
+ IsInGroupAsync(this: Player, groupId: number): boolean;
34899
+ /**
34900
+ * **Deprecated:**
34901
+ *
34264
34902
  * Creates a new character for the player, removing the old one. Also clears the player's `Backpack` and `PlayerGui`.
34265
34903
  *
34266
34904
  * - **ThreadSafety**: Unsafe
@@ -34268,9 +34906,23 @@ interface Player extends Instance {
34268
34906
  *
34269
34907
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadCharacter)
34270
34908
  * @param this An object that represents a presently connected client to the experience.
34909
+ *
34910
+ * @deprecated LoadCharacterAsync
34271
34911
  */
34272
34912
  LoadCharacter(this: Player): void;
34273
34913
  /**
34914
+ * Creates a new character for the player, removing the old one. Also clears the player's `Backpack` and `PlayerGui`.
34915
+ *
34916
+ * - **ThreadSafety**: Unsafe
34917
+ * - **Tags**: Yields
34918
+ *
34919
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadCharacterAsync)
34920
+ * @param this An object that represents a presently connected client to the experience.
34921
+ */
34922
+ LoadCharacterAsync(this: Player): void;
34923
+ /**
34924
+ * **Deprecated:**
34925
+ *
34274
34926
  * Spawns a player character with everything equipped in the passed in `HumanoidDescription`.
34275
34927
  *
34276
34928
  * - **ThreadSafety**: Unsafe
@@ -34279,8 +34931,21 @@ interface Player extends Instance {
34279
34931
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadCharacterWithHumanoidDescription)
34280
34932
  * @param this An object that represents a presently connected client to the experience.
34281
34933
  * @param humanoidDescription A `HumanoidDescription` containing traits like body parts/colors, body scaling, accessories, clothing, and animations that will be equipped to the loaded character.
34934
+ *
34935
+ * @deprecated LoadCharacterWithHumanoidDescriptionAsync
34282
34936
  */
34283
34937
  LoadCharacterWithHumanoidDescription(this: Player, humanoidDescription: HumanoidDescription): void;
34938
+ /**
34939
+ * Spawns a player character with everything equipped in the passed in `HumanoidDescription`.
34940
+ *
34941
+ * - **ThreadSafety**: Unsafe
34942
+ * - **Tags**: Yields
34943
+ *
34944
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadCharacterWithHumanoidDescriptionAsync)
34945
+ * @param this An object that represents a presently connected client to the experience.
34946
+ * @param humanoidDescription A `HumanoidDescription` containing traits like body parts/colors, body scaling, accessories, clothing, and animations that will be equipped to the loaded character.
34947
+ */
34948
+ LoadCharacterWithHumanoidDescriptionAsync(this: Player, humanoidDescription: HumanoidDescription): void;
34284
34949
  /**
34285
34950
  * Requests that the server stream to the player around the specified location.
34286
34951
  *
@@ -34874,6 +35539,8 @@ interface Players extends Instance {
34874
35539
  */
34875
35540
  BanAsync(this: Players, config: BanAsyncConfig): void;
34876
35541
  /**
35542
+ * **Deprecated:**
35543
+ *
34877
35544
  * Returns a character `Model` equipped with everything specified in the passed in `HumanoidDescription`.
34878
35545
  *
34879
35546
  * - **ThreadSafety**: Unsafe
@@ -34885,9 +35552,27 @@ interface Players extends Instance {
34885
35552
  * @param rigType Specifies whether the returned character will be R6 or R15.
34886
35553
  * @param assetTypeVerification The asset type verification mode.
34887
35554
  * @returns A `Humanoid` character `Model`.
35555
+ *
35556
+ * @deprecated CreateHumanoidModelFromDescriptionAsync
34888
35557
  */
34889
35558
  CreateHumanoidModelFromDescription(this: Players, description: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): Model;
34890
35559
  /**
35560
+ * Returns a character `Model` equipped with everything specified in the passed in `HumanoidDescription`.
35561
+ *
35562
+ * - **ThreadSafety**: Unsafe
35563
+ * - **Tags**: Yields
35564
+ *
35565
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Players#CreateHumanoidModelFromDescriptionAsync)
35566
+ * @param this A service that contains presently connected `Player` objects.
35567
+ * @param description Specifies the appearance of the returned character.
35568
+ * @param rigType Specifies whether the returned character will be R6 or R15.
35569
+ * @param assetTypeVerification The asset type verification mode.
35570
+ * @returns A `Humanoid` character `Model`.
35571
+ */
35572
+ CreateHumanoidModelFromDescriptionAsync(this: Players, description: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): Model;
35573
+ /**
35574
+ * **Deprecated:**
35575
+ *
34891
35576
  * Returns a character Model set-up with everything equipped to match the avatar of the user specified by the passed in userId.
34892
35577
  *
34893
35578
  * - **ThreadSafety**: Unsafe
@@ -34897,8 +35582,22 @@ interface Players extends Instance {
34897
35582
  * @param this A service that contains presently connected `Player` objects.
34898
35583
  * @param userId The userId for a Roblox user. (The UserId is the number in the profile of the user e.g www.roblox.com/users/1/profile).
34899
35584
  * @returns A Humanoid character Model.
35585
+ *
35586
+ * @deprecated CreateHumanoidModelFromUserIdAsync
34900
35587
  */
34901
35588
  CreateHumanoidModelFromUserId(this: Players, userId: number): Model;
35589
+ /**
35590
+ * Returns a character Model set-up with everything equipped to match the avatar of the user specified by the passed in userId.
35591
+ *
35592
+ * - **ThreadSafety**: Unsafe
35593
+ * - **Tags**: Yields
35594
+ *
35595
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Players#CreateHumanoidModelFromUserIdAsync)
35596
+ * @param this A service that contains presently connected `Player` objects.
35597
+ * @param userId The userId for a Roblox user. (The UserId is the number in the profile of the user e.g www.roblox.com/users/1/profile).
35598
+ * @returns A Humanoid character Model.
35599
+ */
35600
+ CreateHumanoidModelFromUserIdAsync(this: Players, userId: number): Model;
34902
35601
  /**
34903
35602
  * Retrieves the ban and unban history of any user within the experience's universe. This method is enabled and disabled by the `Players.BanningEnabled` property, which you can toggle in Studio.
34904
35603
  *
@@ -34950,6 +35649,8 @@ interface Players extends Instance {
34950
35649
  */
34951
35650
  GetFriendsAsync(this: Players, userId: number): FriendPages;
34952
35651
  /**
35652
+ * **Deprecated:**
35653
+ *
34953
35654
  * Returns the HumanoidDescription for a specified outfit, which will be set with the parts/colors/Animations etc of the outfit.
34954
35655
  *
34955
35656
  * - **ThreadSafety**: Unsafe
@@ -34959,9 +35660,25 @@ interface Players extends Instance {
34959
35660
  * @param this A service that contains presently connected `Player` objects.
34960
35661
  * @param outfitId The ID of the outfit for which the HumanoidDescription is sought.
34961
35662
  * @returns HumanoidDescription initialized with the specification for the passed in outfitId.
35663
+ *
35664
+ * @deprecated GetHumanoidDescriptionFromOutfitIdAsync
34962
35665
  */
34963
35666
  GetHumanoidDescriptionFromOutfitId(this: Players, outfitId: number): HumanoidDescription;
34964
35667
  /**
35668
+ * Returns the HumanoidDescription for a specified outfit, which will be set with the parts/colors/Animations etc of the outfit.
35669
+ *
35670
+ * - **ThreadSafety**: Unsafe
35671
+ * - **Tags**: Yields
35672
+ *
35673
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Players#GetHumanoidDescriptionFromOutfitIdAsync)
35674
+ * @param this A service that contains presently connected `Player` objects.
35675
+ * @param outfitId The ID of the outfit for which the HumanoidDescription is sought.
35676
+ * @returns HumanoidDescription initialized with the specification for the passed in outfitId.
35677
+ */
35678
+ GetHumanoidDescriptionFromOutfitIdAsync(this: Players, outfitId: number): HumanoidDescription;
35679
+ /**
35680
+ * **Deprecated:**
35681
+ *
34965
35682
  * Returns a HumanoidDescription which specifies everything equipped for the avatar of the user specified by the passed in userId.
34966
35683
  *
34967
35684
  * - **ThreadSafety**: Unsafe
@@ -34971,8 +35688,22 @@ interface Players extends Instance {
34971
35688
  * @param this A service that contains presently connected `Player` objects.
34972
35689
  * @param userId The userId for a Roblox user. (The UserId is the number in the profile of the user e.g www.roblox.com/users/1/profile).
34973
35690
  * @returns HumanoidDescription initialized with the passed in user's avatar specification.
35691
+ *
35692
+ * @deprecated GetHumanoidDescriptionFromUserIdAsync
34974
35693
  */
34975
35694
  GetHumanoidDescriptionFromUserId(this: Players, userId: number): HumanoidDescription;
35695
+ /**
35696
+ * Returns a HumanoidDescription which specifies everything equipped for the avatar of the user specified by the passed in userId.
35697
+ *
35698
+ * - **ThreadSafety**: Unsafe
35699
+ * - **Tags**: Yields
35700
+ *
35701
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Players#GetHumanoidDescriptionFromUserIdAsync)
35702
+ * @param this A service that contains presently connected `Player` objects.
35703
+ * @param userId The userId for a Roblox user. (The UserId is the number in the profile of the user e.g www.roblox.com/users/1/profile).
35704
+ * @returns HumanoidDescription initialized with the passed in user's avatar specification.
35705
+ */
35706
+ GetHumanoidDescriptionFromUserIdAsync(this: Players, userId: number): HumanoidDescription;
34976
35707
  /**
34977
35708
  * Sends a query to the Roblox website for the username of an account with a given `UserId`.
34978
35709
  *
@@ -35580,7 +36311,7 @@ interface ProximityPrompt extends Instance {
35580
36311
  */
35581
36312
  ClickablePrompt: boolean;
35582
36313
  /**
35583
- * Whether this prompt should be shown.
36314
+ * Whether or not this prompt should be shown.
35584
36315
  *
35585
36316
  * - **ThreadSafety**: ReadSafe
35586
36317
  *
@@ -35720,7 +36451,7 @@ interface ProximityPrompt extends Instance {
35720
36451
  */
35721
36452
  readonly PromptButtonHoldEnded: RBXScriptSignal<(playerWhoTriggered: Player) => void>;
35722
36453
  /**
35723
- * Triggers when the prompt becomes hidden.
36454
+ * Triggers when the `prompt` becomes hidden.
35724
36455
  *
35725
36456
  * - **ThreadSafety**: Unsafe
35726
36457
  *
@@ -36524,20 +37255,29 @@ interface RunService extends Instance {
36524
37255
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RunService#BindToRenderStep)
36525
37256
  * @param this Service responsible for all runtime activity and progression of time.
36526
37257
  * @param name Label for the binding which can be used with `Unbind` if the binding is no longer needed.
36527
- * @param priority Priority of the binding as an integer; it determines when during the render step to call the custom function. The lower this number, the sooner the custom function will be called. If two bindings have the same priority the Roblox Engine will randomly pick one to run first.
37258
+ * @param priority Priority of the binding as an integer; it determines when during the render step to call the custom function. The lower this number, the sooner the custom function will be called. If two bindings have the same priority, the engine will randomly pick one to run first.
36528
37259
  * @param function The custom function being bound.
36529
37260
  */
36530
37261
  BindToRenderStep(this: RunService, name: string, priority: number, callback: (deltaTime: number) => void): void;
36531
37262
  /**
37263
+ * Binds a custom function to be called at a fixed frequency which is independent of the frame rate.
37264
+ *
36532
37265
  * - **ThreadSafety**: Unsafe
36533
37266
  *
36534
37267
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RunService#BindToSimulation)
37268
+ * @param this Service responsible for all runtime activity and progression of time.
37269
+ * @param function The function to call. This function will be passed one parameter called `deltaTime` which shows how much time passed between the beginning of the previous simulation step and the beginning of the current simulation step.
37270
+ * @param frequency Optional `StepFrequency` value indicating the frequency at which to call the bound function. If not provided, the default frequency will be used.
36535
37271
  */
36536
37272
  BindToSimulation(this: RunService, callback: Callback, frequency?: CastsToEnum<Enum.StepFrequency>): RBXScriptConnection;
36537
37273
  /**
37274
+ * Checks the `PredictionStatus` of a specific context instance, useful for debugging scripts affecting multiple instances where some might be predicted and others might not.
37275
+ *
36538
37276
  * - **ThreadSafety**: Unsafe
36539
37277
  *
36540
37278
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RunService#GetPredictionStatus)
37279
+ * @param this Service responsible for all runtime activity and progression of time.
37280
+ * @param context The `Instance` for which to check prediction status.
36541
37281
  */
36542
37282
  GetPredictionStatus(this: RunService, context: Instance): Enum.PredictionStatus;
36543
37283
  /**
@@ -36591,9 +37331,14 @@ interface RunService extends Instance {
36591
37331
  */
36592
37332
  IsStudio(this: RunService): boolean;
36593
37333
  /**
37334
+ * Sets the prediction mode for an `Instance` to an `PredictionMode` value.
37335
+ *
36594
37336
  * - **ThreadSafety**: Unsafe
36595
37337
  *
36596
37338
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RunService#SetPredictionMode)
37339
+ * @param this Service responsible for all runtime activity and progression of time.
37340
+ * @param context The `Instance` for which to set the prediction mode.
37341
+ * @param mode The `PredictionMode` to set for the context instance.
36597
37342
  */
36598
37343
  SetPredictionMode(this: RunService, context: Instance, mode: CastsToEnum<Enum.PredictionMode>): void;
36599
37344
  /**
@@ -36706,7 +37451,7 @@ interface RuntimeContentService extends Instance {
36706
37451
  *
36707
37452
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RuntimeContentService#RuntimeContentShare)
36708
37453
  */
36709
- readonly RuntimeContentShare: RBXScriptSignal<(id: string, content: string) => void>;
37454
+ readonly RuntimeContentShare: RBXScriptSignal<(id: string, content: string, metadata: string) => void>;
36710
37455
  }
36711
37456
  /**
36712
37457
  * - **Tags**: NotCreatable, Service
@@ -37525,6 +38270,13 @@ interface DataModel extends ServiceProvider<Services> {
37525
38270
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#PrivateServerOwnerId)
37526
38271
  */
37527
38272
  readonly PrivateServerOwnerId: number;
38273
+ /**
38274
+ * - **ThreadSafety**: ReadSafe
38275
+ * - **Tags**: NotReplicated
38276
+ *
38277
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#RunService)
38278
+ */
38279
+ readonly RunService: Instance | undefined;
37528
38280
  /**
37529
38281
  * **Deprecated:** This property has been deprecated. Use `DataModel.PrivateServerId` instead.
37530
38282
  *
@@ -38000,6 +38752,51 @@ interface Sky extends Instance {
38000
38752
  */
38001
38753
  SunTextureId: ContentId;
38002
38754
  }
38755
+ /**
38756
+ * - **Tags**: NotCreatable
38757
+ *
38758
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SlimAnimationDataEntity)
38759
+ */
38760
+ interface SlimAnimationDataEntity extends Instance {
38761
+ /**
38762
+ * **DO NOT USE!**
38763
+ *
38764
+ * This field exists to force TypeScript to recognize this as a nominal type
38765
+ * @hidden
38766
+ * @deprecated
38767
+ */
38768
+ readonly _nominal_SlimAnimationDataEntity: unique symbol;
38769
+ }
38770
+ /**
38771
+ * - **Tags**: NotCreatable, Service
38772
+ *
38773
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SlimAnimationReplicationService)
38774
+ */
38775
+ interface SlimAnimationReplicationService extends Instance {
38776
+ /**
38777
+ * **DO NOT USE!**
38778
+ *
38779
+ * This field exists to force TypeScript to recognize this as a nominal type
38780
+ * @hidden
38781
+ * @deprecated
38782
+ */
38783
+ readonly _nominal_SlimAnimationReplicationService: unique symbol;
38784
+ }
38785
+ /**
38786
+ * - **Tags**: NotCreatable, Service, NotReplicated
38787
+ *
38788
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SlimReplicationService)
38789
+ */
38790
+ interface SlimReplicationService extends Instance {
38791
+ /**
38792
+ * **DO NOT USE!**
38793
+ *
38794
+ * This field exists to force TypeScript to recognize this as a nominal type
38795
+ * @hidden
38796
+ * @deprecated
38797
+ */
38798
+ readonly _nominal_SlimReplicationService: unique symbol;
38799
+ }
38003
38800
  /**
38004
38801
  * - **Tags**: NotCreatable, Service, NotReplicated
38005
38802
  *
@@ -38269,6 +39066,8 @@ interface SocialService extends Instance {
38269
39066
  */
38270
39067
  PromptFeedbackSubmissionAsync(this: SocialService): void;
38271
39068
  /**
39069
+ * **Deprecated:**
39070
+ *
38272
39071
  * - **ThreadSafety**: Unsafe
38273
39072
  * - **Tags**: Yields
38274
39073
  *
@@ -38284,8 +39083,28 @@ interface SocialService extends Instance {
38284
39083
  *
38285
39084
  *
38286
39085
  * @returns A tuple containing an `PromptLinkSharingResult` indicating the result of the link sharing prompt.
39086
+ *
39087
+ * @deprecated PromptLinkSharingAsync
38287
39088
  */
38288
39089
  PromptLinkSharing(this: SocialService, player: Player, options?: object): unknown;
39090
+ /**
39091
+ * - **ThreadSafety**: Unsafe
39092
+ * - **Tags**: Yields
39093
+ *
39094
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#PromptLinkSharingAsync)
39095
+ * @param this Facilitates social functions that impact relationships made on the Roblox platform.
39096
+ * @param player Prompts the given `Player` with a Roblox platform-level share sheet with a generated share link.
39097
+ * @param options `Dictionary` that specifies the configuration for the generated link. It includes the following optional key-value pairs: - `FallbackLinkId` (string). Determines how this share link will direct player to once expired. Default to experience join link.
39098
+ * - `ExpirationSeconds` (number). Determines time to expiration once the share link is created. Truncates to nearest integer. Defaults to 86,400.
39099
+ * - `PreviewTitle` (string) Preview title of the share link.
39100
+ * - `PreviewDescription` (string) Preview description of the share link.
39101
+ * - `PreviewAssetId` (number) Image asset ID used for share link preview.
39102
+ * - `LaunchData` (string). Used to set a parameter in `Player:GetJoinData()` when a player joined using the generated share link.
39103
+ *
39104
+ *
39105
+ * @returns A tuple containing an `PromptLinkSharingResult` indicating the result of the link sharing prompt.
39106
+ */
39107
+ PromptLinkSharingAsync(this: SocialService, player: Player, options?: object): unknown;
38289
39108
  /**
38290
39109
  * Prompts the local `Player` with a prompt to change their RSVP status to the given event.
38291
39110
  *
@@ -39140,7 +39959,7 @@ interface SoundGroup extends Instance {
39140
39959
  Volume: number;
39141
39960
  }
39142
39961
  /**
39143
- * A service that determines various aspects of how `Sounds` play in the experience.
39962
+ * A service that determines various aspects of how the audio engine works. Most of its properties affect how `Sounds` play in the experience.
39144
39963
  *
39145
39964
  * - **Tags**: NotCreatable, Service
39146
39965
  *
@@ -39156,13 +39975,15 @@ interface SoundService extends Instance {
39156
39975
  */
39157
39976
  readonly _nominal_SoundService: unique symbol;
39158
39977
  /**
39978
+ * Determines whether acoustic simulation is enabled globally in the advanced audio system.
39979
+ *
39159
39980
  * - **ThreadSafety**: ReadSafe
39160
39981
  *
39161
39982
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#AcousticSimulationEnabled)
39162
39983
  */
39163
39984
  AcousticSimulationEnabled: boolean;
39164
39985
  /**
39165
- * The ambient sound environment preset used by `SoundService`.
39986
+ * The ambient sound environment preset applied to all `Sounds`.
39166
39987
  *
39167
39988
  * - **ThreadSafety**: ReadSafe
39168
39989
  *
@@ -39170,13 +39991,15 @@ interface SoundService extends Instance {
39170
39991
  */
39171
39992
  AmbientReverb: Enum.ReverbType;
39172
39993
  /**
39994
+ * Determines whether the default character sounds will use instances in the advanced audio system vs. `Sounds`.
39995
+ *
39173
39996
  * - **ThreadSafety**: ReadSafe
39174
39997
  *
39175
39998
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#CharacterSoundsUseNewApi)
39176
39999
  */
39177
40000
  get CharacterSoundsUseNewApi(): Enum.RolloutState;
39178
40001
  /**
39179
- * The number of studs to be considered a meter by `SoundService` when calculating volume attenuation of `Sounds` parented to a `BasePart` or `Attachment`.
40002
+ * The number of studs to be considered a meter by `SoundService` when simulating the Doppler effect for `Sounds`.
39180
40003
  *
39181
40004
  * - **ThreadSafety**: ReadSafe
39182
40005
  *
@@ -39200,7 +40023,7 @@ interface SoundService extends Instance {
39200
40023
  */
39201
40024
  RespectFilteringEnabled: boolean;
39202
40025
  /**
39203
- * Sets how fast `Sound` volume attenuates.
40026
+ * Determines how fast the volume of a `Sound` attenuates beyond its `Sound.RollOffMinDistance`.
39204
40027
  *
39205
40028
  * - **ThreadSafety**: ReadSafe
39206
40029
  *
@@ -39208,13 +40031,18 @@ interface SoundService extends Instance {
39208
40031
  */
39209
40032
  RolloffScale: number;
39210
40033
  /**
39211
- * Returns the current `SoundService` listener type and what is set as the listener.
40034
+ * Returns the current listener type used by `Sounds`, as well as what that listener is currently set to.
39212
40035
  *
39213
40036
  * - **ThreadSafety**: Unsafe
39214
40037
  *
39215
40038
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#GetListener)
39216
- * @param this A service that determines various aspects of how `Sounds` play in the experience.
39217
- * @returns The current `ListenerType` and what the listener has been set to. Listener can be a `BasePart`, a `CFrame`, or `nil`.
40039
+ * @param this A service that determines various aspects of how the audio engine works. Most of its properties affect how `Sounds` play in the experience.
40040
+ * @returns A table containing two results. The first result is the listener's `ListenerType` and the second result is dependent on that type: | Listener Type | Description |
40041
+ * | ---------------------------------- | -------------------------------------------------------------------------------------------------- |
40042
+ * | `Enum.ListenerType.Camera` | Does not return a listener object as `Class.Workspace.CurrentCamera|CurrentCamera` is always used. |
40043
+ * | `Enum.ListenerType.CFrame` | Returns the `Datatype.CFrame` used in `Class.SoundService:SetListener()|SetListener()`. |
40044
+ * | `Enum.ListenerType.ObjectPosition` | Returns the `Class.BasePart` used in `Class.SoundService:SetListener()|SetListener()`. |
40045
+ * | `Enum.ListenerType.ObjectCFrame` | Returns the `Class.BasePart` used in `Class.SoundService:SetListener()|SetListener()`. |
39218
40046
  */
39219
40047
  GetListener(this: SoundService): LuaTuple<[
39220
40048
  Enum.ListenerType.Camera,
@@ -39230,22 +40058,22 @@ interface SoundService extends Instance {
39230
40058
  BasePart
39231
40059
  ]>;
39232
40060
  /**
39233
- * Plays a `Sound` locally, meaning the sound will only be heard by the client calling this method, regardless of where it's parented to.
40061
+ * Plays a copy of a `Sound` locally, such that it will only be heard by the client calling this method.
39234
40062
  *
39235
40063
  * - **ThreadSafety**: Unsafe
39236
40064
  *
39237
40065
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#PlayLocalSound)
39238
- * @param this A service that determines various aspects of how `Sounds` play in the experience.
40066
+ * @param this A service that determines various aspects of how the audio engine works. Most of its properties affect how `Sounds` play in the experience.
39239
40067
  * @param sound The `Sound` to be played.
39240
40068
  */
39241
40069
  PlayLocalSound(this: SoundService, sound: Sound): void;
39242
40070
  /**
39243
- * Sets the listener for the `SoundService`.
40071
+ * Sets the listener used by `Sounds`.
39244
40072
  *
39245
40073
  * - **ThreadSafety**: Unsafe
39246
40074
  *
39247
40075
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#SetListener)
39248
- * @param this A service that determines various aspects of how `Sounds` play in the experience.
40076
+ * @param this A service that determines various aspects of how the audio engine works. Most of its properties affect how `Sounds` play in the experience.
39249
40077
  * @param listenerType The `ListenerType` of the listener.
39250
40078
  * @param listener Dependent on the `ListenerType`. Use a `BasePart` for `ListenerType.ObjectPosition` or `ListenerType.ObjectCFrame`, a `CFrame` for `ListenerType.CFrame`, or `nil` for `ListenerType.Camera`.
39251
40079
  */
@@ -39442,6 +40270,8 @@ interface StarterPlayer extends Instance {
39442
40270
  */
39443
40271
  CameraMode: Enum.CameraMode;
39444
40272
  /**
40273
+ * Determines the starting value of `Humanoid.BreakJointsOnDeath` for `Player.Character`.
40274
+ *
39445
40275
  * - **ThreadSafety**: ReadSafe
39446
40276
  *
39447
40277
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StarterPlayer#CharacterBreakJointsOnDeath)
@@ -39489,6 +40319,7 @@ interface StarterPlayer extends Instance {
39489
40319
  CharacterWalkSpeed: number;
39490
40320
  /**
39491
40321
  * - **ThreadSafety**: ReadSafe
40322
+ * - **Tags**: NotBrowsable
39492
40323
  *
39493
40324
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StarterPlayer#ClassicDeath)
39494
40325
  */
@@ -40148,6 +40979,8 @@ interface StudioSdkService extends Instance {
40148
40979
  readonly _nominal_StudioSdkService: unique symbol;
40149
40980
  }
40150
40981
  /**
40982
+ * Service allowing plugins to automate and customize Test and Run mode testing.
40983
+ *
40151
40984
  * - **Tags**: NotCreatable, Service, NotReplicated
40152
40985
  *
40153
40986
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioTestService)
@@ -40165,12 +40998,16 @@ interface StudioTestService extends Instance {
40165
40998
  * - **ThreadSafety**: Unsafe
40166
40999
  *
40167
41000
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioTestService#EndTest)
41001
+ * @param this Service allowing plugins to automate and customize Test and Run mode testing.
41002
+ * @param value Value returned to the calling `StudioTestService:ExecutePlayModeAsync()` or `StudioTestService:ExecuteRunModeAsync()` method.
40168
41003
  */
40169
41004
  EndTest(this: StudioTestService, value: unknown): void;
40170
41005
  /**
40171
41006
  * - **ThreadSafety**: Unsafe
40172
41007
  *
40173
41008
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioTestService#GetTestArgs)
41009
+ * @param this Service allowing plugins to automate and customize Test and Run mode testing.
41010
+ * @returns Arguments passed to the test, or `nil`.
40174
41011
  */
40175
41012
  GetTestArgs(this: StudioTestService): unknown;
40176
41013
  }
@@ -40456,12 +41293,6 @@ interface StyleQuery extends Instance {
40456
41293
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleQuery#IsActive)
40457
41294
  */
40458
41295
  readonly IsActive: boolean;
40459
- /**
40460
- * - **ThreadSafety**: ReadSafe
40461
- *
40462
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleQuery#MaxSize)
40463
- */
40464
- MaxSize: Vector2;
40465
41296
  /**
40466
41297
  * - **ThreadSafety**: ReadSafe
40467
41298
  *
@@ -41052,6 +41883,8 @@ interface TeleportService extends Instance {
41052
41883
  */
41053
41884
  PromptExperienceDetailsAsync(this: TeleportService, player: Player, universeId: number): Enum.PromptExperienceDetailsResult;
41054
41885
  /**
41886
+ * **Deprecated:**
41887
+ *
41055
41888
  * Returns an access code that can be used to teleport players to a reserved server, along with the `DataModel.PrivateServerId` for it.
41056
41889
  *
41057
41890
  * - **ThreadSafety**: Unsafe
@@ -41061,11 +41894,25 @@ interface TeleportService extends Instance {
41061
41894
  * @param this Enables transporting `Players` between places and servers.
41062
41895
  * @param placeId The `DataModel.PlaceId` of the place the reserved server is being created for.
41063
41896
  * @returns The server access code required by `TeleportService:TeleportToPrivateServer()` and the `DataModel.PrivateServerId` for the reserved server.
41897
+ *
41898
+ * @deprecated ReserveServerAsync
41064
41899
  */
41065
41900
  ReserveServer(this: TeleportService, placeId: number): LuaTuple<[
41066
41901
  string,
41067
41902
  string
41068
41903
  ]>;
41904
+ /**
41905
+ * Returns an access code that can be used to teleport players to a reserved server, along with the `DataModel.PrivateServerId` for it.
41906
+ *
41907
+ * - **ThreadSafety**: Unsafe
41908
+ * - **Tags**: Yields
41909
+ *
41910
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TeleportService#ReserveServerAsync)
41911
+ * @param this Enables transporting `Players` between places and servers.
41912
+ * @param placeId The `DataModel.PlaceId` of the place the reserved server is being created for.
41913
+ * @returns The server access code required by `TeleportService:TeleportToPrivateServer()` and the `DataModel.PrivateServerId` for the reserved server.
41914
+ */
41915
+ ReserveServerAsync(this: TeleportService, placeId: number): unknown;
41069
41916
  /**
41070
41917
  * The all-encompassing method to teleport a player or group of players from one server to another.
41071
41918
  *
@@ -42239,7 +43086,7 @@ interface ChatWindowConfiguration extends TextChatConfigurations {
42239
43086
  DeriveNewMessageProperties(this: ChatWindowConfiguration): ChatWindowMessageProperties;
42240
43087
  }
42241
43088
  /**
42242
- * Immutable data object representing a text chat message.
43089
+ * A data object representing a text chat message.
42243
43090
  *
42244
43091
  * - **Tags**: NotCreatable
42245
43092
  *