@rbxts/types 1.0.896 → 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;
@@ -903,6 +904,8 @@ interface VideoCapture extends Capture {
903
904
  readonly TimeLength: number;
904
905
  }
905
906
  /**
907
+ * A snapshot of configuration values at a given version. Can be player-specific.
908
+ *
906
909
  * - **Tags**: NotCreatable, NotReplicated
907
910
  *
908
911
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot)
@@ -917,6 +920,8 @@ interface ConfigSnapshot extends RBXObject {
917
920
  */
918
921
  readonly _nominal_ConfigSnapshot: unique symbol;
919
922
  /**
923
+ * Populated if snapshot was in an error state.
924
+ *
920
925
  * - **ThreadSafety**: ReadSafe
921
926
  * - **Tags**: NotReplicated
922
927
  *
@@ -924,6 +929,8 @@ interface ConfigSnapshot extends RBXObject {
924
929
  */
925
930
  readonly Error: Enum.ConfigSnapshotErrorState;
926
931
  /**
932
+ * If true, indicates the snapshot is outdated and can be refreshed to newer values.
933
+ *
927
934
  * - **ThreadSafety**: ReadSafe
928
935
  * - **Tags**: NotReplicated
929
936
  *
@@ -931,29 +938,39 @@ interface ConfigSnapshot extends RBXObject {
931
938
  */
932
939
  readonly Outdated: boolean;
933
940
  /**
941
+ * Returns the value for the given key.
942
+ *
934
943
  * - **ThreadSafety**: Unsafe
935
944
  *
936
945
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#GetValue)
937
- * @param this
938
- * @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.
939
949
  */
940
950
  GetValue(this: ConfigSnapshot, key: string): unknown;
941
951
  /**
952
+ * Returns a signal that fires when the value for the given key changes due to a refresh.
953
+ *
942
954
  * - **ThreadSafety**: Unsafe
943
955
  *
944
956
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#GetValueChangedSignal)
945
- * @param this
946
- * @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.
947
960
  */
948
961
  GetValueChangedSignal(this: ConfigSnapshot, key: string): RBXScriptSignal;
949
962
  /**
963
+ * Refreshes the snapshot to the latest configuration values.
964
+ *
950
965
  * - **ThreadSafety**: Unsafe
951
966
  *
952
967
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#Refresh)
953
- * @param this
968
+ * @param this A snapshot of configuration values at a given version. Can be player-specific.
954
969
  */
955
970
  Refresh(this: ConfigSnapshot): void;
956
971
  /**
972
+ * Fires when a newer version of the configuration is available.
973
+ *
957
974
  * - **ThreadSafety**: Unsafe
958
975
  *
959
976
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigSnapshot#UpdateAvailable)
@@ -1035,7 +1052,7 @@ interface EditableImage extends RBXObject {
1035
1052
  * @param brushConfig Brush configuration dictionary including the following key-value pairs: - `AlphaBlendType` (`ImageAlphaType`) which determines how this projection will blend alpha values.
1036
1053
  * - `ColorBlendType` (`ImageCombineType`) which determines how this projection will blend color values.
1037
1054
  * - `Decal` (`EditableImage`) as the image used for projection.
1038
- * - `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.
1039
1056
  * - `BlendIntensity` (number) as the value between `0` and `1` which controls how much of the projection is blended into the resulting image.
1040
1057
  */
1041
1058
  DrawImageProjected(this: EditableImage, mesh: EditableMesh, projection: DrawImageProjectedProjection, brushConfig: DrawImageProjectedBrushConfig): void;
@@ -3381,6 +3398,8 @@ interface AnimationClipProvider extends Instance {
3381
3398
  */
3382
3399
  GetAnimationClipAsync(this: AnimationClipProvider, assetId: ContentId): AnimationClip;
3383
3400
  /**
3401
+ * **Deprecated:**
3402
+ *
3384
3403
  * This function returns an `InventoryPages` object which can be used to iterate over animations owned by a specific user.
3385
3404
  *
3386
3405
  * - **ThreadSafety**: Unsafe
@@ -3395,10 +3414,15 @@ interface AnimationClipProvider extends Instance {
3395
3414
  */
3396
3415
  GetAnimations(this: AnimationClipProvider, userId: number): Instance | undefined;
3397
3416
  /**
3417
+ * This function returns an `InventoryPages` object which can be used to iterate over animations owned by a specific user.
3418
+ *
3398
3419
  * - **ThreadSafety**: Unsafe
3399
3420
  * - **Tags**: Yields
3400
3421
  *
3401
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.
3402
3426
  */
3403
3427
  GetAnimationsAsync(this: AnimationClipProvider, userId: number): Instance | undefined;
3404
3428
  /**
@@ -4340,6 +4364,8 @@ interface AssetService extends Instance {
4340
4364
  */
4341
4365
  CreateSurfaceAppearanceAsync(this: AssetService, content: object): SurfaceAppearance;
4342
4366
  /**
4367
+ * **Deprecated:**
4368
+ *
4343
4369
  * Returns an array of asset IDs that are contained in a specified package.
4344
4370
  *
4345
4371
  * - **ThreadSafety**: Unsafe
@@ -4354,10 +4380,15 @@ interface AssetService extends Instance {
4354
4380
  */
4355
4381
  GetAssetIdsForPackage(this: AssetService, packageAssetId: number): Array<number>;
4356
4382
  /**
4383
+ * Returns an array of asset IDs that are contained in a specified package.
4384
+ *
4357
4385
  * - **ThreadSafety**: Unsafe
4358
4386
  * - **Tags**: Yields
4359
4387
  *
4360
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.
4361
4392
  */
4362
4393
  GetAssetIdsForPackageAsync(this: AssetService, packageAssetId: number): Array<unknown>;
4363
4394
  /**
@@ -4473,6 +4504,8 @@ interface AssetService extends Instance {
4473
4504
  */
4474
4505
  SavePlaceAsync(this: AssetService, requestParameters?: object): void;
4475
4506
  /**
4507
+ * **Deprecated:**
4508
+ *
4476
4509
  * Finds audio assets matching a variety of search criteria.
4477
4510
  *
4478
4511
  * - **ThreadSafety**: Unsafe
@@ -4486,10 +4519,14 @@ interface AssetService extends Instance {
4486
4519
  */
4487
4520
  SearchAudio(this: AssetService, searchParameters: AudioSearchParams): AudioPages;
4488
4521
  /**
4522
+ * Finds audio assets matching a variety of search criteria.
4523
+ *
4489
4524
  * - **ThreadSafety**: Unsafe
4490
4525
  * - **Tags**: Yields
4491
4526
  *
4492
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
4493
4530
  */
4494
4531
  SearchAudioAsync(this: AssetService, searchParameters: AudioSearchParams): AudioPages;
4495
4532
  }
@@ -6370,6 +6407,8 @@ interface AudioPlayer extends Instance {
6370
6407
  */
6371
6408
  AutoLoad: boolean;
6372
6409
  /**
6410
+ * Denotes whether this `AudioPlayer` starts playing as soon as it spawns in for the first time.
6411
+ *
6373
6412
  * - **ThreadSafety**: ReadSafe
6374
6413
  *
6375
6414
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#AutoPlay)
@@ -7881,6 +7920,8 @@ interface AvatarEditorService extends Instance {
7881
7920
  */
7882
7921
  PromptUpdateOutfit(this: AvatarEditorService, outfitId: number, updatedOutfit: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>): void;
7883
7922
  /**
7923
+ * **Deprecated:**
7924
+ *
7884
7925
  * Used to apply default clothing to the `HumanoidDescription` if necessary.
7885
7926
  *
7886
7927
  * - **ThreadSafety**: Unsafe
@@ -7895,13 +7936,20 @@ interface AvatarEditorService extends Instance {
7895
7936
  */
7896
7937
  CheckApplyDefaultClothing(this: AvatarEditorService, humanoidDescription: HumanoidDescription): HumanoidDescription | undefined;
7897
7938
  /**
7939
+ * Used to apply default clothing to the `HumanoidDescription` if necessary.
7940
+ *
7898
7941
  * - **ThreadSafety**: Unsafe
7899
7942
  * - **Tags**: Yields
7900
7943
  *
7901
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`.
7902
7948
  */
7903
7949
  CheckApplyDefaultClothingAsync(this: AvatarEditorService, humanoidDescription: HumanoidDescription): HumanoidDescription;
7904
7950
  /**
7951
+ * **Deprecated:**
7952
+ *
7905
7953
  * - **ThreadSafety**: Unsafe
7906
7954
  * - **Tags**: Yields
7907
7955
  *
@@ -7917,9 +7965,13 @@ interface AvatarEditorService extends Instance {
7917
7965
  * - **Tags**: Yields
7918
7966
  *
7919
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
7920
7970
  */
7921
7971
  ConformToAvatarRulesAsync(this: AvatarEditorService, humanoidDescription: HumanoidDescription): HumanoidDescription;
7922
7972
  /**
7973
+ * **Deprecated:**
7974
+ *
7923
7975
  * Returns the platform Avatar rules for things such as scaling, default shirts and pants, number of wearable assets.
7924
7976
  *
7925
7977
  * - **ThreadSafety**: Unsafe
@@ -7933,13 +7985,19 @@ interface AvatarEditorService extends Instance {
7933
7985
  */
7934
7986
  GetAvatarRules(this: AvatarEditorService): AvatarRules;
7935
7987
  /**
7988
+ * Returns the platform Avatar rules for things such as scaling, default shirts and pants, number of wearable assets.
7989
+ *
7936
7990
  * - **ThreadSafety**: Unsafe
7937
7991
  * - **Tags**: Yields
7938
7992
  *
7939
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.
7940
7996
  */
7941
7997
  GetAvatarRulesAsync(this: AvatarEditorService): object;
7942
7998
  /**
7999
+ * **Deprecated:**
8000
+ *
7943
8001
  * Gets the item details for a list of items at once.
7944
8002
  *
7945
8003
  * - **ThreadSafety**: Unsafe
@@ -7960,13 +8018,24 @@ interface AvatarEditorService extends Instance {
7960
8018
  GetBatchItemDetails(this: AvatarEditorService, itemIds: ReadonlyArray<number>, itemType: CastsToEnum<Enum.AvatarItemType.Bundle>): ReadonlyArray<BundleItemDetails>;
7961
8019
  GetBatchItemDetails(this: AvatarEditorService, itemIds: ReadonlyArray<number>, itemType: CastsToEnum<Enum.AvatarItemType>): ReadonlyArray<ItemDetails>;
7962
8020
  /**
8021
+ * Gets the item details for a list of items at once.
8022
+ *
7963
8023
  * - **ThreadSafety**: Unsafe
7964
8024
  * - **Tags**: Yields
7965
8025
  *
7966
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
+ * ``` .
7967
8034
  */
7968
8035
  GetBatchItemDetailsAsync(this: AvatarEditorService, itemIds: Array<unknown>, itemType: CastsToEnum<Enum.AvatarItemType>): Array<unknown>;
7969
8036
  /**
8037
+ * **Deprecated:**
8038
+ *
7970
8039
  * Returns if the `Players.LocalPlayer` has favorited the given bundle or asset.
7971
8040
  *
7972
8041
  * - **ThreadSafety**: Unsafe
@@ -7982,13 +8051,21 @@ interface AvatarEditorService extends Instance {
7982
8051
  */
7983
8052
  GetFavorite(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType>): boolean;
7984
8053
  /**
8054
+ * Returns if the `Players.LocalPlayer` has favorited the given bundle or asset.
8055
+ *
7985
8056
  * - **ThreadSafety**: Unsafe
7986
8057
  * - **Tags**: Yields
7987
8058
  *
7988
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.
7989
8064
  */
7990
8065
  GetFavoriteAsync(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType>): boolean;
7991
8066
  /**
8067
+ * **Deprecated:**
8068
+ *
7992
8069
  * Returns an `InventoryPages` object with information about owned items in the users inventory with the given AvatarAssetTypes.
7993
8070
  *
7994
8071
  * - **ThreadSafety**: Unsafe
@@ -8007,13 +8084,19 @@ interface AvatarEditorService extends Instance {
8007
8084
  Name: string;
8008
8085
  }>;
8009
8086
  /**
8087
+ * Returns an `InventoryPages` object with information about owned items in the users inventory with the given AvatarAssetTypes.
8088
+ *
8010
8089
  * - **ThreadSafety**: Unsafe
8011
8090
  * - **Tags**: Yields
8012
8091
  *
8013
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.
8014
8095
  */
8015
8096
  GetInventoryAsync(this: AvatarEditorService, assetTypes: Array<unknown>): InventoryPages;
8016
8097
  /**
8098
+ * **Deprecated:**
8099
+ *
8017
8100
  * Returns the item details for the given item.
8018
8101
  *
8019
8102
  * - **ThreadSafety**: Unsafe
@@ -8031,13 +8114,21 @@ interface AvatarEditorService extends Instance {
8031
8114
  GetItemDetails(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType.Bundle>): BundleItemDetails;
8032
8115
  GetItemDetails(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType>): ItemDetails;
8033
8116
  /**
8117
+ * Returns the item details for the given item.
8118
+ *
8034
8119
  * - **ThreadSafety**: Unsafe
8035
8120
  * - **Tags**: Yields
8036
8121
  *
8037
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.
8038
8127
  */
8039
8128
  GetItemDetailsAsync(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType>): object;
8040
8129
  /**
8130
+ * **Deprecated:**
8131
+ *
8041
8132
  * Returns the outfit details for the given outfit.
8042
8133
  *
8043
8134
  * - **ThreadSafety**: Unsafe
@@ -8052,13 +8143,20 @@ interface AvatarEditorService extends Instance {
8052
8143
  */
8053
8144
  GetOutfitDetails(this: AvatarEditorService, outfitId: number): object;
8054
8145
  /**
8146
+ * Returns the outfit details for the given outfit.
8147
+ *
8055
8148
  * - **ThreadSafety**: Unsafe
8056
8149
  * - **Tags**: Yields
8057
8150
  *
8058
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.
8059
8155
  */
8060
8156
  GetOutfitDetailsAsync(this: AvatarEditorService, outfitId: number): object;
8061
8157
  /**
8158
+ * **Deprecated:**
8159
+ *
8062
8160
  * Returns outfit data for the `Players.LocalPlayer`.
8063
8161
  *
8064
8162
  * - **ThreadSafety**: Unsafe
@@ -8073,13 +8171,20 @@ interface AvatarEditorService extends Instance {
8073
8171
  */
8074
8172
  GetOutfits(this: AvatarEditorService, outfitSource?: CastsToEnum<Enum.OutfitSource>, outfitType?: CastsToEnum<Enum.OutfitType>): OutfitPages;
8075
8173
  /**
8174
+ * Returns outfit data for the `Players.LocalPlayer`.
8175
+ *
8076
8176
  * - **ThreadSafety**: Unsafe
8077
8177
  * - **Tags**: Yields
8078
8178
  *
8079
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
8080
8183
  */
8081
8184
  GetOutfitsAsync(this: AvatarEditorService, outfitSource?: CastsToEnum<Enum.OutfitSource>, outfitType?: CastsToEnum<Enum.OutfitType>): OutfitPages;
8082
8185
  /**
8186
+ * **Deprecated:**
8187
+ *
8083
8188
  * Returns a list of recommended assets based on a given `AssetType` and asset ID.
8084
8189
  *
8085
8190
  * - **ThreadSafety**: Unsafe
@@ -8095,13 +8200,21 @@ interface AvatarEditorService extends Instance {
8095
8200
  */
8096
8201
  GetRecommendedAssets(this: AvatarEditorService, assetType: CastsToEnum<Enum.AvatarAssetType>, contextAssetId?: number): ReadonlyArray<RecommendedAsset>;
8097
8202
  /**
8203
+ * Returns a list of recommended assets based on a given `AssetType` and asset ID.
8204
+ *
8098
8205
  * - **ThreadSafety**: Unsafe
8099
8206
  * - **Tags**: Yields
8100
8207
  *
8101
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`.
8102
8213
  */
8103
8214
  GetRecommendedAssetsAsync(this: AvatarEditorService, assetType: CastsToEnum<Enum.AvatarAssetType>, contextAssetId?: number): Array<unknown>;
8104
8215
  /**
8216
+ * **Deprecated:**
8217
+ *
8105
8218
  * Returns a list of recommended bundles for a given bundle id.
8106
8219
  *
8107
8220
  * - **ThreadSafety**: Unsafe
@@ -8116,13 +8229,20 @@ interface AvatarEditorService extends Instance {
8116
8229
  */
8117
8230
  GetRecommendedBundles(this: AvatarEditorService, bundleId: number): ReadonlyArray<RecommendedBundle>;
8118
8231
  /**
8232
+ * Returns a list of recommended bundles for a given bundle id.
8233
+ *
8119
8234
  * - **ThreadSafety**: Unsafe
8120
8235
  * - **Tags**: Yields
8121
8236
  *
8122
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.
8123
8241
  */
8124
8242
  GetRecommendedBundlesAsync(this: AvatarEditorService, bundleId: number): Array<unknown>;
8125
8243
  /**
8244
+ * **Deprecated:**
8245
+ *
8126
8246
  * Returns a `CatalogPages` object containing the result of the given search.
8127
8247
  *
8128
8248
  * - **ThreadSafety**: Unsafe
@@ -8136,10 +8256,14 @@ interface AvatarEditorService extends Instance {
8136
8256
  */
8137
8257
  SearchCatalog(this: AvatarEditorService, searchParameters: CatalogSearchParams): CatalogPages;
8138
8258
  /**
8259
+ * Returns a `CatalogPages` object containing the result of the given search.
8260
+ *
8139
8261
  * - **ThreadSafety**: Unsafe
8140
8262
  * - **Tags**: Yields
8141
8263
  *
8142
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.
8143
8267
  */
8144
8268
  SearchCatalogAsync(this: AvatarEditorService, searchParameters: CatalogSearchParams): CatalogPages;
8145
8269
  /**
@@ -8274,6 +8398,8 @@ interface BadgeService extends Instance {
8274
8398
  */
8275
8399
  readonly _nominal_BadgeService: unique symbol;
8276
8400
  /**
8401
+ * **Deprecated:**
8402
+ *
8277
8403
  * Award a badge to a player given the ID of each.
8278
8404
  *
8279
8405
  * - **ThreadSafety**: Unsafe
@@ -8289,10 +8415,16 @@ interface BadgeService extends Instance {
8289
8415
  */
8290
8416
  AwardBadge(this: BadgeService, userId: number, badgeId: number): boolean;
8291
8417
  /**
8418
+ * Award a badge to a player given the ID of each.
8419
+ *
8292
8420
  * - **ThreadSafety**: Unsafe
8293
8421
  * - **Tags**: Yields
8294
8422
  *
8295
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.
8296
8428
  */
8297
8429
  AwardBadgeAsync(this: BadgeService, userId: number, badgeId: number): boolean;
8298
8430
  /**
@@ -11703,6 +11835,8 @@ interface CommerceService extends Instance {
11703
11835
  readonly PromptCommerceProductPurchaseFinished: RBXScriptSignal<(user: Player, productId: string) => void>;
11704
11836
  }
11705
11837
  /**
11838
+ * An animation curve that groups child `FloatCurves` which each animate a different component of a non-unary value.
11839
+ *
11706
11840
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CompositeValueCurve)
11707
11841
  */
11708
11842
  interface CompositeValueCurve extends Instance {
@@ -11715,25 +11849,37 @@ interface CompositeValueCurve extends Instance {
11715
11849
  */
11716
11850
  readonly _nominal_CompositeValueCurve: unique symbol;
11717
11851
  /**
11852
+ * The type of value animated by this `CompositeValueCurve`.
11853
+ *
11718
11854
  * - **ThreadSafety**: ReadSafe
11719
11855
  *
11720
11856
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CompositeValueCurve#CurveType)
11721
11857
  */
11722
11858
  CurveType: Enum.CompositeValueCurveType;
11723
11859
  /**
11860
+ * Returns the child curves with the given names for the `CurveType` of this `CompositeValueCurve`.
11861
+ *
11724
11862
  * - **ThreadSafety**: Unsafe
11725
11863
  *
11726
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.
11727
11866
  */
11728
11867
  GetComponentCurves(this: CompositeValueCurve): Array<Instance>;
11729
11868
  /**
11869
+ * Returns the sampled animated value at the passed `time` argument.
11870
+ *
11730
11871
  * - **ThreadSafety**: Unsafe
11731
11872
  *
11732
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.
11733
11877
  */
11734
11878
  GetValueAtTime(this: CompositeValueCurve, time: number): unknown;
11735
11879
  }
11736
11880
  /**
11881
+ * A game service that gives access to in-experience configuration with updates in real time.
11882
+ *
11737
11883
  * - **Tags**: NotCreatable, Service, NotReplicated
11738
11884
  *
11739
11885
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigService)
@@ -11748,37 +11894,47 @@ interface ConfigService extends Instance {
11748
11894
  */
11749
11895
  readonly _nominal_ConfigService: unique symbol;
11750
11896
  /**
11897
+ * Clears current testing value for the given key.
11898
+ *
11751
11899
  * - **ThreadSafety**: Unsafe
11752
11900
  *
11753
11901
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigService#ClearTestingValue)
11754
- * @param this
11755
- * @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.
11756
11904
  */
11757
11905
  ClearTestingValue(this: ConfigService, key: string): void;
11758
11906
  /**
11907
+ * Sets a testing override for the given key.
11908
+ *
11759
11909
  * - **ThreadSafety**: Unsafe
11760
11910
  *
11761
11911
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigService#SetTestingValue)
11762
- * @param this
11763
- * @param key
11764
- * @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.
11765
11915
  */
11766
11916
  SetTestingValue(this: ConfigService, key: string, value: unknown): void;
11767
11917
  /**
11918
+ * Retrieves a snapshot of the latest configuration.
11919
+ *
11768
11920
  * - **ThreadSafety**: Unsafe
11769
11921
  * - **Tags**: Yields
11770
11922
  *
11771
11923
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigService#GetConfigAsync)
11772
- * @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.
11773
11926
  */
11774
11927
  GetConfigAsync(this: ConfigService): ConfigSnapshot;
11775
11928
  /**
11929
+ * Retrieves a snapshot of the latest configuration for a specific player.
11930
+ *
11776
11931
  * - **ThreadSafety**: Unsafe
11777
11932
  * - **Tags**: Yields
11778
11933
  *
11779
11934
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigService#GetConfigForPlayerAsync)
11780
- * @param this
11781
- * @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.
11782
11938
  */
11783
11939
  GetConfigForPlayerAsync(this: ConfigService, player: Player): ConfigSnapshot;
11784
11940
  }
@@ -12184,6 +12340,8 @@ interface AngularVelocity extends Constraint {
12184
12340
  /**
12185
12341
  * Aligns two `BaseParts` with an animate-able kinematic or force-based joint.
12186
12342
  *
12343
+ * - **Tags**: NotBrowsable
12344
+ *
12187
12345
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationConstraint)
12188
12346
  */
12189
12347
  interface AnimationConstraint extends Constraint {
@@ -17294,10 +17452,15 @@ interface GroupService extends Instance {
17294
17452
  */
17295
17453
  GetGroupsAsync(this: GroupService, userId: number): Array<GetGroupsAsyncResult>;
17296
17454
  /**
17455
+ * Prompts the local `Player` to join a specified Roblox group via a native modal.
17456
+ *
17297
17457
  * - **ThreadSafety**: Unsafe
17298
17458
  * - **Tags**: Yields
17299
17459
  *
17300
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.
17301
17464
  */
17302
17465
  PromptJoinAsync(this: GroupService, groupId: number): Enum.GroupMembershipStatus;
17303
17466
  }
@@ -19031,6 +19194,18 @@ interface ScrollingFrame extends GuiObject {
19031
19194
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame#VerticalScrollBarPosition)
19032
19195
  */
19033
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;
19034
19209
  }
19035
19210
  /**
19036
19211
  * A 2D user interface element that displays player-editable text.
@@ -21542,6 +21717,12 @@ interface GuiService extends Instance {
21542
21717
  Vector2,
21543
21718
  Vector2
21544
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;
21545
21726
  /**
21546
21727
  * Returns whether the avatar inspection menu is enabled.
21547
21728
  *
@@ -23024,6 +23205,8 @@ interface Humanoid extends Instance {
23024
23205
  */
23025
23206
  UnequipTools(this: Humanoid): void;
23026
23207
  /**
23208
+ * **Deprecated:**
23209
+ *
23027
23210
  * Makes the character's look match that of the passed in `HumanoidDescription`.
23028
23211
  *
23029
23212
  * - **ThreadSafety**: Unsafe
@@ -23038,13 +23221,20 @@ interface Humanoid extends Instance {
23038
23221
  */
23039
23222
  ApplyDescription(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
23040
23223
  /**
23224
+ * Makes the character's look match that of the passed in `HumanoidDescription`.
23225
+ *
23041
23226
  * - **ThreadSafety**: Unsafe
23042
23227
  * - **Tags**: Yields
23043
23228
  *
23044
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.
23045
23233
  */
23046
23234
  ApplyDescriptionAsync(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
23047
23235
  /**
23236
+ * **Deprecated:**
23237
+ *
23048
23238
  * Makes the character's look match that of the passed in `HumanoidDescription`, even after external changes.
23049
23239
  *
23050
23240
  * - **ThreadSafety**: Unsafe
@@ -23059,13 +23249,20 @@ interface Humanoid extends Instance {
23059
23249
  */
23060
23250
  ApplyDescriptionReset(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
23061
23251
  /**
23252
+ * Makes the character's look match that of the passed in `HumanoidDescription`, even after external changes.
23253
+ *
23062
23254
  * - **ThreadSafety**: Unsafe
23063
23255
  * - **Tags**: Yields
23064
23256
  *
23065
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.
23066
23261
  */
23067
23262
  ApplyDescriptionResetAsync(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
23068
23263
  /**
23264
+ * **Deprecated:**
23265
+ *
23069
23266
  * Plays emotes and returns if was successfully ran.
23070
23267
  *
23071
23268
  * - **ThreadSafety**: Unsafe
@@ -23080,10 +23277,15 @@ interface Humanoid extends Instance {
23080
23277
  */
23081
23278
  PlayEmote(this: Humanoid, emoteName: string): boolean;
23082
23279
  /**
23280
+ * Plays emotes and returns if was successfully ran.
23281
+ *
23083
23282
  * - **ThreadSafety**: Unsafe
23084
23283
  * - **Tags**: Yields
23085
23284
  *
23086
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.
23087
23289
  */
23088
23290
  PlayEmoteAsync(this: Humanoid, emoteName: string): boolean;
23089
23291
  /**
@@ -24882,6 +25084,12 @@ interface InputBinding extends Instance {
24882
25084
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#PressedThreshold)
24883
25085
  */
24884
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;
24885
25093
  /**
24886
25094
  * Numerical value below which to fire an `InputAction` with a `Type` of `Bool`.
24887
25095
  *
@@ -24914,6 +25122,12 @@ interface InputBinding extends Instance {
24914
25122
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Scale)
24915
25123
  */
24916
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;
24917
25131
  /**
24918
25132
  * Connects a `GuiButton` to a boolean action.
24919
25133
  *
@@ -25178,6 +25392,8 @@ interface InsertService extends Instance {
25178
25392
  */
25179
25393
  GetCollection(this: InsertService, categoryId: number): Array<CollectionInfo>;
25180
25394
  /**
25395
+ * **Deprecated:**
25396
+ *
25181
25397
  * Retrieves a list of free Decals from the Catalog.
25182
25398
  *
25183
25399
  * - **ThreadSafety**: Unsafe
@@ -25195,13 +25411,21 @@ interface InsertService extends Instance {
25195
25411
  Array<FreeSearchResult>
25196
25412
  ];
25197
25413
  /**
25414
+ * Retrieves a list of free Decals from the Catalog.
25415
+ *
25198
25416
  * - **ThreadSafety**: Unsafe
25199
25417
  * - **Tags**: Yields
25200
25418
  *
25201
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.
25202
25424
  */
25203
25425
  GetFreeDecalsAsync(this: InsertService, searchText: string, pageNum: number): Array<unknown>;
25204
25426
  /**
25427
+ * **Deprecated:**
25428
+ *
25205
25429
  * Retrieves a list of Free Models from the Catalog.
25206
25430
  *
25207
25431
  * - **ThreadSafety**: Unsafe
@@ -25219,10 +25443,16 @@ interface InsertService extends Instance {
25219
25443
  Array<FreeSearchResult>
25220
25444
  ];
25221
25445
  /**
25446
+ * Retrieves a list of Free Models from the Catalog.
25447
+ *
25222
25448
  * - **ThreadSafety**: Unsafe
25223
25449
  * - **Tags**: Yields
25224
25450
  *
25225
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.
25226
25456
  */
25227
25457
  GetFreeModelsAsync(this: InsertService, searchText: string, pageNum: number): Array<unknown>;
25228
25458
  /**
@@ -25310,6 +25540,21 @@ interface InstanceExtensionsService extends Instance {
25310
25540
  */
25311
25541
  readonly _nominal_InstanceExtensionsService: unique symbol;
25312
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
+ }
25313
25558
  /**
25314
25559
  * - **Tags**: NotReplicated
25315
25560
  *
@@ -25980,6 +26225,8 @@ interface KeyframeSequenceProvider extends Instance {
25980
26225
  */
25981
26226
  RegisterKeyframeSequence(this: KeyframeSequenceProvider, keyframeSequence: Instance): ContentId;
25982
26227
  /**
26228
+ * **Deprecated:**
26229
+ *
25983
26230
  * This function returns an `InventoryPages` object which can be used to iterate over animations owned by a specific user.
25984
26231
  *
25985
26232
  * - **ThreadSafety**: Unsafe
@@ -25994,10 +26241,15 @@ interface KeyframeSequenceProvider extends Instance {
25994
26241
  */
25995
26242
  GetAnimations(this: KeyframeSequenceProvider, userId: number): InventoryPages<number>;
25996
26243
  /**
26244
+ * This function returns an `InventoryPages` object which can be used to iterate over animations owned by a specific user.
26245
+ *
25997
26246
  * - **ThreadSafety**: Unsafe
25998
26247
  * - **Tags**: Yields
25999
26248
  *
26000
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.
26001
26253
  */
26002
26254
  GetAnimationsAsync(this: KeyframeSequenceProvider, userId: number): Instance | undefined;
26003
26255
  /**
@@ -27461,6 +27713,8 @@ interface MarketplaceService extends Instance {
27461
27713
  Name: string;
27462
27714
  }>;
27463
27715
  /**
27716
+ * **Deprecated:**
27717
+ *
27464
27718
  * Returns the product information of an asset using its asset ID.
27465
27719
  *
27466
27720
  * - **ThreadSafety**: Unsafe
@@ -27482,10 +27736,16 @@ interface MarketplaceService extends Instance {
27482
27736
  GetProductInfo(this: MarketplaceService, id: number, infoType: CastsToEnum<Enum.InfoType.Subscription>): SubscriptionProductInfo;
27483
27737
  GetProductInfo(this: MarketplaceService, id: number, infoType?: CastsToEnum<Enum.InfoType>): AssetProductInfo | BundleInfo | GamePassProductInfo | DeveloperProductInfo | SubscriptionProductInfo;
27484
27738
  /**
27739
+ * Returns the product information of an asset using its asset ID.
27740
+ *
27485
27741
  * - **ThreadSafety**: Unsafe
27486
27742
  * - **Tags**: Yields
27487
27743
  *
27488
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.
27489
27749
  */
27490
27750
  GetProductInfoAsync(this: MarketplaceService, assetId: number, infoType?: CastsToEnum<Enum.InfoType>): object;
27491
27751
  /**
@@ -27548,6 +27808,8 @@ interface MarketplaceService extends Instance {
27548
27808
  */
27549
27809
  GetUsersPriceLevelsAsync(this: MarketplaceService, userIds: Array<unknown>): Array<unknown>;
27550
27810
  /**
27811
+ * **Deprecated:**
27812
+ *
27551
27813
  * Returns whether the given user has the given asset.
27552
27814
  *
27553
27815
  * - **ThreadSafety**: Unsafe
@@ -27563,13 +27825,21 @@ interface MarketplaceService extends Instance {
27563
27825
  */
27564
27826
  PlayerOwnsAsset(this: MarketplaceService, player: Player, assetId: number): boolean;
27565
27827
  /**
27828
+ * Returns whether the given user has the given asset.
27829
+ *
27566
27830
  * - **ThreadSafety**: Unsafe
27567
27831
  * - **Tags**: Yields
27568
27832
  *
27569
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.
27570
27838
  */
27571
27839
  PlayerOwnsAssetAsync(this: MarketplaceService, player: Instance, assetId: number): boolean;
27572
27840
  /**
27841
+ * **Deprecated:**
27842
+ *
27573
27843
  * Returns whether the given player owns the given bundle.
27574
27844
  *
27575
27845
  * - **ThreadSafety**: Unsafe
@@ -27585,28 +27855,54 @@ interface MarketplaceService extends Instance {
27585
27855
  */
27586
27856
  PlayerOwnsBundle(this: MarketplaceService, player: Player, bundleId: number): boolean;
27587
27857
  /**
27858
+ * Returns whether the given player owns the given bundle.
27859
+ *
27588
27860
  * - **ThreadSafety**: Unsafe
27589
27861
  * - **Tags**: Yields
27590
27862
  *
27591
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.
27592
27868
  */
27593
27869
  PlayerOwnsBundleAsync(this: MarketplaceService, player: Player, bundleId: number): boolean;
27594
27870
  /**
27871
+ * Takes a list of product IDs and returns a personalized ordered list of those products.
27872
+ *
27595
27873
  * - **ThreadSafety**: Unsafe
27596
27874
  * - **Tags**: Yields
27597
27875
  *
27598
27876
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#RankProductsAsync)
27599
27877
  * @param this The service responsible for in-experience transactions.
27600
- * @param productIdentifiers
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`.
27601
27889
  */
27602
27890
  RankProductsAsync(this: MarketplaceService, productIdentifiers: Array<unknown>): Array<unknown>;
27603
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
+ *
27604
27896
  * - **ThreadSafety**: Unsafe
27605
27897
  * - **Tags**: Yields
27606
27898
  *
27607
27899
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#RecommendTopProductsAsync)
27608
27900
  * @param this The service responsible for in-experience transactions.
27609
- * @param infoTypes
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.
27610
27906
  */
27611
27907
  RecommendTopProductsAsync(this: MarketplaceService, infoTypes: Array<unknown>): Array<unknown>;
27612
27908
  /**
@@ -32439,7 +32735,7 @@ interface Workspace extends WorldRoot {
32439
32735
  *
32440
32736
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#GetPhysicsThrottling)
32441
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.
32442
- * @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.
32443
32739
  */
32444
32740
  GetPhysicsThrottling(this: Workspace): number;
32445
32741
  /**
@@ -34247,7 +34543,7 @@ interface Player extends Instance {
34247
34543
  */
34248
34544
  GetMouse(this: Player): PlayerMouse;
34249
34545
  /**
34250
- * Returns the isolated network latency in seconds.
34546
+ * Returns the round-trip, isolated network latency in seconds.
34251
34547
  *
34252
34548
  * - **ThreadSafety**: Safe
34253
34549
  *
@@ -34446,6 +34742,8 @@ interface Player extends Instance {
34446
34742
  */
34447
34743
  SaveString(this: Player, key: string, value: string): void;
34448
34744
  /**
34745
+ * **Deprecated:**
34746
+ *
34449
34747
  * Returns a dictionary of online connections.
34450
34748
  *
34451
34749
  * - **ThreadSafety**: Unsafe
@@ -34460,13 +34758,20 @@ interface Player extends Instance {
34460
34758
  */
34461
34759
  GetFriendsOnline(this: Player, maxFriends?: number): Array<FriendOnlineInfo>;
34462
34760
  /**
34761
+ * Returns a dictionary of online connections.
34762
+ *
34463
34763
  * - **ThreadSafety**: Unsafe
34464
34764
  * - **Tags**: Yields
34465
34765
  *
34466
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).
34467
34770
  */
34468
34771
  GetFriendsOnlineAsync(this: Player, maxFriends?: number): Array<unknown>;
34469
34772
  /**
34773
+ * **Deprecated:**
34774
+ *
34470
34775
  * Returns the player's rank in the group as an integer.
34471
34776
  *
34472
34777
  * - **ThreadSafety**: Unsafe
@@ -34481,13 +34786,20 @@ interface Player extends Instance {
34481
34786
  */
34482
34787
  GetRankInGroup(this: Player, groupId: number): number;
34483
34788
  /**
34789
+ * Returns the player's rank in the group as an integer.
34790
+ *
34484
34791
  * - **ThreadSafety**: Unsafe
34485
34792
  * - **Tags**: Yields
34486
34793
  *
34487
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.
34488
34798
  */
34489
34799
  GetRankInGroupAsync(this: Player, groupId: number): number;
34490
34800
  /**
34801
+ * **Deprecated:**
34802
+ *
34491
34803
  * Returns the player's role in the group as a string, or `Guest` if the player isn't part of the group.
34492
34804
  *
34493
34805
  * - **ThreadSafety**: Unsafe
@@ -34502,10 +34814,15 @@ interface Player extends Instance {
34502
34814
  */
34503
34815
  GetRoleInGroup(this: Player, groupId: number): string;
34504
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
+ *
34505
34819
  * - **ThreadSafety**: Unsafe
34506
34820
  * - **Tags**: Yields
34507
34821
  *
34508
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.
34509
34826
  */
34510
34827
  GetRoleInGroupAsync(this: Player, groupId: number): string;
34511
34828
  /**
@@ -34524,6 +34841,8 @@ interface Player extends Instance {
34524
34841
  */
34525
34842
  IsBestFriendsWith(this: Player, userId: number): boolean;
34526
34843
  /**
34844
+ * **Deprecated:**
34845
+ *
34527
34846
  * Checks whether a player is a connection of the user with the given `Player.UserId`.
34528
34847
  *
34529
34848
  * - **ThreadSafety**: Unsafe
@@ -34538,13 +34857,20 @@ interface Player extends Instance {
34538
34857
  */
34539
34858
  IsFriendsWith(this: Player, userId: number): boolean;
34540
34859
  /**
34860
+ * Checks whether a player is a connection of the user with the given `Player.UserId`.
34861
+ *
34541
34862
  * - **ThreadSafety**: Unsafe
34542
34863
  * - **Tags**: Yields
34543
34864
  *
34544
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.
34545
34869
  */
34546
34870
  IsFriendsWithAsync(this: Player, userId: number): boolean;
34547
34871
  /**
34872
+ * **Deprecated:**
34873
+ *
34548
34874
  * Checks whether a player is a member of a group with the given ID.
34549
34875
  *
34550
34876
  * - **ThreadSafety**: Unsafe
@@ -34559,13 +34885,20 @@ interface Player extends Instance {
34559
34885
  */
34560
34886
  IsInGroup(this: Player, groupId: number): boolean;
34561
34887
  /**
34888
+ * Checks whether a player is a member of a group with the given ID.
34889
+ *
34562
34890
  * - **ThreadSafety**: Unsafe
34563
34891
  * - **Tags**: Yields
34564
34892
  *
34565
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.
34566
34897
  */
34567
34898
  IsInGroupAsync(this: Player, groupId: number): boolean;
34568
34899
  /**
34900
+ * **Deprecated:**
34901
+ *
34569
34902
  * Creates a new character for the player, removing the old one. Also clears the player's `Backpack` and `PlayerGui`.
34570
34903
  *
34571
34904
  * - **ThreadSafety**: Unsafe
@@ -34578,13 +34911,18 @@ interface Player extends Instance {
34578
34911
  */
34579
34912
  LoadCharacter(this: Player): void;
34580
34913
  /**
34914
+ * Creates a new character for the player, removing the old one. Also clears the player's `Backpack` and `PlayerGui`.
34915
+ *
34581
34916
  * - **ThreadSafety**: Unsafe
34582
34917
  * - **Tags**: Yields
34583
34918
  *
34584
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.
34585
34921
  */
34586
34922
  LoadCharacterAsync(this: Player): void;
34587
34923
  /**
34924
+ * **Deprecated:**
34925
+ *
34588
34926
  * Spawns a player character with everything equipped in the passed in `HumanoidDescription`.
34589
34927
  *
34590
34928
  * - **ThreadSafety**: Unsafe
@@ -34598,10 +34936,14 @@ interface Player extends Instance {
34598
34936
  */
34599
34937
  LoadCharacterWithHumanoidDescription(this: Player, humanoidDescription: HumanoidDescription): void;
34600
34938
  /**
34939
+ * Spawns a player character with everything equipped in the passed in `HumanoidDescription`.
34940
+ *
34601
34941
  * - **ThreadSafety**: Unsafe
34602
34942
  * - **Tags**: Yields
34603
34943
  *
34604
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.
34605
34947
  */
34606
34948
  LoadCharacterWithHumanoidDescriptionAsync(this: Player, humanoidDescription: HumanoidDescription): void;
34607
34949
  /**
@@ -35197,6 +35539,8 @@ interface Players extends Instance {
35197
35539
  */
35198
35540
  BanAsync(this: Players, config: BanAsyncConfig): void;
35199
35541
  /**
35542
+ * **Deprecated:**
35543
+ *
35200
35544
  * Returns a character `Model` equipped with everything specified in the passed in `HumanoidDescription`.
35201
35545
  *
35202
35546
  * - **ThreadSafety**: Unsafe
@@ -35213,13 +35557,22 @@ interface Players extends Instance {
35213
35557
  */
35214
35558
  CreateHumanoidModelFromDescription(this: Players, description: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): Model;
35215
35559
  /**
35560
+ * Returns a character `Model` equipped with everything specified in the passed in `HumanoidDescription`.
35561
+ *
35216
35562
  * - **ThreadSafety**: Unsafe
35217
35563
  * - **Tags**: Yields
35218
35564
  *
35219
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`.
35220
35571
  */
35221
35572
  CreateHumanoidModelFromDescriptionAsync(this: Players, description: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): Model;
35222
35573
  /**
35574
+ * **Deprecated:**
35575
+ *
35223
35576
  * Returns a character Model set-up with everything equipped to match the avatar of the user specified by the passed in userId.
35224
35577
  *
35225
35578
  * - **ThreadSafety**: Unsafe
@@ -35234,10 +35587,15 @@ interface Players extends Instance {
35234
35587
  */
35235
35588
  CreateHumanoidModelFromUserId(this: Players, userId: number): Model;
35236
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
+ *
35237
35592
  * - **ThreadSafety**: Unsafe
35238
35593
  * - **Tags**: Yields
35239
35594
  *
35240
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.
35241
35599
  */
35242
35600
  CreateHumanoidModelFromUserIdAsync(this: Players, userId: number): Model;
35243
35601
  /**
@@ -35291,6 +35649,8 @@ interface Players extends Instance {
35291
35649
  */
35292
35650
  GetFriendsAsync(this: Players, userId: number): FriendPages;
35293
35651
  /**
35652
+ * **Deprecated:**
35653
+ *
35294
35654
  * Returns the HumanoidDescription for a specified outfit, which will be set with the parts/colors/Animations etc of the outfit.
35295
35655
  *
35296
35656
  * - **ThreadSafety**: Unsafe
@@ -35305,13 +35665,20 @@ interface Players extends Instance {
35305
35665
  */
35306
35666
  GetHumanoidDescriptionFromOutfitId(this: Players, outfitId: number): HumanoidDescription;
35307
35667
  /**
35668
+ * Returns the HumanoidDescription for a specified outfit, which will be set with the parts/colors/Animations etc of the outfit.
35669
+ *
35308
35670
  * - **ThreadSafety**: Unsafe
35309
35671
  * - **Tags**: Yields
35310
35672
  *
35311
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.
35312
35677
  */
35313
35678
  GetHumanoidDescriptionFromOutfitIdAsync(this: Players, outfitId: number): HumanoidDescription;
35314
35679
  /**
35680
+ * **Deprecated:**
35681
+ *
35315
35682
  * Returns a HumanoidDescription which specifies everything equipped for the avatar of the user specified by the passed in userId.
35316
35683
  *
35317
35684
  * - **ThreadSafety**: Unsafe
@@ -35326,10 +35693,15 @@ interface Players extends Instance {
35326
35693
  */
35327
35694
  GetHumanoidDescriptionFromUserId(this: Players, userId: number): HumanoidDescription;
35328
35695
  /**
35696
+ * Returns a HumanoidDescription which specifies everything equipped for the avatar of the user specified by the passed in userId.
35697
+ *
35329
35698
  * - **ThreadSafety**: Unsafe
35330
35699
  * - **Tags**: Yields
35331
35700
  *
35332
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.
35333
35705
  */
35334
35706
  GetHumanoidDescriptionFromUserIdAsync(this: Players, userId: number): HumanoidDescription;
35335
35707
  /**
@@ -35939,7 +36311,7 @@ interface ProximityPrompt extends Instance {
35939
36311
  */
35940
36312
  ClickablePrompt: boolean;
35941
36313
  /**
35942
- * Whether this prompt should be shown.
36314
+ * Whether or not this prompt should be shown.
35943
36315
  *
35944
36316
  * - **ThreadSafety**: ReadSafe
35945
36317
  *
@@ -36079,7 +36451,7 @@ interface ProximityPrompt extends Instance {
36079
36451
  */
36080
36452
  readonly PromptButtonHoldEnded: RBXScriptSignal<(playerWhoTriggered: Player) => void>;
36081
36453
  /**
36082
- * Triggers when the prompt becomes hidden.
36454
+ * Triggers when the `prompt` becomes hidden.
36083
36455
  *
36084
36456
  * - **ThreadSafety**: Unsafe
36085
36457
  *
@@ -36883,20 +37255,29 @@ interface RunService extends Instance {
36883
37255
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RunService#BindToRenderStep)
36884
37256
  * @param this Service responsible for all runtime activity and progression of time.
36885
37257
  * @param name Label for the binding which can be used with `Unbind` if the binding is no longer needed.
36886
- * @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.
36887
37259
  * @param function The custom function being bound.
36888
37260
  */
36889
37261
  BindToRenderStep(this: RunService, name: string, priority: number, callback: (deltaTime: number) => void): void;
36890
37262
  /**
37263
+ * Binds a custom function to be called at a fixed frequency which is independent of the frame rate.
37264
+ *
36891
37265
  * - **ThreadSafety**: Unsafe
36892
37266
  *
36893
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.
36894
37271
  */
36895
37272
  BindToSimulation(this: RunService, callback: Callback, frequency?: CastsToEnum<Enum.StepFrequency>): RBXScriptConnection;
36896
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
+ *
36897
37276
  * - **ThreadSafety**: Unsafe
36898
37277
  *
36899
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.
36900
37281
  */
36901
37282
  GetPredictionStatus(this: RunService, context: Instance): Enum.PredictionStatus;
36902
37283
  /**
@@ -36950,9 +37331,14 @@ interface RunService extends Instance {
36950
37331
  */
36951
37332
  IsStudio(this: RunService): boolean;
36952
37333
  /**
37334
+ * Sets the prediction mode for an `Instance` to an `PredictionMode` value.
37335
+ *
36953
37336
  * - **ThreadSafety**: Unsafe
36954
37337
  *
36955
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.
36956
37342
  */
36957
37343
  SetPredictionMode(this: RunService, context: Instance, mode: CastsToEnum<Enum.PredictionMode>): void;
36958
37344
  /**
@@ -37065,7 +37451,7 @@ interface RuntimeContentService extends Instance {
37065
37451
  *
37066
37452
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RuntimeContentService#RuntimeContentShare)
37067
37453
  */
37068
- readonly RuntimeContentShare: RBXScriptSignal<(id: string, content: string) => void>;
37454
+ readonly RuntimeContentShare: RBXScriptSignal<(id: string, content: string, metadata: string) => void>;
37069
37455
  }
37070
37456
  /**
37071
37457
  * - **Tags**: NotCreatable, Service
@@ -37884,6 +38270,13 @@ interface DataModel extends ServiceProvider<Services> {
37884
38270
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#PrivateServerOwnerId)
37885
38271
  */
37886
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;
37887
38280
  /**
37888
38281
  * **Deprecated:** This property has been deprecated. Use `DataModel.PrivateServerId` instead.
37889
38282
  *
@@ -38673,6 +39066,8 @@ interface SocialService extends Instance {
38673
39066
  */
38674
39067
  PromptFeedbackSubmissionAsync(this: SocialService): void;
38675
39068
  /**
39069
+ * **Deprecated:**
39070
+ *
38676
39071
  * - **ThreadSafety**: Unsafe
38677
39072
  * - **Tags**: Yields
38678
39073
  *
@@ -38697,6 +39092,17 @@ interface SocialService extends Instance {
38697
39092
  * - **Tags**: Yields
38698
39093
  *
38699
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.
38700
39106
  */
38701
39107
  PromptLinkSharingAsync(this: SocialService, player: Player, options?: object): unknown;
38702
39108
  /**
@@ -39553,7 +39959,7 @@ interface SoundGroup extends Instance {
39553
39959
  Volume: number;
39554
39960
  }
39555
39961
  /**
39556
- * 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.
39557
39963
  *
39558
39964
  * - **Tags**: NotCreatable, Service
39559
39965
  *
@@ -39569,13 +39975,15 @@ interface SoundService extends Instance {
39569
39975
  */
39570
39976
  readonly _nominal_SoundService: unique symbol;
39571
39977
  /**
39978
+ * Determines whether acoustic simulation is enabled globally in the advanced audio system.
39979
+ *
39572
39980
  * - **ThreadSafety**: ReadSafe
39573
39981
  *
39574
39982
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#AcousticSimulationEnabled)
39575
39983
  */
39576
39984
  AcousticSimulationEnabled: boolean;
39577
39985
  /**
39578
- * The ambient sound environment preset used by `SoundService`.
39986
+ * The ambient sound environment preset applied to all `Sounds`.
39579
39987
  *
39580
39988
  * - **ThreadSafety**: ReadSafe
39581
39989
  *
@@ -39583,13 +39991,15 @@ interface SoundService extends Instance {
39583
39991
  */
39584
39992
  AmbientReverb: Enum.ReverbType;
39585
39993
  /**
39994
+ * Determines whether the default character sounds will use instances in the advanced audio system vs. `Sounds`.
39995
+ *
39586
39996
  * - **ThreadSafety**: ReadSafe
39587
39997
  *
39588
39998
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#CharacterSoundsUseNewApi)
39589
39999
  */
39590
40000
  get CharacterSoundsUseNewApi(): Enum.RolloutState;
39591
40001
  /**
39592
- * 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`.
39593
40003
  *
39594
40004
  * - **ThreadSafety**: ReadSafe
39595
40005
  *
@@ -39613,7 +40023,7 @@ interface SoundService extends Instance {
39613
40023
  */
39614
40024
  RespectFilteringEnabled: boolean;
39615
40025
  /**
39616
- * Sets how fast `Sound` volume attenuates.
40026
+ * Determines how fast the volume of a `Sound` attenuates beyond its `Sound.RollOffMinDistance`.
39617
40027
  *
39618
40028
  * - **ThreadSafety**: ReadSafe
39619
40029
  *
@@ -39621,13 +40031,18 @@ interface SoundService extends Instance {
39621
40031
  */
39622
40032
  RolloffScale: number;
39623
40033
  /**
39624
- * 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.
39625
40035
  *
39626
40036
  * - **ThreadSafety**: Unsafe
39627
40037
  *
39628
40038
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#GetListener)
39629
- * @param this A service that determines various aspects of how `Sounds` play in the experience.
39630
- * @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()`. |
39631
40046
  */
39632
40047
  GetListener(this: SoundService): LuaTuple<[
39633
40048
  Enum.ListenerType.Camera,
@@ -39643,22 +40058,22 @@ interface SoundService extends Instance {
39643
40058
  BasePart
39644
40059
  ]>;
39645
40060
  /**
39646
- * 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.
39647
40062
  *
39648
40063
  * - **ThreadSafety**: Unsafe
39649
40064
  *
39650
40065
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#PlayLocalSound)
39651
- * @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.
39652
40067
  * @param sound The `Sound` to be played.
39653
40068
  */
39654
40069
  PlayLocalSound(this: SoundService, sound: Sound): void;
39655
40070
  /**
39656
- * Sets the listener for the `SoundService`.
40071
+ * Sets the listener used by `Sounds`.
39657
40072
  *
39658
40073
  * - **ThreadSafety**: Unsafe
39659
40074
  *
39660
40075
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#SetListener)
39661
- * @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.
39662
40077
  * @param listenerType The `ListenerType` of the listener.
39663
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`.
39664
40079
  */
@@ -39855,6 +40270,8 @@ interface StarterPlayer extends Instance {
39855
40270
  */
39856
40271
  CameraMode: Enum.CameraMode;
39857
40272
  /**
40273
+ * Determines the starting value of `Humanoid.BreakJointsOnDeath` for `Player.Character`.
40274
+ *
39858
40275
  * - **ThreadSafety**: ReadSafe
39859
40276
  *
39860
40277
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StarterPlayer#CharacterBreakJointsOnDeath)
@@ -39902,6 +40319,7 @@ interface StarterPlayer extends Instance {
39902
40319
  CharacterWalkSpeed: number;
39903
40320
  /**
39904
40321
  * - **ThreadSafety**: ReadSafe
40322
+ * - **Tags**: NotBrowsable
39905
40323
  *
39906
40324
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StarterPlayer#ClassicDeath)
39907
40325
  */
@@ -40561,6 +40979,8 @@ interface StudioSdkService extends Instance {
40561
40979
  readonly _nominal_StudioSdkService: unique symbol;
40562
40980
  }
40563
40981
  /**
40982
+ * Service allowing plugins to automate and customize Test and Run mode testing.
40983
+ *
40564
40984
  * - **Tags**: NotCreatable, Service, NotReplicated
40565
40985
  *
40566
40986
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioTestService)
@@ -40578,12 +40998,16 @@ interface StudioTestService extends Instance {
40578
40998
  * - **ThreadSafety**: Unsafe
40579
40999
  *
40580
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.
40581
41003
  */
40582
41004
  EndTest(this: StudioTestService, value: unknown): void;
40583
41005
  /**
40584
41006
  * - **ThreadSafety**: Unsafe
40585
41007
  *
40586
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`.
40587
41011
  */
40588
41012
  GetTestArgs(this: StudioTestService): unknown;
40589
41013
  }
@@ -40869,12 +41293,6 @@ interface StyleQuery extends Instance {
40869
41293
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleQuery#IsActive)
40870
41294
  */
40871
41295
  readonly IsActive: boolean;
40872
- /**
40873
- * - **ThreadSafety**: ReadSafe
40874
- *
40875
- * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleQuery#MaxSize)
40876
- */
40877
- MaxSize: Vector2;
40878
41296
  /**
40879
41297
  * - **ThreadSafety**: ReadSafe
40880
41298
  *
@@ -41465,6 +41883,8 @@ interface TeleportService extends Instance {
41465
41883
  */
41466
41884
  PromptExperienceDetailsAsync(this: TeleportService, player: Player, universeId: number): Enum.PromptExperienceDetailsResult;
41467
41885
  /**
41886
+ * **Deprecated:**
41887
+ *
41468
41888
  * Returns an access code that can be used to teleport players to a reserved server, along with the `DataModel.PrivateServerId` for it.
41469
41889
  *
41470
41890
  * - **ThreadSafety**: Unsafe
@@ -41482,10 +41902,15 @@ interface TeleportService extends Instance {
41482
41902
  string
41483
41903
  ]>;
41484
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
+ *
41485
41907
  * - **ThreadSafety**: Unsafe
41486
41908
  * - **Tags**: Yields
41487
41909
  *
41488
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.
41489
41914
  */
41490
41915
  ReserveServerAsync(this: TeleportService, placeId: number): unknown;
41491
41916
  /**
@@ -42661,7 +43086,7 @@ interface ChatWindowConfiguration extends TextChatConfigurations {
42661
43086
  DeriveNewMessageProperties(this: ChatWindowConfiguration): ChatWindowMessageProperties;
42662
43087
  }
42663
43088
  /**
42664
- * Immutable data object representing a text chat message.
43089
+ * A data object representing a text chat message.
42665
43090
  *
42666
43091
  * - **Tags**: NotCreatable
42667
43092
  *