@rbxts/types 1.0.896 → 1.0.902
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.
- package/README.md +2 -0
- package/include/generated/None.d.ts +496 -82
- package/include/generated/PluginSecurity.d.ts +140 -27
- package/include/generated/enums.d.ts +228 -53
- package/package.json +1 -1
|
@@ -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;
|
|
@@ -810,7 +811,7 @@ interface AnimationNode extends RBXObject {
|
|
|
810
811
|
readonly _nominal_AnimationNode: unique symbol;
|
|
811
812
|
}
|
|
812
813
|
/**
|
|
813
|
-
* A class which defines a piece of content, such as a
|
|
814
|
+
* A class which defines a piece of content, such as a screenshot or video, taken in-experience.
|
|
814
815
|
*
|
|
815
816
|
* - **Tags**: NotCreatable, NotReplicated
|
|
816
817
|
*
|
|
@@ -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;
|
|
@@ -2913,13 +2930,15 @@ interface AdService extends Instance {
|
|
|
2913
2930
|
*/
|
|
2914
2931
|
GetAdAvailabilityNowAsync(this: AdService, adFormat: CastsToEnum<Enum.AdFormat>): unknown;
|
|
2915
2932
|
/**
|
|
2933
|
+
* Tracks how many times a user had the chance to watch a video ad and the rate at which they actually watched the ad.
|
|
2934
|
+
*
|
|
2916
2935
|
* - **ThreadSafety**: Unsafe
|
|
2917
2936
|
* - **Tags**: Yields
|
|
2918
2937
|
*
|
|
2919
2938
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#RegisterAdOpportunityAsync)
|
|
2920
2939
|
* @param this A class that allows the display of mobile video ads.
|
|
2921
2940
|
* @param instance
|
|
2922
|
-
* @param placementId
|
|
2941
|
+
* @param placementId The ID of the placement of the rewarded video ad inside the experience. Allows for reporting on the performance of individual ad placements.
|
|
2923
2942
|
*/
|
|
2924
2943
|
RegisterAdOpportunityAsync(this: AdService, instance: Instance, placementId?: number): void;
|
|
2925
2944
|
/**
|
|
@@ -3381,6 +3400,8 @@ interface AnimationClipProvider extends Instance {
|
|
|
3381
3400
|
*/
|
|
3382
3401
|
GetAnimationClipAsync(this: AnimationClipProvider, assetId: ContentId): AnimationClip;
|
|
3383
3402
|
/**
|
|
3403
|
+
* **Deprecated:**
|
|
3404
|
+
*
|
|
3384
3405
|
* This function returns an `InventoryPages` object which can be used to iterate over animations owned by a specific user.
|
|
3385
3406
|
*
|
|
3386
3407
|
* - **ThreadSafety**: Unsafe
|
|
@@ -3395,10 +3416,15 @@ interface AnimationClipProvider extends Instance {
|
|
|
3395
3416
|
*/
|
|
3396
3417
|
GetAnimations(this: AnimationClipProvider, userId: number): Instance | undefined;
|
|
3397
3418
|
/**
|
|
3419
|
+
* This function returns an `InventoryPages` object which can be used to iterate over animations owned by a specific user.
|
|
3420
|
+
*
|
|
3398
3421
|
* - **ThreadSafety**: Unsafe
|
|
3399
3422
|
* - **Tags**: Yields
|
|
3400
3423
|
*
|
|
3401
3424
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationClipProvider#GetAnimationsAsync)
|
|
3425
|
+
* @param this Provides functions to load and preview `AnimationClips`.
|
|
3426
|
+
* @param userId The user ID of the user.
|
|
3427
|
+
* @returns An `InventoryPages` of animations.
|
|
3402
3428
|
*/
|
|
3403
3429
|
GetAnimationsAsync(this: AnimationClipProvider, userId: number): Instance | undefined;
|
|
3404
3430
|
/**
|
|
@@ -4340,6 +4366,8 @@ interface AssetService extends Instance {
|
|
|
4340
4366
|
*/
|
|
4341
4367
|
CreateSurfaceAppearanceAsync(this: AssetService, content: object): SurfaceAppearance;
|
|
4342
4368
|
/**
|
|
4369
|
+
* **Deprecated:**
|
|
4370
|
+
*
|
|
4343
4371
|
* Returns an array of asset IDs that are contained in a specified package.
|
|
4344
4372
|
*
|
|
4345
4373
|
* - **ThreadSafety**: Unsafe
|
|
@@ -4354,10 +4382,15 @@ interface AssetService extends Instance {
|
|
|
4354
4382
|
*/
|
|
4355
4383
|
GetAssetIdsForPackage(this: AssetService, packageAssetId: number): Array<number>;
|
|
4356
4384
|
/**
|
|
4385
|
+
* Returns an array of asset IDs that are contained in a specified package.
|
|
4386
|
+
*
|
|
4357
4387
|
* - **ThreadSafety**: Unsafe
|
|
4358
4388
|
* - **Tags**: Yields
|
|
4359
4389
|
*
|
|
4360
4390
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#GetAssetIdsForPackageAsync)
|
|
4391
|
+
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
4392
|
+
* @param packageAssetId
|
|
4393
|
+
* @returns Asset IDs that are contained in a specified package.
|
|
4361
4394
|
*/
|
|
4362
4395
|
GetAssetIdsForPackageAsync(this: AssetService, packageAssetId: number): Array<unknown>;
|
|
4363
4396
|
/**
|
|
@@ -4473,6 +4506,8 @@ interface AssetService extends Instance {
|
|
|
4473
4506
|
*/
|
|
4474
4507
|
SavePlaceAsync(this: AssetService, requestParameters?: object): void;
|
|
4475
4508
|
/**
|
|
4509
|
+
* **Deprecated:**
|
|
4510
|
+
*
|
|
4476
4511
|
* Finds audio assets matching a variety of search criteria.
|
|
4477
4512
|
*
|
|
4478
4513
|
* - **ThreadSafety**: Unsafe
|
|
@@ -4486,10 +4521,14 @@ interface AssetService extends Instance {
|
|
|
4486
4521
|
*/
|
|
4487
4522
|
SearchAudio(this: AssetService, searchParameters: AudioSearchParams): AudioPages;
|
|
4488
4523
|
/**
|
|
4524
|
+
* Finds audio assets matching a variety of search criteria.
|
|
4525
|
+
*
|
|
4489
4526
|
* - **ThreadSafety**: Unsafe
|
|
4490
4527
|
* - **Tags**: Yields
|
|
4491
4528
|
*
|
|
4492
4529
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#SearchAudioAsync)
|
|
4530
|
+
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
4531
|
+
* @param searchParameters
|
|
4493
4532
|
*/
|
|
4494
4533
|
SearchAudioAsync(this: AssetService, searchParameters: AudioSearchParams): AudioPages;
|
|
4495
4534
|
}
|
|
@@ -6370,6 +6409,8 @@ interface AudioPlayer extends Instance {
|
|
|
6370
6409
|
*/
|
|
6371
6410
|
AutoLoad: boolean;
|
|
6372
6411
|
/**
|
|
6412
|
+
* Denotes whether this `AudioPlayer` starts playing as soon as it spawns in for the first time.
|
|
6413
|
+
*
|
|
6373
6414
|
* - **ThreadSafety**: ReadSafe
|
|
6374
6415
|
*
|
|
6375
6416
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#AutoPlay)
|
|
@@ -7584,14 +7625,7 @@ interface AvatarCreationService extends Instance {
|
|
|
7584
7625
|
* @param progressCallback Optional callback function that will be invoked periodically with a progressInfo table with the overall progress (from 0 to 1). Type: `(progressInfo: { Progress: number }) -> ()`
|
|
7585
7626
|
* @returns A unique identifier for the generated avatar.
|
|
7586
7627
|
*/
|
|
7587
|
-
AutoSetupAvatarAsync(this: AvatarCreationService, player: Player,
|
|
7588
|
-
/**
|
|
7589
|
-
* - **ThreadSafety**: Unsafe
|
|
7590
|
-
* - **Tags**: Yields
|
|
7591
|
-
*
|
|
7592
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarCreationService#AutoSetupAvatarNewAsync)
|
|
7593
|
-
*/
|
|
7594
|
-
AutoSetupAvatarNewAsync(this: AvatarCreationService, player: Player, autoSetupParams: object, progressCallback?: Callback): string;
|
|
7628
|
+
AutoSetupAvatarAsync(this: AvatarCreationService, player: Player, autoSetupParams: object, progressCallback?: Callback): string;
|
|
7595
7629
|
/**
|
|
7596
7630
|
* Creates a 2D avatar preview and returns a previewId.
|
|
7597
7631
|
*
|
|
@@ -7881,6 +7915,8 @@ interface AvatarEditorService extends Instance {
|
|
|
7881
7915
|
*/
|
|
7882
7916
|
PromptUpdateOutfit(this: AvatarEditorService, outfitId: number, updatedOutfit: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>): void;
|
|
7883
7917
|
/**
|
|
7918
|
+
* **Deprecated:**
|
|
7919
|
+
*
|
|
7884
7920
|
* Used to apply default clothing to the `HumanoidDescription` if necessary.
|
|
7885
7921
|
*
|
|
7886
7922
|
* - **ThreadSafety**: Unsafe
|
|
@@ -7895,13 +7931,20 @@ interface AvatarEditorService extends Instance {
|
|
|
7895
7931
|
*/
|
|
7896
7932
|
CheckApplyDefaultClothing(this: AvatarEditorService, humanoidDescription: HumanoidDescription): HumanoidDescription | undefined;
|
|
7897
7933
|
/**
|
|
7934
|
+
* Used to apply default clothing to the `HumanoidDescription` if necessary.
|
|
7935
|
+
*
|
|
7898
7936
|
* - **ThreadSafety**: Unsafe
|
|
7899
7937
|
* - **Tags**: Yields
|
|
7900
7938
|
*
|
|
7901
7939
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#CheckApplyDefaultClothingAsync)
|
|
7940
|
+
* @param this A service to support developer Avatar Editors.
|
|
7941
|
+
* @param humanoidDescription The HumanoidDescription to check if default clothing is required.
|
|
7942
|
+
* @returns Returns a HumanoidDescription if default clothing was necessary. Otherwise returns `nil`.
|
|
7902
7943
|
*/
|
|
7903
7944
|
CheckApplyDefaultClothingAsync(this: AvatarEditorService, humanoidDescription: HumanoidDescription): HumanoidDescription;
|
|
7904
7945
|
/**
|
|
7946
|
+
* **Deprecated:**
|
|
7947
|
+
*
|
|
7905
7948
|
* - **ThreadSafety**: Unsafe
|
|
7906
7949
|
* - **Tags**: Yields
|
|
7907
7950
|
*
|
|
@@ -7917,9 +7960,13 @@ interface AvatarEditorService extends Instance {
|
|
|
7917
7960
|
* - **Tags**: Yields
|
|
7918
7961
|
*
|
|
7919
7962
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#ConformToAvatarRulesAsync)
|
|
7963
|
+
* @param this A service to support developer Avatar Editors.
|
|
7964
|
+
* @param humanoidDescription
|
|
7920
7965
|
*/
|
|
7921
7966
|
ConformToAvatarRulesAsync(this: AvatarEditorService, humanoidDescription: HumanoidDescription): HumanoidDescription;
|
|
7922
7967
|
/**
|
|
7968
|
+
* **Deprecated:**
|
|
7969
|
+
*
|
|
7923
7970
|
* Returns the platform Avatar rules for things such as scaling, default shirts and pants, number of wearable assets.
|
|
7924
7971
|
*
|
|
7925
7972
|
* - **ThreadSafety**: Unsafe
|
|
@@ -7933,13 +7980,19 @@ interface AvatarEditorService extends Instance {
|
|
|
7933
7980
|
*/
|
|
7934
7981
|
GetAvatarRules(this: AvatarEditorService): AvatarRules;
|
|
7935
7982
|
/**
|
|
7983
|
+
* Returns the platform Avatar rules for things such as scaling, default shirts and pants, number of wearable assets.
|
|
7984
|
+
*
|
|
7936
7985
|
* - **ThreadSafety**: Unsafe
|
|
7937
7986
|
* - **Tags**: Yields
|
|
7938
7987
|
*
|
|
7939
7988
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetAvatarRulesAsync)
|
|
7989
|
+
* @param this A service to support developer Avatar Editors.
|
|
7990
|
+
* @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
7991
|
*/
|
|
7941
7992
|
GetAvatarRulesAsync(this: AvatarEditorService): object;
|
|
7942
7993
|
/**
|
|
7994
|
+
* **Deprecated:**
|
|
7995
|
+
*
|
|
7943
7996
|
* Gets the item details for a list of items at once.
|
|
7944
7997
|
*
|
|
7945
7998
|
* - **ThreadSafety**: Unsafe
|
|
@@ -7960,13 +8013,24 @@ interface AvatarEditorService extends Instance {
|
|
|
7960
8013
|
GetBatchItemDetails(this: AvatarEditorService, itemIds: ReadonlyArray<number>, itemType: CastsToEnum<Enum.AvatarItemType.Bundle>): ReadonlyArray<BundleItemDetails>;
|
|
7961
8014
|
GetBatchItemDetails(this: AvatarEditorService, itemIds: ReadonlyArray<number>, itemType: CastsToEnum<Enum.AvatarItemType>): ReadonlyArray<ItemDetails>;
|
|
7962
8015
|
/**
|
|
8016
|
+
* Gets the item details for a list of items at once.
|
|
8017
|
+
*
|
|
7963
8018
|
* - **ThreadSafety**: Unsafe
|
|
7964
8019
|
* - **Tags**: Yields
|
|
7965
8020
|
*
|
|
7966
8021
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetBatchItemDetailsAsync)
|
|
8022
|
+
* @param this A service to support developer Avatar Editors.
|
|
8023
|
+
* @param itemIds The list of item ids to get details of.
|
|
8024
|
+
* @param itemType The type of the item ids provided.
|
|
8025
|
+
* @returns Returns an array of item details with the following fields:
|
|
8026
|
+
* ```lua
|
|
8027
|
+
* { "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 }
|
|
8028
|
+
* ``` .
|
|
7967
8029
|
*/
|
|
7968
8030
|
GetBatchItemDetailsAsync(this: AvatarEditorService, itemIds: Array<unknown>, itemType: CastsToEnum<Enum.AvatarItemType>): Array<unknown>;
|
|
7969
8031
|
/**
|
|
8032
|
+
* **Deprecated:**
|
|
8033
|
+
*
|
|
7970
8034
|
* Returns if the `Players.LocalPlayer` has favorited the given bundle or asset.
|
|
7971
8035
|
*
|
|
7972
8036
|
* - **ThreadSafety**: Unsafe
|
|
@@ -7982,13 +8046,28 @@ interface AvatarEditorService extends Instance {
|
|
|
7982
8046
|
*/
|
|
7983
8047
|
GetFavorite(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType>): boolean;
|
|
7984
8048
|
/**
|
|
8049
|
+
* Returns if the `Players.LocalPlayer` has favorited the given bundle or asset.
|
|
8050
|
+
*
|
|
7985
8051
|
* - **ThreadSafety**: Unsafe
|
|
7986
8052
|
* - **Tags**: Yields
|
|
7987
8053
|
*
|
|
7988
8054
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetFavoriteAsync)
|
|
8055
|
+
* @param this A service to support developer Avatar Editors.
|
|
8056
|
+
* @param itemId The ID of the specified asset or bundle.
|
|
8057
|
+
* @param itemType The `AvatarItemType` of the specified asset or bundle.
|
|
8058
|
+
* @returns Whether the `LocalPlayer` has favorited the given bundle or asset.
|
|
7989
8059
|
*/
|
|
7990
8060
|
GetFavoriteAsync(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType>): boolean;
|
|
7991
8061
|
/**
|
|
8062
|
+
* - **ThreadSafety**: Unsafe
|
|
8063
|
+
* - **Tags**: Yields
|
|
8064
|
+
*
|
|
8065
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetHeadShapesAsync)
|
|
8066
|
+
*/
|
|
8067
|
+
GetHeadShapesAsync(this: AvatarEditorService): Array<unknown>;
|
|
8068
|
+
/**
|
|
8069
|
+
* **Deprecated:**
|
|
8070
|
+
*
|
|
7992
8071
|
* Returns an `InventoryPages` object with information about owned items in the users inventory with the given AvatarAssetTypes.
|
|
7993
8072
|
*
|
|
7994
8073
|
* - **ThreadSafety**: Unsafe
|
|
@@ -8007,13 +8086,19 @@ interface AvatarEditorService extends Instance {
|
|
|
8007
8086
|
Name: string;
|
|
8008
8087
|
}>;
|
|
8009
8088
|
/**
|
|
8089
|
+
* Returns an `InventoryPages` object with information about owned items in the users inventory with the given AvatarAssetTypes.
|
|
8090
|
+
*
|
|
8010
8091
|
* - **ThreadSafety**: Unsafe
|
|
8011
8092
|
* - **Tags**: Yields
|
|
8012
8093
|
*
|
|
8013
8094
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetInventoryAsync)
|
|
8095
|
+
* @param this A service to support developer Avatar Editors.
|
|
8096
|
+
* @param assetTypes The `AvatarAssetType` that can will be checked for in the player's inventory.
|
|
8014
8097
|
*/
|
|
8015
8098
|
GetInventoryAsync(this: AvatarEditorService, assetTypes: Array<unknown>): InventoryPages;
|
|
8016
8099
|
/**
|
|
8100
|
+
* **Deprecated:**
|
|
8101
|
+
*
|
|
8017
8102
|
* Returns the item details for the given item.
|
|
8018
8103
|
*
|
|
8019
8104
|
* - **ThreadSafety**: Unsafe
|
|
@@ -8031,13 +8116,21 @@ interface AvatarEditorService extends Instance {
|
|
|
8031
8116
|
GetItemDetails(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType.Bundle>): BundleItemDetails;
|
|
8032
8117
|
GetItemDetails(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType>): ItemDetails;
|
|
8033
8118
|
/**
|
|
8119
|
+
* Returns the item details for the given item.
|
|
8120
|
+
*
|
|
8034
8121
|
* - **ThreadSafety**: Unsafe
|
|
8035
8122
|
* - **Tags**: Yields
|
|
8036
8123
|
*
|
|
8037
8124
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetItemDetailsAsync)
|
|
8125
|
+
* @param this A service to support developer Avatar Editors.
|
|
8126
|
+
* @param itemId The ID of the item whose details are being retrieved.
|
|
8127
|
+
* @param itemType An enum value indicating the type of item whose details are being retrieved.
|
|
8128
|
+
* @returns A table containing the item info for the retrieved item. See above for a sample table.
|
|
8038
8129
|
*/
|
|
8039
8130
|
GetItemDetailsAsync(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType>): object;
|
|
8040
8131
|
/**
|
|
8132
|
+
* **Deprecated:**
|
|
8133
|
+
*
|
|
8041
8134
|
* Returns the outfit details for the given outfit.
|
|
8042
8135
|
*
|
|
8043
8136
|
* - **ThreadSafety**: Unsafe
|
|
@@ -8052,13 +8145,20 @@ interface AvatarEditorService extends Instance {
|
|
|
8052
8145
|
*/
|
|
8053
8146
|
GetOutfitDetails(this: AvatarEditorService, outfitId: number): object;
|
|
8054
8147
|
/**
|
|
8148
|
+
* Returns the outfit details for the given outfit.
|
|
8149
|
+
*
|
|
8055
8150
|
* - **ThreadSafety**: Unsafe
|
|
8056
8151
|
* - **Tags**: Yields
|
|
8057
8152
|
*
|
|
8058
8153
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetOutfitDetailsAsync)
|
|
8154
|
+
* @param this A service to support developer Avatar Editors.
|
|
8155
|
+
* @param outfitId The ID of the outfit whose details are being retrieved.
|
|
8156
|
+
* @returns A table containing the outfit info for the retrieved outfit. See above for a sample table.
|
|
8059
8157
|
*/
|
|
8060
8158
|
GetOutfitDetailsAsync(this: AvatarEditorService, outfitId: number): object;
|
|
8061
8159
|
/**
|
|
8160
|
+
* **Deprecated:**
|
|
8161
|
+
*
|
|
8062
8162
|
* Returns outfit data for the `Players.LocalPlayer`.
|
|
8063
8163
|
*
|
|
8064
8164
|
* - **ThreadSafety**: Unsafe
|
|
@@ -8073,13 +8173,20 @@ interface AvatarEditorService extends Instance {
|
|
|
8073
8173
|
*/
|
|
8074
8174
|
GetOutfits(this: AvatarEditorService, outfitSource?: CastsToEnum<Enum.OutfitSource>, outfitType?: CastsToEnum<Enum.OutfitType>): OutfitPages;
|
|
8075
8175
|
/**
|
|
8176
|
+
* Returns outfit data for the `Players.LocalPlayer`.
|
|
8177
|
+
*
|
|
8076
8178
|
* - **ThreadSafety**: Unsafe
|
|
8077
8179
|
* - **Tags**: Yields
|
|
8078
8180
|
*
|
|
8079
8181
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetOutfitsAsync)
|
|
8182
|
+
* @param this A service to support developer Avatar Editors.
|
|
8183
|
+
* @param outfitSource
|
|
8184
|
+
* @param outfitType
|
|
8080
8185
|
*/
|
|
8081
8186
|
GetOutfitsAsync(this: AvatarEditorService, outfitSource?: CastsToEnum<Enum.OutfitSource>, outfitType?: CastsToEnum<Enum.OutfitType>): OutfitPages;
|
|
8082
8187
|
/**
|
|
8188
|
+
* **Deprecated:**
|
|
8189
|
+
*
|
|
8083
8190
|
* Returns a list of recommended assets based on a given `AssetType` and asset ID.
|
|
8084
8191
|
*
|
|
8085
8192
|
* - **ThreadSafety**: Unsafe
|
|
@@ -8095,13 +8202,21 @@ interface AvatarEditorService extends Instance {
|
|
|
8095
8202
|
*/
|
|
8096
8203
|
GetRecommendedAssets(this: AvatarEditorService, assetType: CastsToEnum<Enum.AvatarAssetType>, contextAssetId?: number): ReadonlyArray<RecommendedAsset>;
|
|
8097
8204
|
/**
|
|
8205
|
+
* Returns a list of recommended assets based on a given `AssetType` and asset ID.
|
|
8206
|
+
*
|
|
8098
8207
|
* - **ThreadSafety**: Unsafe
|
|
8099
8208
|
* - **Tags**: Yields
|
|
8100
8209
|
*
|
|
8101
8210
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetRecommendedAssetsAsync)
|
|
8211
|
+
* @param this A service to support developer Avatar Editors.
|
|
8212
|
+
* @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`.
|
|
8213
|
+
* @param contextAssetId The ID of an asset with a type matching the provided assetType used for context when retrieving recommendations.
|
|
8214
|
+
* @returns A list of recommendations based on the given `AssetType`.
|
|
8102
8215
|
*/
|
|
8103
8216
|
GetRecommendedAssetsAsync(this: AvatarEditorService, assetType: CastsToEnum<Enum.AvatarAssetType>, contextAssetId?: number): Array<unknown>;
|
|
8104
8217
|
/**
|
|
8218
|
+
* **Deprecated:**
|
|
8219
|
+
*
|
|
8105
8220
|
* Returns a list of recommended bundles for a given bundle id.
|
|
8106
8221
|
*
|
|
8107
8222
|
* - **ThreadSafety**: Unsafe
|
|
@@ -8116,13 +8231,20 @@ interface AvatarEditorService extends Instance {
|
|
|
8116
8231
|
*/
|
|
8117
8232
|
GetRecommendedBundles(this: AvatarEditorService, bundleId: number): ReadonlyArray<RecommendedBundle>;
|
|
8118
8233
|
/**
|
|
8234
|
+
* Returns a list of recommended bundles for a given bundle id.
|
|
8235
|
+
*
|
|
8119
8236
|
* - **ThreadSafety**: Unsafe
|
|
8120
8237
|
* - **Tags**: Yields
|
|
8121
8238
|
*
|
|
8122
8239
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetRecommendedBundlesAsync)
|
|
8240
|
+
* @param this A service to support developer Avatar Editors.
|
|
8241
|
+
* @param bundleId A list of recommended bundles.
|
|
8242
|
+
* @returns The bundle ID that the recommended bundles will be returned for.
|
|
8123
8243
|
*/
|
|
8124
8244
|
GetRecommendedBundlesAsync(this: AvatarEditorService, bundleId: number): Array<unknown>;
|
|
8125
8245
|
/**
|
|
8246
|
+
* **Deprecated:**
|
|
8247
|
+
*
|
|
8126
8248
|
* Returns a `CatalogPages` object containing the result of the given search.
|
|
8127
8249
|
*
|
|
8128
8250
|
* - **ThreadSafety**: Unsafe
|
|
@@ -8136,10 +8258,14 @@ interface AvatarEditorService extends Instance {
|
|
|
8136
8258
|
*/
|
|
8137
8259
|
SearchCatalog(this: AvatarEditorService, searchParameters: CatalogSearchParams): CatalogPages;
|
|
8138
8260
|
/**
|
|
8261
|
+
* Returns a `CatalogPages` object containing the result of the given search.
|
|
8262
|
+
*
|
|
8139
8263
|
* - **ThreadSafety**: Unsafe
|
|
8140
8264
|
* - **Tags**: Yields
|
|
8141
8265
|
*
|
|
8142
8266
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#SearchCatalogAsync)
|
|
8267
|
+
* @param this A service to support developer Avatar Editors.
|
|
8268
|
+
* @param searchParameters An object containing the parameters used for the search.
|
|
8143
8269
|
*/
|
|
8144
8270
|
SearchCatalogAsync(this: AvatarEditorService, searchParameters: CatalogSearchParams): CatalogPages;
|
|
8145
8271
|
/**
|
|
@@ -8274,6 +8400,8 @@ interface BadgeService extends Instance {
|
|
|
8274
8400
|
*/
|
|
8275
8401
|
readonly _nominal_BadgeService: unique symbol;
|
|
8276
8402
|
/**
|
|
8403
|
+
* **Deprecated:**
|
|
8404
|
+
*
|
|
8277
8405
|
* Award a badge to a player given the ID of each.
|
|
8278
8406
|
*
|
|
8279
8407
|
* - **ThreadSafety**: Unsafe
|
|
@@ -8289,10 +8417,16 @@ interface BadgeService extends Instance {
|
|
|
8289
8417
|
*/
|
|
8290
8418
|
AwardBadge(this: BadgeService, userId: number, badgeId: number): boolean;
|
|
8291
8419
|
/**
|
|
8420
|
+
* Award a badge to a player given the ID of each.
|
|
8421
|
+
*
|
|
8292
8422
|
* - **ThreadSafety**: Unsafe
|
|
8293
8423
|
* - **Tags**: Yields
|
|
8294
8424
|
*
|
|
8295
8425
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BadgeService#AwardBadgeAsync)
|
|
8426
|
+
* @param this Provides information on badges and awards them.
|
|
8427
|
+
* @param userId The `Player.UserId` of the user the badge is to be awarded to.
|
|
8428
|
+
* @param badgeId The ID of the badge to be awarded.
|
|
8429
|
+
* @returns Boolean of `true` if the badge was awarded successfully.
|
|
8296
8430
|
*/
|
|
8297
8431
|
AwardBadgeAsync(this: BadgeService, userId: number, badgeId: number): boolean;
|
|
8298
8432
|
/**
|
|
@@ -8353,7 +8487,7 @@ interface BadgeService extends Instance {
|
|
|
8353
8487
|
*/
|
|
8354
8488
|
IsLegal(this: BadgeService, badgeId: number): boolean;
|
|
8355
8489
|
/**
|
|
8356
|
-
* **Deprecated:** This
|
|
8490
|
+
* **Deprecated:** This method has been superseded by `BadgeService:UserHasBadgeAsync()` which should be used for new instead.
|
|
8357
8491
|
*
|
|
8358
8492
|
* Checks whether a user has the badge given the `Player.UserId` and the badge ID.
|
|
8359
8493
|
*
|
|
@@ -10361,12 +10495,9 @@ interface CaptureService extends Instance {
|
|
|
10361
10495
|
/**
|
|
10362
10496
|
* - **ThreadSafety**: Unsafe
|
|
10363
10497
|
*
|
|
10364
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#
|
|
10365
|
-
* @param this A service which provides control over screenshot and video capture features.
|
|
10366
|
-
* @param onCaptureReady
|
|
10367
|
-
* @param captureParams
|
|
10498
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#TakeScreenshotCaptureAsync)
|
|
10368
10499
|
*/
|
|
10369
|
-
|
|
10500
|
+
TakeScreenshotCaptureAsync(this: CaptureService, onCaptureReady: Callback, captureParams?: object): void;
|
|
10370
10501
|
/**
|
|
10371
10502
|
* - **ThreadSafety**: Unsafe
|
|
10372
10503
|
* - **Tags**: Yields
|
|
@@ -11703,6 +11834,8 @@ interface CommerceService extends Instance {
|
|
|
11703
11834
|
readonly PromptCommerceProductPurchaseFinished: RBXScriptSignal<(user: Player, productId: string) => void>;
|
|
11704
11835
|
}
|
|
11705
11836
|
/**
|
|
11837
|
+
* An animation curve that groups child `FloatCurves` which each animate a different component of a non-unary value.
|
|
11838
|
+
*
|
|
11706
11839
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CompositeValueCurve)
|
|
11707
11840
|
*/
|
|
11708
11841
|
interface CompositeValueCurve extends Instance {
|
|
@@ -11715,25 +11848,37 @@ interface CompositeValueCurve extends Instance {
|
|
|
11715
11848
|
*/
|
|
11716
11849
|
readonly _nominal_CompositeValueCurve: unique symbol;
|
|
11717
11850
|
/**
|
|
11851
|
+
* The type of value animated by this `CompositeValueCurve`.
|
|
11852
|
+
*
|
|
11718
11853
|
* - **ThreadSafety**: ReadSafe
|
|
11719
11854
|
*
|
|
11720
11855
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CompositeValueCurve#CurveType)
|
|
11721
11856
|
*/
|
|
11722
11857
|
CurveType: Enum.CompositeValueCurveType;
|
|
11723
11858
|
/**
|
|
11859
|
+
* Returns the child curves with the given names for the `CurveType` of this `CompositeValueCurve`.
|
|
11860
|
+
*
|
|
11724
11861
|
* - **ThreadSafety**: Unsafe
|
|
11725
11862
|
*
|
|
11726
11863
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CompositeValueCurve#GetComponentCurves)
|
|
11864
|
+
* @param this An animation curve that groups child `FloatCurves` which each animate a different component of a non-unary value.
|
|
11727
11865
|
*/
|
|
11728
11866
|
GetComponentCurves(this: CompositeValueCurve): Array<Instance>;
|
|
11729
11867
|
/**
|
|
11868
|
+
* Returns the sampled animated value at the passed `time` argument.
|
|
11869
|
+
*
|
|
11730
11870
|
* - **ThreadSafety**: Unsafe
|
|
11731
11871
|
*
|
|
11732
11872
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CompositeValueCurve#GetValueAtTime)
|
|
11873
|
+
* @param this An animation curve that groups child `FloatCurves` which each animate a different component of a non-unary value.
|
|
11874
|
+
* @param time Time at which to get the value.
|
|
11875
|
+
* @returns The value of the curve at the passed time.
|
|
11733
11876
|
*/
|
|
11734
11877
|
GetValueAtTime(this: CompositeValueCurve, time: number): unknown;
|
|
11735
11878
|
}
|
|
11736
11879
|
/**
|
|
11880
|
+
* A game service that gives access to in-experience configuration with updates in real time.
|
|
11881
|
+
*
|
|
11737
11882
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
11738
11883
|
*
|
|
11739
11884
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigService)
|
|
@@ -11748,37 +11893,47 @@ interface ConfigService extends Instance {
|
|
|
11748
11893
|
*/
|
|
11749
11894
|
readonly _nominal_ConfigService: unique symbol;
|
|
11750
11895
|
/**
|
|
11896
|
+
* Clears current testing value for the given key.
|
|
11897
|
+
*
|
|
11751
11898
|
* - **ThreadSafety**: Unsafe
|
|
11752
11899
|
*
|
|
11753
11900
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigService#ClearTestingValue)
|
|
11754
|
-
* @param this
|
|
11755
|
-
* @param key
|
|
11901
|
+
* @param this A game service that gives access to in-experience configuration with updates in real time.
|
|
11902
|
+
* @param key Key of the configuration to clear testing value for.
|
|
11756
11903
|
*/
|
|
11757
11904
|
ClearTestingValue(this: ConfigService, key: string): void;
|
|
11758
11905
|
/**
|
|
11906
|
+
* Sets a testing override for the given key.
|
|
11907
|
+
*
|
|
11759
11908
|
* - **ThreadSafety**: Unsafe
|
|
11760
11909
|
*
|
|
11761
11910
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigService#SetTestingValue)
|
|
11762
|
-
* @param this
|
|
11763
|
-
* @param key
|
|
11764
|
-
* @param value
|
|
11911
|
+
* @param this A game service that gives access to in-experience configuration with updates in real time.
|
|
11912
|
+
* @param key Key of the configuration to override with a testing value.
|
|
11913
|
+
* @param value Value to set as the testing override.
|
|
11765
11914
|
*/
|
|
11766
11915
|
SetTestingValue(this: ConfigService, key: string, value: unknown): void;
|
|
11767
11916
|
/**
|
|
11917
|
+
* Retrieves a snapshot of the latest configuration.
|
|
11918
|
+
*
|
|
11768
11919
|
* - **ThreadSafety**: Unsafe
|
|
11769
11920
|
* - **Tags**: Yields
|
|
11770
11921
|
*
|
|
11771
11922
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigService#GetConfigAsync)
|
|
11772
|
-
* @param this
|
|
11923
|
+
* @param this A game service that gives access to in-experience configuration with updates in real time.
|
|
11924
|
+
* @returns A `ConfigSnapshot` instance with the latest configuration.
|
|
11773
11925
|
*/
|
|
11774
11926
|
GetConfigAsync(this: ConfigService): ConfigSnapshot;
|
|
11775
11927
|
/**
|
|
11928
|
+
* Retrieves a snapshot of the latest configuration for a specific player.
|
|
11929
|
+
*
|
|
11776
11930
|
* - **ThreadSafety**: Unsafe
|
|
11777
11931
|
* - **Tags**: Yields
|
|
11778
11932
|
*
|
|
11779
11933
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ConfigService#GetConfigForPlayerAsync)
|
|
11780
|
-
* @param this
|
|
11781
|
-
* @param player
|
|
11934
|
+
* @param this A game service that gives access to in-experience configuration with updates in real time.
|
|
11935
|
+
* @param player The player to get the configuration for.
|
|
11936
|
+
* @returns A `ConfigSnapshot` instance with the latest configuration targeted to the player.
|
|
11782
11937
|
*/
|
|
11783
11938
|
GetConfigForPlayerAsync(this: ConfigService, player: Player): ConfigSnapshot;
|
|
11784
11939
|
}
|
|
@@ -12184,6 +12339,8 @@ interface AngularVelocity extends Constraint {
|
|
|
12184
12339
|
/**
|
|
12185
12340
|
* Aligns two `BaseParts` with an animate-able kinematic or force-based joint.
|
|
12186
12341
|
*
|
|
12342
|
+
* - **Tags**: NotBrowsable
|
|
12343
|
+
*
|
|
12187
12344
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationConstraint)
|
|
12188
12345
|
*/
|
|
12189
12346
|
interface AnimationConstraint extends Constraint {
|
|
@@ -17294,10 +17451,15 @@ interface GroupService extends Instance {
|
|
|
17294
17451
|
*/
|
|
17295
17452
|
GetGroupsAsync(this: GroupService, userId: number): Array<GetGroupsAsyncResult>;
|
|
17296
17453
|
/**
|
|
17454
|
+
* Prompts the local `Player` to join a specified Roblox group via a native modal.
|
|
17455
|
+
*
|
|
17297
17456
|
* - **ThreadSafety**: Unsafe
|
|
17298
17457
|
* - **Tags**: Yields
|
|
17299
17458
|
*
|
|
17300
17459
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GroupService#PromptJoinAsync)
|
|
17460
|
+
* @param this GroupService is a service that allows developers to fetch information about a Roblox group from within a game.
|
|
17461
|
+
* @param groupId ID of the group to prompt the player to join. This must be a valid group ID.
|
|
17462
|
+
* @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
17463
|
*/
|
|
17302
17464
|
PromptJoinAsync(this: GroupService, groupId: number): Enum.GroupMembershipStatus;
|
|
17303
17465
|
}
|
|
@@ -19031,6 +19193,18 @@ interface ScrollingFrame extends GuiObject {
|
|
|
19031
19193
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame#VerticalScrollBarPosition)
|
|
19032
19194
|
*/
|
|
19033
19195
|
VerticalScrollBarPosition: Enum.VerticalScrollBarPosition;
|
|
19196
|
+
/**
|
|
19197
|
+
* - **ThreadSafety**: Unsafe
|
|
19198
|
+
*
|
|
19199
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame#GetScrollVelocity)
|
|
19200
|
+
*/
|
|
19201
|
+
GetScrollVelocity(this: ScrollingFrame): Vector2;
|
|
19202
|
+
/**
|
|
19203
|
+
* - **ThreadSafety**: Unsafe
|
|
19204
|
+
*
|
|
19205
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ScrollingFrame#ResetScrollVelocity)
|
|
19206
|
+
*/
|
|
19207
|
+
ResetScrollVelocity(this: ScrollingFrame): void;
|
|
19034
19208
|
}
|
|
19035
19209
|
/**
|
|
19036
19210
|
* A 2D user interface element that displays player-editable text.
|
|
@@ -21542,6 +21716,12 @@ interface GuiService extends Instance {
|
|
|
21542
21716
|
Vector2,
|
|
21543
21717
|
Vector2
|
|
21544
21718
|
]>;
|
|
21719
|
+
/**
|
|
21720
|
+
* - **ThreadSafety**: Unsafe
|
|
21721
|
+
*
|
|
21722
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiService#GetInsetArea)
|
|
21723
|
+
*/
|
|
21724
|
+
GetInsetArea(this: GuiService, screenInsets: CastsToEnum<Enum.ScreenInsets>): Rect;
|
|
21545
21725
|
/**
|
|
21546
21726
|
* Returns whether the avatar inspection menu is enabled.
|
|
21547
21727
|
*
|
|
@@ -23024,6 +23204,8 @@ interface Humanoid extends Instance {
|
|
|
23024
23204
|
*/
|
|
23025
23205
|
UnequipTools(this: Humanoid): void;
|
|
23026
23206
|
/**
|
|
23207
|
+
* **Deprecated:**
|
|
23208
|
+
*
|
|
23027
23209
|
* Makes the character's look match that of the passed in `HumanoidDescription`.
|
|
23028
23210
|
*
|
|
23029
23211
|
* - **ThreadSafety**: Unsafe
|
|
@@ -23038,13 +23220,20 @@ interface Humanoid extends Instance {
|
|
|
23038
23220
|
*/
|
|
23039
23221
|
ApplyDescription(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
|
|
23040
23222
|
/**
|
|
23223
|
+
* Makes the character's look match that of the passed in `HumanoidDescription`.
|
|
23224
|
+
*
|
|
23041
23225
|
* - **ThreadSafety**: Unsafe
|
|
23042
23226
|
* - **Tags**: Yields
|
|
23043
23227
|
*
|
|
23044
23228
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Humanoid#ApplyDescriptionAsync)
|
|
23229
|
+
* @param this A special object that gives models the functionality of a character.
|
|
23230
|
+
* @param humanoidDescription The `HumanoidDescription` instance which you want to set the character to match.
|
|
23231
|
+
* @param assetTypeVerification The asset type verification mode.
|
|
23045
23232
|
*/
|
|
23046
23233
|
ApplyDescriptionAsync(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
|
|
23047
23234
|
/**
|
|
23235
|
+
* **Deprecated:**
|
|
23236
|
+
*
|
|
23048
23237
|
* Makes the character's look match that of the passed in `HumanoidDescription`, even after external changes.
|
|
23049
23238
|
*
|
|
23050
23239
|
* - **ThreadSafety**: Unsafe
|
|
@@ -23059,13 +23248,20 @@ interface Humanoid extends Instance {
|
|
|
23059
23248
|
*/
|
|
23060
23249
|
ApplyDescriptionReset(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
|
|
23061
23250
|
/**
|
|
23251
|
+
* Makes the character's look match that of the passed in `HumanoidDescription`, even after external changes.
|
|
23252
|
+
*
|
|
23062
23253
|
* - **ThreadSafety**: Unsafe
|
|
23063
23254
|
* - **Tags**: Yields
|
|
23064
23255
|
*
|
|
23065
23256
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Humanoid#ApplyDescriptionResetAsync)
|
|
23257
|
+
* @param this A special object that gives models the functionality of a character.
|
|
23258
|
+
* @param humanoidDescription The `HumanoidDescription` instance which you want to set the character to match.
|
|
23259
|
+
* @param assetTypeVerification The asset type verification mode.
|
|
23066
23260
|
*/
|
|
23067
23261
|
ApplyDescriptionResetAsync(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
|
|
23068
23262
|
/**
|
|
23263
|
+
* **Deprecated:**
|
|
23264
|
+
*
|
|
23069
23265
|
* Plays emotes and returns if was successfully ran.
|
|
23070
23266
|
*
|
|
23071
23267
|
* - **ThreadSafety**: Unsafe
|
|
@@ -23080,10 +23276,15 @@ interface Humanoid extends Instance {
|
|
|
23080
23276
|
*/
|
|
23081
23277
|
PlayEmote(this: Humanoid, emoteName: string): boolean;
|
|
23082
23278
|
/**
|
|
23279
|
+
* Plays emotes and returns if was successfully ran.
|
|
23280
|
+
*
|
|
23083
23281
|
* - **ThreadSafety**: Unsafe
|
|
23084
23282
|
* - **Tags**: Yields
|
|
23085
23283
|
*
|
|
23086
23284
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Humanoid#PlayEmoteAsync)
|
|
23285
|
+
* @param this A special object that gives models the functionality of a character.
|
|
23286
|
+
* @param emoteName name of the emote to play.
|
|
23287
|
+
* @returns successfully played.
|
|
23087
23288
|
*/
|
|
23088
23289
|
PlayEmoteAsync(this: Humanoid, emoteName: string): boolean;
|
|
23089
23290
|
/**
|
|
@@ -24782,7 +24983,7 @@ interface InputAction extends Instance {
|
|
|
24782
24983
|
/**
|
|
24783
24984
|
* Returns the current state of the `InputAction`.
|
|
24784
24985
|
*
|
|
24785
|
-
* - **ThreadSafety**:
|
|
24986
|
+
* - **ThreadSafety**: Safe
|
|
24786
24987
|
*
|
|
24787
24988
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputAction#GetState)
|
|
24788
24989
|
* @param this Defines a gameplay action mechanic. These actions are then mapped to hardware inputs using `InputBinding`.
|
|
@@ -24882,6 +25083,12 @@ interface InputBinding extends Instance {
|
|
|
24882
25083
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#PressedThreshold)
|
|
24883
25084
|
*/
|
|
24884
25085
|
PressedThreshold: number;
|
|
25086
|
+
/**
|
|
25087
|
+
* - **ThreadSafety**: ReadSafe
|
|
25088
|
+
*
|
|
25089
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#PrimaryModifier)
|
|
25090
|
+
*/
|
|
25091
|
+
PrimaryModifier: Enum.KeyCode;
|
|
24885
25092
|
/**
|
|
24886
25093
|
* Numerical value below which to fire an `InputAction` with a `Type` of `Bool`.
|
|
24887
25094
|
*
|
|
@@ -24914,6 +25121,12 @@ interface InputBinding extends Instance {
|
|
|
24914
25121
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Scale)
|
|
24915
25122
|
*/
|
|
24916
25123
|
Scale: number;
|
|
25124
|
+
/**
|
|
25125
|
+
* - **ThreadSafety**: ReadSafe
|
|
25126
|
+
*
|
|
25127
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#SecondaryModifier)
|
|
25128
|
+
*/
|
|
25129
|
+
SecondaryModifier: Enum.KeyCode;
|
|
24917
25130
|
/**
|
|
24918
25131
|
* Connects a `GuiButton` to a boolean action.
|
|
24919
25132
|
*
|
|
@@ -25178,6 +25391,8 @@ interface InsertService extends Instance {
|
|
|
25178
25391
|
*/
|
|
25179
25392
|
GetCollection(this: InsertService, categoryId: number): Array<CollectionInfo>;
|
|
25180
25393
|
/**
|
|
25394
|
+
* **Deprecated:**
|
|
25395
|
+
*
|
|
25181
25396
|
* Retrieves a list of free Decals from the Catalog.
|
|
25182
25397
|
*
|
|
25183
25398
|
* - **ThreadSafety**: Unsafe
|
|
@@ -25195,13 +25410,21 @@ interface InsertService extends Instance {
|
|
|
25195
25410
|
Array<FreeSearchResult>
|
|
25196
25411
|
];
|
|
25197
25412
|
/**
|
|
25413
|
+
* Retrieves a list of free Decals from the Catalog.
|
|
25414
|
+
*
|
|
25198
25415
|
* - **ThreadSafety**: Unsafe
|
|
25199
25416
|
* - **Tags**: Yields
|
|
25200
25417
|
*
|
|
25201
25418
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InsertService#GetFreeDecalsAsync)
|
|
25419
|
+
* @param this Used to insert assets from the Roblox website.
|
|
25420
|
+
* @param searchText String used to search for free decals in the Catalog.
|
|
25421
|
+
* @param pageNum The page number in the Catalog to return.
|
|
25422
|
+
* @returns A single table (of returned free decals) wrapped in a table.
|
|
25202
25423
|
*/
|
|
25203
25424
|
GetFreeDecalsAsync(this: InsertService, searchText: string, pageNum: number): Array<unknown>;
|
|
25204
25425
|
/**
|
|
25426
|
+
* **Deprecated:**
|
|
25427
|
+
*
|
|
25205
25428
|
* Retrieves a list of Free Models from the Catalog.
|
|
25206
25429
|
*
|
|
25207
25430
|
* - **ThreadSafety**: Unsafe
|
|
@@ -25219,10 +25442,16 @@ interface InsertService extends Instance {
|
|
|
25219
25442
|
Array<FreeSearchResult>
|
|
25220
25443
|
];
|
|
25221
25444
|
/**
|
|
25445
|
+
* Retrieves a list of Free Models from the Catalog.
|
|
25446
|
+
*
|
|
25222
25447
|
* - **ThreadSafety**: Unsafe
|
|
25223
25448
|
* - **Tags**: Yields
|
|
25224
25449
|
*
|
|
25225
25450
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InsertService#GetFreeModelsAsync)
|
|
25451
|
+
* @param this Used to insert assets from the Roblox website.
|
|
25452
|
+
* @param searchText String used to search for free decals in the Catalog.
|
|
25453
|
+
* @param pageNum The page number in the Catalog to return.
|
|
25454
|
+
* @returns A single table (of returned free models) wrapped in a table.
|
|
25226
25455
|
*/
|
|
25227
25456
|
GetFreeModelsAsync(this: InsertService, searchText: string, pageNum: number): Array<unknown>;
|
|
25228
25457
|
/**
|
|
@@ -25310,6 +25539,21 @@ interface InstanceExtensionsService extends Instance {
|
|
|
25310
25539
|
*/
|
|
25311
25540
|
readonly _nominal_InstanceExtensionsService: unique symbol;
|
|
25312
25541
|
}
|
|
25542
|
+
/**
|
|
25543
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
25544
|
+
*
|
|
25545
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InstanceFileSyncService)
|
|
25546
|
+
*/
|
|
25547
|
+
interface InstanceFileSyncService extends Instance {
|
|
25548
|
+
/**
|
|
25549
|
+
* **DO NOT USE!**
|
|
25550
|
+
*
|
|
25551
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
25552
|
+
* @hidden
|
|
25553
|
+
* @deprecated
|
|
25554
|
+
*/
|
|
25555
|
+
readonly _nominal_InstanceFileSyncService: unique symbol;
|
|
25556
|
+
}
|
|
25313
25557
|
/**
|
|
25314
25558
|
* - **Tags**: NotReplicated
|
|
25315
25559
|
*
|
|
@@ -25980,6 +26224,8 @@ interface KeyframeSequenceProvider extends Instance {
|
|
|
25980
26224
|
*/
|
|
25981
26225
|
RegisterKeyframeSequence(this: KeyframeSequenceProvider, keyframeSequence: Instance): ContentId;
|
|
25982
26226
|
/**
|
|
26227
|
+
* **Deprecated:**
|
|
26228
|
+
*
|
|
25983
26229
|
* This function returns an `InventoryPages` object which can be used to iterate over animations owned by a specific user.
|
|
25984
26230
|
*
|
|
25985
26231
|
* - **ThreadSafety**: Unsafe
|
|
@@ -25994,10 +26240,15 @@ interface KeyframeSequenceProvider extends Instance {
|
|
|
25994
26240
|
*/
|
|
25995
26241
|
GetAnimations(this: KeyframeSequenceProvider, userId: number): InventoryPages<number>;
|
|
25996
26242
|
/**
|
|
26243
|
+
* This function returns an `InventoryPages` object which can be used to iterate over animations owned by a specific user.
|
|
26244
|
+
*
|
|
25997
26245
|
* - **ThreadSafety**: Unsafe
|
|
25998
26246
|
* - **Tags**: Yields
|
|
25999
26247
|
*
|
|
26000
26248
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/KeyframeSequenceProvider#GetAnimationsAsync)
|
|
26249
|
+
* @param this Provides functions to load and preview `KeyframeSequence`.
|
|
26250
|
+
* @param userId The user ID of the user.
|
|
26251
|
+
* @returns An `InventoryPages` of animations.
|
|
26001
26252
|
*/
|
|
26002
26253
|
GetAnimationsAsync(this: KeyframeSequenceProvider, userId: number): Instance | undefined;
|
|
26003
26254
|
/**
|
|
@@ -27461,6 +27712,8 @@ interface MarketplaceService extends Instance {
|
|
|
27461
27712
|
Name: string;
|
|
27462
27713
|
}>;
|
|
27463
27714
|
/**
|
|
27715
|
+
* **Deprecated:**
|
|
27716
|
+
*
|
|
27464
27717
|
* Returns the product information of an asset using its asset ID.
|
|
27465
27718
|
*
|
|
27466
27719
|
* - **ThreadSafety**: Unsafe
|
|
@@ -27482,10 +27735,16 @@ interface MarketplaceService extends Instance {
|
|
|
27482
27735
|
GetProductInfo(this: MarketplaceService, id: number, infoType: CastsToEnum<Enum.InfoType.Subscription>): SubscriptionProductInfo;
|
|
27483
27736
|
GetProductInfo(this: MarketplaceService, id: number, infoType?: CastsToEnum<Enum.InfoType>): AssetProductInfo | BundleInfo | GamePassProductInfo | DeveloperProductInfo | SubscriptionProductInfo;
|
|
27484
27737
|
/**
|
|
27738
|
+
* Returns the product information of an asset using its asset ID.
|
|
27739
|
+
*
|
|
27485
27740
|
* - **ThreadSafety**: Unsafe
|
|
27486
27741
|
* - **Tags**: Yields
|
|
27487
27742
|
*
|
|
27488
27743
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#GetProductInfoAsync)
|
|
27744
|
+
* @param this The service responsible for in-experience transactions.
|
|
27745
|
+
* @param assetId The asset ID of the specified product.
|
|
27746
|
+
* @param infoType An `InfoType` enum value specifying the type of information being retrieved.
|
|
27747
|
+
* @returns A dictionary containing information about the queried item, described in the previous tables.
|
|
27489
27748
|
*/
|
|
27490
27749
|
GetProductInfoAsync(this: MarketplaceService, assetId: number, infoType?: CastsToEnum<Enum.InfoType>): object;
|
|
27491
27750
|
/**
|
|
@@ -27548,6 +27807,8 @@ interface MarketplaceService extends Instance {
|
|
|
27548
27807
|
*/
|
|
27549
27808
|
GetUsersPriceLevelsAsync(this: MarketplaceService, userIds: Array<unknown>): Array<unknown>;
|
|
27550
27809
|
/**
|
|
27810
|
+
* **Deprecated:**
|
|
27811
|
+
*
|
|
27551
27812
|
* Returns whether the given user has the given asset.
|
|
27552
27813
|
*
|
|
27553
27814
|
* - **ThreadSafety**: Unsafe
|
|
@@ -27563,13 +27824,21 @@ interface MarketplaceService extends Instance {
|
|
|
27563
27824
|
*/
|
|
27564
27825
|
PlayerOwnsAsset(this: MarketplaceService, player: Player, assetId: number): boolean;
|
|
27565
27826
|
/**
|
|
27827
|
+
* Returns whether the given user has the given asset.
|
|
27828
|
+
*
|
|
27566
27829
|
* - **ThreadSafety**: Unsafe
|
|
27567
27830
|
* - **Tags**: Yields
|
|
27568
27831
|
*
|
|
27569
27832
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PlayerOwnsAssetAsync)
|
|
27833
|
+
* @param this The service responsible for in-experience transactions.
|
|
27834
|
+
* @param player The `Player` whose inventory is tested for ownership of the given asset.
|
|
27835
|
+
* @param assetId The asset ID for which the given player's inventory is tested.
|
|
27836
|
+
* @returns Indicates whether the given player's inventory contains the given asset.
|
|
27570
27837
|
*/
|
|
27571
27838
|
PlayerOwnsAssetAsync(this: MarketplaceService, player: Instance, assetId: number): boolean;
|
|
27572
27839
|
/**
|
|
27840
|
+
* **Deprecated:**
|
|
27841
|
+
*
|
|
27573
27842
|
* Returns whether the given player owns the given bundle.
|
|
27574
27843
|
*
|
|
27575
27844
|
* - **ThreadSafety**: Unsafe
|
|
@@ -27585,28 +27854,54 @@ interface MarketplaceService extends Instance {
|
|
|
27585
27854
|
*/
|
|
27586
27855
|
PlayerOwnsBundle(this: MarketplaceService, player: Player, bundleId: number): boolean;
|
|
27587
27856
|
/**
|
|
27857
|
+
* Returns whether the given player owns the given bundle.
|
|
27858
|
+
*
|
|
27588
27859
|
* - **ThreadSafety**: Unsafe
|
|
27589
27860
|
* - **Tags**: Yields
|
|
27590
27861
|
*
|
|
27591
27862
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PlayerOwnsBundleAsync)
|
|
27863
|
+
* @param this The service responsible for in-experience transactions.
|
|
27864
|
+
* @param player The `Player` whose inventory is tested for ownership of the given bundle.
|
|
27865
|
+
* @param bundleId The bundle ID for which the given player's inventory is tested.
|
|
27866
|
+
* @returns Indicates whether the given player's inventory contains the given bundle.
|
|
27592
27867
|
*/
|
|
27593
27868
|
PlayerOwnsBundleAsync(this: MarketplaceService, player: Player, bundleId: number): boolean;
|
|
27594
27869
|
/**
|
|
27870
|
+
* Takes a list of product IDs and returns a personalized ordered list of those products.
|
|
27871
|
+
*
|
|
27595
27872
|
* - **ThreadSafety**: Unsafe
|
|
27596
27873
|
* - **Tags**: Yields
|
|
27597
27874
|
*
|
|
27598
27875
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#RankProductsAsync)
|
|
27599
27876
|
* @param this The service responsible for in-experience transactions.
|
|
27600
|
-
* @param productIdentifiers
|
|
27877
|
+
* @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
|
|
27878
|
+
* - Must be either `InfoType.GamePass` or `InfoType.Product`.
|
|
27879
|
+
* - `Id`: number
|
|
27880
|
+
* - The ID of the game pass or developer product.
|
|
27881
|
+
*
|
|
27882
|
+
*
|
|
27883
|
+
* ```lua
|
|
27884
|
+
* local ProductIdentifier = { InfoType = Enum.InfoType.GamePass, Id = 123456 }
|
|
27885
|
+
* ```
|
|
27886
|
+
* @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.
|
|
27887
|
+
* - `ProductInfo`: The standard product info dictionary returned by `GetProductInfo`.
|
|
27601
27888
|
*/
|
|
27602
27889
|
RankProductsAsync(this: MarketplaceService, productIdentifiers: Array<unknown>): Array<unknown>;
|
|
27603
27890
|
/**
|
|
27891
|
+
* - Takes an array of `InfoType` and returns up to 50 items representing the products a user is most likely to engage with and purchase.
|
|
27892
|
+
*
|
|
27893
|
+
*
|
|
27894
|
+
*
|
|
27604
27895
|
* - **ThreadSafety**: Unsafe
|
|
27605
27896
|
* - **Tags**: Yields
|
|
27606
27897
|
*
|
|
27607
27898
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#RecommendTopProductsAsync)
|
|
27608
27899
|
* @param this The service responsible for in-experience transactions.
|
|
27609
|
-
* @param infoTypes
|
|
27900
|
+
* @param infoTypes An array of `InfoType` values specifying the types of product to retrieve recommendations for. Supported `InfoTypes`: `InfoType.GamePass`, `InfoType.Product`.
|
|
27901
|
+
* ```lua
|
|
27902
|
+
* local infoTypes = { Enum.InfoType.GamePass, Enum.InfoType.Product }
|
|
27903
|
+
* ```
|
|
27904
|
+
* @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
27905
|
*/
|
|
27611
27906
|
RecommendTopProductsAsync(this: MarketplaceService, infoTypes: Array<unknown>): Array<unknown>;
|
|
27612
27907
|
/**
|
|
@@ -27830,6 +28125,8 @@ interface MaterialVariant extends Instance {
|
|
|
27830
28125
|
*/
|
|
27831
28126
|
readonly _nominal_MaterialVariant: unique symbol;
|
|
27832
28127
|
/**
|
|
28128
|
+
* Determines how the alpha channel of the `MaterialVariant.ColorMap` is used.
|
|
28129
|
+
*
|
|
27833
28130
|
* - **ThreadSafety**: ReadSafe
|
|
27834
28131
|
* - **Tags**: NotBrowsable
|
|
27835
28132
|
*
|
|
@@ -32439,7 +32736,7 @@ interface Workspace extends WorldRoot {
|
|
|
32439
32736
|
*
|
|
32440
32737
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#GetPhysicsThrottling)
|
|
32441
32738
|
* @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
|
|
32739
|
+
* @returns The percentage of real time that physics simulation is currently being throttled to.
|
|
32443
32740
|
*/
|
|
32444
32741
|
GetPhysicsThrottling(this: Workspace): number;
|
|
32445
32742
|
/**
|
|
@@ -34247,7 +34544,7 @@ interface Player extends Instance {
|
|
|
34247
34544
|
*/
|
|
34248
34545
|
GetMouse(this: Player): PlayerMouse;
|
|
34249
34546
|
/**
|
|
34250
|
-
* Returns the isolated network latency in seconds.
|
|
34547
|
+
* Returns the round-trip, isolated network latency in seconds.
|
|
34251
34548
|
*
|
|
34252
34549
|
* - **ThreadSafety**: Safe
|
|
34253
34550
|
*
|
|
@@ -34446,6 +34743,8 @@ interface Player extends Instance {
|
|
|
34446
34743
|
*/
|
|
34447
34744
|
SaveString(this: Player, key: string, value: string): void;
|
|
34448
34745
|
/**
|
|
34746
|
+
* **Deprecated:**
|
|
34747
|
+
*
|
|
34449
34748
|
* Returns a dictionary of online connections.
|
|
34450
34749
|
*
|
|
34451
34750
|
* - **ThreadSafety**: Unsafe
|
|
@@ -34460,13 +34759,20 @@ interface Player extends Instance {
|
|
|
34460
34759
|
*/
|
|
34461
34760
|
GetFriendsOnline(this: Player, maxFriends?: number): Array<FriendOnlineInfo>;
|
|
34462
34761
|
/**
|
|
34762
|
+
* Returns a dictionary of online connections.
|
|
34763
|
+
*
|
|
34463
34764
|
* - **ThreadSafety**: Unsafe
|
|
34464
34765
|
* - **Tags**: Yields
|
|
34465
34766
|
*
|
|
34466
34767
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetFriendsOnlineAsync)
|
|
34768
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
34769
|
+
* @param maxFriends The maximum number of online connections to return.
|
|
34770
|
+
* @returns A dictionary of online connections (see the table above).
|
|
34467
34771
|
*/
|
|
34468
34772
|
GetFriendsOnlineAsync(this: Player, maxFriends?: number): Array<unknown>;
|
|
34469
34773
|
/**
|
|
34774
|
+
* **Deprecated:**
|
|
34775
|
+
*
|
|
34470
34776
|
* Returns the player's rank in the group as an integer.
|
|
34471
34777
|
*
|
|
34472
34778
|
* - **ThreadSafety**: Unsafe
|
|
@@ -34481,13 +34787,20 @@ interface Player extends Instance {
|
|
|
34481
34787
|
*/
|
|
34482
34788
|
GetRankInGroup(this: Player, groupId: number): number;
|
|
34483
34789
|
/**
|
|
34790
|
+
* Returns the player's rank in the group as an integer.
|
|
34791
|
+
*
|
|
34484
34792
|
* - **ThreadSafety**: Unsafe
|
|
34485
34793
|
* - **Tags**: Yields
|
|
34486
34794
|
*
|
|
34487
34795
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetRankInGroupAsync)
|
|
34796
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
34797
|
+
* @param groupId The `groupId` of the specified group.
|
|
34798
|
+
* @returns The player's rank in the group.
|
|
34488
34799
|
*/
|
|
34489
34800
|
GetRankInGroupAsync(this: Player, groupId: number): number;
|
|
34490
34801
|
/**
|
|
34802
|
+
* **Deprecated:**
|
|
34803
|
+
*
|
|
34491
34804
|
* Returns the player's role in the group as a string, or `Guest` if the player isn't part of the group.
|
|
34492
34805
|
*
|
|
34493
34806
|
* - **ThreadSafety**: Unsafe
|
|
@@ -34502,14 +34815,19 @@ interface Player extends Instance {
|
|
|
34502
34815
|
*/
|
|
34503
34816
|
GetRoleInGroup(this: Player, groupId: number): string;
|
|
34504
34817
|
/**
|
|
34818
|
+
* Returns the player's role in the group as a string, or `Guest` if the player isn't part of the group.
|
|
34819
|
+
*
|
|
34505
34820
|
* - **ThreadSafety**: Unsafe
|
|
34506
34821
|
* - **Tags**: Yields
|
|
34507
34822
|
*
|
|
34508
34823
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetRoleInGroupAsync)
|
|
34824
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
34825
|
+
* @param groupId The group ID of the specified group.
|
|
34826
|
+
* @returns The player's role in the specified group, or `Guest` if the player is not a member.
|
|
34509
34827
|
*/
|
|
34510
34828
|
GetRoleInGroupAsync(this: Player, groupId: number): string;
|
|
34511
34829
|
/**
|
|
34512
|
-
* **Deprecated:** This function is obsolete because the
|
|
34830
|
+
* **Deprecated:** This function is obsolete because the "best friends" feature was removed. Use `Player:IsFriendsWithAsync()` instead.
|
|
34513
34831
|
*
|
|
34514
34832
|
* Returns whether a player is connections with the specified user.
|
|
34515
34833
|
*
|
|
@@ -34524,6 +34842,8 @@ interface Player extends Instance {
|
|
|
34524
34842
|
*/
|
|
34525
34843
|
IsBestFriendsWith(this: Player, userId: number): boolean;
|
|
34526
34844
|
/**
|
|
34845
|
+
* **Deprecated:** This method has been superseded by the `Player:IsFriendsWithAsync()` method which should be used for new work.
|
|
34846
|
+
*
|
|
34527
34847
|
* Checks whether a player is a connection of the user with the given `Player.UserId`.
|
|
34528
34848
|
*
|
|
34529
34849
|
* - **ThreadSafety**: Unsafe
|
|
@@ -34538,13 +34858,20 @@ interface Player extends Instance {
|
|
|
34538
34858
|
*/
|
|
34539
34859
|
IsFriendsWith(this: Player, userId: number): boolean;
|
|
34540
34860
|
/**
|
|
34861
|
+
* Checks whether a player is a connection of the user with the given `Player.UserId`.
|
|
34862
|
+
*
|
|
34541
34863
|
* - **ThreadSafety**: Unsafe
|
|
34542
34864
|
* - **Tags**: Yields
|
|
34543
34865
|
*
|
|
34544
34866
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#IsFriendsWithAsync)
|
|
34867
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
34868
|
+
* @param userId The `Player.UserId` of the specified player.
|
|
34869
|
+
* @returns A boolean indicating whether a player is a connection of the specified user.
|
|
34545
34870
|
*/
|
|
34546
34871
|
IsFriendsWithAsync(this: Player, userId: number): boolean;
|
|
34547
34872
|
/**
|
|
34873
|
+
* **Deprecated:**
|
|
34874
|
+
*
|
|
34548
34875
|
* Checks whether a player is a member of a group with the given ID.
|
|
34549
34876
|
*
|
|
34550
34877
|
* - **ThreadSafety**: Unsafe
|
|
@@ -34559,13 +34886,20 @@ interface Player extends Instance {
|
|
|
34559
34886
|
*/
|
|
34560
34887
|
IsInGroup(this: Player, groupId: number): boolean;
|
|
34561
34888
|
/**
|
|
34889
|
+
* Checks whether a player is a member of a group with the given ID.
|
|
34890
|
+
*
|
|
34562
34891
|
* - **ThreadSafety**: Unsafe
|
|
34563
34892
|
* - **Tags**: Yields
|
|
34564
34893
|
*
|
|
34565
34894
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#IsInGroupAsync)
|
|
34895
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
34896
|
+
* @param groupId The group ID of the specified group.
|
|
34897
|
+
* @returns A boolean indicating whether the player is in the specified group.
|
|
34566
34898
|
*/
|
|
34567
34899
|
IsInGroupAsync(this: Player, groupId: number): boolean;
|
|
34568
34900
|
/**
|
|
34901
|
+
* **Deprecated:**
|
|
34902
|
+
*
|
|
34569
34903
|
* Creates a new character for the player, removing the old one. Also clears the player's `Backpack` and `PlayerGui`.
|
|
34570
34904
|
*
|
|
34571
34905
|
* - **ThreadSafety**: Unsafe
|
|
@@ -34578,13 +34912,18 @@ interface Player extends Instance {
|
|
|
34578
34912
|
*/
|
|
34579
34913
|
LoadCharacter(this: Player): void;
|
|
34580
34914
|
/**
|
|
34915
|
+
* Creates a new character for the player, removing the old one. Also clears the player's `Backpack` and `PlayerGui`.
|
|
34916
|
+
*
|
|
34581
34917
|
* - **ThreadSafety**: Unsafe
|
|
34582
34918
|
* - **Tags**: Yields
|
|
34583
34919
|
*
|
|
34584
34920
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadCharacterAsync)
|
|
34921
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
34585
34922
|
*/
|
|
34586
34923
|
LoadCharacterAsync(this: Player): void;
|
|
34587
34924
|
/**
|
|
34925
|
+
* **Deprecated:**
|
|
34926
|
+
*
|
|
34588
34927
|
* Spawns a player character with everything equipped in the passed in `HumanoidDescription`.
|
|
34589
34928
|
*
|
|
34590
34929
|
* - **ThreadSafety**: Unsafe
|
|
@@ -34598,10 +34937,14 @@ interface Player extends Instance {
|
|
|
34598
34937
|
*/
|
|
34599
34938
|
LoadCharacterWithHumanoidDescription(this: Player, humanoidDescription: HumanoidDescription): void;
|
|
34600
34939
|
/**
|
|
34940
|
+
* Spawns a player character with everything equipped in the passed in `HumanoidDescription`.
|
|
34941
|
+
*
|
|
34601
34942
|
* - **ThreadSafety**: Unsafe
|
|
34602
34943
|
* - **Tags**: Yields
|
|
34603
34944
|
*
|
|
34604
34945
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadCharacterWithHumanoidDescriptionAsync)
|
|
34946
|
+
* @param this An object that represents a presently connected client to the experience.
|
|
34947
|
+
* @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
34948
|
*/
|
|
34606
34949
|
LoadCharacterWithHumanoidDescriptionAsync(this: Player, humanoidDescription: HumanoidDescription): void;
|
|
34607
34950
|
/**
|
|
@@ -35197,6 +35540,8 @@ interface Players extends Instance {
|
|
|
35197
35540
|
*/
|
|
35198
35541
|
BanAsync(this: Players, config: BanAsyncConfig): void;
|
|
35199
35542
|
/**
|
|
35543
|
+
* **Deprecated:**
|
|
35544
|
+
*
|
|
35200
35545
|
* Returns a character `Model` equipped with everything specified in the passed in `HumanoidDescription`.
|
|
35201
35546
|
*
|
|
35202
35547
|
* - **ThreadSafety**: Unsafe
|
|
@@ -35213,13 +35558,22 @@ interface Players extends Instance {
|
|
|
35213
35558
|
*/
|
|
35214
35559
|
CreateHumanoidModelFromDescription(this: Players, description: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): Model;
|
|
35215
35560
|
/**
|
|
35561
|
+
* Returns a character `Model` equipped with everything specified in the passed in `HumanoidDescription`.
|
|
35562
|
+
*
|
|
35216
35563
|
* - **ThreadSafety**: Unsafe
|
|
35217
35564
|
* - **Tags**: Yields
|
|
35218
35565
|
*
|
|
35219
35566
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Players#CreateHumanoidModelFromDescriptionAsync)
|
|
35567
|
+
* @param this A service that contains presently connected `Player` objects.
|
|
35568
|
+
* @param description Specifies the appearance of the returned character.
|
|
35569
|
+
* @param rigType Specifies whether the returned character will be R6 or R15.
|
|
35570
|
+
* @param assetTypeVerification The asset type verification mode.
|
|
35571
|
+
* @returns A `Humanoid` character `Model`.
|
|
35220
35572
|
*/
|
|
35221
35573
|
CreateHumanoidModelFromDescriptionAsync(this: Players, description: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): Model;
|
|
35222
35574
|
/**
|
|
35575
|
+
* **Deprecated:**
|
|
35576
|
+
*
|
|
35223
35577
|
* Returns a character Model set-up with everything equipped to match the avatar of the user specified by the passed in userId.
|
|
35224
35578
|
*
|
|
35225
35579
|
* - **ThreadSafety**: Unsafe
|
|
@@ -35234,10 +35588,15 @@ interface Players extends Instance {
|
|
|
35234
35588
|
*/
|
|
35235
35589
|
CreateHumanoidModelFromUserId(this: Players, userId: number): Model;
|
|
35236
35590
|
/**
|
|
35591
|
+
* Returns a character Model set-up with everything equipped to match the avatar of the user specified by the passed in userId.
|
|
35592
|
+
*
|
|
35237
35593
|
* - **ThreadSafety**: Unsafe
|
|
35238
35594
|
* - **Tags**: Yields
|
|
35239
35595
|
*
|
|
35240
35596
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Players#CreateHumanoidModelFromUserIdAsync)
|
|
35597
|
+
* @param this A service that contains presently connected `Player` objects.
|
|
35598
|
+
* @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).
|
|
35599
|
+
* @returns A Humanoid character Model.
|
|
35241
35600
|
*/
|
|
35242
35601
|
CreateHumanoidModelFromUserIdAsync(this: Players, userId: number): Model;
|
|
35243
35602
|
/**
|
|
@@ -35291,6 +35650,8 @@ interface Players extends Instance {
|
|
|
35291
35650
|
*/
|
|
35292
35651
|
GetFriendsAsync(this: Players, userId: number): FriendPages;
|
|
35293
35652
|
/**
|
|
35653
|
+
* **Deprecated:**
|
|
35654
|
+
*
|
|
35294
35655
|
* Returns the HumanoidDescription for a specified outfit, which will be set with the parts/colors/Animations etc of the outfit.
|
|
35295
35656
|
*
|
|
35296
35657
|
* - **ThreadSafety**: Unsafe
|
|
@@ -35305,13 +35666,20 @@ interface Players extends Instance {
|
|
|
35305
35666
|
*/
|
|
35306
35667
|
GetHumanoidDescriptionFromOutfitId(this: Players, outfitId: number): HumanoidDescription;
|
|
35307
35668
|
/**
|
|
35669
|
+
* Returns the HumanoidDescription for a specified outfit, which will be set with the parts/colors/Animations etc of the outfit.
|
|
35670
|
+
*
|
|
35308
35671
|
* - **ThreadSafety**: Unsafe
|
|
35309
35672
|
* - **Tags**: Yields
|
|
35310
35673
|
*
|
|
35311
35674
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Players#GetHumanoidDescriptionFromOutfitIdAsync)
|
|
35675
|
+
* @param this A service that contains presently connected `Player` objects.
|
|
35676
|
+
* @param outfitId The ID of the outfit for which the HumanoidDescription is sought.
|
|
35677
|
+
* @returns HumanoidDescription initialized with the specification for the passed in outfitId.
|
|
35312
35678
|
*/
|
|
35313
35679
|
GetHumanoidDescriptionFromOutfitIdAsync(this: Players, outfitId: number): HumanoidDescription;
|
|
35314
35680
|
/**
|
|
35681
|
+
* **Deprecated:**
|
|
35682
|
+
*
|
|
35315
35683
|
* Returns a HumanoidDescription which specifies everything equipped for the avatar of the user specified by the passed in userId.
|
|
35316
35684
|
*
|
|
35317
35685
|
* - **ThreadSafety**: Unsafe
|
|
@@ -35326,10 +35694,15 @@ interface Players extends Instance {
|
|
|
35326
35694
|
*/
|
|
35327
35695
|
GetHumanoidDescriptionFromUserId(this: Players, userId: number): HumanoidDescription;
|
|
35328
35696
|
/**
|
|
35697
|
+
* Returns a HumanoidDescription which specifies everything equipped for the avatar of the user specified by the passed in userId.
|
|
35698
|
+
*
|
|
35329
35699
|
* - **ThreadSafety**: Unsafe
|
|
35330
35700
|
* - **Tags**: Yields
|
|
35331
35701
|
*
|
|
35332
35702
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Players#GetHumanoidDescriptionFromUserIdAsync)
|
|
35703
|
+
* @param this A service that contains presently connected `Player` objects.
|
|
35704
|
+
* @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).
|
|
35705
|
+
* @returns HumanoidDescription initialized with the passed in user's avatar specification.
|
|
35333
35706
|
*/
|
|
35334
35707
|
GetHumanoidDescriptionFromUserIdAsync(this: Players, userId: number): HumanoidDescription;
|
|
35335
35708
|
/**
|
|
@@ -35939,7 +36312,7 @@ interface ProximityPrompt extends Instance {
|
|
|
35939
36312
|
*/
|
|
35940
36313
|
ClickablePrompt: boolean;
|
|
35941
36314
|
/**
|
|
35942
|
-
* Whether this prompt should be shown.
|
|
36315
|
+
* Whether or not this prompt should be shown.
|
|
35943
36316
|
*
|
|
35944
36317
|
* - **ThreadSafety**: ReadSafe
|
|
35945
36318
|
*
|
|
@@ -36079,7 +36452,7 @@ interface ProximityPrompt extends Instance {
|
|
|
36079
36452
|
*/
|
|
36080
36453
|
readonly PromptButtonHoldEnded: RBXScriptSignal<(playerWhoTriggered: Player) => void>;
|
|
36081
36454
|
/**
|
|
36082
|
-
* Triggers when the prompt becomes hidden.
|
|
36455
|
+
* Triggers when the `prompt` becomes hidden.
|
|
36083
36456
|
*
|
|
36084
36457
|
* - **ThreadSafety**: Unsafe
|
|
36085
36458
|
*
|
|
@@ -36883,20 +37256,29 @@ interface RunService extends Instance {
|
|
|
36883
37256
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RunService#BindToRenderStep)
|
|
36884
37257
|
* @param this Service responsible for all runtime activity and progression of time.
|
|
36885
37258
|
* @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
|
|
37259
|
+
* @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
37260
|
* @param function The custom function being bound.
|
|
36888
37261
|
*/
|
|
36889
37262
|
BindToRenderStep(this: RunService, name: string, priority: number, callback: (deltaTime: number) => void): void;
|
|
36890
37263
|
/**
|
|
37264
|
+
* Binds a custom function to be called at a fixed frequency which is independent of the frame rate.
|
|
37265
|
+
*
|
|
36891
37266
|
* - **ThreadSafety**: Unsafe
|
|
36892
37267
|
*
|
|
36893
37268
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RunService#BindToSimulation)
|
|
37269
|
+
* @param this Service responsible for all runtime activity and progression of time.
|
|
37270
|
+
* @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.
|
|
37271
|
+
* @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
37272
|
*/
|
|
36895
37273
|
BindToSimulation(this: RunService, callback: Callback, frequency?: CastsToEnum<Enum.StepFrequency>): RBXScriptConnection;
|
|
36896
37274
|
/**
|
|
37275
|
+
* Checks the `PredictionStatus` of a specific context instance, useful for debugging scripts affecting multiple instances where some might be predicted and others might not.
|
|
37276
|
+
*
|
|
36897
37277
|
* - **ThreadSafety**: Unsafe
|
|
36898
37278
|
*
|
|
36899
37279
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RunService#GetPredictionStatus)
|
|
37280
|
+
* @param this Service responsible for all runtime activity and progression of time.
|
|
37281
|
+
* @param context The `Instance` for which to check prediction status.
|
|
36900
37282
|
*/
|
|
36901
37283
|
GetPredictionStatus(this: RunService, context: Instance): Enum.PredictionStatus;
|
|
36902
37284
|
/**
|
|
@@ -36950,9 +37332,14 @@ interface RunService extends Instance {
|
|
|
36950
37332
|
*/
|
|
36951
37333
|
IsStudio(this: RunService): boolean;
|
|
36952
37334
|
/**
|
|
37335
|
+
* Sets the prediction mode for an `Instance` to an `PredictionMode` value.
|
|
37336
|
+
*
|
|
36953
37337
|
* - **ThreadSafety**: Unsafe
|
|
36954
37338
|
*
|
|
36955
37339
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RunService#SetPredictionMode)
|
|
37340
|
+
* @param this Service responsible for all runtime activity and progression of time.
|
|
37341
|
+
* @param context The `Instance` for which to set the prediction mode.
|
|
37342
|
+
* @param mode The `PredictionMode` to set for the context instance.
|
|
36956
37343
|
*/
|
|
36957
37344
|
SetPredictionMode(this: RunService, context: Instance, mode: CastsToEnum<Enum.PredictionMode>): void;
|
|
36958
37345
|
/**
|
|
@@ -37065,7 +37452,7 @@ interface RuntimeContentService extends Instance {
|
|
|
37065
37452
|
*
|
|
37066
37453
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RuntimeContentService#RuntimeContentShare)
|
|
37067
37454
|
*/
|
|
37068
|
-
readonly RuntimeContentShare: RBXScriptSignal<(id: string, content: string) => void>;
|
|
37455
|
+
readonly RuntimeContentShare: RBXScriptSignal<(id: string, content: string, metadata: string) => void>;
|
|
37069
37456
|
}
|
|
37070
37457
|
/**
|
|
37071
37458
|
* - **Tags**: NotCreatable, Service
|
|
@@ -37884,6 +38271,13 @@ interface DataModel extends ServiceProvider<Services> {
|
|
|
37884
38271
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#PrivateServerOwnerId)
|
|
37885
38272
|
*/
|
|
37886
38273
|
readonly PrivateServerOwnerId: number;
|
|
38274
|
+
/**
|
|
38275
|
+
* - **ThreadSafety**: ReadSafe
|
|
38276
|
+
* - **Tags**: NotReplicated
|
|
38277
|
+
*
|
|
38278
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/DataModel#RunService)
|
|
38279
|
+
*/
|
|
38280
|
+
readonly RunService: Instance | undefined;
|
|
37887
38281
|
/**
|
|
37888
38282
|
* **Deprecated:** This property has been deprecated. Use `DataModel.PrivateServerId` instead.
|
|
37889
38283
|
*
|
|
@@ -38673,6 +39067,8 @@ interface SocialService extends Instance {
|
|
|
38673
39067
|
*/
|
|
38674
39068
|
PromptFeedbackSubmissionAsync(this: SocialService): void;
|
|
38675
39069
|
/**
|
|
39070
|
+
* **Deprecated:**
|
|
39071
|
+
*
|
|
38676
39072
|
* - **ThreadSafety**: Unsafe
|
|
38677
39073
|
* - **Tags**: Yields
|
|
38678
39074
|
*
|
|
@@ -38697,6 +39093,17 @@ interface SocialService extends Instance {
|
|
|
38697
39093
|
* - **Tags**: Yields
|
|
38698
39094
|
*
|
|
38699
39095
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#PromptLinkSharingAsync)
|
|
39096
|
+
* @param this Facilitates social functions that impact relationships made on the Roblox platform.
|
|
39097
|
+
* @param player Prompts the given `Player` with a Roblox platform-level share sheet with a generated share link.
|
|
39098
|
+
* @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.
|
|
39099
|
+
* - `ExpirationSeconds` (number). Determines time to expiration once the share link is created. Truncates to nearest integer. Defaults to 86,400.
|
|
39100
|
+
* - `PreviewTitle` (string) Preview title of the share link.
|
|
39101
|
+
* - `PreviewDescription` (string) Preview description of the share link.
|
|
39102
|
+
* - `PreviewAssetId` (number) Image asset ID used for share link preview.
|
|
39103
|
+
* - `LaunchData` (string). Used to set a parameter in `Player:GetJoinData()` when a player joined using the generated share link.
|
|
39104
|
+
*
|
|
39105
|
+
*
|
|
39106
|
+
* @returns A tuple containing an `PromptLinkSharingResult` indicating the result of the link sharing prompt.
|
|
38700
39107
|
*/
|
|
38701
39108
|
PromptLinkSharingAsync(this: SocialService, player: Player, options?: object): unknown;
|
|
38702
39109
|
/**
|
|
@@ -39553,7 +39960,7 @@ interface SoundGroup extends Instance {
|
|
|
39553
39960
|
Volume: number;
|
|
39554
39961
|
}
|
|
39555
39962
|
/**
|
|
39556
|
-
* A service that determines various aspects of how `Sounds` play in the experience.
|
|
39963
|
+
* A service that determines various aspects of how the audio engine works. Most of its properties affect how `Sounds` play in the experience.
|
|
39557
39964
|
*
|
|
39558
39965
|
* - **Tags**: NotCreatable, Service
|
|
39559
39966
|
*
|
|
@@ -39569,13 +39976,15 @@ interface SoundService extends Instance {
|
|
|
39569
39976
|
*/
|
|
39570
39977
|
readonly _nominal_SoundService: unique symbol;
|
|
39571
39978
|
/**
|
|
39979
|
+
* Determines whether acoustic simulation is enabled globally in the advanced audio system.
|
|
39980
|
+
*
|
|
39572
39981
|
* - **ThreadSafety**: ReadSafe
|
|
39573
39982
|
*
|
|
39574
39983
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#AcousticSimulationEnabled)
|
|
39575
39984
|
*/
|
|
39576
39985
|
AcousticSimulationEnabled: boolean;
|
|
39577
39986
|
/**
|
|
39578
|
-
* The ambient sound environment preset
|
|
39987
|
+
* The ambient sound environment preset applied to all `Sounds`.
|
|
39579
39988
|
*
|
|
39580
39989
|
* - **ThreadSafety**: ReadSafe
|
|
39581
39990
|
*
|
|
@@ -39583,13 +39992,15 @@ interface SoundService extends Instance {
|
|
|
39583
39992
|
*/
|
|
39584
39993
|
AmbientReverb: Enum.ReverbType;
|
|
39585
39994
|
/**
|
|
39995
|
+
* Determines whether the default character sounds will use instances in the advanced audio system vs. `Sounds`.
|
|
39996
|
+
*
|
|
39586
39997
|
* - **ThreadSafety**: ReadSafe
|
|
39587
39998
|
*
|
|
39588
39999
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#CharacterSoundsUseNewApi)
|
|
39589
40000
|
*/
|
|
39590
40001
|
get CharacterSoundsUseNewApi(): Enum.RolloutState;
|
|
39591
40002
|
/**
|
|
39592
|
-
* The number of studs to be considered a meter by `SoundService` when
|
|
40003
|
+
* The number of studs to be considered a meter by `SoundService` when simulating the Doppler effect for `Sounds`.
|
|
39593
40004
|
*
|
|
39594
40005
|
* - **ThreadSafety**: ReadSafe
|
|
39595
40006
|
*
|
|
@@ -39613,7 +40024,7 @@ interface SoundService extends Instance {
|
|
|
39613
40024
|
*/
|
|
39614
40025
|
RespectFilteringEnabled: boolean;
|
|
39615
40026
|
/**
|
|
39616
|
-
*
|
|
40027
|
+
* Determines how fast the volume of a `Sound` attenuates beyond its `Sound.RollOffMinDistance`.
|
|
39617
40028
|
*
|
|
39618
40029
|
* - **ThreadSafety**: ReadSafe
|
|
39619
40030
|
*
|
|
@@ -39621,13 +40032,18 @@ interface SoundService extends Instance {
|
|
|
39621
40032
|
*/
|
|
39622
40033
|
RolloffScale: number;
|
|
39623
40034
|
/**
|
|
39624
|
-
* Returns the current
|
|
40035
|
+
* Returns the current listener type used by `Sounds`, as well as what that listener is currently set to.
|
|
39625
40036
|
*
|
|
39626
40037
|
* - **ThreadSafety**: Unsafe
|
|
39627
40038
|
*
|
|
39628
40039
|
* [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
|
|
40040
|
+
* @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.
|
|
40041
|
+
* @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 |
|
|
40042
|
+
* | ---------------------------------- | -------------------------------------------------------------------------------------------------- |
|
|
40043
|
+
* | `Enum.ListenerType.Camera` | Does not return a listener object as `Class.Workspace.CurrentCamera|CurrentCamera` is always used. |
|
|
40044
|
+
* | `Enum.ListenerType.CFrame` | Returns the `Datatype.CFrame` used in `Class.SoundService:SetListener()|SetListener()`. |
|
|
40045
|
+
* | `Enum.ListenerType.ObjectPosition` | Returns the `Class.BasePart` used in `Class.SoundService:SetListener()|SetListener()`. |
|
|
40046
|
+
* | `Enum.ListenerType.ObjectCFrame` | Returns the `Class.BasePart` used in `Class.SoundService:SetListener()|SetListener()`. |
|
|
39631
40047
|
*/
|
|
39632
40048
|
GetListener(this: SoundService): LuaTuple<[
|
|
39633
40049
|
Enum.ListenerType.Camera,
|
|
@@ -39643,22 +40059,22 @@ interface SoundService extends Instance {
|
|
|
39643
40059
|
BasePart
|
|
39644
40060
|
]>;
|
|
39645
40061
|
/**
|
|
39646
|
-
* Plays a `Sound` locally,
|
|
40062
|
+
* Plays a copy of a `Sound` locally, such that it will only be heard by the client calling this method.
|
|
39647
40063
|
*
|
|
39648
40064
|
* - **ThreadSafety**: Unsafe
|
|
39649
40065
|
*
|
|
39650
40066
|
* [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.
|
|
40067
|
+
* @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
40068
|
* @param sound The `Sound` to be played.
|
|
39653
40069
|
*/
|
|
39654
40070
|
PlayLocalSound(this: SoundService, sound: Sound): void;
|
|
39655
40071
|
/**
|
|
39656
|
-
* Sets the listener
|
|
40072
|
+
* Sets the listener used by `Sounds`.
|
|
39657
40073
|
*
|
|
39658
40074
|
* - **ThreadSafety**: Unsafe
|
|
39659
40075
|
*
|
|
39660
40076
|
* [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.
|
|
40077
|
+
* @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
40078
|
* @param listenerType The `ListenerType` of the listener.
|
|
39663
40079
|
* @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
40080
|
*/
|
|
@@ -39855,6 +40271,8 @@ interface StarterPlayer extends Instance {
|
|
|
39855
40271
|
*/
|
|
39856
40272
|
CameraMode: Enum.CameraMode;
|
|
39857
40273
|
/**
|
|
40274
|
+
* Determines the starting value of `Humanoid.BreakJointsOnDeath` for `Player.Character`.
|
|
40275
|
+
*
|
|
39858
40276
|
* - **ThreadSafety**: ReadSafe
|
|
39859
40277
|
*
|
|
39860
40278
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StarterPlayer#CharacterBreakJointsOnDeath)
|
|
@@ -39902,6 +40320,7 @@ interface StarterPlayer extends Instance {
|
|
|
39902
40320
|
CharacterWalkSpeed: number;
|
|
39903
40321
|
/**
|
|
39904
40322
|
* - **ThreadSafety**: ReadSafe
|
|
40323
|
+
* - **Tags**: NotBrowsable
|
|
39905
40324
|
*
|
|
39906
40325
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StarterPlayer#ClassicDeath)
|
|
39907
40326
|
*/
|
|
@@ -40561,6 +40980,8 @@ interface StudioSdkService extends Instance {
|
|
|
40561
40980
|
readonly _nominal_StudioSdkService: unique symbol;
|
|
40562
40981
|
}
|
|
40563
40982
|
/**
|
|
40983
|
+
* Service allowing plugins to automate and customize Test and Run mode testing.
|
|
40984
|
+
*
|
|
40564
40985
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
40565
40986
|
*
|
|
40566
40987
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioTestService)
|
|
@@ -40578,12 +40999,16 @@ interface StudioTestService extends Instance {
|
|
|
40578
40999
|
* - **ThreadSafety**: Unsafe
|
|
40579
41000
|
*
|
|
40580
41001
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioTestService#EndTest)
|
|
41002
|
+
* @param this Service allowing plugins to automate and customize Test and Run mode testing.
|
|
41003
|
+
* @param value Value returned to the calling `StudioTestService:ExecutePlayModeAsync()` or `StudioTestService:ExecuteRunModeAsync()` method.
|
|
40581
41004
|
*/
|
|
40582
41005
|
EndTest(this: StudioTestService, value: unknown): void;
|
|
40583
41006
|
/**
|
|
40584
41007
|
* - **ThreadSafety**: Unsafe
|
|
40585
41008
|
*
|
|
40586
41009
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StudioTestService#GetTestArgs)
|
|
41010
|
+
* @param this Service allowing plugins to automate and customize Test and Run mode testing.
|
|
41011
|
+
* @returns Arguments passed to the test, or `nil`.
|
|
40587
41012
|
*/
|
|
40588
41013
|
GetTestArgs(this: StudioTestService): unknown;
|
|
40589
41014
|
}
|
|
@@ -40856,12 +41281,6 @@ interface StyleQuery extends Instance {
|
|
|
40856
41281
|
* @deprecated
|
|
40857
41282
|
*/
|
|
40858
41283
|
readonly _nominal_StyleQuery: unique symbol;
|
|
40859
|
-
/**
|
|
40860
|
-
* - **ThreadSafety**: ReadSafe
|
|
40861
|
-
*
|
|
40862
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleQuery#AspectRatioRange)
|
|
40863
|
-
*/
|
|
40864
|
-
AspectRatioRange: NumberRange;
|
|
40865
41284
|
/**
|
|
40866
41285
|
* - **ThreadSafety**: ReadSafe
|
|
40867
41286
|
* - **Tags**: NotReplicated
|
|
@@ -40869,18 +41288,6 @@ interface StyleQuery extends Instance {
|
|
|
40869
41288
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleQuery#IsActive)
|
|
40870
41289
|
*/
|
|
40871
41290
|
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
|
-
/**
|
|
40879
|
-
* - **ThreadSafety**: ReadSafe
|
|
40880
|
-
*
|
|
40881
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleQuery#MinSize)
|
|
40882
|
-
*/
|
|
40883
|
-
MinSize: Vector2;
|
|
40884
41291
|
/**
|
|
40885
41292
|
* - **ThreadSafety**: Unsafe
|
|
40886
41293
|
*
|
|
@@ -41465,6 +41872,8 @@ interface TeleportService extends Instance {
|
|
|
41465
41872
|
*/
|
|
41466
41873
|
PromptExperienceDetailsAsync(this: TeleportService, player: Player, universeId: number): Enum.PromptExperienceDetailsResult;
|
|
41467
41874
|
/**
|
|
41875
|
+
* **Deprecated:**
|
|
41876
|
+
*
|
|
41468
41877
|
* Returns an access code that can be used to teleport players to a reserved server, along with the `DataModel.PrivateServerId` for it.
|
|
41469
41878
|
*
|
|
41470
41879
|
* - **ThreadSafety**: Unsafe
|
|
@@ -41482,10 +41891,15 @@ interface TeleportService extends Instance {
|
|
|
41482
41891
|
string
|
|
41483
41892
|
]>;
|
|
41484
41893
|
/**
|
|
41894
|
+
* Returns an access code that can be used to teleport players to a reserved server, along with the `DataModel.PrivateServerId` for it.
|
|
41895
|
+
*
|
|
41485
41896
|
* - **ThreadSafety**: Unsafe
|
|
41486
41897
|
* - **Tags**: Yields
|
|
41487
41898
|
*
|
|
41488
41899
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TeleportService#ReserveServerAsync)
|
|
41900
|
+
* @param this Enables transporting `Players` between places and servers.
|
|
41901
|
+
* @param placeId The `DataModel.PlaceId` of the place the reserved server is being created for.
|
|
41902
|
+
* @returns The server access code required by `TeleportService:TeleportToPrivateServer()` and the `DataModel.PrivateServerId` for the reserved server.
|
|
41489
41903
|
*/
|
|
41490
41904
|
ReserveServerAsync(this: TeleportService, placeId: number): unknown;
|
|
41491
41905
|
/**
|
|
@@ -41671,7 +42085,7 @@ interface TestService extends Instance {
|
|
|
41671
42085
|
*/
|
|
41672
42086
|
readonly _nominal_TestService: unique symbol;
|
|
41673
42087
|
/**
|
|
41674
|
-
* If set to true
|
|
42088
|
+
* If set to `true`, the game will start running when the service's `TestService:Run()` method is called.
|
|
41675
42089
|
*
|
|
41676
42090
|
* - **ThreadSafety**: ReadSafe
|
|
41677
42091
|
*
|
|
@@ -41696,7 +42110,7 @@ interface TestService extends Instance {
|
|
|
41696
42110
|
*/
|
|
41697
42111
|
readonly ErrorCount: number;
|
|
41698
42112
|
/**
|
|
41699
|
-
* When set to true
|
|
42113
|
+
* When set to `true`, `TestService` will be executed when using the **Run** action in Roblox Studio.
|
|
41700
42114
|
*
|
|
41701
42115
|
* - **ThreadSafety**: ReadSafe
|
|
41702
42116
|
*
|
|
@@ -41783,7 +42197,7 @@ interface TestService extends Instance {
|
|
|
41783
42197
|
*/
|
|
41784
42198
|
readonly WarnCount: number;
|
|
41785
42199
|
/**
|
|
41786
|
-
* Prints result of condition to output.
|
|
42200
|
+
* Prints result of a condition to the output.
|
|
41787
42201
|
*
|
|
41788
42202
|
* - **ThreadSafety**: Unsafe
|
|
41789
42203
|
*
|
|
@@ -41796,7 +42210,7 @@ interface TestService extends Instance {
|
|
|
41796
42210
|
*/
|
|
41797
42211
|
Check(this: TestService, condition: boolean, description: string, source?: Instance, line?: number): void;
|
|
41798
42212
|
/**
|
|
41799
|
-
* Prints
|
|
42213
|
+
* Prints `Test checkpoint:` followed by a string to the output in blue text.
|
|
41800
42214
|
*
|
|
41801
42215
|
* - **ThreadSafety**: Unsafe
|
|
41802
42216
|
*
|
|
@@ -41808,7 +42222,7 @@ interface TestService extends Instance {
|
|
|
41808
42222
|
*/
|
|
41809
42223
|
Checkpoint(this: TestService, text: string, source?: Instance, line?: number): void;
|
|
41810
42224
|
/**
|
|
41811
|
-
* Prints Testing Done to the output
|
|
42225
|
+
* Prints `Testing Done` to the output in blue text.
|
|
41812
42226
|
*
|
|
41813
42227
|
* - **ThreadSafety**: Unsafe
|
|
41814
42228
|
*
|
|
@@ -41817,7 +42231,7 @@ interface TestService extends Instance {
|
|
|
41817
42231
|
*/
|
|
41818
42232
|
Done(this: TestService): void;
|
|
41819
42233
|
/**
|
|
41820
|
-
* Prints a red message to the output, prefixed by `TestService:`.
|
|
42234
|
+
* Prints a red error message to the output, prefixed by `TestService:`.
|
|
41821
42235
|
*
|
|
41822
42236
|
* - **ThreadSafety**: Unsafe
|
|
41823
42237
|
*
|
|
@@ -41829,7 +42243,7 @@ interface TestService extends Instance {
|
|
|
41829
42243
|
*/
|
|
41830
42244
|
Error(this: TestService, description: string, source?: Instance, line?: number): void;
|
|
41831
42245
|
/**
|
|
41832
|
-
* Indicates a fatal error in a TestService run.
|
|
42246
|
+
* Indicates a fatal error in a `TestService` run.
|
|
41833
42247
|
*
|
|
41834
42248
|
* - **ThreadSafety**: Unsafe
|
|
41835
42249
|
*
|
|
@@ -41841,7 +42255,7 @@ interface TestService extends Instance {
|
|
|
41841
42255
|
*/
|
|
41842
42256
|
Fail(this: TestService, description: string, source?: Instance, line?: number): void;
|
|
41843
42257
|
/**
|
|
41844
|
-
* Prints
|
|
42258
|
+
* Prints `TestService:` followed by a string to the output in blue text.
|
|
41845
42259
|
*
|
|
41846
42260
|
* - **ThreadSafety**: Unsafe
|
|
41847
42261
|
*
|
|
@@ -41853,7 +42267,7 @@ interface TestService extends Instance {
|
|
|
41853
42267
|
*/
|
|
41854
42268
|
Message(this: TestService, text: string, source?: Instance, line?: number): void;
|
|
41855
42269
|
/**
|
|
41856
|
-
* Prints whether a condition is true along with description
|
|
42270
|
+
* Prints whether a condition is true along with a description string.
|
|
41857
42271
|
*
|
|
41858
42272
|
* - **ThreadSafety**: Unsafe
|
|
41859
42273
|
*
|
|
@@ -41881,7 +42295,7 @@ interface TestService extends Instance {
|
|
|
41881
42295
|
*/
|
|
41882
42296
|
TakeSnapshot(this: TestService, snapshotname: string): void;
|
|
41883
42297
|
/**
|
|
41884
|
-
* Prints if a condition is true
|
|
42298
|
+
* Prints if a condition is `true`, otherwise prints a warning.
|
|
41885
42299
|
*
|
|
41886
42300
|
* - **ThreadSafety**: Unsafe
|
|
41887
42301
|
*
|
|
@@ -41902,7 +42316,7 @@ interface TestService extends Instance {
|
|
|
41902
42316
|
*/
|
|
41903
42317
|
isFeatureEnabled(this: TestService, name: string): boolean;
|
|
41904
42318
|
/**
|
|
41905
|
-
*
|
|
42319
|
+
* Fires when the server should collect a conditional test result.
|
|
41906
42320
|
*
|
|
41907
42321
|
* - **ThreadSafety**: Unsafe
|
|
41908
42322
|
*
|
|
@@ -41910,7 +42324,7 @@ interface TestService extends Instance {
|
|
|
41910
42324
|
*/
|
|
41911
42325
|
readonly ServerCollectConditionalResult: RBXScriptSignal<(condition: boolean, text: string, script: Instance, line: number) => void>;
|
|
41912
42326
|
/**
|
|
41913
|
-
*
|
|
42327
|
+
* Fires when the server should collect a test result.
|
|
41914
42328
|
*
|
|
41915
42329
|
* - **ThreadSafety**: Unsafe
|
|
41916
42330
|
*
|
|
@@ -42661,7 +43075,7 @@ interface ChatWindowConfiguration extends TextChatConfigurations {
|
|
|
42661
43075
|
DeriveNewMessageProperties(this: ChatWindowConfiguration): ChatWindowMessageProperties;
|
|
42662
43076
|
}
|
|
42663
43077
|
/**
|
|
42664
|
-
*
|
|
43078
|
+
* A data object representing a text chat message.
|
|
42665
43079
|
*
|
|
42666
43080
|
* - **Tags**: NotCreatable
|
|
42667
43081
|
*
|