@rbxts/types 1.0.894 → 1.0.896
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/include/generated/None.d.ts +642 -47
- package/include/generated/PluginSecurity.d.ts +166 -4
- package/include/generated/enums.d.ts +515 -2
- package/package.json +1 -1
|
@@ -19,6 +19,7 @@ interface Services {
|
|
|
19
19
|
AssetDeliveryProxy: AssetDeliveryProxy;
|
|
20
20
|
AssetImportService: AssetImportService;
|
|
21
21
|
AssetManagerService: AssetManagerService;
|
|
22
|
+
AssetQualityService: AssetQualityService;
|
|
22
23
|
AssetService: AssetService;
|
|
23
24
|
AudioFocusService: AudioFocusService;
|
|
24
25
|
AuroraScriptService: AuroraScriptService;
|
|
@@ -173,7 +174,9 @@ interface Services {
|
|
|
173
174
|
SessionCheckService: SessionCheckService;
|
|
174
175
|
SessionService: SessionService;
|
|
175
176
|
SharedTableRegistry: SharedTableRegistry;
|
|
177
|
+
SlimAnimationReplicationService: SlimAnimationReplicationService;
|
|
176
178
|
SlimContentProvider: SlimContentProvider;
|
|
179
|
+
SlimReplicationService: SlimReplicationService;
|
|
177
180
|
SlimService: SlimService;
|
|
178
181
|
SmoothVoxelsUpgraderService: SmoothVoxelsUpgraderService;
|
|
179
182
|
SnippetService: SnippetService;
|
|
@@ -325,6 +328,7 @@ interface CreatableInstances {
|
|
|
325
328
|
Color3Value: Color3Value;
|
|
326
329
|
ColorCorrectionEffect: ColorCorrectionEffect;
|
|
327
330
|
ColorGradingEffect: ColorGradingEffect;
|
|
331
|
+
CompositeValueCurve: CompositeValueCurve;
|
|
328
332
|
CompressorSoundEffect: CompressorSoundEffect;
|
|
329
333
|
ConeHandleAdornment: ConeHandleAdornment;
|
|
330
334
|
Configuration: Configuration;
|
|
@@ -398,6 +402,7 @@ interface CreatableInstances {
|
|
|
398
402
|
LineHandleAdornment: LineHandleAdornment;
|
|
399
403
|
LocalizationTable: LocalizationTable;
|
|
400
404
|
LocalScript: LocalScript;
|
|
405
|
+
MakeupDescription: MakeupDescription;
|
|
401
406
|
ManualGlue: ManualGlue;
|
|
402
407
|
ManualWeld: ManualWeld;
|
|
403
408
|
MarkerCurve: MarkerCurve;
|
|
@@ -676,6 +681,7 @@ interface Instances extends Services, CreatableInstances {
|
|
|
676
681
|
SensorBase: SensorBase;
|
|
677
682
|
ServiceProvider: ServiceProvider;
|
|
678
683
|
SlidingBallConstraint: SlidingBallConstraint;
|
|
684
|
+
SlimAnimationDataEntity: SlimAnimationDataEntity;
|
|
679
685
|
SoundEffect: SoundEffect;
|
|
680
686
|
StackFrame: StackFrame;
|
|
681
687
|
StandardPages: StandardPages;
|
|
@@ -732,7 +738,7 @@ interface Objects extends Instances {
|
|
|
732
738
|
}
|
|
733
739
|
// GENERATED ROBLOX INSTANCE CLASSES
|
|
734
740
|
/**
|
|
735
|
-
* Object is the base class for all classes in the Roblox class hierarchy.
|
|
741
|
+
* `Object` is the base class for all classes in the Roblox class hierarchy.
|
|
736
742
|
*
|
|
737
743
|
* - **Tags**: NotCreatable, NotReplicated
|
|
738
744
|
*
|
|
@@ -762,7 +768,7 @@ interface RBXObject {
|
|
|
762
768
|
* - **ThreadSafety**: Unsafe
|
|
763
769
|
*
|
|
764
770
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Object#GetPropertyChangedSignal)
|
|
765
|
-
* @param this Object is the base class for all classes in the Roblox class hierarchy.
|
|
771
|
+
* @param this `Object` is the base class for all classes in the Roblox class hierarchy.
|
|
766
772
|
* @param property The property to connect to.
|
|
767
773
|
* @returns A signal that fires whenever the property changes.
|
|
768
774
|
*/
|
|
@@ -774,13 +780,13 @@ interface RBXObject {
|
|
|
774
780
|
* - **Tags**: CustomLuaState
|
|
775
781
|
*
|
|
776
782
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Object#IsA)
|
|
777
|
-
* @param this Object is the base class for all classes in the Roblox class hierarchy.
|
|
783
|
+
* @param this `Object` is the base class for all classes in the Roblox class hierarchy.
|
|
778
784
|
* @param className The class against which the Object's class will be checked. Case-sensitive.
|
|
779
785
|
* @returns Describes whether the Object's class matched or is a subclass of the given class.
|
|
780
786
|
*/
|
|
781
787
|
IsA<T extends keyof Objects>(this: RBXObject, className: T): this is Objects[T];
|
|
782
788
|
/**
|
|
783
|
-
*
|
|
789
|
+
* Fires immediately after a property of the object changes, with some limitations.
|
|
784
790
|
*
|
|
785
791
|
* - **ThreadSafety**: Unsafe
|
|
786
792
|
*
|
|
@@ -3384,8 +3390,17 @@ interface AnimationClipProvider extends Instance {
|
|
|
3384
3390
|
* @param this Provides functions to load and preview `AnimationClips`.
|
|
3385
3391
|
* @param userId The user ID of the user.
|
|
3386
3392
|
* @returns An `InventoryPages` of animations.
|
|
3393
|
+
*
|
|
3394
|
+
* @deprecated GetAnimationsAsync
|
|
3387
3395
|
*/
|
|
3388
3396
|
GetAnimations(this: AnimationClipProvider, userId: number): Instance | undefined;
|
|
3397
|
+
/**
|
|
3398
|
+
* - **ThreadSafety**: Unsafe
|
|
3399
|
+
* - **Tags**: Yields
|
|
3400
|
+
*
|
|
3401
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationClipProvider#GetAnimationsAsync)
|
|
3402
|
+
*/
|
|
3403
|
+
GetAnimationsAsync(this: AnimationClipProvider, userId: number): Instance | undefined;
|
|
3389
3404
|
/**
|
|
3390
3405
|
* - **ThreadSafety**: Unsafe
|
|
3391
3406
|
* - **Tags**: Yields
|
|
@@ -3726,12 +3741,15 @@ interface AnimationTrack extends Instance {
|
|
|
3726
3741
|
* - **ThreadSafety**: Unsafe
|
|
3727
3742
|
*
|
|
3728
3743
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#GetParameter)
|
|
3744
|
+
* @param this Controls the playback of an animation on an `Animator`.
|
|
3745
|
+
* @param key
|
|
3729
3746
|
*/
|
|
3730
3747
|
GetParameter(this: AnimationTrack, key: string): unknown;
|
|
3731
3748
|
/**
|
|
3732
3749
|
* - **ThreadSafety**: Unsafe
|
|
3733
3750
|
*
|
|
3734
3751
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#GetParameterDefaults)
|
|
3752
|
+
* @param this Controls the playback of an animation on an `Animator`.
|
|
3735
3753
|
*/
|
|
3736
3754
|
GetParameterDefaults(this: AnimationTrack): object;
|
|
3737
3755
|
/**
|
|
@@ -3777,6 +3795,9 @@ interface AnimationTrack extends Instance {
|
|
|
3777
3795
|
* - **ThreadSafety**: Unsafe
|
|
3778
3796
|
*
|
|
3779
3797
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#SetParameter)
|
|
3798
|
+
* @param this Controls the playback of an animation on an `Animator`.
|
|
3799
|
+
* @param key
|
|
3800
|
+
* @param value
|
|
3780
3801
|
*/
|
|
3781
3802
|
SetParameter(this: AnimationTrack, key: string, value: unknown): void;
|
|
3782
3803
|
/**
|
|
@@ -4116,6 +4137,21 @@ interface AssetPatchSettings extends Instance {
|
|
|
4116
4137
|
*/
|
|
4117
4138
|
PatchId: string;
|
|
4118
4139
|
}
|
|
4140
|
+
/**
|
|
4141
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
4142
|
+
*
|
|
4143
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetQualityService)
|
|
4144
|
+
*/
|
|
4145
|
+
interface AssetQualityService extends Instance {
|
|
4146
|
+
/**
|
|
4147
|
+
* **DO NOT USE!**
|
|
4148
|
+
*
|
|
4149
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
4150
|
+
* @hidden
|
|
4151
|
+
* @deprecated
|
|
4152
|
+
*/
|
|
4153
|
+
readonly _nominal_AssetQualityService: unique symbol;
|
|
4154
|
+
}
|
|
4119
4155
|
/**
|
|
4120
4156
|
* A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
4121
4157
|
*
|
|
@@ -4313,8 +4349,17 @@ interface AssetService extends Instance {
|
|
|
4313
4349
|
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
4314
4350
|
* @param packageAssetId
|
|
4315
4351
|
* @returns Asset IDs that are contained in a specified package.
|
|
4352
|
+
*
|
|
4353
|
+
* @deprecated GetAssetIdsForPackageAsync
|
|
4316
4354
|
*/
|
|
4317
4355
|
GetAssetIdsForPackage(this: AssetService, packageAssetId: number): Array<number>;
|
|
4356
|
+
/**
|
|
4357
|
+
* - **ThreadSafety**: Unsafe
|
|
4358
|
+
* - **Tags**: Yields
|
|
4359
|
+
*
|
|
4360
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#GetAssetIdsForPackageAsync)
|
|
4361
|
+
*/
|
|
4362
|
+
GetAssetIdsForPackageAsync(this: AssetService, packageAssetId: number): Array<unknown>;
|
|
4318
4363
|
/**
|
|
4319
4364
|
* Provides relevant metadata about a specific audio source.
|
|
4320
4365
|
*
|
|
@@ -4436,8 +4481,17 @@ interface AssetService extends Instance {
|
|
|
4436
4481
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#SearchAudio)
|
|
4437
4482
|
* @param this A non-replicated service that handles asset-related queries to the Roblox web API.
|
|
4438
4483
|
* @param searchParameters
|
|
4484
|
+
*
|
|
4485
|
+
* @deprecated SearchAudioAsync
|
|
4439
4486
|
*/
|
|
4440
4487
|
SearchAudio(this: AssetService, searchParameters: AudioSearchParams): AudioPages;
|
|
4488
|
+
/**
|
|
4489
|
+
* - **ThreadSafety**: Unsafe
|
|
4490
|
+
* - **Tags**: Yields
|
|
4491
|
+
*
|
|
4492
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AssetService#SearchAudioAsync)
|
|
4493
|
+
*/
|
|
4494
|
+
SearchAudioAsync(this: AssetService, searchParameters: AudioSearchParams): AudioPages;
|
|
4441
4495
|
}
|
|
4442
4496
|
/**
|
|
4443
4497
|
* The `Atmosphere` object pushes Roblox closer toward realistic environments where sunlight scatters in different ways depending on density and other air particle properties.
|
|
@@ -7134,18 +7188,22 @@ interface AudioTremolo extends Instance {
|
|
|
7134
7188
|
* - **ThreadSafety**: Unsafe
|
|
7135
7189
|
*
|
|
7136
7190
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#GetConnectedWires)
|
|
7191
|
+
* @param this Creates a trembling effect on a sound by varying the volume of the sound up and down.
|
|
7192
|
+
* @param pin
|
|
7137
7193
|
*/
|
|
7138
7194
|
GetConnectedWires(this: AudioTremolo, pin: string): Array<Instance>;
|
|
7139
7195
|
/**
|
|
7140
7196
|
* - **ThreadSafety**: Unsafe
|
|
7141
7197
|
*
|
|
7142
7198
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#GetInputPins)
|
|
7199
|
+
* @param this Creates a trembling effect on a sound by varying the volume of the sound up and down.
|
|
7143
7200
|
*/
|
|
7144
7201
|
GetInputPins(this: AudioTremolo): Array<unknown>;
|
|
7145
7202
|
/**
|
|
7146
7203
|
* - **ThreadSafety**: Unsafe
|
|
7147
7204
|
*
|
|
7148
7205
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioTremolo#GetOutputPins)
|
|
7206
|
+
* @param this Creates a trembling effect on a sound by varying the volume of the sound up and down.
|
|
7149
7207
|
*/
|
|
7150
7208
|
GetOutputPins(this: AudioTremolo): Array<unknown>;
|
|
7151
7209
|
/**
|
|
@@ -7832,8 +7890,17 @@ interface AvatarEditorService extends Instance {
|
|
|
7832
7890
|
* @param this A service to support developer Avatar Editors.
|
|
7833
7891
|
* @param humanoidDescription The HumanoidDescription to check if default clothing is required.
|
|
7834
7892
|
* @returns Returns a HumanoidDescription if default clothing was necessary. Otherwise returns `nil`.
|
|
7893
|
+
*
|
|
7894
|
+
* @deprecated CheckApplyDefaultClothingAsync
|
|
7835
7895
|
*/
|
|
7836
7896
|
CheckApplyDefaultClothing(this: AvatarEditorService, humanoidDescription: HumanoidDescription): HumanoidDescription | undefined;
|
|
7897
|
+
/**
|
|
7898
|
+
* - **ThreadSafety**: Unsafe
|
|
7899
|
+
* - **Tags**: Yields
|
|
7900
|
+
*
|
|
7901
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#CheckApplyDefaultClothingAsync)
|
|
7902
|
+
*/
|
|
7903
|
+
CheckApplyDefaultClothingAsync(this: AvatarEditorService, humanoidDescription: HumanoidDescription): HumanoidDescription;
|
|
7837
7904
|
/**
|
|
7838
7905
|
* - **ThreadSafety**: Unsafe
|
|
7839
7906
|
* - **Tags**: Yields
|
|
@@ -7841,8 +7908,17 @@ interface AvatarEditorService extends Instance {
|
|
|
7841
7908
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#ConformToAvatarRules)
|
|
7842
7909
|
* @param this A service to support developer Avatar Editors.
|
|
7843
7910
|
* @param humanoidDescription
|
|
7911
|
+
*
|
|
7912
|
+
* @deprecated ConformToAvatarRulesAsync
|
|
7844
7913
|
*/
|
|
7845
7914
|
ConformToAvatarRules(this: AvatarEditorService, humanoidDescription: HumanoidDescription): HumanoidDescription;
|
|
7915
|
+
/**
|
|
7916
|
+
* - **ThreadSafety**: Unsafe
|
|
7917
|
+
* - **Tags**: Yields
|
|
7918
|
+
*
|
|
7919
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#ConformToAvatarRulesAsync)
|
|
7920
|
+
*/
|
|
7921
|
+
ConformToAvatarRulesAsync(this: AvatarEditorService, humanoidDescription: HumanoidDescription): HumanoidDescription;
|
|
7846
7922
|
/**
|
|
7847
7923
|
* Returns the platform Avatar rules for things such as scaling, default shirts and pants, number of wearable assets.
|
|
7848
7924
|
*
|
|
@@ -7852,8 +7928,17 @@ interface AvatarEditorService extends Instance {
|
|
|
7852
7928
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetAvatarRules)
|
|
7853
7929
|
* @param this A service to support developer Avatar Editors.
|
|
7854
7930
|
* @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.
|
|
7931
|
+
*
|
|
7932
|
+
* @deprecated GetAvatarRulesAsync
|
|
7855
7933
|
*/
|
|
7856
7934
|
GetAvatarRules(this: AvatarEditorService): AvatarRules;
|
|
7935
|
+
/**
|
|
7936
|
+
* - **ThreadSafety**: Unsafe
|
|
7937
|
+
* - **Tags**: Yields
|
|
7938
|
+
*
|
|
7939
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetAvatarRulesAsync)
|
|
7940
|
+
*/
|
|
7941
|
+
GetAvatarRulesAsync(this: AvatarEditorService): object;
|
|
7857
7942
|
/**
|
|
7858
7943
|
* Gets the item details for a list of items at once.
|
|
7859
7944
|
*
|
|
@@ -7868,10 +7953,19 @@ interface AvatarEditorService extends Instance {
|
|
|
7868
7953
|
* ```lua
|
|
7869
7954
|
* { "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 }
|
|
7870
7955
|
* ``` .
|
|
7956
|
+
*
|
|
7957
|
+
* @deprecated GetBatchItemDetailsAsync
|
|
7871
7958
|
*/
|
|
7872
7959
|
GetBatchItemDetails(this: AvatarEditorService, itemIds: ReadonlyArray<number>, itemType: CastsToEnum<Enum.AvatarItemType.Asset>): ReadonlyArray<AssetItemDetails>;
|
|
7873
7960
|
GetBatchItemDetails(this: AvatarEditorService, itemIds: ReadonlyArray<number>, itemType: CastsToEnum<Enum.AvatarItemType.Bundle>): ReadonlyArray<BundleItemDetails>;
|
|
7874
7961
|
GetBatchItemDetails(this: AvatarEditorService, itemIds: ReadonlyArray<number>, itemType: CastsToEnum<Enum.AvatarItemType>): ReadonlyArray<ItemDetails>;
|
|
7962
|
+
/**
|
|
7963
|
+
* - **ThreadSafety**: Unsafe
|
|
7964
|
+
* - **Tags**: Yields
|
|
7965
|
+
*
|
|
7966
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetBatchItemDetailsAsync)
|
|
7967
|
+
*/
|
|
7968
|
+
GetBatchItemDetailsAsync(this: AvatarEditorService, itemIds: Array<unknown>, itemType: CastsToEnum<Enum.AvatarItemType>): Array<unknown>;
|
|
7875
7969
|
/**
|
|
7876
7970
|
* Returns if the `Players.LocalPlayer` has favorited the given bundle or asset.
|
|
7877
7971
|
*
|
|
@@ -7883,8 +7977,17 @@ interface AvatarEditorService extends Instance {
|
|
|
7883
7977
|
* @param itemId The ID of the specified asset or bundle.
|
|
7884
7978
|
* @param itemType The `AvatarItemType` of the specified asset or bundle.
|
|
7885
7979
|
* @returns Whether the `LocalPlayer` has favorited the given bundle or asset.
|
|
7980
|
+
*
|
|
7981
|
+
* @deprecated GetFavoriteAsync
|
|
7886
7982
|
*/
|
|
7887
7983
|
GetFavorite(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType>): boolean;
|
|
7984
|
+
/**
|
|
7985
|
+
* - **ThreadSafety**: Unsafe
|
|
7986
|
+
* - **Tags**: Yields
|
|
7987
|
+
*
|
|
7988
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetFavoriteAsync)
|
|
7989
|
+
*/
|
|
7990
|
+
GetFavoriteAsync(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType>): boolean;
|
|
7888
7991
|
/**
|
|
7889
7992
|
* Returns an `InventoryPages` object with information about owned items in the users inventory with the given AvatarAssetTypes.
|
|
7890
7993
|
*
|
|
@@ -7894,6 +7997,8 @@ interface AvatarEditorService extends Instance {
|
|
|
7894
7997
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetInventory)
|
|
7895
7998
|
* @param this A service to support developer Avatar Editors.
|
|
7896
7999
|
* @param assetTypes The `AvatarAssetType` that can will be checked for in the player's inventory.
|
|
8000
|
+
*
|
|
8001
|
+
* @deprecated GetInventoryAsync
|
|
7897
8002
|
*/
|
|
7898
8003
|
GetInventory(this: AvatarEditorService, assetTypes: ReadonlyArray<Enum.AvatarAssetType>): InventoryPages<{
|
|
7899
8004
|
AssetId: number;
|
|
@@ -7901,6 +8006,13 @@ interface AvatarEditorService extends Instance {
|
|
|
7901
8006
|
Created: string;
|
|
7902
8007
|
Name: string;
|
|
7903
8008
|
}>;
|
|
8009
|
+
/**
|
|
8010
|
+
* - **ThreadSafety**: Unsafe
|
|
8011
|
+
* - **Tags**: Yields
|
|
8012
|
+
*
|
|
8013
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetInventoryAsync)
|
|
8014
|
+
*/
|
|
8015
|
+
GetInventoryAsync(this: AvatarEditorService, assetTypes: Array<unknown>): InventoryPages;
|
|
7904
8016
|
/**
|
|
7905
8017
|
* Returns the item details for the given item.
|
|
7906
8018
|
*
|
|
@@ -7912,10 +8024,19 @@ interface AvatarEditorService extends Instance {
|
|
|
7912
8024
|
* @param itemId The ID of the item whose details are being retrieved.
|
|
7913
8025
|
* @param itemType An enum value indicating the type of item whose details are being retrieved.
|
|
7914
8026
|
* @returns A table containing the item info for the retrieved item. See above for a sample table.
|
|
8027
|
+
*
|
|
8028
|
+
* @deprecated GetItemDetailsAsync
|
|
7915
8029
|
*/
|
|
7916
8030
|
GetItemDetails(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType.Asset>): AssetItemDetails;
|
|
7917
8031
|
GetItemDetails(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType.Bundle>): BundleItemDetails;
|
|
7918
8032
|
GetItemDetails(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType>): ItemDetails;
|
|
8033
|
+
/**
|
|
8034
|
+
* - **ThreadSafety**: Unsafe
|
|
8035
|
+
* - **Tags**: Yields
|
|
8036
|
+
*
|
|
8037
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetItemDetailsAsync)
|
|
8038
|
+
*/
|
|
8039
|
+
GetItemDetailsAsync(this: AvatarEditorService, itemId: number, itemType: CastsToEnum<Enum.AvatarItemType>): object;
|
|
7919
8040
|
/**
|
|
7920
8041
|
* Returns the outfit details for the given outfit.
|
|
7921
8042
|
*
|
|
@@ -7926,8 +8047,17 @@ interface AvatarEditorService extends Instance {
|
|
|
7926
8047
|
* @param this A service to support developer Avatar Editors.
|
|
7927
8048
|
* @param outfitId The ID of the outfit whose details are being retrieved.
|
|
7928
8049
|
* @returns A table containing the outfit info for the retrieved outfit. See above for a sample table.
|
|
8050
|
+
*
|
|
8051
|
+
* @deprecated GetOutfitDetailsAsync
|
|
7929
8052
|
*/
|
|
7930
8053
|
GetOutfitDetails(this: AvatarEditorService, outfitId: number): object;
|
|
8054
|
+
/**
|
|
8055
|
+
* - **ThreadSafety**: Unsafe
|
|
8056
|
+
* - **Tags**: Yields
|
|
8057
|
+
*
|
|
8058
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetOutfitDetailsAsync)
|
|
8059
|
+
*/
|
|
8060
|
+
GetOutfitDetailsAsync(this: AvatarEditorService, outfitId: number): object;
|
|
7931
8061
|
/**
|
|
7932
8062
|
* Returns outfit data for the `Players.LocalPlayer`.
|
|
7933
8063
|
*
|
|
@@ -7938,8 +8068,17 @@ interface AvatarEditorService extends Instance {
|
|
|
7938
8068
|
* @param this A service to support developer Avatar Editors.
|
|
7939
8069
|
* @param outfitSource
|
|
7940
8070
|
* @param outfitType
|
|
8071
|
+
*
|
|
8072
|
+
* @deprecated GetOutfitsAsync
|
|
7941
8073
|
*/
|
|
7942
8074
|
GetOutfits(this: AvatarEditorService, outfitSource?: CastsToEnum<Enum.OutfitSource>, outfitType?: CastsToEnum<Enum.OutfitType>): OutfitPages;
|
|
8075
|
+
/**
|
|
8076
|
+
* - **ThreadSafety**: Unsafe
|
|
8077
|
+
* - **Tags**: Yields
|
|
8078
|
+
*
|
|
8079
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetOutfitsAsync)
|
|
8080
|
+
*/
|
|
8081
|
+
GetOutfitsAsync(this: AvatarEditorService, outfitSource?: CastsToEnum<Enum.OutfitSource>, outfitType?: CastsToEnum<Enum.OutfitType>): OutfitPages;
|
|
7943
8082
|
/**
|
|
7944
8083
|
* Returns a list of recommended assets based on a given `AssetType` and asset ID.
|
|
7945
8084
|
*
|
|
@@ -7951,8 +8090,17 @@ interface AvatarEditorService extends Instance {
|
|
|
7951
8090
|
* @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`.
|
|
7952
8091
|
* @param contextAssetId The ID of an asset with a type matching the provided assetType used for context when retrieving recommendations.
|
|
7953
8092
|
* @returns A list of recommendations based on the given `AssetType`.
|
|
8093
|
+
*
|
|
8094
|
+
* @deprecated GetRecommendedAssetsAsync
|
|
7954
8095
|
*/
|
|
7955
8096
|
GetRecommendedAssets(this: AvatarEditorService, assetType: CastsToEnum<Enum.AvatarAssetType>, contextAssetId?: number): ReadonlyArray<RecommendedAsset>;
|
|
8097
|
+
/**
|
|
8098
|
+
* - **ThreadSafety**: Unsafe
|
|
8099
|
+
* - **Tags**: Yields
|
|
8100
|
+
*
|
|
8101
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetRecommendedAssetsAsync)
|
|
8102
|
+
*/
|
|
8103
|
+
GetRecommendedAssetsAsync(this: AvatarEditorService, assetType: CastsToEnum<Enum.AvatarAssetType>, contextAssetId?: number): Array<unknown>;
|
|
7956
8104
|
/**
|
|
7957
8105
|
* Returns a list of recommended bundles for a given bundle id.
|
|
7958
8106
|
*
|
|
@@ -7963,8 +8111,17 @@ interface AvatarEditorService extends Instance {
|
|
|
7963
8111
|
* @param this A service to support developer Avatar Editors.
|
|
7964
8112
|
* @param bundleId A list of recommended bundles.
|
|
7965
8113
|
* @returns The bundle ID that the recommended bundles will be returned for.
|
|
8114
|
+
*
|
|
8115
|
+
* @deprecated GetRecommendedBundlesAsync
|
|
7966
8116
|
*/
|
|
7967
8117
|
GetRecommendedBundles(this: AvatarEditorService, bundleId: number): ReadonlyArray<RecommendedBundle>;
|
|
8118
|
+
/**
|
|
8119
|
+
* - **ThreadSafety**: Unsafe
|
|
8120
|
+
* - **Tags**: Yields
|
|
8121
|
+
*
|
|
8122
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#GetRecommendedBundlesAsync)
|
|
8123
|
+
*/
|
|
8124
|
+
GetRecommendedBundlesAsync(this: AvatarEditorService, bundleId: number): Array<unknown>;
|
|
7968
8125
|
/**
|
|
7969
8126
|
* Returns a `CatalogPages` object containing the result of the given search.
|
|
7970
8127
|
*
|
|
@@ -7974,8 +8131,17 @@ interface AvatarEditorService extends Instance {
|
|
|
7974
8131
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#SearchCatalog)
|
|
7975
8132
|
* @param this A service to support developer Avatar Editors.
|
|
7976
8133
|
* @param searchParameters An object containing the parameters used for the search.
|
|
8134
|
+
*
|
|
8135
|
+
* @deprecated SearchCatalogAsync
|
|
7977
8136
|
*/
|
|
7978
8137
|
SearchCatalog(this: AvatarEditorService, searchParameters: CatalogSearchParams): CatalogPages;
|
|
8138
|
+
/**
|
|
8139
|
+
* - **ThreadSafety**: Unsafe
|
|
8140
|
+
* - **Tags**: Yields
|
|
8141
|
+
*
|
|
8142
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AvatarEditorService#SearchCatalogAsync)
|
|
8143
|
+
*/
|
|
8144
|
+
SearchCatalogAsync(this: AvatarEditorService, searchParameters: CatalogSearchParams): CatalogPages;
|
|
7979
8145
|
/**
|
|
7980
8146
|
* Fires when the `AvatarEditorService:PromptAllowInventoryReadAccess()` prompt is responded to by the user.
|
|
7981
8147
|
*
|
|
@@ -8118,8 +8284,17 @@ interface BadgeService extends Instance {
|
|
|
8118
8284
|
* @param userId The `Player.UserId` of the user the badge is to be awarded to.
|
|
8119
8285
|
* @param badgeId The ID of the badge to be awarded.
|
|
8120
8286
|
* @returns Boolean of `true` if the badge was awarded successfully.
|
|
8287
|
+
*
|
|
8288
|
+
* @deprecated AwardBadgeAsync
|
|
8121
8289
|
*/
|
|
8122
8290
|
AwardBadge(this: BadgeService, userId: number, badgeId: number): boolean;
|
|
8291
|
+
/**
|
|
8292
|
+
* - **ThreadSafety**: Unsafe
|
|
8293
|
+
* - **Tags**: Yields
|
|
8294
|
+
*
|
|
8295
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/BadgeService#AwardBadgeAsync)
|
|
8296
|
+
*/
|
|
8297
|
+
AwardBadgeAsync(this: BadgeService, userId: number, badgeId: number): boolean;
|
|
8123
8298
|
/**
|
|
8124
8299
|
* Checks a list of badge IDs against a `UserId` and returns a list of badge IDs that the player owns.
|
|
8125
8300
|
*
|
|
@@ -10157,8 +10332,8 @@ interface CaptureService extends Instance {
|
|
|
10157
10332
|
*
|
|
10158
10333
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#PromptSaveCapturesToGallery)
|
|
10159
10334
|
* @param this A service which provides control over screenshot and video capture features.
|
|
10160
|
-
* @param captures
|
|
10161
|
-
* @param resultCallback A callback function that will be invoked with a dictionary mapping each `contentId` to a boolean indicating if the user accepted saving that capture.
|
|
10335
|
+
* @param captures An array of content IDs and/or `Capture` objects.
|
|
10336
|
+
* @param resultCallback A callback function that will be invoked with a dictionary mapping each `contentId` and/or `Capture` object to a boolean indicating if the user accepted saving that capture.
|
|
10162
10337
|
*/
|
|
10163
10338
|
PromptSaveCapturesToGallery<T extends string>(this: CaptureService, contentIds: Array<T>, resultCallback: (results: Record<T, boolean>) => void): void;
|
|
10164
10339
|
/**
|
|
@@ -10168,7 +10343,7 @@ interface CaptureService extends Instance {
|
|
|
10168
10343
|
*
|
|
10169
10344
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#PromptShareCapture)
|
|
10170
10345
|
* @param this A service which provides control over screenshot and video capture features.
|
|
10171
|
-
* @param captureContent
|
|
10346
|
+
* @param captureContent A `Content` containing a `contentId` or `Capture` object.
|
|
10172
10347
|
* @param launchData An optional string to include as launch data in the invite link.
|
|
10173
10348
|
* @param onAcceptedCallback An optional callback function invoked if the user accepts sharing.
|
|
10174
10349
|
* @param onDeniedCallback An optional callback function invoked if the user denies sharing.
|
|
@@ -10234,7 +10409,7 @@ interface CaptureService extends Instance {
|
|
|
10234
10409
|
*
|
|
10235
10410
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CaptureService#StartVideoCaptureAsync)
|
|
10236
10411
|
* @param this A service which provides control over screenshot and video capture features.
|
|
10237
|
-
* @param onCaptureReady
|
|
10412
|
+
* @param onCaptureReady A callback function that is called on video capture completion with a `VideoCaptureResult` and, if successful, a `VideoCapture`.
|
|
10238
10413
|
* @param captureParams
|
|
10239
10414
|
*/
|
|
10240
10415
|
StartVideoCaptureAsync(this: CaptureService, onCaptureReady: Callback, captureParams?: object): Enum.VideoCaptureStartedResult;
|
|
@@ -11527,6 +11702,37 @@ interface CommerceService extends Instance {
|
|
|
11527
11702
|
*/
|
|
11528
11703
|
readonly PromptCommerceProductPurchaseFinished: RBXScriptSignal<(user: Player, productId: string) => void>;
|
|
11529
11704
|
}
|
|
11705
|
+
/**
|
|
11706
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CompositeValueCurve)
|
|
11707
|
+
*/
|
|
11708
|
+
interface CompositeValueCurve extends Instance {
|
|
11709
|
+
/**
|
|
11710
|
+
* **DO NOT USE!**
|
|
11711
|
+
*
|
|
11712
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
11713
|
+
* @hidden
|
|
11714
|
+
* @deprecated
|
|
11715
|
+
*/
|
|
11716
|
+
readonly _nominal_CompositeValueCurve: unique symbol;
|
|
11717
|
+
/**
|
|
11718
|
+
* - **ThreadSafety**: ReadSafe
|
|
11719
|
+
*
|
|
11720
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CompositeValueCurve#CurveType)
|
|
11721
|
+
*/
|
|
11722
|
+
CurveType: Enum.CompositeValueCurveType;
|
|
11723
|
+
/**
|
|
11724
|
+
* - **ThreadSafety**: Unsafe
|
|
11725
|
+
*
|
|
11726
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CompositeValueCurve#GetComponentCurves)
|
|
11727
|
+
*/
|
|
11728
|
+
GetComponentCurves(this: CompositeValueCurve): Array<Instance>;
|
|
11729
|
+
/**
|
|
11730
|
+
* - **ThreadSafety**: Unsafe
|
|
11731
|
+
*
|
|
11732
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CompositeValueCurve#GetValueAtTime)
|
|
11733
|
+
*/
|
|
11734
|
+
GetValueAtTime(this: CompositeValueCurve, time: number): unknown;
|
|
11735
|
+
}
|
|
11530
11736
|
/**
|
|
11531
11737
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
11532
11738
|
*
|
|
@@ -16567,6 +16773,10 @@ interface GenerationService extends Instance {
|
|
|
16567
16773
|
* - **Tags**: Yields
|
|
16568
16774
|
*
|
|
16569
16775
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GenerationService#GenerateModelAsync)
|
|
16776
|
+
* @param this Service that allows developers to generate 3D objects from text prompts.
|
|
16777
|
+
* @param inputs
|
|
16778
|
+
* @param schema
|
|
16779
|
+
* @param options
|
|
16570
16780
|
*/
|
|
16571
16781
|
GenerateModelAsync(this: GenerationService, inputs: object, schema: object, options?: object): unknown;
|
|
16572
16782
|
/**
|
|
@@ -22823,8 +23033,17 @@ interface Humanoid extends Instance {
|
|
|
22823
23033
|
* @param this A special object that gives models the functionality of a character.
|
|
22824
23034
|
* @param humanoidDescription The `HumanoidDescription` instance which you want to set the character to match.
|
|
22825
23035
|
* @param assetTypeVerification The asset type verification mode.
|
|
23036
|
+
*
|
|
23037
|
+
* @deprecated ApplyDescriptionAsync
|
|
22826
23038
|
*/
|
|
22827
23039
|
ApplyDescription(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
|
|
23040
|
+
/**
|
|
23041
|
+
* - **ThreadSafety**: Unsafe
|
|
23042
|
+
* - **Tags**: Yields
|
|
23043
|
+
*
|
|
23044
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Humanoid#ApplyDescriptionAsync)
|
|
23045
|
+
*/
|
|
23046
|
+
ApplyDescriptionAsync(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
|
|
22828
23047
|
/**
|
|
22829
23048
|
* Makes the character's look match that of the passed in `HumanoidDescription`, even after external changes.
|
|
22830
23049
|
*
|
|
@@ -22835,8 +23054,17 @@ interface Humanoid extends Instance {
|
|
|
22835
23054
|
* @param this A special object that gives models the functionality of a character.
|
|
22836
23055
|
* @param humanoidDescription The `HumanoidDescription` instance which you want to set the character to match.
|
|
22837
23056
|
* @param assetTypeVerification The asset type verification mode.
|
|
23057
|
+
*
|
|
23058
|
+
* @deprecated ApplyDescriptionResetAsync
|
|
22838
23059
|
*/
|
|
22839
23060
|
ApplyDescriptionReset(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
|
|
23061
|
+
/**
|
|
23062
|
+
* - **ThreadSafety**: Unsafe
|
|
23063
|
+
* - **Tags**: Yields
|
|
23064
|
+
*
|
|
23065
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Humanoid#ApplyDescriptionResetAsync)
|
|
23066
|
+
*/
|
|
23067
|
+
ApplyDescriptionResetAsync(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
|
|
22840
23068
|
/**
|
|
22841
23069
|
* Plays emotes and returns if was successfully ran.
|
|
22842
23070
|
*
|
|
@@ -22847,8 +23075,17 @@ interface Humanoid extends Instance {
|
|
|
22847
23075
|
* @param this A special object that gives models the functionality of a character.
|
|
22848
23076
|
* @param emoteName name of the emote to play.
|
|
22849
23077
|
* @returns successfully played.
|
|
23078
|
+
*
|
|
23079
|
+
* @deprecated PlayEmoteAsync
|
|
22850
23080
|
*/
|
|
22851
23081
|
PlayEmote(this: Humanoid, emoteName: string): boolean;
|
|
23082
|
+
/**
|
|
23083
|
+
* - **ThreadSafety**: Unsafe
|
|
23084
|
+
* - **Tags**: Yields
|
|
23085
|
+
*
|
|
23086
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Humanoid#PlayEmoteAsync)
|
|
23087
|
+
*/
|
|
23088
|
+
PlayEmoteAsync(this: Humanoid, emoteName: string): boolean;
|
|
22852
23089
|
/**
|
|
22853
23090
|
* **Deprecated:**
|
|
22854
23091
|
*
|
|
@@ -23368,6 +23605,12 @@ interface HumanoidDescription extends Instance {
|
|
|
23368
23605
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#TorsoColor)
|
|
23369
23606
|
*/
|
|
23370
23607
|
TorsoColor: Color3;
|
|
23608
|
+
/**
|
|
23609
|
+
* - **ThreadSafety**: ReadSafe
|
|
23610
|
+
*
|
|
23611
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidDescription#UseAvatarSettings)
|
|
23612
|
+
*/
|
|
23613
|
+
UseAvatarSettings: boolean;
|
|
23371
23614
|
/**
|
|
23372
23615
|
* A comma-separated list of asset IDs that will be added as `Accessories` to a `Humanoid` rig when `applied`, usually those attached to its waist (such as belts).
|
|
23373
23616
|
*
|
|
@@ -23510,8 +23753,6 @@ interface HumanoidDescription extends Instance {
|
|
|
23510
23753
|
readonly EquippedEmotesChanged: RBXScriptSignal<(newEquippedEmotes: EquippedEmotes) => void>;
|
|
23511
23754
|
}
|
|
23512
23755
|
/**
|
|
23513
|
-
* - **Tags**: NotBrowsable
|
|
23514
|
-
*
|
|
23515
23756
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/HumanoidRigDescription)
|
|
23516
23757
|
*/
|
|
23517
23758
|
interface HumanoidRigDescription extends Instance {
|
|
@@ -24627,6 +24868,12 @@ interface InputBinding extends Instance {
|
|
|
24627
24868
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Left)
|
|
24628
24869
|
*/
|
|
24629
24870
|
Left: Enum.KeyCode;
|
|
24871
|
+
/**
|
|
24872
|
+
* - **ThreadSafety**: ReadSafe
|
|
24873
|
+
*
|
|
24874
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#PointerIndex)
|
|
24875
|
+
*/
|
|
24876
|
+
PointerIndex: number;
|
|
24630
24877
|
/**
|
|
24631
24878
|
* Numerical value above which to fire an `InputAction` with a `Type` of `Bool`.
|
|
24632
24879
|
*
|
|
@@ -24691,6 +24938,12 @@ interface InputBinding extends Instance {
|
|
|
24691
24938
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Vector2Scale)
|
|
24692
24939
|
*/
|
|
24693
24940
|
Vector2Scale: Vector2;
|
|
24941
|
+
/**
|
|
24942
|
+
* - **ThreadSafety**: ReadSafe
|
|
24943
|
+
*
|
|
24944
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InputBinding#Vector3Scale)
|
|
24945
|
+
*/
|
|
24946
|
+
Vector3Scale: Vector3;
|
|
24694
24947
|
}
|
|
24695
24948
|
/**
|
|
24696
24949
|
* Collection of actions which holds related actions and defines how they interact with other contexts/actions.
|
|
@@ -24935,10 +25188,19 @@ interface InsertService extends Instance {
|
|
|
24935
25188
|
* @param searchText String used to search for free decals in the Catalog.
|
|
24936
25189
|
* @param pageNum The page number in the Catalog to return.
|
|
24937
25190
|
* @returns A single table (of returned free decals) wrapped in a table.
|
|
25191
|
+
*
|
|
25192
|
+
* @deprecated GetFreeDecalsAsync
|
|
24938
25193
|
*/
|
|
24939
25194
|
GetFreeDecals(this: InsertService, searchText: string, pageNum: number): [
|
|
24940
25195
|
Array<FreeSearchResult>
|
|
24941
25196
|
];
|
|
25197
|
+
/**
|
|
25198
|
+
* - **ThreadSafety**: Unsafe
|
|
25199
|
+
* - **Tags**: Yields
|
|
25200
|
+
*
|
|
25201
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InsertService#GetFreeDecalsAsync)
|
|
25202
|
+
*/
|
|
25203
|
+
GetFreeDecalsAsync(this: InsertService, searchText: string, pageNum: number): Array<unknown>;
|
|
24942
25204
|
/**
|
|
24943
25205
|
* Retrieves a list of Free Models from the Catalog.
|
|
24944
25206
|
*
|
|
@@ -24950,10 +25212,19 @@ interface InsertService extends Instance {
|
|
|
24950
25212
|
* @param searchText String used to search for free decals in the Catalog.
|
|
24951
25213
|
* @param pageNum The page number in the Catalog to return.
|
|
24952
25214
|
* @returns A single table (of returned free models) wrapped in a table.
|
|
25215
|
+
*
|
|
25216
|
+
* @deprecated GetFreeModelsAsync
|
|
24953
25217
|
*/
|
|
24954
25218
|
GetFreeModels(this: InsertService, searchText: string, pageNum: number): [
|
|
24955
25219
|
Array<FreeSearchResult>
|
|
24956
25220
|
];
|
|
25221
|
+
/**
|
|
25222
|
+
* - **ThreadSafety**: Unsafe
|
|
25223
|
+
* - **Tags**: Yields
|
|
25224
|
+
*
|
|
25225
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/InsertService#GetFreeModelsAsync)
|
|
25226
|
+
*/
|
|
25227
|
+
GetFreeModelsAsync(this: InsertService, searchText: string, pageNum: number): Array<unknown>;
|
|
24957
25228
|
/**
|
|
24958
25229
|
* Returns the latest AssetVersionId of an asset for assets created by the place creator. Can be used in combination with `InsertService:LoadAssetVersion()` to load the latest version of a model, even if it gets updated while the game is running.
|
|
24959
25230
|
*
|
|
@@ -25718,8 +25989,17 @@ interface KeyframeSequenceProvider extends Instance {
|
|
|
25718
25989
|
* @param this Provides functions to load and preview `KeyframeSequence`.
|
|
25719
25990
|
* @param userId The user ID of the user.
|
|
25720
25991
|
* @returns An `InventoryPages` of animations.
|
|
25992
|
+
*
|
|
25993
|
+
* @deprecated GetAnimationsAsync
|
|
25721
25994
|
*/
|
|
25722
25995
|
GetAnimations(this: KeyframeSequenceProvider, userId: number): InventoryPages<number>;
|
|
25996
|
+
/**
|
|
25997
|
+
* - **ThreadSafety**: Unsafe
|
|
25998
|
+
* - **Tags**: Yields
|
|
25999
|
+
*
|
|
26000
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/KeyframeSequenceProvider#GetAnimationsAsync)
|
|
26001
|
+
*/
|
|
26002
|
+
GetAnimationsAsync(this: KeyframeSequenceProvider, userId: number): Instance | undefined;
|
|
25723
26003
|
/**
|
|
25724
26004
|
* Returns a KeyframeSequence based on the specified assetId asynchronously.
|
|
25725
26005
|
*
|
|
@@ -26936,6 +27216,51 @@ interface MLService extends Instance {
|
|
|
26936
27216
|
*/
|
|
26937
27217
|
CreateSessionAsync(this: MLService, assetId: string): MLSession;
|
|
26938
27218
|
}
|
|
27219
|
+
/**
|
|
27220
|
+
* - **Tags**: NotBrowsable
|
|
27221
|
+
*
|
|
27222
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MakeupDescription)
|
|
27223
|
+
*/
|
|
27224
|
+
interface MakeupDescription extends Instance {
|
|
27225
|
+
/**
|
|
27226
|
+
* **DO NOT USE!**
|
|
27227
|
+
*
|
|
27228
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
27229
|
+
* @hidden
|
|
27230
|
+
* @deprecated
|
|
27231
|
+
*/
|
|
27232
|
+
readonly _nominal_MakeupDescription: unique symbol;
|
|
27233
|
+
/**
|
|
27234
|
+
* - **ThreadSafety**: ReadSafe
|
|
27235
|
+
*
|
|
27236
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MakeupDescription#AssetId)
|
|
27237
|
+
*/
|
|
27238
|
+
AssetId: number;
|
|
27239
|
+
/**
|
|
27240
|
+
* - **ThreadSafety**: ReadSafe
|
|
27241
|
+
*
|
|
27242
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MakeupDescription#Instance)
|
|
27243
|
+
*/
|
|
27244
|
+
Instance: Instance | undefined;
|
|
27245
|
+
/**
|
|
27246
|
+
* - **ThreadSafety**: ReadSafe
|
|
27247
|
+
*
|
|
27248
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MakeupDescription#MakeupType)
|
|
27249
|
+
*/
|
|
27250
|
+
MakeupType: Enum.MakeupType;
|
|
27251
|
+
/**
|
|
27252
|
+
* - **ThreadSafety**: ReadSafe
|
|
27253
|
+
*
|
|
27254
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MakeupDescription#Order)
|
|
27255
|
+
*/
|
|
27256
|
+
Order: number;
|
|
27257
|
+
/**
|
|
27258
|
+
* - **ThreadSafety**: Unsafe
|
|
27259
|
+
*
|
|
27260
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MakeupDescription#GetAppliedInstance)
|
|
27261
|
+
*/
|
|
27262
|
+
GetAppliedInstance(this: MakeupDescription): Instance | undefined;
|
|
27263
|
+
}
|
|
26939
27264
|
/**
|
|
26940
27265
|
* Represents a list of strings markers in chronological order.
|
|
26941
27266
|
*
|
|
@@ -27146,6 +27471,8 @@ interface MarketplaceService extends Instance {
|
|
|
27146
27471
|
* @param assetId The asset ID of the specified product.
|
|
27147
27472
|
* @param infoType An `InfoType` enum value specifying the type of information being retrieved.
|
|
27148
27473
|
* @returns A dictionary containing information about the queried item, described in the previous tables.
|
|
27474
|
+
*
|
|
27475
|
+
* @deprecated GetProductInfoAsync
|
|
27149
27476
|
*/
|
|
27150
27477
|
GetProductInfo(this: MarketplaceService, id: number): AssetProductInfo;
|
|
27151
27478
|
GetProductInfo(this: MarketplaceService, id: number, infoType: CastsToEnum<Enum.InfoType.Asset>): AssetProductInfo;
|
|
@@ -27154,6 +27481,13 @@ interface MarketplaceService extends Instance {
|
|
|
27154
27481
|
GetProductInfo(this: MarketplaceService, id: number, infoType: CastsToEnum<Enum.InfoType.Product>): DeveloperProductInfo;
|
|
27155
27482
|
GetProductInfo(this: MarketplaceService, id: number, infoType: CastsToEnum<Enum.InfoType.Subscription>): SubscriptionProductInfo;
|
|
27156
27483
|
GetProductInfo(this: MarketplaceService, id: number, infoType?: CastsToEnum<Enum.InfoType>): AssetProductInfo | BundleInfo | GamePassProductInfo | DeveloperProductInfo | SubscriptionProductInfo;
|
|
27484
|
+
/**
|
|
27485
|
+
* - **ThreadSafety**: Unsafe
|
|
27486
|
+
* - **Tags**: Yields
|
|
27487
|
+
*
|
|
27488
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#GetProductInfoAsync)
|
|
27489
|
+
*/
|
|
27490
|
+
GetProductInfoAsync(this: MarketplaceService, assetId: number, infoType?: CastsToEnum<Enum.InfoType>): object;
|
|
27157
27491
|
/**
|
|
27158
27492
|
* Returns the product information of a subscription for the given `subscriptionId`.
|
|
27159
27493
|
*
|
|
@@ -27224,8 +27558,17 @@ interface MarketplaceService extends Instance {
|
|
|
27224
27558
|
* @param player The `Player` whose inventory is tested for ownership of the given asset.
|
|
27225
27559
|
* @param assetId The asset ID for which the given player's inventory is tested.
|
|
27226
27560
|
* @returns Indicates whether the given player's inventory contains the given asset.
|
|
27561
|
+
*
|
|
27562
|
+
* @deprecated PlayerOwnsAssetAsync
|
|
27227
27563
|
*/
|
|
27228
27564
|
PlayerOwnsAsset(this: MarketplaceService, player: Player, assetId: number): boolean;
|
|
27565
|
+
/**
|
|
27566
|
+
* - **ThreadSafety**: Unsafe
|
|
27567
|
+
* - **Tags**: Yields
|
|
27568
|
+
*
|
|
27569
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PlayerOwnsAssetAsync)
|
|
27570
|
+
*/
|
|
27571
|
+
PlayerOwnsAssetAsync(this: MarketplaceService, player: Instance, assetId: number): boolean;
|
|
27229
27572
|
/**
|
|
27230
27573
|
* Returns whether the given player owns the given bundle.
|
|
27231
27574
|
*
|
|
@@ -27237,13 +27580,24 @@ interface MarketplaceService extends Instance {
|
|
|
27237
27580
|
* @param player The `Player` whose inventory is tested for ownership of the given bundle.
|
|
27238
27581
|
* @param bundleId The bundle ID for which the given player's inventory is tested.
|
|
27239
27582
|
* @returns Indicates whether the given player's inventory contains the given bundle.
|
|
27583
|
+
*
|
|
27584
|
+
* @deprecated PlayerOwnsBundleAsync
|
|
27240
27585
|
*/
|
|
27241
27586
|
PlayerOwnsBundle(this: MarketplaceService, player: Player, bundleId: number): boolean;
|
|
27587
|
+
/**
|
|
27588
|
+
* - **ThreadSafety**: Unsafe
|
|
27589
|
+
* - **Tags**: Yields
|
|
27590
|
+
*
|
|
27591
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PlayerOwnsBundleAsync)
|
|
27592
|
+
*/
|
|
27593
|
+
PlayerOwnsBundleAsync(this: MarketplaceService, player: Player, bundleId: number): boolean;
|
|
27242
27594
|
/**
|
|
27243
27595
|
* - **ThreadSafety**: Unsafe
|
|
27244
27596
|
* - **Tags**: Yields
|
|
27245
27597
|
*
|
|
27246
27598
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#RankProductsAsync)
|
|
27599
|
+
* @param this The service responsible for in-experience transactions.
|
|
27600
|
+
* @param productIdentifiers
|
|
27247
27601
|
*/
|
|
27248
27602
|
RankProductsAsync(this: MarketplaceService, productIdentifiers: Array<unknown>): Array<unknown>;
|
|
27249
27603
|
/**
|
|
@@ -27251,6 +27605,8 @@ interface MarketplaceService extends Instance {
|
|
|
27251
27605
|
* - **Tags**: Yields
|
|
27252
27606
|
*
|
|
27253
27607
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#RecommendTopProductsAsync)
|
|
27608
|
+
* @param this The service responsible for in-experience transactions.
|
|
27609
|
+
* @param infoTypes
|
|
27254
27610
|
*/
|
|
27255
27611
|
RecommendTopProductsAsync(this: MarketplaceService, infoTypes: Array<unknown>): Array<unknown>;
|
|
27256
27612
|
/**
|
|
@@ -27473,6 +27829,13 @@ interface MaterialVariant extends Instance {
|
|
|
27473
27829
|
* @deprecated
|
|
27474
27830
|
*/
|
|
27475
27831
|
readonly _nominal_MaterialVariant: unique symbol;
|
|
27832
|
+
/**
|
|
27833
|
+
* - **ThreadSafety**: ReadSafe
|
|
27834
|
+
* - **Tags**: NotBrowsable
|
|
27835
|
+
*
|
|
27836
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MaterialVariant#AlphaMode)
|
|
27837
|
+
*/
|
|
27838
|
+
AlphaMode: Enum.AlphaMode;
|
|
27476
27839
|
/**
|
|
27477
27840
|
* Category Material this variant belongs to.
|
|
27478
27841
|
*
|
|
@@ -27979,12 +28342,17 @@ interface ModerationService extends Instance {
|
|
|
27979
28342
|
* - **ThreadSafety**: Unsafe
|
|
27980
28343
|
*
|
|
27981
28344
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService#BindReviewableContentEventProcessor)
|
|
28345
|
+
* @param this
|
|
28346
|
+
* @param priority
|
|
28347
|
+
* @param callback
|
|
27982
28348
|
*/
|
|
27983
28349
|
BindReviewableContentEventProcessor(this: ModerationService, priority: number, callback: Callback): RBXScriptConnection;
|
|
27984
28350
|
/**
|
|
27985
28351
|
* - **ThreadSafety**: Unsafe
|
|
27986
28352
|
*
|
|
27987
28353
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService#CreateReviewableContentKey)
|
|
28354
|
+
* @param this
|
|
28355
|
+
* @param content
|
|
27988
28356
|
*/
|
|
27989
28357
|
CreateReviewableContentKey(this: ModerationService, content: Content): string;
|
|
27990
28358
|
/**
|
|
@@ -27992,6 +28360,8 @@ interface ModerationService extends Instance {
|
|
|
27992
28360
|
* - **Tags**: Yields
|
|
27993
28361
|
*
|
|
27994
28362
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ModerationService#CreateReviewableContentAsync)
|
|
28363
|
+
* @param this
|
|
28364
|
+
* @param config
|
|
27995
28365
|
*/
|
|
27996
28366
|
CreateReviewableContentAsync(this: ModerationService, config: object): string;
|
|
27997
28367
|
/**
|
|
@@ -31955,12 +32325,6 @@ interface Workspace extends WorldRoot {
|
|
|
31955
32325
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#AllowThirdPartySales)
|
|
31956
32326
|
*/
|
|
31957
32327
|
AllowThirdPartySales: boolean;
|
|
31958
|
-
/**
|
|
31959
|
-
* - **ThreadSafety**: ReadSafe
|
|
31960
|
-
*
|
|
31961
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Workspace#AuthorityMode)
|
|
31962
|
-
*/
|
|
31963
|
-
AuthorityMode: Enum.AuthorityMode;
|
|
31964
32328
|
/**
|
|
31965
32329
|
* Specifies the animation throttling mode for the local client.
|
|
31966
32330
|
*
|
|
@@ -32069,7 +32433,7 @@ interface Workspace extends WorldRoot {
|
|
|
32069
32433
|
*/
|
|
32070
32434
|
GetNumAwakeParts(this: Workspace): number;
|
|
32071
32435
|
/**
|
|
32072
|
-
* Returns an integer, between 0 and 100, representing the percentage of real
|
|
32436
|
+
* Returns an integer, between 0 and 100, representing the percentage of real time that physics simulation is currently being throttled to.
|
|
32073
32437
|
*
|
|
32074
32438
|
* - **ThreadSafety**: Safe
|
|
32075
32439
|
*
|
|
@@ -34091,8 +34455,17 @@ interface Player extends Instance {
|
|
|
34091
34455
|
* @param this An object that represents a presently connected client to the experience.
|
|
34092
34456
|
* @param maxFriends The maximum number of online connections to return.
|
|
34093
34457
|
* @returns A dictionary of online connections (see the table above).
|
|
34458
|
+
*
|
|
34459
|
+
* @deprecated GetFriendsOnlineAsync
|
|
34094
34460
|
*/
|
|
34095
34461
|
GetFriendsOnline(this: Player, maxFriends?: number): Array<FriendOnlineInfo>;
|
|
34462
|
+
/**
|
|
34463
|
+
* - **ThreadSafety**: Unsafe
|
|
34464
|
+
* - **Tags**: Yields
|
|
34465
|
+
*
|
|
34466
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetFriendsOnlineAsync)
|
|
34467
|
+
*/
|
|
34468
|
+
GetFriendsOnlineAsync(this: Player, maxFriends?: number): Array<unknown>;
|
|
34096
34469
|
/**
|
|
34097
34470
|
* Returns the player's rank in the group as an integer.
|
|
34098
34471
|
*
|
|
@@ -34103,8 +34476,17 @@ interface Player extends Instance {
|
|
|
34103
34476
|
* @param this An object that represents a presently connected client to the experience.
|
|
34104
34477
|
* @param groupId The `groupId` of the specified group.
|
|
34105
34478
|
* @returns The player's rank in the group.
|
|
34479
|
+
*
|
|
34480
|
+
* @deprecated GetRankInGroupAsync
|
|
34106
34481
|
*/
|
|
34107
34482
|
GetRankInGroup(this: Player, groupId: number): number;
|
|
34483
|
+
/**
|
|
34484
|
+
* - **ThreadSafety**: Unsafe
|
|
34485
|
+
* - **Tags**: Yields
|
|
34486
|
+
*
|
|
34487
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetRankInGroupAsync)
|
|
34488
|
+
*/
|
|
34489
|
+
GetRankInGroupAsync(this: Player, groupId: number): number;
|
|
34108
34490
|
/**
|
|
34109
34491
|
* Returns the player's role in the group as a string, or `Guest` if the player isn't part of the group.
|
|
34110
34492
|
*
|
|
@@ -34115,8 +34497,17 @@ interface Player extends Instance {
|
|
|
34115
34497
|
* @param this An object that represents a presently connected client to the experience.
|
|
34116
34498
|
* @param groupId The group ID of the specified group.
|
|
34117
34499
|
* @returns The player's role in the specified group, or `Guest` if the player is not a member.
|
|
34500
|
+
*
|
|
34501
|
+
* @deprecated GetRoleInGroupAsync
|
|
34118
34502
|
*/
|
|
34119
34503
|
GetRoleInGroup(this: Player, groupId: number): string;
|
|
34504
|
+
/**
|
|
34505
|
+
* - **ThreadSafety**: Unsafe
|
|
34506
|
+
* - **Tags**: Yields
|
|
34507
|
+
*
|
|
34508
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetRoleInGroupAsync)
|
|
34509
|
+
*/
|
|
34510
|
+
GetRoleInGroupAsync(this: Player, groupId: number): string;
|
|
34120
34511
|
/**
|
|
34121
34512
|
* **Deprecated:** This function is obsolete because the Best Friends feature was removed. Use `Player:IsFriendsWith()` instead.
|
|
34122
34513
|
*
|
|
@@ -34142,8 +34533,17 @@ interface Player extends Instance {
|
|
|
34142
34533
|
* @param this An object that represents a presently connected client to the experience.
|
|
34143
34534
|
* @param userId The `Player.UserId` of the specified player.
|
|
34144
34535
|
* @returns A boolean indicating whether a player is a connection of the specified user.
|
|
34536
|
+
*
|
|
34537
|
+
* @deprecated IsFriendsWithAsync
|
|
34145
34538
|
*/
|
|
34146
34539
|
IsFriendsWith(this: Player, userId: number): boolean;
|
|
34540
|
+
/**
|
|
34541
|
+
* - **ThreadSafety**: Unsafe
|
|
34542
|
+
* - **Tags**: Yields
|
|
34543
|
+
*
|
|
34544
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#IsFriendsWithAsync)
|
|
34545
|
+
*/
|
|
34546
|
+
IsFriendsWithAsync(this: Player, userId: number): boolean;
|
|
34147
34547
|
/**
|
|
34148
34548
|
* Checks whether a player is a member of a group with the given ID.
|
|
34149
34549
|
*
|
|
@@ -34154,8 +34554,17 @@ interface Player extends Instance {
|
|
|
34154
34554
|
* @param this An object that represents a presently connected client to the experience.
|
|
34155
34555
|
* @param groupId The group ID of the specified group.
|
|
34156
34556
|
* @returns A boolean indicating whether the player is in the specified group.
|
|
34557
|
+
*
|
|
34558
|
+
* @deprecated IsInGroupAsync
|
|
34157
34559
|
*/
|
|
34158
34560
|
IsInGroup(this: Player, groupId: number): boolean;
|
|
34561
|
+
/**
|
|
34562
|
+
* - **ThreadSafety**: Unsafe
|
|
34563
|
+
* - **Tags**: Yields
|
|
34564
|
+
*
|
|
34565
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#IsInGroupAsync)
|
|
34566
|
+
*/
|
|
34567
|
+
IsInGroupAsync(this: Player, groupId: number): boolean;
|
|
34159
34568
|
/**
|
|
34160
34569
|
* Creates a new character for the player, removing the old one. Also clears the player's `Backpack` and `PlayerGui`.
|
|
34161
34570
|
*
|
|
@@ -34164,8 +34573,17 @@ interface Player extends Instance {
|
|
|
34164
34573
|
*
|
|
34165
34574
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadCharacter)
|
|
34166
34575
|
* @param this An object that represents a presently connected client to the experience.
|
|
34576
|
+
*
|
|
34577
|
+
* @deprecated LoadCharacterAsync
|
|
34167
34578
|
*/
|
|
34168
34579
|
LoadCharacter(this: Player): void;
|
|
34580
|
+
/**
|
|
34581
|
+
* - **ThreadSafety**: Unsafe
|
|
34582
|
+
* - **Tags**: Yields
|
|
34583
|
+
*
|
|
34584
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadCharacterAsync)
|
|
34585
|
+
*/
|
|
34586
|
+
LoadCharacterAsync(this: Player): void;
|
|
34169
34587
|
/**
|
|
34170
34588
|
* Spawns a player character with everything equipped in the passed in `HumanoidDescription`.
|
|
34171
34589
|
*
|
|
@@ -34175,8 +34593,17 @@ interface Player extends Instance {
|
|
|
34175
34593
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadCharacterWithHumanoidDescription)
|
|
34176
34594
|
* @param this An object that represents a presently connected client to the experience.
|
|
34177
34595
|
* @param humanoidDescription A `HumanoidDescription` containing traits like body parts/colors, body scaling, accessories, clothing, and animations that will be equipped to the loaded character.
|
|
34596
|
+
*
|
|
34597
|
+
* @deprecated LoadCharacterWithHumanoidDescriptionAsync
|
|
34178
34598
|
*/
|
|
34179
34599
|
LoadCharacterWithHumanoidDescription(this: Player, humanoidDescription: HumanoidDescription): void;
|
|
34600
|
+
/**
|
|
34601
|
+
* - **ThreadSafety**: Unsafe
|
|
34602
|
+
* - **Tags**: Yields
|
|
34603
|
+
*
|
|
34604
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#LoadCharacterWithHumanoidDescriptionAsync)
|
|
34605
|
+
*/
|
|
34606
|
+
LoadCharacterWithHumanoidDescriptionAsync(this: Player, humanoidDescription: HumanoidDescription): void;
|
|
34180
34607
|
/**
|
|
34181
34608
|
* Requests that the server stream to the player around the specified location.
|
|
34182
34609
|
*
|
|
@@ -34781,8 +35208,17 @@ interface Players extends Instance {
|
|
|
34781
35208
|
* @param rigType Specifies whether the returned character will be R6 or R15.
|
|
34782
35209
|
* @param assetTypeVerification The asset type verification mode.
|
|
34783
35210
|
* @returns A `Humanoid` character `Model`.
|
|
35211
|
+
*
|
|
35212
|
+
* @deprecated CreateHumanoidModelFromDescriptionAsync
|
|
34784
35213
|
*/
|
|
34785
35214
|
CreateHumanoidModelFromDescription(this: Players, description: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): Model;
|
|
35215
|
+
/**
|
|
35216
|
+
* - **ThreadSafety**: Unsafe
|
|
35217
|
+
* - **Tags**: Yields
|
|
35218
|
+
*
|
|
35219
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Players#CreateHumanoidModelFromDescriptionAsync)
|
|
35220
|
+
*/
|
|
35221
|
+
CreateHumanoidModelFromDescriptionAsync(this: Players, description: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): Model;
|
|
34786
35222
|
/**
|
|
34787
35223
|
* Returns a character Model set-up with everything equipped to match the avatar of the user specified by the passed in userId.
|
|
34788
35224
|
*
|
|
@@ -34793,8 +35229,17 @@ interface Players extends Instance {
|
|
|
34793
35229
|
* @param this A service that contains presently connected `Player` objects.
|
|
34794
35230
|
* @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).
|
|
34795
35231
|
* @returns A Humanoid character Model.
|
|
35232
|
+
*
|
|
35233
|
+
* @deprecated CreateHumanoidModelFromUserIdAsync
|
|
34796
35234
|
*/
|
|
34797
35235
|
CreateHumanoidModelFromUserId(this: Players, userId: number): Model;
|
|
35236
|
+
/**
|
|
35237
|
+
* - **ThreadSafety**: Unsafe
|
|
35238
|
+
* - **Tags**: Yields
|
|
35239
|
+
*
|
|
35240
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Players#CreateHumanoidModelFromUserIdAsync)
|
|
35241
|
+
*/
|
|
35242
|
+
CreateHumanoidModelFromUserIdAsync(this: Players, userId: number): Model;
|
|
34798
35243
|
/**
|
|
34799
35244
|
* Retrieves the ban and unban history of any user within the experience's universe. This method is enabled and disabled by the `Players.BanningEnabled` property, which you can toggle in Studio.
|
|
34800
35245
|
*
|
|
@@ -34855,8 +35300,17 @@ interface Players extends Instance {
|
|
|
34855
35300
|
* @param this A service that contains presently connected `Player` objects.
|
|
34856
35301
|
* @param outfitId The ID of the outfit for which the HumanoidDescription is sought.
|
|
34857
35302
|
* @returns HumanoidDescription initialized with the specification for the passed in outfitId.
|
|
35303
|
+
*
|
|
35304
|
+
* @deprecated GetHumanoidDescriptionFromOutfitIdAsync
|
|
34858
35305
|
*/
|
|
34859
35306
|
GetHumanoidDescriptionFromOutfitId(this: Players, outfitId: number): HumanoidDescription;
|
|
35307
|
+
/**
|
|
35308
|
+
* - **ThreadSafety**: Unsafe
|
|
35309
|
+
* - **Tags**: Yields
|
|
35310
|
+
*
|
|
35311
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Players#GetHumanoidDescriptionFromOutfitIdAsync)
|
|
35312
|
+
*/
|
|
35313
|
+
GetHumanoidDescriptionFromOutfitIdAsync(this: Players, outfitId: number): HumanoidDescription;
|
|
34860
35314
|
/**
|
|
34861
35315
|
* Returns a HumanoidDescription which specifies everything equipped for the avatar of the user specified by the passed in userId.
|
|
34862
35316
|
*
|
|
@@ -34867,8 +35321,17 @@ interface Players extends Instance {
|
|
|
34867
35321
|
* @param this A service that contains presently connected `Player` objects.
|
|
34868
35322
|
* @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).
|
|
34869
35323
|
* @returns HumanoidDescription initialized with the passed in user's avatar specification.
|
|
35324
|
+
*
|
|
35325
|
+
* @deprecated GetHumanoidDescriptionFromUserIdAsync
|
|
34870
35326
|
*/
|
|
34871
35327
|
GetHumanoidDescriptionFromUserId(this: Players, userId: number): HumanoidDescription;
|
|
35328
|
+
/**
|
|
35329
|
+
* - **ThreadSafety**: Unsafe
|
|
35330
|
+
* - **Tags**: Yields
|
|
35331
|
+
*
|
|
35332
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Players#GetHumanoidDescriptionFromUserIdAsync)
|
|
35333
|
+
*/
|
|
35334
|
+
GetHumanoidDescriptionFromUserIdAsync(this: Players, userId: number): HumanoidDescription;
|
|
34872
35335
|
/**
|
|
34873
35336
|
* Sends a query to the Roblox website for the username of an account with a given `UserId`.
|
|
34874
35337
|
*
|
|
@@ -35848,10 +36311,10 @@ interface RecommendationService extends Instance {
|
|
|
35848
36311
|
* @param actionType The enum for the type of action.
|
|
35849
36312
|
* @param itemId The item ID returned from registration and `GenerateItemListAsync`.
|
|
35850
36313
|
* @param tracingId The tracing ID returned from the `GenerateItemListAsync` response. Each item has a `TracingId`.
|
|
35851
|
-
* @param actionEventDetails A dictionary containing the following fields: - `Weight` — A number representing the weight of the action.
|
|
35852
|
-
* - `DestinationPlaceId` — The ID of the place the user was sent
|
|
35853
|
-
* - `CommentText` — Any text associated with the action, such as a
|
|
35854
|
-
* - `ReactionType` — A string describing the type of reaction, for
|
|
36314
|
+
* @param actionEventDetails A dictionary containing the following fields: - `Weight` — A number representing the weight of the action. Default is 1.
|
|
36315
|
+
* - `DestinationPlaceId` — The ID of the place the user was sent to after the action. Used for `Play`.
|
|
36316
|
+
* - `CommentText` — Any text associated with the action, such as a comment. Used for `Comment`.
|
|
36317
|
+
* - `ReactionType` — A string describing the type of reaction, for example, "like" or "dislike". Used for `AddReaction` or `RemoveReaction`.
|
|
35855
36318
|
*/
|
|
35856
36319
|
LogActionEvent(this: RecommendationService, actionType: CastsToEnum<Enum.RecommendationActionType>, itemId: string, tracingId: string, actionEventDetails?: object): void;
|
|
35857
36320
|
/**
|
|
@@ -35863,9 +36326,9 @@ interface RecommendationService extends Instance {
|
|
|
35863
36326
|
* @param itemId The item ID returned from registration and `GenerateItemListAsync`.
|
|
35864
36327
|
* @param tracingId The tracing ID returned from the `GenerateItemListAsync` response. Each item has a `TracingId`.
|
|
35865
36328
|
* @param impressionEventDetails A dictionary containing the following fields: - `Duration` — The duration of the impression in seconds.
|
|
35866
|
-
* - `Weight` — A number representing the weight of the impression.
|
|
35867
|
-
* - `ItemPosition` — The position of the item in the
|
|
35868
|
-
* - `DepartureIntent` — The `RecommendationDepartureIntent`
|
|
36329
|
+
* - `Weight` — A number representing the weight of the impression. Default is 1.
|
|
36330
|
+
* - `ItemPosition` — The position of the item in the recommendation list.
|
|
36331
|
+
* - `DepartureIntent` — The `RecommendationDepartureIntent` indicating the user's intent when leaving a view. For example, `Positive` if the view is considered good.
|
|
35869
36332
|
*/
|
|
35870
36333
|
LogImpressionEvent(this: RecommendationService, impressionType: CastsToEnum<Enum.RecommendationImpressionType>, itemId: string, tracingId: string, impressionEventDetails?: object): void;
|
|
35871
36334
|
/**
|
|
@@ -35874,11 +36337,11 @@ interface RecommendationService extends Instance {
|
|
|
35874
36337
|
*
|
|
35875
36338
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#GenerateItemListAsync)
|
|
35876
36339
|
* @param this A service that provides an interface for you to manage and display personalized content recommendations.
|
|
35877
|
-
* @param generateRecommendationItemListRequest A dictionary containing the following
|
|
35878
|
-
* - `LocationId` — A developer-defined string that specifies the
|
|
36340
|
+
* @param generateRecommendationItemListRequest A dictionary containing the following fields: - `ConfigName` — A unique ID for the specific configuration. This determines how the candidates are ranked.
|
|
36341
|
+
* - `LocationId` — A developer-defined string that specifies the location where the recommendation is used, such as `"For_you"` or `"Lobby"`. This parameter will not affect the items returned, and it can help you track the performance of multiple recommendation features within your experience. Recommendation metrics for each individual location will be displayed in the Creator Hub. `LocationId` **must** be a string and cannot be `"Other"` or `"other"` as these values are reserved by the Creator Hub.
|
|
35879
36342
|
* - `PageSize` — The number of items returned for each page.
|
|
35880
|
-
* - `BoostCustomTags` — A list of string tags. Any item with this
|
|
35881
|
-
* - `CustomContexts` — A table of key-value pairs used to pass in
|
|
36343
|
+
* - `BoostCustomTags` — A list of string tags. Any item with this tag will be boosted in ranking. Note: only supports boosting one tag now.
|
|
36344
|
+
* - `CustomContexts` — A table of key-value pairs used to pass in additional context data for ranking. For example, `UserId` for a Server script.
|
|
35882
36345
|
*/
|
|
35883
36346
|
GenerateItemListAsync(this: RecommendationService, generateRecommendationItemListRequest: object): RecommendationPages;
|
|
35884
36347
|
/**
|
|
@@ -35888,7 +36351,13 @@ interface RecommendationService extends Instance {
|
|
|
35888
36351
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#GetRecommendationItemAsync)
|
|
35889
36352
|
* @param this A service that provides an interface for you to manage and display personalized content recommendations.
|
|
35890
36353
|
* @param itemId The ID of the item to retrieve.
|
|
35891
|
-
* @returns A dictionary representing the recommendation item with the following fields: - `ItemId` — The unique ID for the item.
|
|
36354
|
+
* @returns A dictionary representing the recommendation item with the following fields: - `ItemId` — The unique ID for the item.
|
|
36355
|
+
* - `ReferenceId` — The developer-provided ID for the item.
|
|
36356
|
+
* - `TracingId` — An ID for tracking recommendation sessions. This will be empty when fetching a single item directly.
|
|
36357
|
+
* - `Creator` — A table containing the `CreatorId` and `CreatorType`.
|
|
36358
|
+
* - `Attributes` — A list of content attributes associated with the item.
|
|
36359
|
+
* - `CustomTags` — A list of custom string tags.
|
|
36360
|
+
* - `Visibility` — An enum of type `RecommendationItemVisibility`.
|
|
35892
36361
|
*/
|
|
35893
36362
|
GetRecommendationItemAsync(this: RecommendationService, itemId: string): object;
|
|
35894
36363
|
/**
|
|
@@ -35898,12 +36367,12 @@ interface RecommendationService extends Instance {
|
|
|
35898
36367
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#RegisterItemAsync)
|
|
35899
36368
|
* @param this A service that provides an interface for you to manage and display personalized content recommendations.
|
|
35900
36369
|
* @param player The player who created the item.
|
|
35901
|
-
* @param registerRecommendationItemsRequest A dictionary containing the following fields: - `ContentType` — The `RecommendationItemContentType`
|
|
35902
|
-
* - `ReferenceId` — The developer-defined string that uniquely
|
|
36370
|
+
* @param registerRecommendationItemsRequest A dictionary containing the following fields: - `ContentType` — The `RecommendationItemContentType` specifying the type of content. Type is defined in a generic way. For example, you can use `Static` for images, `Dynamic` for videos, and `Interactive` for 3D models that support interaction.
|
|
36371
|
+
* - `ReferenceId` — The developer-defined string that uniquely identifies the item.
|
|
35903
36372
|
* - `Duration` — The duration of the content in seconds.
|
|
35904
|
-
* - `Attributes` — The table of attributes for the item, such as
|
|
35905
|
-
* - `CustomTags` — The list of string tags for filtering and
|
|
35906
|
-
* - `Visibility` — The
|
|
36373
|
+
* - `Attributes` — The table of attributes for the item, such as `AssetId` or `Description`.
|
|
36374
|
+
* - `CustomTags` — The list of string tags for filtering and boosting.
|
|
36375
|
+
* - `Visibility` — The `RecommendationItemVisibility` enum that controls the item's visibility, such as `Public` or `Private`.
|
|
35907
36376
|
*
|
|
35908
36377
|
*
|
|
35909
36378
|
* @returns A table with only two fields: `ItemId` and `ReferenceId`.
|
|
@@ -35925,8 +36394,8 @@ interface RecommendationService extends Instance {
|
|
|
35925
36394
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RecommendationService#UpdateItemAsync)
|
|
35926
36395
|
* @param this A service that provides an interface for you to manage and display personalized content recommendations.
|
|
35927
36396
|
* @param updateRecommendationItemRequest A dictionary containing the following fields: - `ItemId` — The ID of the item to update.
|
|
35928
|
-
* - `ReferenceId` — The new developer-defined string to identify
|
|
35929
|
-
* - `Creator` — The new creator for the item. Creator is a table
|
|
36397
|
+
* - `ReferenceId` — The new developer-defined string to identify the item.
|
|
36398
|
+
* - `Creator` — The new creator for the item. Creator is a table containing two fields: `CreatorId: number` and `CreatorType: Enum.CreatorType`.
|
|
35930
36399
|
* - `Duration` — The new duration for the content in seconds.
|
|
35931
36400
|
* - `Visibility` — The new visibility setting for the item.
|
|
35932
36401
|
* - `Attributes` — The new table of attributes for the item.
|
|
@@ -35949,32 +36418,41 @@ interface ReflectionService extends Instance {
|
|
|
35949
36418
|
*/
|
|
35950
36419
|
readonly _nominal_ReflectionService: unique symbol;
|
|
35951
36420
|
/**
|
|
36421
|
+
* Returns information about a class when given its name, assuming that class is accessible.
|
|
36422
|
+
*
|
|
35952
36423
|
* - **ThreadSafety**: Unsafe
|
|
35953
36424
|
* - **Tags**: CustomLuaState
|
|
35954
36425
|
*
|
|
35955
36426
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ReflectionService#GetClass)
|
|
35956
36427
|
* @param this
|
|
35957
|
-
* @param className
|
|
35958
|
-
* @param filter
|
|
36428
|
+
* @param className The name of the class for which you wish to retrieve information.
|
|
36429
|
+
* @param filter An optional filter to restrict or expand the set of classes that this method can return and change the method's behavior.
|
|
36430
|
+
* @returns A `ReflectedClass` dictionary with reflection information if the class exists; otherwise, `nil`.
|
|
35959
36431
|
*/
|
|
35960
36432
|
GetClass(this: ReflectionService, className: string, filter?: object): object | undefined;
|
|
35961
36433
|
/**
|
|
36434
|
+
* Returns a list of all classes accessible with filters applied.
|
|
36435
|
+
*
|
|
35962
36436
|
* - **ThreadSafety**: Unsafe
|
|
35963
36437
|
* - **Tags**: CustomLuaState
|
|
35964
36438
|
*
|
|
35965
36439
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ReflectionService#GetClasses)
|
|
35966
36440
|
* @param this
|
|
35967
|
-
* @param filter
|
|
36441
|
+
* @param filter An optional filter to restrict or expand the set of classes that this method can return and change the method's behavior.
|
|
36442
|
+
* @returns A list of `ReflectedClass` dictionaries with reflection information for each class that matches the filter criteria.
|
|
35968
36443
|
*/
|
|
35969
36444
|
GetClasses(this: ReflectionService, filter?: object): Array<unknown>;
|
|
35970
36445
|
/**
|
|
36446
|
+
* Returns a list of properties for a given class with filters applied.
|
|
36447
|
+
*
|
|
35971
36448
|
* - **ThreadSafety**: Unsafe
|
|
35972
36449
|
* - **Tags**: CustomLuaState
|
|
35973
36450
|
*
|
|
35974
36451
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ReflectionService#GetPropertiesOfClass)
|
|
35975
36452
|
* @param this
|
|
35976
|
-
* @param className
|
|
35977
|
-
* @param filter
|
|
36453
|
+
* @param className The name of the class for which you wish to retrieve properties.
|
|
36454
|
+
* @param filter An optional filter to restrict or expand the set of properties that this method can return and change the method's behavior.
|
|
36455
|
+
* @returns A list of `ReflectedProperty` dictionaries with reflection information for each property of the class that matches the filter criteria.
|
|
35978
36456
|
*/
|
|
35979
36457
|
GetPropertiesOfClass(this: ReflectionService, className: string, filter?: object): Array<unknown>;
|
|
35980
36458
|
}
|
|
@@ -37744,6 +38222,12 @@ interface Sky extends Instance {
|
|
|
37744
38222
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sky#MoonAngularSize)
|
|
37745
38223
|
*/
|
|
37746
38224
|
MoonAngularSize: number;
|
|
38225
|
+
/**
|
|
38226
|
+
* - **ThreadSafety**: ReadSafe
|
|
38227
|
+
*
|
|
38228
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sky#MoonTextureContent)
|
|
38229
|
+
*/
|
|
38230
|
+
MoonTextureContent: Content;
|
|
37747
38231
|
/**
|
|
37748
38232
|
* The texture of the moon while using this skybox.
|
|
37749
38233
|
*
|
|
@@ -37752,6 +38236,12 @@ interface Sky extends Instance {
|
|
|
37752
38236
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sky#MoonTextureId)
|
|
37753
38237
|
*/
|
|
37754
38238
|
MoonTextureId: ContentId;
|
|
38239
|
+
/**
|
|
38240
|
+
* - **ThreadSafety**: ReadSafe
|
|
38241
|
+
*
|
|
38242
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sky#SkyboxBackContent)
|
|
38243
|
+
*/
|
|
38244
|
+
SkyboxBackContent: Content;
|
|
37755
38245
|
/**
|
|
37756
38246
|
* The URL link to a picture for the back surface of the sky.
|
|
37757
38247
|
*
|
|
@@ -37768,6 +38258,18 @@ interface Sky extends Instance {
|
|
|
37768
38258
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sky#SkyboxDn)
|
|
37769
38259
|
*/
|
|
37770
38260
|
SkyboxDn: ContentId;
|
|
38261
|
+
/**
|
|
38262
|
+
* - **ThreadSafety**: ReadSafe
|
|
38263
|
+
*
|
|
38264
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sky#SkyboxDownContent)
|
|
38265
|
+
*/
|
|
38266
|
+
SkyboxDownContent: Content;
|
|
38267
|
+
/**
|
|
38268
|
+
* - **ThreadSafety**: ReadSafe
|
|
38269
|
+
*
|
|
38270
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sky#SkyboxFrontContent)
|
|
38271
|
+
*/
|
|
38272
|
+
SkyboxFrontContent: Content;
|
|
37771
38273
|
/**
|
|
37772
38274
|
* Asset ID for the front surface of the skybox.
|
|
37773
38275
|
*
|
|
@@ -37776,6 +38278,12 @@ interface Sky extends Instance {
|
|
|
37776
38278
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sky#SkyboxFt)
|
|
37777
38279
|
*/
|
|
37778
38280
|
SkyboxFt: ContentId;
|
|
38281
|
+
/**
|
|
38282
|
+
* - **ThreadSafety**: ReadSafe
|
|
38283
|
+
*
|
|
38284
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sky#SkyboxLeftContent)
|
|
38285
|
+
*/
|
|
38286
|
+
SkyboxLeftContent: Content;
|
|
37779
38287
|
/**
|
|
37780
38288
|
* Asset ID for the left surface of the skybox.
|
|
37781
38289
|
*
|
|
@@ -37792,6 +38300,12 @@ interface Sky extends Instance {
|
|
|
37792
38300
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sky#SkyboxOrientation)
|
|
37793
38301
|
*/
|
|
37794
38302
|
SkyboxOrientation: Vector3;
|
|
38303
|
+
/**
|
|
38304
|
+
* - **ThreadSafety**: ReadSafe
|
|
38305
|
+
*
|
|
38306
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sky#SkyboxRightContent)
|
|
38307
|
+
*/
|
|
38308
|
+
SkyboxRightContent: Content;
|
|
37795
38309
|
/**
|
|
37796
38310
|
* Asset ID for the right surface of the skybox.
|
|
37797
38311
|
*
|
|
@@ -37808,6 +38322,12 @@ interface Sky extends Instance {
|
|
|
37808
38322
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sky#SkyboxUp)
|
|
37809
38323
|
*/
|
|
37810
38324
|
SkyboxUp: ContentId;
|
|
38325
|
+
/**
|
|
38326
|
+
* - **ThreadSafety**: ReadSafe
|
|
38327
|
+
*
|
|
38328
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sky#SkyboxUpContent)
|
|
38329
|
+
*/
|
|
38330
|
+
SkyboxUpContent: Content;
|
|
37811
38331
|
/**
|
|
37812
38332
|
* How many stars are shown in the skybox.
|
|
37813
38333
|
*
|
|
@@ -37824,6 +38344,12 @@ interface Sky extends Instance {
|
|
|
37824
38344
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sky#SunAngularSize)
|
|
37825
38345
|
*/
|
|
37826
38346
|
SunAngularSize: number;
|
|
38347
|
+
/**
|
|
38348
|
+
* - **ThreadSafety**: ReadSafe
|
|
38349
|
+
*
|
|
38350
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Sky#SunTextureContent)
|
|
38351
|
+
*/
|
|
38352
|
+
SunTextureContent: Content;
|
|
37827
38353
|
/**
|
|
37828
38354
|
* The texture of the sun while using this skybox.
|
|
37829
38355
|
*
|
|
@@ -37833,6 +38359,51 @@ interface Sky extends Instance {
|
|
|
37833
38359
|
*/
|
|
37834
38360
|
SunTextureId: ContentId;
|
|
37835
38361
|
}
|
|
38362
|
+
/**
|
|
38363
|
+
* - **Tags**: NotCreatable
|
|
38364
|
+
*
|
|
38365
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SlimAnimationDataEntity)
|
|
38366
|
+
*/
|
|
38367
|
+
interface SlimAnimationDataEntity extends Instance {
|
|
38368
|
+
/**
|
|
38369
|
+
* **DO NOT USE!**
|
|
38370
|
+
*
|
|
38371
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
38372
|
+
* @hidden
|
|
38373
|
+
* @deprecated
|
|
38374
|
+
*/
|
|
38375
|
+
readonly _nominal_SlimAnimationDataEntity: unique symbol;
|
|
38376
|
+
}
|
|
38377
|
+
/**
|
|
38378
|
+
* - **Tags**: NotCreatable, Service
|
|
38379
|
+
*
|
|
38380
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SlimAnimationReplicationService)
|
|
38381
|
+
*/
|
|
38382
|
+
interface SlimAnimationReplicationService extends Instance {
|
|
38383
|
+
/**
|
|
38384
|
+
* **DO NOT USE!**
|
|
38385
|
+
*
|
|
38386
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
38387
|
+
* @hidden
|
|
38388
|
+
* @deprecated
|
|
38389
|
+
*/
|
|
38390
|
+
readonly _nominal_SlimAnimationReplicationService: unique symbol;
|
|
38391
|
+
}
|
|
38392
|
+
/**
|
|
38393
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
38394
|
+
*
|
|
38395
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SlimReplicationService)
|
|
38396
|
+
*/
|
|
38397
|
+
interface SlimReplicationService extends Instance {
|
|
38398
|
+
/**
|
|
38399
|
+
* **DO NOT USE!**
|
|
38400
|
+
*
|
|
38401
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
38402
|
+
* @hidden
|
|
38403
|
+
* @deprecated
|
|
38404
|
+
*/
|
|
38405
|
+
readonly _nominal_SlimReplicationService: unique symbol;
|
|
38406
|
+
}
|
|
37836
38407
|
/**
|
|
37837
38408
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
37838
38409
|
*
|
|
@@ -38117,8 +38688,17 @@ interface SocialService extends Instance {
|
|
|
38117
38688
|
*
|
|
38118
38689
|
*
|
|
38119
38690
|
* @returns A tuple containing an `PromptLinkSharingResult` indicating the result of the link sharing prompt.
|
|
38691
|
+
*
|
|
38692
|
+
* @deprecated PromptLinkSharingAsync
|
|
38120
38693
|
*/
|
|
38121
38694
|
PromptLinkSharing(this: SocialService, player: Player, options?: object): unknown;
|
|
38695
|
+
/**
|
|
38696
|
+
* - **ThreadSafety**: Unsafe
|
|
38697
|
+
* - **Tags**: Yields
|
|
38698
|
+
*
|
|
38699
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SocialService#PromptLinkSharingAsync)
|
|
38700
|
+
*/
|
|
38701
|
+
PromptLinkSharingAsync(this: SocialService, player: Player, options?: object): unknown;
|
|
38122
38702
|
/**
|
|
38123
38703
|
* Prompts the local `Player` with a prompt to change their RSVP status to the given event.
|
|
38124
38704
|
*
|
|
@@ -40872,10 +41452,16 @@ interface TeleportService extends Instance {
|
|
|
40872
41452
|
string
|
|
40873
41453
|
]>;
|
|
40874
41454
|
/**
|
|
41455
|
+
* Prompts a `Player` with information about the specified experience. The player can choose to teleport to the target experience through the prompt.
|
|
41456
|
+
*
|
|
40875
41457
|
* - **ThreadSafety**: Unsafe
|
|
40876
41458
|
* - **Tags**: Yields
|
|
40877
41459
|
*
|
|
40878
41460
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TeleportService#PromptExperienceDetailsAsync)
|
|
41461
|
+
* @param this Enables transporting `Players` between places and servers.
|
|
41462
|
+
* @param player The `Player` to be presented the prompt.
|
|
41463
|
+
* @param universeId `DataModel.UniverseId` of the experience to be presented to the `Player`
|
|
41464
|
+
* @returns `PromptExperienceDetailsResult`
|
|
40879
41465
|
*/
|
|
40880
41466
|
PromptExperienceDetailsAsync(this: TeleportService, player: Player, universeId: number): Enum.PromptExperienceDetailsResult;
|
|
40881
41467
|
/**
|
|
@@ -40888,11 +41474,20 @@ interface TeleportService extends Instance {
|
|
|
40888
41474
|
* @param this Enables transporting `Players` between places and servers.
|
|
40889
41475
|
* @param placeId The `DataModel.PlaceId` of the place the reserved server is being created for.
|
|
40890
41476
|
* @returns The server access code required by `TeleportService:TeleportToPrivateServer()` and the `DataModel.PrivateServerId` for the reserved server.
|
|
41477
|
+
*
|
|
41478
|
+
* @deprecated ReserveServerAsync
|
|
40891
41479
|
*/
|
|
40892
41480
|
ReserveServer(this: TeleportService, placeId: number): LuaTuple<[
|
|
40893
41481
|
string,
|
|
40894
41482
|
string
|
|
40895
41483
|
]>;
|
|
41484
|
+
/**
|
|
41485
|
+
* - **ThreadSafety**: Unsafe
|
|
41486
|
+
* - **Tags**: Yields
|
|
41487
|
+
*
|
|
41488
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TeleportService#ReserveServerAsync)
|
|
41489
|
+
*/
|
|
41490
|
+
ReserveServerAsync(this: TeleportService, placeId: number): unknown;
|
|
40896
41491
|
/**
|
|
40897
41492
|
* The all-encompassing method to teleport a player or group of players from one server to another.
|
|
40898
41493
|
*
|
|
@@ -42632,7 +43227,7 @@ interface TextGenerator extends Instance {
|
|
|
42632
43227
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TextGenerator#GenerateTextAsync)
|
|
42633
43228
|
* @param this Gives access to a large language model for text generation.
|
|
42634
43229
|
* @param request A dictionary containing optional parameters for the text generation request. The currently supported parameters are `UserPrompt`, `ContextToken`, and `MaxTokens`.
|
|
42635
|
-
* @returns A dictionary containing the
|
|
43230
|
+
* @returns A dictionary containing the generated response.
|
|
42636
43231
|
*/
|
|
42637
43232
|
GenerateTextAsync(this: TextGenerator, request: object): object;
|
|
42638
43233
|
}
|
|
@@ -45579,7 +46174,7 @@ interface VRStatusService extends Instance {
|
|
|
45579
46174
|
readonly _nominal_VRStatusService: unique symbol;
|
|
45580
46175
|
}
|
|
45581
46176
|
/**
|
|
45582
|
-
* Base class of all
|
|
46177
|
+
* Base class of all "value instance" objects.
|
|
45583
46178
|
*
|
|
45584
46179
|
* - **Tags**: NotCreatable
|
|
45585
46180
|
*
|
|
@@ -45620,7 +46215,7 @@ interface BoolValue extends ValueBase {
|
|
|
45620
46215
|
*/
|
|
45621
46216
|
Value: boolean;
|
|
45622
46217
|
/**
|
|
45623
|
-
*
|
|
46218
|
+
* Fires whenever the `BoolValue.Value` is changed.
|
|
45624
46219
|
*
|
|
45625
46220
|
* - **ThreadSafety**: Unsafe
|
|
45626
46221
|
*
|
|
@@ -45899,7 +46494,7 @@ interface NumberValue extends ValueBase {
|
|
|
45899
46494
|
*/
|
|
45900
46495
|
Value: number;
|
|
45901
46496
|
/**
|
|
45902
|
-
*
|
|
46497
|
+
* Fires whenever the `NumberValue.Value` is changed.
|
|
45903
46498
|
*
|
|
45904
46499
|
* - **ThreadSafety**: Unsafe
|
|
45905
46500
|
*
|
|
@@ -45930,7 +46525,7 @@ interface ObjectValue extends ValueBase {
|
|
|
45930
46525
|
*/
|
|
45931
46526
|
Value: Instance | undefined;
|
|
45932
46527
|
/**
|
|
45933
|
-
*
|
|
46528
|
+
* Fires whenever the `ObjectValue.Value` is changed.
|
|
45934
46529
|
*
|
|
45935
46530
|
* - **ThreadSafety**: Unsafe
|
|
45936
46531
|
*
|
|
@@ -45992,7 +46587,7 @@ interface StringValue extends ValueBase {
|
|
|
45992
46587
|
*/
|
|
45993
46588
|
Value: string;
|
|
45994
46589
|
/**
|
|
45995
|
-
*
|
|
46590
|
+
* Fires whenever `StringValue.Value` is changed.
|
|
45996
46591
|
*
|
|
45997
46592
|
* - **ThreadSafety**: Unsafe
|
|
45998
46593
|
*
|