@rbxts/types 1.0.916 → 1.0.918
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 +219 -45
- package/include/generated/PluginSecurity.d.ts +145 -19
- package/include/generated/enums.d.ts +135 -66
- package/package.json +1 -1
|
@@ -39,6 +39,7 @@ interface Services {
|
|
|
39
39
|
ChangeHistoryStreamingService: ChangeHistoryStreamingService;
|
|
40
40
|
Chat: Chat;
|
|
41
41
|
CloudCRUDService: CloudCRUDService;
|
|
42
|
+
CloudExecutionService: CloudExecutionService;
|
|
42
43
|
CollaboratorsService: CollaboratorsService;
|
|
43
44
|
CollectionService: CollectionService;
|
|
44
45
|
CommerceService: CommerceService;
|
|
@@ -171,6 +172,7 @@ interface Services {
|
|
|
171
172
|
RunService: RunService;
|
|
172
173
|
RuntimeContentService: RuntimeContentService;
|
|
173
174
|
SafetyService: SafetyService;
|
|
175
|
+
SceneAnalysisService: SceneAnalysisService;
|
|
174
176
|
ScriptChangeService: ScriptChangeService;
|
|
175
177
|
ScriptCloneWatcher: ScriptCloneWatcher;
|
|
176
178
|
ScriptCloneWatcherHelper: ScriptCloneWatcherHelper;
|
|
@@ -624,7 +626,6 @@ interface Instances extends Services, CreatableInstances {
|
|
|
624
626
|
DebuggerLuaResponse: DebuggerLuaResponse;
|
|
625
627
|
DebuggerVariable: DebuggerVariable;
|
|
626
628
|
DynamicRotate: DynamicRotate;
|
|
627
|
-
EmotesPages: EmotesPages;
|
|
628
629
|
ExplorerFilterAutocompleter: ExplorerFilterAutocompleter;
|
|
629
630
|
FaceInstance: FaceInstance;
|
|
630
631
|
FacialAnimationStreamingServiceStats: FacialAnimationStreamingServiceStats;
|
|
@@ -1051,8 +1052,9 @@ interface EditableImage extends RBXObject {
|
|
|
1051
1052
|
* @param color Color of the circle.
|
|
1052
1053
|
* @param transparency Transparency of the circle with 0 being fully opaque and 1 being fully transparent.
|
|
1053
1054
|
* @param combineType How the pixels of the source image are blended with the pixels of the added image.
|
|
1055
|
+
* @param antiAliasing Determines whether anti-aliasing is applied to the circle. When set to `AntiAliasing.Enabled`, circle edges are soft. When set to `AntiAliasing.Disabled`, circle edges are hard.
|
|
1054
1056
|
*/
|
|
1055
|
-
DrawCircle(this: EditableImage, center: Vector2, radius: number, color: Color3, transparency: number, combineType: CastsToEnum<Enum.ImageCombineType>): void;
|
|
1057
|
+
DrawCircle(this: EditableImage, center: Vector2, radius: number, color: Color3, transparency: number, combineType: CastsToEnum<Enum.ImageCombineType>, antiAliasing?: CastsToEnum<Enum.AntiAliasing>): void;
|
|
1056
1058
|
/**
|
|
1057
1059
|
* Draws another `EditableImage` into this `EditableImage` at the given position.
|
|
1058
1060
|
*
|
|
@@ -1114,8 +1116,9 @@ interface EditableImage extends RBXObject {
|
|
|
1114
1116
|
* @param color Color of the line.
|
|
1115
1117
|
* @param transparency Transparency of the line.
|
|
1116
1118
|
* @param combineType How the pixels of the source image are blended with the pixels of the added image.
|
|
1119
|
+
* @param antiAliasing Determines whether anti-aliasing is applied to the line. When set to `AntiAliasing.Enabled`, line edges are soft. When set to `AntiAliasing.Disabled`, line edges are hard.
|
|
1117
1120
|
*/
|
|
1118
|
-
DrawLine(this: EditableImage, p1: Vector2, p2: Vector2, color: Color3, transparency: number, combineType: CastsToEnum<Enum.ImageCombineType>): void;
|
|
1121
|
+
DrawLine(this: EditableImage, p1: Vector2, p2: Vector2, color: Color3, transparency: number, combineType: CastsToEnum<Enum.ImageCombineType>, antiAliasing?: CastsToEnum<Enum.AntiAliasing>): void;
|
|
1119
1122
|
/**
|
|
1120
1123
|
* Draws a rectangle of the given size at the given top-left position.
|
|
1121
1124
|
*
|
|
@@ -2931,6 +2934,9 @@ interface AdService extends Instance {
|
|
|
2931
2934
|
* - **ThreadSafety**: Unsafe
|
|
2932
2935
|
*
|
|
2933
2936
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#RegisterDisclosureButton)
|
|
2937
|
+
* @param this A class that allows the display of mobile video ads.
|
|
2938
|
+
* @param disclosureButton The `GuiButton` you want to mark as an ad disclosure.
|
|
2939
|
+
* @param adIntegrationPlacementId The id of the placement that this disclosure is attached to.
|
|
2934
2940
|
*/
|
|
2935
2941
|
RegisterDisclosureButton(this: AdService, disclosureButton: GuiButton, adIntegrationPlacementId: string): void;
|
|
2936
2942
|
/**
|
|
@@ -2972,6 +2978,10 @@ interface AdService extends Instance {
|
|
|
2972
2978
|
* - **Tags**: Yields
|
|
2973
2979
|
*
|
|
2974
2980
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#GetCampaignEligibilityAsync)
|
|
2981
|
+
* @param this A class that allows the display of mobile video ads.
|
|
2982
|
+
* @param campaignId The id of the campaign that you want to check a `Player`'s eligibility for.
|
|
2983
|
+
* @param player The `Player` you want to check eligibility for. If omitted, it will default to `LocalPlayer`.
|
|
2984
|
+
* @returns A dictionary that looks like `{ IsEligible: boolean }`.
|
|
2975
2985
|
*/
|
|
2976
2986
|
GetCampaignEligibilityAsync(this: AdService, campaignId: string, player?: Player): object;
|
|
2977
2987
|
/**
|
|
@@ -3308,6 +3318,15 @@ interface AnimationClip extends Instance {
|
|
|
3308
3318
|
* @deprecated
|
|
3309
3319
|
*/
|
|
3310
3320
|
readonly _nominal_AnimationClip: unique symbol;
|
|
3321
|
+
/**
|
|
3322
|
+
* Returns the length (in seconds) of this `AnimationClip`. This will return `0` until the animation has fully loaded and thus may not be immediately available.
|
|
3323
|
+
*
|
|
3324
|
+
* - **ThreadSafety**: ReadSafe
|
|
3325
|
+
* - **Tags**: NotReplicated
|
|
3326
|
+
*
|
|
3327
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AnimationClip#Length)
|
|
3328
|
+
*/
|
|
3329
|
+
readonly Length: number;
|
|
3311
3330
|
/**
|
|
3312
3331
|
* Determines whether the animation stored in this `AnimationClip` is intended to loop.
|
|
3313
3332
|
*
|
|
@@ -3970,6 +3989,12 @@ interface Animator extends Instance {
|
|
|
3970
3989
|
* @param this Responsible for the playback and replication of `Animations`.
|
|
3971
3990
|
*/
|
|
3972
3991
|
GetPlayingAnimationTracks(this: Animator): Array<AnimationTrack>;
|
|
3992
|
+
/**
|
|
3993
|
+
* - **ThreadSafety**: Unsafe
|
|
3994
|
+
*
|
|
3995
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Animator#GetTrackByAnimationId)
|
|
3996
|
+
*/
|
|
3997
|
+
GetTrackByAnimationId(this: Animator, animationId: ContentId): AnimationTrack;
|
|
3973
3998
|
/**
|
|
3974
3999
|
* Loads an `Animation` onto an `Animator`, returning an `AnimationTrack`.
|
|
3975
4000
|
*
|
|
@@ -9379,6 +9404,12 @@ interface RootImportData extends BaseImportData {
|
|
|
9379
9404
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RootImportData#ValidateUgcBody)
|
|
9380
9405
|
*/
|
|
9381
9406
|
ValidateUgcBody: boolean;
|
|
9407
|
+
/**
|
|
9408
|
+
* - **ThreadSafety**: ReadSafe
|
|
9409
|
+
*
|
|
9410
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/RootImportData#VersionedAssetId)
|
|
9411
|
+
*/
|
|
9412
|
+
VersionedAssetId: number;
|
|
9382
9413
|
/**
|
|
9383
9414
|
* - **ThreadSafety**: ReadSafe
|
|
9384
9415
|
*
|
|
@@ -11892,6 +11923,21 @@ interface CloudCRUDService extends Instance {
|
|
|
11892
11923
|
*/
|
|
11893
11924
|
readonly _nominal_CloudCRUDService: unique symbol;
|
|
11894
11925
|
}
|
|
11926
|
+
/**
|
|
11927
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
11928
|
+
*
|
|
11929
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/CloudExecutionService)
|
|
11930
|
+
*/
|
|
11931
|
+
interface CloudExecutionService extends Instance {
|
|
11932
|
+
/**
|
|
11933
|
+
* **DO NOT USE!**
|
|
11934
|
+
*
|
|
11935
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
11936
|
+
* @hidden
|
|
11937
|
+
* @deprecated
|
|
11938
|
+
*/
|
|
11939
|
+
readonly _nominal_CloudExecutionService: unique symbol;
|
|
11940
|
+
}
|
|
11895
11941
|
/**
|
|
11896
11942
|
* Renders realistic clouds that drift slowly across the sky.
|
|
11897
11943
|
*
|
|
@@ -15645,8 +15691,6 @@ interface DataStoreSetOptions extends Instance {
|
|
|
15645
15691
|
/**
|
|
15646
15692
|
* Allows scheduling the guaranteed destruction of an object without yielding.
|
|
15647
15693
|
*
|
|
15648
|
-
* .
|
|
15649
|
-
*
|
|
15650
15694
|
* - **Tags**: NotCreatable, Service
|
|
15651
15695
|
*
|
|
15652
15696
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Debris)
|
|
@@ -15667,8 +15711,6 @@ interface Debris extends Instance {
|
|
|
15667
15711
|
*
|
|
15668
15712
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Debris#AddItem)
|
|
15669
15713
|
* @param this Allows scheduling the guaranteed destruction of an object without yielding.
|
|
15670
|
-
*
|
|
15671
|
-
* .
|
|
15672
15714
|
* @param item The `Instance` to add to `Debris`.
|
|
15673
15715
|
* @param lifetime Number of seconds before the `Instance` should be destroyed.
|
|
15674
15716
|
*/
|
|
@@ -16678,7 +16720,7 @@ interface ExperienceInviteOptions extends Instance {
|
|
|
16678
16720
|
*/
|
|
16679
16721
|
InviteMessageId: string;
|
|
16680
16722
|
/**
|
|
16681
|
-
* Roblox `UserId` of the specific
|
|
16723
|
+
* Roblox `UserId` of the specific friend to invite.
|
|
16682
16724
|
*
|
|
16683
16725
|
* - **ThreadSafety**: ReadSafe
|
|
16684
16726
|
*
|
|
@@ -16686,7 +16728,7 @@ interface ExperienceInviteOptions extends Instance {
|
|
|
16686
16728
|
*/
|
|
16687
16729
|
InviteUser: number;
|
|
16688
16730
|
/**
|
|
16689
|
-
* Used to set a parameter in `Player:GetJoinData()` when a
|
|
16731
|
+
* Used to set a parameter in `Player:GetJoinData()` when a friend joins from the invite notification.
|
|
16690
16732
|
*
|
|
16691
16733
|
* - **ThreadSafety**: ReadSafe
|
|
16692
16734
|
*
|
|
@@ -17562,6 +17604,8 @@ interface Folder extends Instance {
|
|
|
17562
17604
|
readonly _nominal_Folder: unique symbol;
|
|
17563
17605
|
}
|
|
17564
17606
|
/**
|
|
17607
|
+
* A container that stores `ProceduralModel` generation results.
|
|
17608
|
+
*
|
|
17565
17609
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GeneratedFolder)
|
|
17566
17610
|
*/
|
|
17567
17611
|
interface GeneratedFolder extends Folder {
|
|
@@ -17574,10 +17618,12 @@ interface GeneratedFolder extends Folder {
|
|
|
17574
17618
|
*/
|
|
17575
17619
|
readonly _nominal_GeneratedFolder: unique symbol;
|
|
17576
17620
|
/**
|
|
17621
|
+
* Specifies which part within the `GeneratedFolder` should be set as the `PrimaryPart` of the `ProceduralModel`.
|
|
17622
|
+
*
|
|
17577
17623
|
* - **ThreadSafety**: Unsafe
|
|
17578
17624
|
*
|
|
17579
17625
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GeneratedFolder#SetPrimaryPart)
|
|
17580
|
-
* @param this
|
|
17626
|
+
* @param this A container that stores `ProceduralModel` generation results.
|
|
17581
17627
|
* @param part
|
|
17582
17628
|
*/
|
|
17583
17629
|
SetPrimaryPart(this: GeneratedFolder, part: BasePart): void;
|
|
@@ -23421,7 +23467,7 @@ interface Humanoid extends Instance {
|
|
|
23421
23467
|
*/
|
|
23422
23468
|
RightLeg: BasePart | undefined;
|
|
23423
23469
|
/**
|
|
23424
|
-
* A reference to the humanoid's
|
|
23470
|
+
* A reference to the humanoid's `HumanoidRootPart` object.
|
|
23425
23471
|
*
|
|
23426
23472
|
* - **ThreadSafety**: ReadSafe
|
|
23427
23473
|
* - **Tags**: NotReplicated
|
|
@@ -23836,7 +23882,7 @@ interface Humanoid extends Instance {
|
|
|
23836
23882
|
*/
|
|
23837
23883
|
ApplyDescription(this: Humanoid, humanoidDescription: HumanoidDescription, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): void;
|
|
23838
23884
|
/**
|
|
23839
|
-
* Makes the character's look match that of the passed in `HumanoidDescription`.
|
|
23885
|
+
* Makes the character's look match that of the passed in `HumanoidDescription`. If `UseAvatarSettings` is true, the Avatar Settings for the experience will also be applied to the character.
|
|
23840
23886
|
*
|
|
23841
23887
|
* - **ThreadSafety**: Unsafe
|
|
23842
23888
|
* - **Tags**: Yields
|
|
@@ -28357,6 +28403,12 @@ interface MarketplaceService extends Instance {
|
|
|
28357
28403
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#BindReceiptHandler)
|
|
28358
28404
|
*/
|
|
28359
28405
|
BindReceiptHandler(this: MarketplaceService, transactionType: CastsToEnum<Enum.ReceiptType>, handler: Callback, filter?: Array<unknown>): RBXScriptConnection;
|
|
28406
|
+
/**
|
|
28407
|
+
* - **ThreadSafety**: Unsafe
|
|
28408
|
+
*
|
|
28409
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#OpenShop)
|
|
28410
|
+
*/
|
|
28411
|
+
OpenShop(this: MarketplaceService, player: Player): void;
|
|
28360
28412
|
/**
|
|
28361
28413
|
* Prompts a user to purchase multiple avatar items with the given `assetId` or `bundleId`.
|
|
28362
28414
|
*
|
|
@@ -28412,10 +28464,13 @@ interface MarketplaceService extends Instance {
|
|
|
28412
28464
|
* Prompts a user to purchase Roblox Premium.
|
|
28413
28465
|
*
|
|
28414
28466
|
* - **ThreadSafety**: Unsafe
|
|
28467
|
+
* - **Tags**:
|
|
28415
28468
|
*
|
|
28416
28469
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PromptPremiumPurchase)
|
|
28417
28470
|
* @param this The service responsible for in-experience transactions.
|
|
28418
28471
|
* @param player The user being prompted to purchase Premium.
|
|
28472
|
+
*
|
|
28473
|
+
* @deprecated PromptRobloxSubscriptionPurchase
|
|
28419
28474
|
*/
|
|
28420
28475
|
PromptPremiumPurchase(this: MarketplaceService, player: Player): void;
|
|
28421
28476
|
/**
|
|
@@ -28445,9 +28500,13 @@ interface MarketplaceService extends Instance {
|
|
|
28445
28500
|
*/
|
|
28446
28501
|
PromptPurchase(this: MarketplaceService, player: Player, assetId: number, equipIfPurchased?: boolean, currencyType?: CastsToEnum<Enum.CurrencyType>): void;
|
|
28447
28502
|
/**
|
|
28503
|
+
* Prompts a user to purchase a Roblox Plus subscription.
|
|
28504
|
+
*
|
|
28448
28505
|
* - **ThreadSafety**: Unsafe
|
|
28449
28506
|
*
|
|
28450
28507
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PromptRobloxSubscriptionPurchase)
|
|
28508
|
+
* @param this The service responsible for in-experience transactions.
|
|
28509
|
+
* @param user The `Player` to be prompted to purchase Roblox Plus.
|
|
28451
28510
|
*/
|
|
28452
28511
|
PromptRobloxSubscriptionPurchase(this: MarketplaceService, user: Player): void;
|
|
28453
28512
|
/**
|
|
@@ -28514,12 +28573,15 @@ interface MarketplaceService extends Instance {
|
|
|
28514
28573
|
*/
|
|
28515
28574
|
GetProductInfoAsync(this: MarketplaceService, assetId: number, infoType?: CastsToEnum<Enum.InfoType>): object;
|
|
28516
28575
|
/**
|
|
28576
|
+
* Returns the subscription details for the given user for the Roblox Subscription ecosystem.
|
|
28577
|
+
*
|
|
28517
28578
|
* - **ThreadSafety**: Unsafe
|
|
28518
28579
|
* - **Tags**: Yields
|
|
28519
28580
|
*
|
|
28520
28581
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#GetRobloxSubscriptionDetailsAsync)
|
|
28521
28582
|
* @param this The service responsible for in-experience transactions.
|
|
28522
|
-
* @param user
|
|
28583
|
+
* @param user The user regarding whom to check the subscription status.
|
|
28584
|
+
* @returns A dictionary containing subscription details such as `IsSubscribed`, `IsOriginExperience`, and optionally `StartTime`.
|
|
28523
28585
|
*/
|
|
28524
28586
|
GetRobloxSubscriptionDetailsAsync(this: MarketplaceService, user: Player): object;
|
|
28525
28587
|
/**
|
|
@@ -28745,6 +28807,8 @@ interface MarketplaceService extends Instance {
|
|
|
28745
28807
|
*/
|
|
28746
28808
|
readonly PromptPurchaseFinished: RBXScriptSignal<(player: Player, assetId: number, isPurchased: boolean) => void>;
|
|
28747
28809
|
/**
|
|
28810
|
+
* Fires when a purchase prompt for Roblox Plus is closed.
|
|
28811
|
+
*
|
|
28748
28812
|
* - **ThreadSafety**: Unsafe
|
|
28749
28813
|
*
|
|
28750
28814
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/MarketplaceService#PromptRobloxSubscriptionPurchaseFinished)
|
|
@@ -31551,6 +31615,12 @@ interface Terrain extends BasePart {
|
|
|
31551
31615
|
* @param material The material with which the wedge will be filled.
|
|
31552
31616
|
*/
|
|
31553
31617
|
FillWedge(this: Terrain, cframe: CFrame, size: Vector3, material: CastsToEnum<Enum.Material>): void;
|
|
31618
|
+
/**
|
|
31619
|
+
* - **ThreadSafety**: Unsafe
|
|
31620
|
+
*
|
|
31621
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#GetBaseMaterialSlotIndex)
|
|
31622
|
+
*/
|
|
31623
|
+
GetBaseMaterialSlotIndex(this: Terrain, baseMaterial: CastsToEnum<Enum.Material>): number | undefined;
|
|
31554
31624
|
/**
|
|
31555
31625
|
* **Deprecated:** This item is a deprecated function of a legacy `Terrain` engine that has been removed. Do not use it for new work.
|
|
31556
31626
|
*
|
|
@@ -31568,6 +31638,12 @@ interface Terrain extends BasePart {
|
|
|
31568
31638
|
* @deprecated
|
|
31569
31639
|
*/
|
|
31570
31640
|
GetCell(this: Terrain, x: number, y: number, z: number): unknown;
|
|
31641
|
+
/**
|
|
31642
|
+
* - **ThreadSafety**: Unsafe
|
|
31643
|
+
*
|
|
31644
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#GetFirstCustomMaterialSlotIndex)
|
|
31645
|
+
*/
|
|
31646
|
+
GetFirstCustomMaterialSlotIndex(this: Terrain): number;
|
|
31571
31647
|
/**
|
|
31572
31648
|
* Returns current terrain material color for specified terrain material.
|
|
31573
31649
|
*
|
|
@@ -31578,6 +31654,12 @@ interface Terrain extends BasePart {
|
|
|
31578
31654
|
* @param material
|
|
31579
31655
|
*/
|
|
31580
31656
|
GetMaterialColor(this: Terrain, material: CastsToEnum<Enum.Material>): Color3;
|
|
31657
|
+
/**
|
|
31658
|
+
* - **ThreadSafety**: Unsafe
|
|
31659
|
+
*
|
|
31660
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#GetMaterialSlot)
|
|
31661
|
+
*/
|
|
31662
|
+
GetMaterialSlot(this: Terrain, slotIndex: number): unknown;
|
|
31581
31663
|
/**
|
|
31582
31664
|
* **Deprecated:** This item is a deprecated function of a legacy `Terrain` engine that has been removed. Do not use it for new work.
|
|
31583
31665
|
*
|
|
@@ -31688,6 +31770,12 @@ interface Terrain extends BasePart {
|
|
|
31688
31770
|
* @param targetMaterial The new material.
|
|
31689
31771
|
*/
|
|
31690
31772
|
ReplaceMaterial(this: Terrain, region: Region3, resolution: number, sourceMaterial: CastsToEnum<Enum.Material>, targetMaterial: CastsToEnum<Enum.Material>): void;
|
|
31773
|
+
/**
|
|
31774
|
+
* - **ThreadSafety**: Unsafe
|
|
31775
|
+
*
|
|
31776
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#ResetMaterialSlot)
|
|
31777
|
+
*/
|
|
31778
|
+
ResetMaterialSlot(this: Terrain, slotIndex: number): void;
|
|
31691
31779
|
/**
|
|
31692
31780
|
* **Deprecated:** This item is a deprecated function of a legacy `Terrain` engine that has been removed. Do not use it for new work.
|
|
31693
31781
|
*
|
|
@@ -31737,6 +31825,12 @@ interface Terrain extends BasePart {
|
|
|
31737
31825
|
* @param value
|
|
31738
31826
|
*/
|
|
31739
31827
|
SetMaterialColor(this: Terrain, material: CastsToEnum<Enum.Material>, value: Color3): void;
|
|
31828
|
+
/**
|
|
31829
|
+
* - **ThreadSafety**: Unsafe
|
|
31830
|
+
*
|
|
31831
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Terrain#SetMaterialSlot)
|
|
31832
|
+
*/
|
|
31833
|
+
SetMaterialSlot(this: Terrain, slotIndex: number, baseMaterial: CastsToEnum<Enum.Material>, materialVariant: string, color: Color3): void;
|
|
31740
31834
|
/**
|
|
31741
31835
|
* **Deprecated:** This item is a deprecated function of a legacy `Terrain` engine that has been removed. Do not use it for new work.
|
|
31742
31836
|
*
|
|
@@ -33071,6 +33165,8 @@ interface Tool extends BackpackItem {
|
|
|
33071
33165
|
readonly Unequipped: RBXScriptSignal<() => void>;
|
|
33072
33166
|
}
|
|
33073
33167
|
/**
|
|
33168
|
+
* Procedural models support edit-time procedural generation. Instead of manually constructing model content, a procedural model generates its contents automatically in response to parameter changes.
|
|
33169
|
+
*
|
|
33074
33170
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProceduralModel)
|
|
33075
33171
|
*/
|
|
33076
33172
|
interface ProceduralModel extends Model {
|
|
@@ -33083,6 +33179,8 @@ interface ProceduralModel extends Model {
|
|
|
33083
33179
|
*/
|
|
33084
33180
|
readonly _nominal_ProceduralModel: unique symbol;
|
|
33085
33181
|
/**
|
|
33182
|
+
* Stores errors that the generator module might encounter during generation.
|
|
33183
|
+
*
|
|
33086
33184
|
* - **ThreadSafety**: ReadSafe
|
|
33087
33185
|
* - **Tags**: NotReplicated
|
|
33088
33186
|
*
|
|
@@ -33090,12 +33188,16 @@ interface ProceduralModel extends Model {
|
|
|
33090
33188
|
*/
|
|
33091
33189
|
readonly GenerationError: string;
|
|
33092
33190
|
/**
|
|
33191
|
+
* A reference to a `ModuleScript` that contains code which defines how the `ProceduralModel` generates its contents in response to parameter changes.
|
|
33192
|
+
*
|
|
33093
33193
|
* - **ThreadSafety**: ReadSafe
|
|
33094
33194
|
*
|
|
33095
33195
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProceduralModel#Generator)
|
|
33096
33196
|
*/
|
|
33097
33197
|
Generator: ModuleScript | undefined;
|
|
33098
33198
|
/**
|
|
33199
|
+
* Defines the bounding volume used for generation.
|
|
33200
|
+
*
|
|
33099
33201
|
* - **ThreadSafety**: ReadSafe
|
|
33100
33202
|
*
|
|
33101
33203
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProceduralModel#Size)
|
|
@@ -33105,15 +33207,18 @@ interface ProceduralModel extends Model {
|
|
|
33105
33207
|
* - **ThreadSafety**: Unsafe
|
|
33106
33208
|
*
|
|
33107
33209
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProceduralModel#ForceGeneration)
|
|
33108
|
-
* @param this
|
|
33210
|
+
* @param this Procedural models support edit-time procedural generation. Instead of manually constructing model content, a procedural model generates its contents automatically in response to parameter changes.
|
|
33109
33211
|
*/
|
|
33110
33212
|
ForceGeneration(this: ProceduralModel): boolean;
|
|
33111
33213
|
/**
|
|
33214
|
+
* Waits for generation to complete after making parameter changes.
|
|
33215
|
+
*
|
|
33112
33216
|
* - **ThreadSafety**: Unsafe
|
|
33113
33217
|
* - **Tags**: Yields
|
|
33114
33218
|
*
|
|
33115
33219
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/ProceduralModel#WaitForGenerationAsync)
|
|
33116
|
-
* @param this
|
|
33220
|
+
* @param this Procedural models support edit-time procedural generation. Instead of manually constructing model content, a procedural model generates its contents automatically in response to parameter changes.
|
|
33221
|
+
* @returns Was the generation successful?
|
|
33117
33222
|
*/
|
|
33118
33223
|
WaitForGenerationAsync(this: ProceduralModel): boolean;
|
|
33119
33224
|
}
|
|
@@ -33895,7 +34000,7 @@ interface DataStoreVersionPages extends Pages<DataStoreObjectVersionInfo> {
|
|
|
33895
34000
|
readonly _nominal_DataStoreVersionPages: unique symbol;
|
|
33896
34001
|
}
|
|
33897
34002
|
/**
|
|
33898
|
-
* A special version of `Pages` that contains information about a player's
|
|
34003
|
+
* A special version of `Pages` that contains information about a player's friends.
|
|
33899
34004
|
*
|
|
33900
34005
|
* - **Tags**: NotCreatable, NotReplicated
|
|
33901
34006
|
*
|
|
@@ -33932,21 +34037,6 @@ interface InventoryPages<T = unknown> extends Pages<T> {
|
|
|
33932
34037
|
*/
|
|
33933
34038
|
readonly _nominal_InventoryPages: unique symbol;
|
|
33934
34039
|
}
|
|
33935
|
-
/**
|
|
33936
|
-
* - **Tags**: NotCreatable, NotReplicated
|
|
33937
|
-
*
|
|
33938
|
-
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/EmotesPages)
|
|
33939
|
-
*/
|
|
33940
|
-
interface EmotesPages extends InventoryPages {
|
|
33941
|
-
/**
|
|
33942
|
-
* **DO NOT USE!**
|
|
33943
|
-
*
|
|
33944
|
-
* This field exists to force TypeScript to recognize this as a nominal type
|
|
33945
|
-
* @hidden
|
|
33946
|
-
* @deprecated
|
|
33947
|
-
*/
|
|
33948
|
-
readonly _nominal_EmotesPages: unique symbol;
|
|
33949
|
-
}
|
|
33950
34040
|
/**
|
|
33951
34041
|
* A special type of `Pages` object whose pages contain key-value pairs from a `MemoryStoreHashMap`.
|
|
33952
34042
|
*
|
|
@@ -35239,6 +35329,8 @@ interface Player extends Instance {
|
|
|
35239
35329
|
*/
|
|
35240
35330
|
get GameplayPaused(): boolean;
|
|
35241
35331
|
/**
|
|
35332
|
+
* Indicates whether the player has an active Roblox subscription.
|
|
35333
|
+
*
|
|
35242
35334
|
* - **ThreadSafety**: ReadSafe
|
|
35243
35335
|
*
|
|
35244
35336
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#HasRobloxSubscription)
|
|
@@ -35602,31 +35694,38 @@ interface Player extends Instance {
|
|
|
35602
35694
|
/**
|
|
35603
35695
|
* **Deprecated:** This method has been superseded by `GetFriendsOnlineAsync()`.
|
|
35604
35696
|
*
|
|
35605
|
-
* Returns a dictionary of online
|
|
35697
|
+
* Returns a dictionary of online friends. Returns the product information of an asset using its asset ID.
|
|
35606
35698
|
*
|
|
35607
35699
|
* - **ThreadSafety**: Unsafe
|
|
35608
35700
|
* - **Tags**: Yields
|
|
35609
35701
|
*
|
|
35610
35702
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetFriendsOnline)
|
|
35611
35703
|
* @param this An object that represents a presently connected client to the experience.
|
|
35612
|
-
* @param maxFriends The maximum number of online
|
|
35613
|
-
* @returns A dictionary of online
|
|
35704
|
+
* @param maxFriends The maximum number of online friends to return.
|
|
35705
|
+
* @returns A dictionary of online friends (see the table above).
|
|
35614
35706
|
*
|
|
35615
35707
|
* @deprecated GetFriendsOnlineAsync
|
|
35616
35708
|
*/
|
|
35617
35709
|
GetFriendsOnline(this: Player, maxFriends?: number): Array<FriendOnlineInfo>;
|
|
35618
35710
|
/**
|
|
35619
|
-
* Returns a dictionary of online
|
|
35711
|
+
* Returns a dictionary of online friends.
|
|
35620
35712
|
*
|
|
35621
35713
|
* - **ThreadSafety**: Unsafe
|
|
35622
35714
|
* - **Tags**: Yields
|
|
35623
35715
|
*
|
|
35624
35716
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetFriendsOnlineAsync)
|
|
35625
35717
|
* @param this An object that represents a presently connected client to the experience.
|
|
35626
|
-
* @param maxFriends The maximum number of online
|
|
35627
|
-
* @returns A dictionary of online
|
|
35718
|
+
* @param maxFriends The maximum number of online friends to return.
|
|
35719
|
+
* @returns A dictionary of online friends (see the table above).
|
|
35628
35720
|
*/
|
|
35629
35721
|
GetFriendsOnlineAsync(this: Player, maxFriends?: number): Array<unknown>;
|
|
35722
|
+
/**
|
|
35723
|
+
* - **ThreadSafety**: Unsafe
|
|
35724
|
+
* - **Tags**: Yields
|
|
35725
|
+
*
|
|
35726
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#GetFriendsWhoPlayedAsync)
|
|
35727
|
+
*/
|
|
35728
|
+
GetFriendsWhoPlayedAsync(this: Player): Array<unknown>;
|
|
35630
35729
|
/**
|
|
35631
35730
|
* **Deprecated:**
|
|
35632
35731
|
*
|
|
@@ -35686,7 +35785,7 @@ interface Player extends Instance {
|
|
|
35686
35785
|
/**
|
|
35687
35786
|
* **Deprecated:** This function is obsolete because the "best friends" feature was removed. Use `Player:IsFriendsWithAsync()` instead.
|
|
35688
35787
|
*
|
|
35689
|
-
* Returns whether a player is
|
|
35788
|
+
* Returns whether a player is friends with the specified user.
|
|
35690
35789
|
*
|
|
35691
35790
|
* - **ThreadSafety**: Unsafe
|
|
35692
35791
|
* - **Tags**: Yields
|
|
@@ -35701,7 +35800,7 @@ interface Player extends Instance {
|
|
|
35701
35800
|
/**
|
|
35702
35801
|
* **Deprecated:** This method has been superseded by the `Player:IsFriendsWithAsync()` method which should be used for new work.
|
|
35703
35802
|
*
|
|
35704
|
-
* Checks whether a player is a
|
|
35803
|
+
* Checks whether a player is a friend of the user with the given `Player.UserId`.
|
|
35705
35804
|
*
|
|
35706
35805
|
* - **ThreadSafety**: Unsafe
|
|
35707
35806
|
* - **Tags**: Yields
|
|
@@ -35709,13 +35808,13 @@ interface Player extends Instance {
|
|
|
35709
35808
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#IsFriendsWith)
|
|
35710
35809
|
* @param this An object that represents a presently connected client to the experience.
|
|
35711
35810
|
* @param userId The `Player.UserId` of the specified player.
|
|
35712
|
-
* @returns A boolean indicating whether a player is a
|
|
35811
|
+
* @returns A boolean indicating whether a player is a friend of the specified user.
|
|
35713
35812
|
*
|
|
35714
35813
|
* @deprecated IsFriendsWithAsync
|
|
35715
35814
|
*/
|
|
35716
35815
|
IsFriendsWith(this: Player, userId: number): boolean;
|
|
35717
35816
|
/**
|
|
35718
|
-
* Checks whether a player is a
|
|
35817
|
+
* Checks whether a player is a friend of the user with the given `Player.UserId`.
|
|
35719
35818
|
*
|
|
35720
35819
|
* - **ThreadSafety**: Unsafe
|
|
35721
35820
|
* - **Tags**: Yields
|
|
@@ -35723,7 +35822,7 @@ interface Player extends Instance {
|
|
|
35723
35822
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/Player#IsFriendsWithAsync)
|
|
35724
35823
|
* @param this An object that represents a presently connected client to the experience.
|
|
35725
35824
|
* @param userId The `Player.UserId` of the specified player.
|
|
35726
|
-
* @returns A boolean indicating whether a player is a
|
|
35825
|
+
* @returns A boolean indicating whether a player is a friend of the specified user.
|
|
35727
35826
|
*/
|
|
35728
35827
|
IsFriendsWithAsync(this: Player, userId: number): boolean;
|
|
35729
35828
|
/**
|
|
@@ -36417,7 +36516,7 @@ interface Players extends Instance {
|
|
|
36417
36516
|
*/
|
|
36418
36517
|
CreateHumanoidModelFromDescription(this: Players, description: HumanoidDescription, rigType: CastsToEnum<Enum.HumanoidRigType>, assetTypeVerification?: CastsToEnum<Enum.AssetTypeVerification>): Model;
|
|
36419
36518
|
/**
|
|
36420
|
-
* Returns a character `Model` equipped with everything specified in the passed in `HumanoidDescription`.
|
|
36519
|
+
* Returns a character `Model` equipped with everything specified in the passed in `HumanoidDescription`. If `UseAvatarSettings` is set to true, Avatar Settings in the experience will be applied to the returned model.
|
|
36421
36520
|
*
|
|
36422
36521
|
* - **ThreadSafety**: Unsafe
|
|
36423
36522
|
* - **Tags**: Yields
|
|
@@ -36498,7 +36597,7 @@ interface Players extends Instance {
|
|
|
36498
36597
|
*/
|
|
36499
36598
|
GetCharacterAppearanceInfoAsync(this: Players, userId: number): CharacterAppearanceInfo;
|
|
36500
36599
|
/**
|
|
36501
|
-
* Returns a `FriendPages` object which contains information for all of the given player's
|
|
36600
|
+
* Returns a `FriendPages` object which contains information for all of the given player's friends.
|
|
36502
36601
|
*
|
|
36503
36602
|
* - **ThreadSafety**: Unsafe
|
|
36504
36603
|
* - **Tags**: Yields
|
|
@@ -36670,6 +36769,8 @@ interface PluginCapabilities extends Instance {
|
|
|
36670
36769
|
readonly _nominal_PluginCapabilities: unique symbol;
|
|
36671
36770
|
}
|
|
36672
36771
|
/**
|
|
36772
|
+
* This service is used by plugins to communicate with other instances of themselves running in other data models.
|
|
36773
|
+
*
|
|
36673
36774
|
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
36674
36775
|
*
|
|
36675
36776
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginConnectionService)
|
|
@@ -38304,7 +38405,7 @@ interface RunService extends Instance {
|
|
|
38304
38405
|
* @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.
|
|
38305
38406
|
* @param frequency Optional `StepFrequency` value indicating the frequency at which to call the bound function. If not provided, the default frequency will be used.
|
|
38306
38407
|
*/
|
|
38307
|
-
BindToSimulation(this: RunService, callback: Callback, frequency?: CastsToEnum<Enum.StepFrequency
|
|
38408
|
+
BindToSimulation(this: RunService, callback: Callback, frequency?: CastsToEnum<Enum.StepFrequency>, priority?: number): RBXScriptConnection;
|
|
38308
38409
|
/**
|
|
38309
38410
|
* Checks the `PredictionStatus` of a specific context instance, useful for debugging scripts affecting multiple instances where some might be predicted and others might not.
|
|
38310
38411
|
*
|
|
@@ -38513,6 +38614,63 @@ interface SafetyService extends Instance {
|
|
|
38513
38614
|
*/
|
|
38514
38615
|
readonly _nominal_SafetyService: unique symbol;
|
|
38515
38616
|
}
|
|
38617
|
+
/**
|
|
38618
|
+
* - **Tags**: NotCreatable, Service, NotReplicated
|
|
38619
|
+
*
|
|
38620
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SceneAnalysisService)
|
|
38621
|
+
*/
|
|
38622
|
+
interface SceneAnalysisService extends Instance {
|
|
38623
|
+
/**
|
|
38624
|
+
* **DO NOT USE!**
|
|
38625
|
+
*
|
|
38626
|
+
* This field exists to force TypeScript to recognize this as a nominal type
|
|
38627
|
+
* @hidden
|
|
38628
|
+
* @deprecated
|
|
38629
|
+
*/
|
|
38630
|
+
readonly _nominal_SceneAnalysisService: unique symbol;
|
|
38631
|
+
/**
|
|
38632
|
+
* - **ThreadSafety**: Unsafe
|
|
38633
|
+
* - **Tags**: Yields
|
|
38634
|
+
*
|
|
38635
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SceneAnalysisService#GetAnimationMemoryAsync)
|
|
38636
|
+
*/
|
|
38637
|
+
GetAnimationMemoryAsync(this: SceneAnalysisService): object;
|
|
38638
|
+
/**
|
|
38639
|
+
* - **ThreadSafety**: Unsafe
|
|
38640
|
+
* - **Tags**: Yields
|
|
38641
|
+
*
|
|
38642
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SceneAnalysisService#GetAudioMemoryAsync)
|
|
38643
|
+
*/
|
|
38644
|
+
GetAudioMemoryAsync(this: SceneAnalysisService): object;
|
|
38645
|
+
/**
|
|
38646
|
+
* - **ThreadSafety**: Unsafe
|
|
38647
|
+
* - **Tags**: Yields
|
|
38648
|
+
*
|
|
38649
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SceneAnalysisService#GetInstanceCompositionAsync)
|
|
38650
|
+
*/
|
|
38651
|
+
GetInstanceCompositionAsync(this: SceneAnalysisService): object;
|
|
38652
|
+
/**
|
|
38653
|
+
* - **ThreadSafety**: Unsafe
|
|
38654
|
+
* - **Tags**: Yields
|
|
38655
|
+
*
|
|
38656
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SceneAnalysisService#GetScriptMemoryAsync)
|
|
38657
|
+
*/
|
|
38658
|
+
GetScriptMemoryAsync(this: SceneAnalysisService): object;
|
|
38659
|
+
/**
|
|
38660
|
+
* - **ThreadSafety**: Unsafe
|
|
38661
|
+
* - **Tags**: Yields
|
|
38662
|
+
*
|
|
38663
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SceneAnalysisService#GetTriangleCompositionAsync)
|
|
38664
|
+
*/
|
|
38665
|
+
GetTriangleCompositionAsync(this: SceneAnalysisService): object;
|
|
38666
|
+
/**
|
|
38667
|
+
* - **ThreadSafety**: Unsafe
|
|
38668
|
+
* - **Tags**: Yields
|
|
38669
|
+
*
|
|
38670
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SceneAnalysisService#GetUnparentedInstancesAsync)
|
|
38671
|
+
*/
|
|
38672
|
+
GetUnparentedInstancesAsync(this: SceneAnalysisService): object;
|
|
38673
|
+
}
|
|
38516
38674
|
/**
|
|
38517
38675
|
* A 2D user interface that allows users to capture and save screenshots to their local device.
|
|
38518
38676
|
*
|
|
@@ -42252,6 +42410,12 @@ interface StyleRule extends StyleBase {
|
|
|
42252
42410
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleRule#SelectorError)
|
|
42253
42411
|
*/
|
|
42254
42412
|
readonly SelectorError: string;
|
|
42413
|
+
/**
|
|
42414
|
+
* - **ThreadSafety**: Unsafe
|
|
42415
|
+
*
|
|
42416
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleRule#GetDefaultPropertyTransition)
|
|
42417
|
+
*/
|
|
42418
|
+
GetDefaultPropertyTransition(this: StyleRule): unknown;
|
|
42255
42419
|
/**
|
|
42256
42420
|
* Returns a dictionary of key-value pairs describing the properties of the `StyleRule`.
|
|
42257
42421
|
*
|
|
@@ -42280,6 +42444,12 @@ interface StyleRule extends StyleBase {
|
|
|
42280
42444
|
* @param this Defines style properties which override properties on the instances affected by the `Selector` property.
|
|
42281
42445
|
*/
|
|
42282
42446
|
GetPropertyTransitions(this: StyleRule): object;
|
|
42447
|
+
/**
|
|
42448
|
+
* - **ThreadSafety**: Unsafe
|
|
42449
|
+
*
|
|
42450
|
+
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/StyleRule#SetDefaultPropertyTransition)
|
|
42451
|
+
*/
|
|
42452
|
+
SetDefaultPropertyTransition(this: StyleRule, transitionParams: unknown): void;
|
|
42283
42453
|
/**
|
|
42284
42454
|
* Lets you declare and set multiple properties of the `StyleRule` at once.
|
|
42285
42455
|
*
|
|
@@ -49420,6 +49590,8 @@ interface OutputLink extends RBXObject {
|
|
|
49420
49590
|
readonly _nominal_OutputLink: unique symbol;
|
|
49421
49591
|
}
|
|
49422
49592
|
/**
|
|
49593
|
+
* Encapsulates a connection between the current data model and another for plugin communication.
|
|
49594
|
+
*
|
|
49423
49595
|
* - **Tags**: NotCreatable, NotReplicated
|
|
49424
49596
|
*
|
|
49425
49597
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/PluginConnection)
|
|
@@ -49593,6 +49765,8 @@ interface VideoSampler extends RBXObject {
|
|
|
49593
49765
|
GetSamplesAtTimesAsync(this: VideoSampler, times: Array<unknown>): Array<unknown>;
|
|
49594
49766
|
}
|
|
49595
49767
|
/**
|
|
49768
|
+
* Allows Studio plugins to simulate mouse, keyboard, and pointer input as if it were performed by a real player.
|
|
49769
|
+
*
|
|
49596
49770
|
* - **Tags**: NotCreatable, NotReplicated
|
|
49597
49771
|
*
|
|
49598
49772
|
* [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/VirtualInput)
|